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

Get account lookup by status

Request

Get Account Lookup entities by status and other filters. Status defaults to REQUESTED.

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
account_lookup_statusArray of strings

Account Lookup status

Default ["REQUESTED"]
Items Enum"REQUESTED""PROCESSED""FAILED""EXPIRED"
start-datestring

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

end-datestring

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.

sort_fieldstring

Attribute for how to sort the results

Default "LAST_MODIFIED_DATE"
Enum"CREATED_DATE""LAST_MODIFIED_DATE"
sort_directionstring

Direction of sorted results.

Default "ASC"
Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/account_lookups?page=0&size=10&account_lookup_status=REQUESTED&start-date=string&end-date=string&sort_field=CREATED_DATE&sort_direction=ASC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned response for Account Lookup

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
account_lookup_idstring(uuid)required

UUID that links Account lookup request and response.

account_lookup_statusstringrequired

State of the Account Lookup object. Should be REQUESTED/PROCESSED/FAILED.

Enum"REQUESTED""PROCESSED""FAILED""EXPIRED"
first_namestring<= 40 characters

First name of the beneficiary.

middle_namestring<= 40 characters

Middle name of the beneficiary.

last_namestring<= 40 characters

Last name of the beneficiary.

org_namestring<= 140 characters

Name of the organization.

country_codestring

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

account_idstring<= 40 characters

Identifier for the Account, e.g account number.

account_id_typestring

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
result_codestring

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_statusstring

Result status of Account Lookup response.

Enum"PASS""FAIL"
result_descriptionstring

Result description of Account Lookup response.

redacted_first_namestring<= 40 characters

First name of the beneficiary redacted by the receiver.

redacted_middle_namestring<= 40 characters

Middle name of the beneficiary redacted by the receiver.

redacted_last_namestring<= 40 characters

Last name of the beneficiary redacted by the receiver.

redacted_org_namestring<= 140 characters

Name of the organization redacted by the receiver.

redacted_country_codestring

Country of the beneficiary redacted by the receiver.

redacted_account_idstring<= 40 characters

Identifier for the Account, e.g account number, redacted by the receiver.

redacted_account_id_typestring

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
redacted_account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_codestring

Clearing system code

branch_codestring

The Branch code (e.g., routing code) that the receiver has on their system.

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

Initiate account lookup

Request

Creates an Account Lookup request to validate a beneficiary's account details before sending a payment. Account lookups are not part of the payment flow and can be made at any time in the payment process.

Security
Bearer
Bodyapplication/jsonrequired
account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_codestring<= 50 characters

Clearing system code

destination_addressstringrequired

RippleNet address of the receiver.

first_namestring<= 40 characters

First name of the beneficiary.

middle_namestring<= 40 characters

Middle name of the beneficiary.

last_namestring<= 40 characters

Last name of the beneficiary.

org_namestring<= 140 characters

Name of the organization.

country_codestring<= 2 charactersrequired

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_idstring<= 40 charactersrequired

Identifier for the Account, e.g account number.

account_id_typestringrequired

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/account_lookups/request \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_currency": "string",
    "clearing_system_code": "string",
    "destination_address": "string",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "org_name": "string",
    "country_code": "st",
    "account_id": "string",
    "account_id_type": "AIIN"
  }'

Responses

Successfully returned Account Lookup response.

Bodyapplication/json
account_lookup_idstring(uuid)required

UUID that links Account lookup request and response.

account_lookup_statusstringrequired

State of the Account Lookup object. Should be REQUESTED/PROCESSED/FAILED.

Enum"REQUESTED""PROCESSED""FAILED""EXPIRED"
first_namestring<= 40 characters

First name of the beneficiary.

middle_namestring<= 40 characters

Middle name of the beneficiary.

last_namestring<= 40 characters

Last name of the beneficiary.

org_namestring<= 140 characters

Name of the organization.

country_codestring

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

account_idstring<= 40 characters

Identifier for the Account, e.g account number.

account_id_typestring

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
result_codestring

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_statusstring

Result status of Account Lookup response.

Enum"PASS""FAIL"
result_descriptionstring

Result description of Account Lookup response.

redacted_first_namestring<= 40 characters

First name of the beneficiary redacted by the receiver.

redacted_middle_namestring<= 40 characters

