Skip to content

RippleNet Server API (4.0.0)

The RippleNet Server API provides you the ability to develop custom applications to manage or interact with your RippleNet instance.

Check out the best practices and tutorials.

Authentication

All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.

API environments

The RippleNet Server API creates a dynamic [domainPrefix] that consists of {tenant}.{environment}.

Note: This example uses aperture as the tenant. Your tenant ID is different.

EnvironmentDomaing PrefixDomainBase URL
Testaperture.testripplexcurrent.comhttps://aperture.test.ripplexcurrent.com
UATaperture.uatripplexcurrent.comhttps://aperture.uat.ripplexcurrent.com
Productionaperture.prodripplexcurrent.comhttps://aperture.prod.ripplexcurrent.com
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/

https://[domainPrefix].ripplexcurrent.com/v4/

Account configuration

Operations

Auditing

Operations

Balances and statements

Operations

Beneficiary confirmation

Operations

Diagnostics

Operations

Exchange transfers

Operations

Fees

Operations

Liquidation configuration

Operations

Non-orchestration payments

Operations

Notifications

Operations

ODL flags configuration

Operations

Orchestration payments

Operations

Payment expiration

Operations

Payout method

Operations

Create payout method

Request

Creates a payout method (for example, LOCAL_RAILS). <p>The Payout Method API lets receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods by enabling the flag <code>enable_quote_per_payout_method</code> in the body of the [Create quote collection] request. </p><p><b>Caution:</b> The existing quote parameter is named <code>payment_method</code> while elsewhere it is <code>payout_method</code>.</p><p><b>Note:</b> On-Demand Liquidity (ODL) receivers should set <code>payment_method</code> to the <code>outlet_id</code> or the string <code>none</code> (not an empty value) to keep funds at the destination exchange when paying out to a local rail.</p>

Security
Bearer
Bodyapplication/jsonrequired
payout_methodstringrequired

Unique string used in the quote to identify the payout method.

Example: "LOCAL_RAILS"
descriptionstring

User defined description of a payout method.

Example: "local rails"
is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to <code>OTHER</code> if not specified.

Enum"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"
Example: "BOOK_TRANSFER"
estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

time_valueinteger(int64)required

The amount of estimated time to credit.

Example: 5
time_unitstringrequired

Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

Enum"SECONDS""MINUTES""HOURS""DAYS"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payout_methods \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_method": "LOCAL_RAILS",
    "description": "local rails",
    "is_default": true,
    "payout_method_category": "BOOK_TRANSFER",
    "estimated_time_to_credit": {
      "time_value": 5,
      "time_unit": "SECONDS"
    }
  }'

Responses

Successfully created payout method.

Bodyapplication/json
payout_method_idstring(uuid)

Unique identifier of a payout method.

Example: "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0"
payout_methodstring

Unique string to identify the payout method.

Example: "LOCAL_RAILS"
descriptionstring

User defined description of a payout method.

Example: "local rails"
is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to <code>OTHER</code> if not specified.

Enum"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"
Example: "BOOK_TRANSFER"
estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

time_valueinteger(int64)required

The amount of estimated time to credit.

Example: 5
time_unitstringrequired

Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

Enum"SECONDS""MINUTES""HOURS""DAYS"
Response
application/json
{
  "payout_method_id": "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0",
  "payout_method": "LOCAL_RAILS",
  "description": "local rails",
  "is_default": true,
  "payout_method_category": "BOOK_TRANSFER",
  "estimated_time_to_credit": {
    "time_value": 5,
    "time_unit": "SECONDS"
  }
}

Get payout methods

Request

Returns a list of payout methods created by a receiving partner.

Security
Bearer
Query
pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.<br/> Set it to 0 to get the first page of results.

Default 0
sizeinteger[ 1 .. 100 ]

Number of payments to return per page.

Default 10
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payout_methods?page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
firstboolean

true if this is the first page.

lastboolean

true if this is the last page.

numberinteger

page number

numberOfElementsinteger

Number Of elements in this request

sizeinteger

page size

totalElementsinteger(int64)

Total number of elements for the given request

totalPagesinteger

Total number of pages for the given request

sortArray of objects

Sort details of this page

directionstring

Direction of the sort

Example: "ASC"
propertystring
ignoreCaseboolean
nullHandlingstring
Example: "NULLS_FIRST"
ascendingboolean
Example: true
descendingboolean
Example: false
contentArray of objects
payout_method_idstring(uuid)

Unique identifier of a payout method.

Example: "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0"
payout_methodstring

Unique string to identify the payout method.

Example: "LOCAL_RAILS"
descriptionstring

User defined description of a payout method.

Example: "local rails"
is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to <code>OTHER</code> if not specified.

Enum"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"
Example: "BOOK_TRANSFER"
estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

time_valueinteger(int64)required

The amount of estimated time to credit.

Example: 5
time_unitstringrequired

Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

