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

Platform accounts

Operations

Create platform

Request

Creates a RippleNet platform, which represents a financial entity that holds accounts in the real world (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node.

Security
Bearer
Bodyapplication/jsonrequired
namestringrequired

Name of the platform.

platform_typestringrequired

The type of institution this platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

Enum"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring<= 512 characters

A short description of the platform.

institutionstringrequired

Name of the institution this platform represents.

servicer_codestringrequired

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/platforms \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_type": "WALLET_PROVIDER",
    "description": "string",
    "institution": "string",
    "servicer_code": "string"
  }'

Responses

Successfully created RippleNet platform.

Bodyapplication/json
platform_idstring(uuid)

Unique identifier for the RippleNet platform.

namestring

Name of the RippleNet platform.

platform_typestring

The type of institution this RippleNet platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

Enum"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring<= 512 characters

A short description of the RippleNet platform.

institutionstring

Name of the institution this RippleNet platform represents.

servicer_codestring

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

Response
application/json
{
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "name": "string",
  "platform_type": "WALLET_PROVIDER",
  "description": "string",
  "institution": "string",
  "servicer_code": "string"
}

Get all platforms

Request

Returns a list of all active RippleNet platforms.

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

Responses

List of all active RippleNet platforms.

Bodyapplication/jsonArray [
platform_idstring(uuid)

Unique identifier for the RippleNet platform.

namestring

Name of the RippleNet platform.

platform_typestring

The type of institution this RippleNet platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

Enum"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring<= 512 characters

A short description of the RippleNet platform.

institutionstring

Name of the institution this RippleNet platform represents.

servicer_codestring

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

]
Response
application/json
[
  {
    "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
    "name": "string",
    "platform_type": "WALLET_PROVIDER",
    "description": "string",
    "institution": "string",
    "servicer_code": "string"
  }
]

Get platform by platform ID

Request

Get a RippleNet platform by its platform ID.

Security
Bearer
Path
platform_idstring(uuid)required

ID of the platform you want to retrieve.

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

Responses

Returns a RippleNet platform for the given platform ID.

Bodyapplication/json
platform_idstring(uuid)

Unique identifier for the RippleNet platform.

namestring

Name of the RippleNet platform.

platform_typestring

The type of institution this RippleNet platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

Enum"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring<= 512 characters

A short description of the RippleNet platform.

institutionstring

Name of the institution this RippleNet platform represents.

servicer_codestring

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

Response
application/json
{
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "name": "string",
  "platform_type": "WALLET_PROVIDER",
  "description": "string",
  "institution": "string",
  "servicer_code": "string"
}

Update platform

Request

Updates a RippleNet platform, which represents a financial entity that holds accounts in the real world (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node.

Security
Bearer
Path
platform_idstring(uuid)required

ID of the platform you want to update.

Bodyapplication/jsonrequired
namestring

Name of the platform.

platform_typestring

The type of institution this platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

Enum"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring<= 512 characters

A short description of the platform.

institutionstring

Name of the institution this platform represents.

servicer_codestring

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/platforms/{platform_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_type": "WALLET_PROVIDER",
    "description": "string",
    "institution": "string",
    "servicer_code": "string"
  }'

Responses

Successfully updated RippleNet platform.

Bodyapplication/json
platform_idstring(uuid)

Unique identifier for the RippleNet platform.

namestring

Name of the RippleNet platform.

platform_typestring

The type of institution this RippleNet platform represents (WALLET_PROVIDER, FIAT_INSTITUTION, or DIGITAL_EXCHANGE).

Enum"WALLET_PROVIDER""FIAT_INSTITUTION""DIGITAL_EXCHANGE"
descriptionstring<= 512 characters

A short description of the RippleNet platform.

institutionstring

Name of the institution this RippleNet platform represents.

servicer_codestring

Akin to the routing number (US), Sort Code (UK), or IFSC code (India).

Response
application/json
{
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "name": "string",
  "platform_type": "WALLET_PROVIDER",
  "description": "string",
  "institution": "string",
  "servicer_code": "string"
}

Delete platform by platform ID

Request

Deletes a RippleNet platform by its platform ID.

Security
Bearer
Path
platform_idstring(uuid)required

ID of the platform you want to delete.

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

Responses

Deleted platform successfully.

Response
No content

Create platform account

Request

Creates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider). This operation creates a database record for a platform account on a RippleNet node.

Security
Bearer
Bodyapplication/jsonrequired
namestringrequired

Name of the platform account.

platform_idstring(uuid)required

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring<= 512 characters