Middle name of the beneficiary redacted by the receiver.

redacted_last_namestring<= 40 characters

Last name of the beneficiary redacted by the receiver.

redacted_org_namestring<= 140 characters

Name of the organization redacted by the receiver.

redacted_country_codestring

Country of the beneficiary redacted by the receiver.

redacted_account_idstring<= 40 characters

Identifier for the Account, e.g account number, redacted by the receiver.

redacted_account_id_typestring

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
redacted_account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_codestring

Clearing system code

branch_codestring

The Branch code (e.g., routing code) that the receiver has on their system.

Response
application/json
{
  "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  "account_lookup_status": "REQUESTED",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "org_name": "string",
  "country_code": "string",
  "account_currency": "string",
  "account_id": "string",
  "account_id_type": "AIIN",
  "result_code": "string",
  "result_status": "PASS",
  "result_description": "string",
  "redacted_first_name": "string",
  "redacted_middle_name": "string",
  "redacted_last_name": "string",
  "redacted_org_name": "string",
  "redacted_country_code": "string",
  "redacted_account_id": "string",
  "redacted_account_id_type": "AIIN",
  "redacted_account_currency": "string",
  "clearing_system_code": "string",
  "branch_code": "string"
}

Complete account lookup

Request

Posts an Account Lookup response to validate a beneficiary's account details before payment.

Security
Bearer
Bodyapplication/jsonrequired
account_lookup_idstring(uuid)required

UUID that links Account Lookup request and response.

result_codestring^RNCB\d{4}required

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_statusstringrequired

Result status of Account Lookup response

Enum"PASS""FAIL"
result_descriptionstringrequired

Result description of Account Lookup response

redacted_first_namestring<= 40 characters

First name of the beneficiary.

redacted_middle_namestring<= 40 characters

Middle name of the beneficiary.

redacted_last_namestring<= 40 characters

Last name of the beneficiary.

redacted_org_namestring<= 140 characters

Name of the organization.

redacted_country_codestring

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

redacted_account_idstring<= 40 characters

Identifier for the Account, e.g account number.

redacted_account_id_typestring

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
redacted_clearing_system_codestring

Clearing system code

redacted_branch_codestring

The Branch code (e.g., routing code) that the receiver has on their system.

redacted_account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/account_lookups/response \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
    "result_code": "string",
    "result_status": "PASS",
    "result_description": "string",
    "redacted_first_name": "string",
    "redacted_middle_name": "string",
    "redacted_last_name": "string",
    "redacted_org_name": "string",
    "redacted_country_code": "string",
    "redacted_account_id": "string",
    "redacted_account_id_type": "AIIN",
    "redacted_clearing_system_code": "string",
    "redacted_branch_code": "string",
    "redacted_account_currency": "string"
  }'

Responses

Successfully returns acknowledgement for Account Lookup response.

Bodyapplication/json
account_lookup_idstring(uuid)required

UUID that links Account lookup request and response.

account_lookup_statusstringrequired

State of the Account Lookup object. Should be REQUESTED/PROCESSED/FAILED.

Enum"REQUESTED""PROCESSED""FAILED""EXPIRED"
first_namestring<= 40 characters

First name of the beneficiary.

middle_namestring<= 40 characters

Middle name of the beneficiary.

last_namestring<= 40 characters

Last name of the beneficiary.

org_namestring<= 140 characters

Name of the organization.

country_codestring

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

account_idstring<= 40 characters

Identifier for the Account, e.g account number.

account_id_typestring

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
result_codestring

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_statusstring

Result status of Account Lookup response.

Enum"PASS""FAIL"
result_descriptionstring

Result description of Account Lookup response.

redacted_first_namestring<= 40 characters

First name of the beneficiary redacted by the receiver.

redacted_middle_namestring<= 40 characters

Middle name of the beneficiary redacted by the receiver.

redacted_last_namestring<= 40 characters

Last name of the beneficiary redacted by the receiver.

redacted_org_namestring<= 140 characters

Name of the organization redacted by the receiver.

redacted_country_codestring

Country of the beneficiary redacted by the receiver.

redacted_account_idstring<= 40 characters

Identifier for the Account, e.g account number, redacted by the receiver.

redacted_account_id_typestring

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
redacted_account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_codestring

Clearing system code

branch_codestring

