Skip to content

Payout service APIs (1.0.0)

Payout service APIs

Overview
E-mail

kjakkula@ripple.com

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/

Forex

Operations

Payout Partner

Operations

Payout Method

Operations

Data requirements

Operations

Payouts

Operations

PayoutsV2

Operations

Quotes

Operations

Webhooks

Operations

Tranglo

Operations

Routing

Operations

Get the routing data

Request

Get the routing information

Query
country_codestring

payout country code

currency_codestring

payout currency code

payout_methodstring

payout method

payout_categorystring

payout category

amountnumber

Amount to be transferred

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-direct/api-docs/payout-service/payout-service/v1/routes?country_code=string&currency_code=string&payout_method=string&payout_category=string&amount=0'

Responses

Returns a routing info matching the criteria

Bodyapplication/json
routing_listArray of objects

A list of routing data

Example: [{"country_code":"VN","payout_currency_code":"VND","destination_exchange":"IR","priority":1,"enabled":true,"payout_method":"CSM_VN_VND"}]
country_codestring^[A-Z]{2,3}$

country code

Example: "VN"
payout_currency_codestring^[A-Z]{3,4}$

payout currency code

Example: "VND"
destination_exchangestring

destination exchange name

Example: "IR"
priorityinteger

priority level

Example: 1
enabledboolean

activity status

Example: true
payout_methodstring

payout method category

Example: "CSM_VN_VND"
payout_categorystring

payout category

Example: "BANK"
bridge_currencystring

bridge currency

Example: "XRP"
payout_partner_namestring

payout partner name

Example: "Tranglo"
payout_method_idstring(uuid)

payout method id

Example: "BANK"
payout_feestring(double)

payout fee

Example: 12.4
payout_triggerstring

payout trigger

Example: "PAYOUT_ON_LIQUIDATION"
funding_modelstring

funding model

Example: "CRYPTO_FUNDING"
receiver_wallet_addressstring

receiver wallet address

Example: "rLSn6Z3T8uCxbcd1oxwfGQN1Fdn5CyGujK?dt=25490962"
Response
application/json
{
  "routing_list": [
    { … }
  ]
}

Data Requirement

Operations