A short description of the platform account.

external_account_idstringrequired

Unique reference identifier for the real world account which is represented by this platform account.

currencystring<= 3 charactersrequired

The currency of the account. Ripple recommends using ISO-4217 currency codes.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/platforms/accounts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
    "description": "string",
    "external_account_id": "string",
    "currency": "str"
  }'

Responses

Successfully created RippleNet platform account.

Bodyapplication/json
platform_account_idstring(uuid)

Unique identifier for the platform account.

namestring

Name of the platform account.

platform_idstring(uuid)

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring<= 512 characters

A short description of the platform account.

external_account_idstring

Unique reference identifier for the real world account which is represented by this platform account.

currencystring

The currency of the account. Ripple recommends using ISO-4217 currency codes.

balancenumber

Real world account balance of the platform account (if available)

Response
application/json
{
  "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
  "name": "string",
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "description": "string",
  "external_account_id": "string",
  "currency": "string",
  "balance": 0
}

Get platform accounts

Request

Returns a paged list of all active RippleNet platform accounts.

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 objects to return per page.

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

Responses

Paged list of all active RippleNet platform accounts.

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
platform_account_idstring(uuid)

Unique identifier for the platform account.

namestring

Name of the platform account.

platform_idstring(uuid)

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring<= 512 characters

A short description of the platform account.

external_account_idstring

Unique reference identifier for the real world account which is represented by this platform account.

currencystring

The currency of the account. Ripple recommends using ISO-4217 currency codes.

balancenumber

Real world account balance of the platform account (if available)

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

Get platform account by platform account ID

Request

Gets a RippleNet platform account by its platform account ID.

Security
Bearer
Path
platform_account_idstring(uuid)required

ID of the platform account you want to retrieve.

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

Responses

Returns a RippleNet platform account for the given platform account ID.

Bodyapplication/json
platform_account_idstring(uuid)

Unique identifier for the platform account.

namestring

Name of the platform account.

platform_idstring(uuid)

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring<= 512 characters

A short description of the platform account.

external_account_idstring

Unique reference identifier for the real world account which is represented by this platform account.

currencystring

The currency of the account. Ripple recommends using ISO-4217 currency codes.

balancenumber

Real world account balance of the platform account (if available)

Response
application/json
{
  "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
  "name": "string",
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "description": "string",
  "external_account_id": "string",
  "currency": "string",
  "balance": 0
}

Update platform account

Request

Updates a RippleNet platform account, which represents a real-world account owned by a financial entity (e.g. Bank, Exchange or Wallet provider).

Security
Bearer
Path
platform_account_idstring(uuid)required

ID of the platform account you want to update.

Bodyapplication/jsonrequired
namestring

Name of the platform account.

platform_idstring(uuid)

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring<= 512 characters

A short description of the platform account.

external_account_idstring

Unique reference identifier for the real world account which is represented by this platform account.

currencystring<= 3 characters

The currency of the account. Ripple recommends using ISO-4217 currency codes.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/platforms/accounts/{platform_account_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
    "description": "string",
    "external_account_id": "string",
    "currency": "str"
  }'

Responses

Successfully updated RippleNet platform account.

Bodyapplication/json
platform_account_idstring(uuid)

Unique identifier for the platform account.

namestring

Name of the platform account.

platform_idstring(uuid)

The unique identifier for the RippleNet platform where this account is defined.

descriptionstring<= 512 characters

A short description of the platform account.

external_account_idstring

Unique reference identifier for the real world account which is represented by this platform account.

currencystring

The currency of the account. Ripple recommends using ISO-4217 currency codes.

balancenumber

Real world account balance of the platform account (if available)

Response
application/json
{
  "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
  "name": "string",
  "platform_id": "f41a0584-7f4a-481e-9327-001efe2ebd2c",
  "description": "string",
  "external_account_id": "string",
  "currency": "string",
  "balance": 0
}

Delete platform account by platform account ID

Request

Deletes a RippleNet platform account by its platform account ID.

Security
Bearer
Path
platform_account_idstring(uuid)required

ID of the platform account you want to delete.

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

Responses

Deleted platform account successfully.

Response
No content

Get platform accounts balances

Request

Get balances for local Platform Accounts

Security
Bearer
curl -i -X GET \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/monitor/platform/accounts/balances \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned balances for all platform accounts.

Bodyapplication/json
platformsArray of objects

List of platforms

platform_idstring(uuid)

Platform ID

namestring

Identifier representing the name of the platform

institutionstring

Institution being represented by this platform