Enum"SECONDS""MINUTES""HOURS""DAYS"
Response
application/json
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}

Get payout method by ID

Request

Returns a payout method by its ID.

Security
Bearer
Path
payout_method_idstring(uuid)required

ID of the payout method you want to retrieve.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payout_methods/{payout_method_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned Payout method

Bodyapplication/json
payout_method_idstring(uuid)

Unique identifier of a payout method.

Example: "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0"
payout_methodstring

Unique string to identify the payout method.

Example: "LOCAL_RAILS"
descriptionstring

User defined description of a payout method.

Example: "local rails"
is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to <code>OTHER</code> if not specified.

Enum"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"
Example: "BOOK_TRANSFER"
estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

time_valueinteger(int64)required

The amount of estimated time to credit.

Example: 5
time_unitstringrequired

Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

Enum"SECONDS""MINUTES""HOURS""DAYS"
Response
application/json
{
  "payout_method_id": "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0",
  "payout_method": "LOCAL_RAILS",
  "description": "local rails",
  "is_default": true,
  "payout_method_category": "BOOK_TRANSFER",
  "estimated_time_to_credit": {
    "time_value": 5,
    "time_unit": "SECONDS"
  }
}

Update payout method

Request

Updates a payout method.

Security
Bearer
Path
payout_method_idstring(uuid)required

ID of the payout method you want to retrieve.

Bodyapplication/jsonrequired
payout_methodstringrequired

Unique string used in the quote to identify the payout method.

Example: "LOCAL_RAILS"
descriptionstring

User defined description of a payout method.

Example: "local rails"
is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to <code>OTHER</code> if not specified.

Enum"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"
Example: "BOOK_TRANSFER"
estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

time_valueinteger(int64)required

The amount of estimated time to credit.

Example: 5
time_unitstringrequired

Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

Enum"SECONDS""MINUTES""HOURS""DAYS"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payout_methods/{payout_method_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "payout_method": "LOCAL_RAILS",
    "description": "local rails",
    "is_default": true,
    "payout_method_category": "BOOK_TRANSFER",
    "estimated_time_to_credit": {
      "time_value": 5,
      "time_unit": "SECONDS"
    }
  }'

Responses

Successfully saved Payout method

Bodyapplication/json
payout_method_idstring(uuid)

Unique identifier of a payout method.

Example: "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0"
payout_methodstring

Unique string to identify the payout method.

Example: "LOCAL_RAILS"
descriptionstring

User defined description of a payout method.

Example: "local rails"
is_defaultboolean

Flag to set this payout method as the default payout method.

payout_method_categorystring

Category of the payout method. Defaults to <code>OTHER</code> if not specified.

Enum"REAL_TIME_GROSS_SETTLEMENT_SYSTEM""REAL_TIME_NET_SETTLEMENT_SYSTEM""MASS_NET_PAYMENT_SYSTEM""BOOK_TRANSFER""CASH_PAYOUT""WALLET_PAYMENT""OTHER"
Example: "BOOK_TRANSFER"
estimated_time_to_creditobject

The estimated time to credit the beneficiary using this payout method.

time_valueinteger(int64)required

The amount of estimated time to credit.

Example: 5
time_unitstringrequired

Unit of the estimated time to credit: <code>SECONDS</code>, <code>MINUTES</code>, <code>HOURS</code>, <code>DAYS</code>.

Enum"SECONDS""MINUTES""HOURS""DAYS"
Response
application/json
{
  "payout_method_id": "a6dbe002-ca7f-4ec7-89e4-f44a1971a0c0",
  "payout_method": "LOCAL_RAILS",
  "description": "local rails",
  "is_default": true,
  "payout_method_category": "BOOK_TRANSFER",
  "estimated_time_to_credit": {
    "time_value": 5,
    "time_unit": "SECONDS"
  }
}

Delete payout method

Request

Deletes a payout method.

Security
Bearer
Path
payout_method_idstring(uuid)required

ID of the payout method you want to retrieve.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payout_methods/{payout_method_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully deleted payout method.

Response
No content

Get all categories

Request

Returns all the payout method categories.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payout_methods/categories \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned Payout method Categories

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

Platform accounts

Operations

Pool accounts

Operations

Quote expiration

Operations

Quotes

Operations

Rates

Operations

Request for payment

Operations

Sender segregated account configuration

Operations

Transfers

Operations

schema

Operations

activity

Operations

Orchestration Template

Operations

diagnostics

Operations

payment

Operations

Get application info

Request

Gets application information.

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched application info.

Bodyapplication/json
namestring

Application name.

Example: "Integration Module"
versionstring

Application version.

Example: "1.2.0"
Response
application/json
{
  "name": "Integration Module",
  "version": "1.2.0"
}

tenant

Operations

Orchestration internal action

Operations

Orchestration internal payments

Operations

Orchestration internal notifications

Operations