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.

Environment	Domaing Prefix	Domain	Base URL
Test	`aperture.test`	`ripplexcurrent.com`	`https://aperture.test.ripplexcurrent.com`
UAT	`aperture.uat`	`ripplexcurrent.com`	`https://aperture.uat.ripplexcurrent.com`
Production	`aperture.prod`	`ripplexcurrent.com`	`https://aperture.prod.ripplexcurrent.com`

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

Get payment expiry by ID

Request

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

Security

Bearer

Path

payment_expiry_idstring(uuid)required

The ID of the payment expiry you want returned.

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

Responses

Successfully returned a payment expiry.

Bodyapplication/json

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment 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"

expiry_idstring(uuid)

id of payment expiry object

Example: "4711728c-cd35-49ec-96a5-72732b4333ec"

Response

application/json

{
  "payment_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "expiry_id": "4711728c-cd35-49ec-96a5-72732b4333ec"
}

Update payment expiry

Request

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

Security

Bearer

Path

payment_expiry_idstring(uuid)required

Provide the payment_expiry_id of the payment expiry you want to update.

Bodyapplication/jsonrequired

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment 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"

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

Responses

Successfully updated payment expiry.

Bodyapplication/json

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment 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"

expiry_idstring(uuid)

id of payment expiry object

Example: "4711728c-cd35-49ec-96a5-72732b4333ec"

Response

application/json

{
  "payment_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "expiry_id": "4711728c-cd35-49ec-96a5-72732b4333ec"
}

Delete payment expiry

Request

Deletes a payment expiry.

Security

Bearer

Path

payment_expiry_idstring(uuid)required

Provide the payment_expiry_id of the payment expiry you want to delete.

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

Responses

Successfully deleted payment expiry.

Response

No content

Get payment expiries

Request

Returns all configured payment 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/payment_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

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment 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"

expiry_idstring(uuid)

id of payment expiry object

Example: "4711728c-cd35-49ec-96a5-72732b4333ec"

Response

application/json

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

Create payment expiry

Request

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

Security

Bearer

Bodyapplication/jsonrequired

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment 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"

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

Responses

Successfully created the payment expiration window.

Bodyapplication/json

payment_ttlnumber

Payment expiration window, or time to live (ttl), in seconds. To calculate the payment expiration date, xCurrent adds this value to the payment 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"

expiry_idstring(uuid)

id of payment expiry object

Example: "4711728c-cd35-49ec-96a5-72732b4333ec"

Response

application/json

{
  "payment_ttl": 5900,
  "sending_partner": "rn.us.ca.san_francisco",
  "receiving_partner": "rn.us.tx.austin",
  "currency": "USD",
  "expiry_id": "4711728c-cd35-49ec-96a5-72732b4333ec"
}

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

RippleNet Server API (4.0.0)

Authentication

API environments

Account configuration

Auditing

Balances and statements

Beneficiary confirmation

Diagnostics

Exchange transfers

Fees

Liquidation configuration

Non-orchestration payments

Notifications

ODL flags configuration

Orchestration payments

Payment expiration

Get payment expiry by ID

Request

Responses

Was this page helpful?

Update payment expiry

Request

Responses

Was this page helpful?

Delete payment expiry

Request

Responses

Was this page helpful?

Get payment expiries

Request

Responses

Was this page helpful?

Create payment expiry

Request

Responses

Was this page helpful?

Payout method

Platform accounts

Pool accounts

Quote expiration

Quotes

Rates

Request for payment

Sender segregated account configuration

Transfers

schema

activity

Orchestration Template

diagnostics

payment

Get application info

Request

Responses

Was this page helpful?

tenant

Orchestration internal action

Orchestration internal payments

Orchestration internal notifications