typestring

Type of the platform

servicer_codestring

Account servicer code, if applicable of the real world platform

accountsArray of objects

List of Platform Accounts a Platform

platform_account_idstring(uuid)

Platform Account ID (UUID)

namestring

Name of the Platform Account

external_account_idstring

External ID of the real world account that is represented by this Platform Account

currencystring

Platform account currency

total_balancenumber

Total balance amount

available_balancenumber

Available balance amount

errorsArray of strings

List of error messages, if any

Response
application/json
{
  "platforms": [
    { … }
  ]
}

Get platform account statement

Request

Get statement for a specified Platform Account

Security
Bearer
Path
platformAccountIdstringrequired

The RippleNet platform account ID that you want to get a statement for. Example: bitso

Query
start-datestringrequired

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-datestringrequired

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

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 payment and transfer objects to return per page.

Default 10
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/monitor/platform/accounts/{platformAccountId}/statement?start-date=string&end-date=string&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned statement for a specified platform account.

Bodyapplication/json
account_namestringrequired

Name of the account the statement covers.

Example: "trans_usd_sf"
start_datetimestring(date-time)required

Lower bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2018-08-06T23:13:55.997Z"
end_datetimestring(date-time)required

Upper bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2020-08-06T23:13:55.997Z"
generated_atstring(date-time)required

Time at which the statement was generated, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:58:23.621Z"
currencystringrequired

Currency supported by the account.

Example: "USD"
ownerstringrequired

Owner of the account

Example: "rn.us.ca.san_francisco"
opening_balancenumberrequired

Opening balance of the account for the given date range.

Example: 0
closing_balancenumberrequired

Closing balance of the account for the given date range.

Example: -909
transactionsobjectrequired

Provides a content array of statement record objects and a set of pagination information fields.

contentArray of objectsrequired

Provides an array of statement record objects.

transaction_idstring(uuid)required

ID of the payment or transfer that caused an account balance change.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"
transaction_typestringrequired

Type of transaction that caused an account balance change.

Enum"PAYMENT""TRANSFER""EXCHANGE_TRANSFER"
Example: "PAYMENT"
transaction_statestringrequired

Current state of the payment or transfer.

Example: "COMPLETED"
balance_changenumberrequired

Account balance change caused by the transaction.

Example: -15
balance_resultnumberrequired

Account balance after the transaction.

Example: -909
created_atstring(date-time)required

Time at which the transaction was created, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:28:28.354Z"
end_to_end_idstringrequired

ID that the sender of a transaction can specify. Persisted on all xCurrent instances that participated in the transaction.

Example: "91ecb6bd-4dd8-4b53-a900-72b79f3064e4"
internal_idstringrequired

Internal identifier that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID.

Example: "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c"
venue_idstring

The id from an exchange associated with a transaction involving an exchange account.

Example: "nz7RpAujYgnQtjEM"
transaction_hashstring

Hash representing the unique identifier for the transfer of funds in the XRP ledger.

Example: "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6"
returns_payment_with_idstring(uuid)required

The payment_id of the original payment that this payment returns, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

returned_by_payment_with_idstring(uuid)required

The payment_id of the return payment that returned this payment, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

balance_change_created_atstring(date-time)

Timestamp of when the balance change was created

Example: "2019-10-01T21:28:28.354Z"
sender_addressstringrequired

RippleNet address of the sending account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.us.ca.san_francisco"
receiver_addressstringrequired

RippleNet address of the recieving account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.mx.mexico"
total_elementsinteger(int64)required

total elements in paginated response

Example: 1
sortstringrequired

retained for backward compatibility

firstbooleanrequired

true if this is the first page.

Example: true
lastbooleanrequired

true if this is the last page.

Example: true
numberintegerrequired

page number

Example: 0
numberOfElementsintegerrequired

Number Of elements in this request

Example: 1
sizeintegerrequired

page size

Example: 10
totalPagesintegerrequired

Total number of pages for the given request

Example: 1
Response
application/json
{
  "account_name": "trans_usd_sf",
  "start_datetime": "2018-08-06T23:13:55.997Z",
  "end_datetime": "2020-08-06T23:13:55.997Z",
  "generated_at": "2019-10-01T21:58:23.621Z",
  "currency": "USD",
  "owner": "rn.us.ca.san_francisco",
  "opening_balance": 0,
  "closing_balance": -909,
  "transactions": {
    "content": [ … ],
    "total_elements": 1,
    "sort": "string",
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 1,
    "size": 10,
    "totalPages": 1
  }
}

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