The Branch code (e.g., routing code) that the receiver has on their system.

Response
application/json
{
  "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  "account_lookup_status": "REQUESTED",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "org_name": "string",
  "country_code": "string",
  "account_currency": "string",
  "account_id": "string",
  "account_id_type": "AIIN",
  "result_code": "string",
  "result_status": "PASS",
  "result_description": "string",
  "redacted_first_name": "string",
  "redacted_middle_name": "string",
  "redacted_last_name": "string",
  "redacted_org_name": "string",
  "redacted_country_code": "string",
  "redacted_account_id": "string",
  "redacted_account_id_type": "AIIN",
  "redacted_account_currency": "string",
  "clearing_system_code": "string",
  "branch_code": "string"
}

Get account lookup by ID

Request

Gets an Account Lookup entity for its account_lookup_id value.

Security
Bearer
Path
account_lookup_idstring(uuid)required

AccountLookupId

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

Responses

Successfully returned Account Lookup response.

Bodyapplication/json
account_lookup_idstring(uuid)required

UUID that links Account lookup request and response.

account_lookup_statusstringrequired

State of the Account Lookup object. Should be REQUESTED/PROCESSED/FAILED.

Enum"REQUESTED""PROCESSED""FAILED""EXPIRED"
first_namestring<= 40 characters

First name of the beneficiary.

middle_namestring<= 40 characters

Middle name of the beneficiary.

last_namestring<= 40 characters

Last name of the beneficiary.

org_namestring<= 140 characters

Name of the organization.

country_codestring

Country of the beneficiary. Alpha-2 Code format per ISO 3166-1.

account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

account_idstring<= 40 characters

Identifier for the Account, e.g account number.

account_id_typestring

Account ID type. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
result_codestring

Result code of the Account Lookup response. Possible values are

  • RNCB0000 - Pass- Name and Identifier are correct and linked
  • RNCB0001 - Fail- Name and Identifier not found
  • RNCB0002 - Fail- Name and Identifier do not match
result_statusstring

Result status of Account Lookup response.

Enum"PASS""FAIL"
result_descriptionstring

Result description of Account Lookup response.

redacted_first_namestring<= 40 characters

First name of the beneficiary redacted by the receiver.

redacted_middle_namestring<= 40 characters

Middle name of the beneficiary redacted by the receiver.

redacted_last_namestring<= 40 characters

Last name of the beneficiary redacted by the receiver.

redacted_org_namestring<= 140 characters

Name of the organization redacted by the receiver.

redacted_country_codestring

Country of the beneficiary redacted by the receiver.

redacted_account_idstring<= 40 characters

Identifier for the Account, e.g account number, redacted by the receiver.

redacted_account_id_typestring

Account ID type, redacted by the receiver. Possible values are

  • AIIN - (default) Account Issue Identification Number
  • BBAN - Basic Bank Account Number
  • CARD - PAN of the card identifying the account
  • CUID - CHIPS Universal Identifier
  • UPIC - Universal Payment Identification Code
  • EMail - Email Address
  • MSISDN - Mobile Subscriber Integrated Service Digital Network (i.e., phone number)
  • DMST - Domestic
  • Other - Other identifier (e.g., PayID)
Enum"AIIN""BBAN""CARD""CUID""UPIC""EMAIL""MSISDN""DMST""OTHER"
redacted_account_currencystring

The 3 character currency code for the account as per ISO-4217 standards

clearing_system_codestring

Clearing system code

branch_codestring

The Branch code (e.g., routing code) that the receiver has on their system.

Response
application/json
{
  "account_lookup_id": "efc26a87-de06-4aef-8217-4566df3c9f14",
  "account_lookup_status": "REQUESTED",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "org_name": "string",
  "country_code": "string",
  "account_currency": "string",
  "account_id": "string",
  "account_id_type": "AIIN",
  "result_code": "string",
  "result_status": "PASS",
  "result_description": "string",
  "redacted_first_name": "string",
  "redacted_middle_name": "string",
  "redacted_last_name": "string",
  "redacted_org_name": "string",
  "redacted_country_code": "string",
  "redacted_account_id": "string",
  "redacted_account_id_type": "AIIN",
  "redacted_account_currency": "string",
  "clearing_system_code": "string",
  "branch_code": "string"
}

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

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