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

Pool accounts

Operations

Quote expiration

Operations

List quote expiries

Request

Returns all configured quote expiries.

Security
Bearer
Query
pageinteger

Zero-based index of the page number of results.

Default 0
sizeinteger

Number of payments returned per page.

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

Responses

Successful response

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
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

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

Create quote expiry

Request

Creates a quote expiration window, or time to live (ttl), in seconds.

Security
Bearer
Bodyapplication/jsonrequired
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payments/quote_expiries \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "quote_ttl": 5900,
    "sending_partner": "rn.us.ca.san_francisco",
    "receiving_partner": "rn.us.tx.austin",
    "currency": "USD",
    "id": 2
  }'

Responses

Successfully created the quote expiration window.

Bodyapplication/json
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
Response
application/json
{
  "quote_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "id": 2
}

Get quote expiry

Request

Gets the time to live (ttl) of a quote expiry in seconds.

Security
Bearer
Path
quote_expiry_idinteger(int64)required

The ID of the quote expiry you want returned.

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

Responses

Successfully returned a quote expiry.

Bodyapplication/json
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
Response
application/json
{
  "quote_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "id": 2
}

Update quote expiry

Request

Updates the time to live (ttl) of a quote expiry in seconds.

Security
Bearer
Path
quote_expiry_idinteger(int64)required

Provide the quote_expiry_id of the quote expiry you want to update.

Bodyapplication/jsonrequired
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payments/quote_expiries/{quote_expiry_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "quote_ttl": 5900,
    "sending_partner": "rn.us.ca.san_francisco",
    "receiving_partner": "rn.us.tx.austin",
    "currency": "USD",
    "id": 2
  }'

Responses

Successfully updated quote expiry.

Bodyapplication/json
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
Response
application/json
{
  "quote_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "id": 2
}

Delete quote expiry

Request

Deletes a quote expiry.

Security
Bearer
Path
quote_expiry_idinteger(int64)required

Provide the quote_expiry_id of the quote expiry you want to delete.

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

Responses

Successfully deleted quote expiry.

Response
No content

Get quote expiration

Request

Gets the configured quote expiration window, or time to live (ttl), in seconds.

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

Responses

Successfully returned the quote expiration window.

Bodyapplication/json
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
Response
application/json
{
  "quote_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "id": 2
}

Set quote expiration

Request

Sets a quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Security
Bearer
Bodyapplication/jsonrequired
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
curl -i -X PUT \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/payments/quote_expiry \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "quote_ttl": 5900,
    "sending_partner": "rn.us.ca.san_francisco",
    "receiving_partner": "rn.us.tx.austin",
    "currency": "USD",
    "id": 2
  }'

Responses

Successfully updated the quote expiration window.

Bodyapplication/json
quote_ttlnumber

Quote expiration window, or time to live (ttl), in seconds. To calculate the quote expiration date, xCurrent adds this value to the quote creation timestamp.

Example: 5900
sending_partnerstring

RippleNet address of the sender, in the format ripplenetaddress. For example, rn.us.sf.san_francisco.

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

RippleNet address of the receiver, in the format ripplenetaddress. For example, rn.us.ny.new_york.

Example: "rn.us.tx.austin"
currencystring

currency of the exchange rate.

Example: "USD"
idinteger

id of quote expiry object

Example: 2
Response
application/json
{
  "quote_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "id": 2
}

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