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

Add payment labels

Request

Adds a list of labels to the payment. To retrieve payments by label, see Get payments.

Security
Bearer
Path
payment_idstring(uuid)required

Unique identifier of the payment you want to label.

Query
labelArray of stringsrequired

Text of the label you want to add to the payment.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/payments/{payment_id}/labels?label=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully added one or more labels to the payment.

Response
No content

Delete payment labels

Request

Deletes an existing label from a payment. The label you provide is deleted from the labels array in the Payment object.

Security
Bearer
Path
payment_idstring(uuid)required

Unique identifier of the payment from which to delete a label.

Query
labelArray of stringsrequired

Text of the label you want to delete from the payment.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/payments/{payment_id}/labels?label=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully deleted label from payment.

Response
No content

Get payment node status

Request

Senders can query for the RippleNet instances (in a given payment chain) that have payments in the <code>LOCKED</code> state. This information is only stored on the sender's RippleNet instance.

Security
Bearer
Path
payment_idstring(uuid)required

Unique identifier of the payment for which to get states on each node participating in the payment.

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

Responses

Successfully retrieved payment states on each node participating in the payment.

Bodyapplication/jsonArray [
paymentIdstring(uuid)required

Unique identifier of the payment.

Example: "efdf213c-9f64-43f7-80ab-15e7b4d139ae"
paymentStatestringrequired

State of the payment. This API only recognizes payments in the <code>LOCKED</code> state. For more on payment states, see Payment States in the RippleNet Developer Guide.<p></p>

Enum"QUOTED""ACCEPTED""AWAITING_COLLECTION""COMPLETED""EXECUTED""FAILED""FORWARDED""LOCK_DECLINED""LOCKED""PREPARED"
Example: "LOCKED"
nodeAddressstringrequired

RippleNet address of the participating node reporting the payment state.

Example: "rn.eur.uk.london"
pathOrderinteger(int32)required

Each node in the payment chain participates in sequence. Provides the order in the sequence in which this node participates.

Example: 3
]
Response
application/json
[
  {
    "paymentId": "efdf213c-9f64-43f7-80ab-15e7b4d139ae",
    "paymentState": "LOCKED",
    "nodeAddress": "rn.eur.uk.london",
    "pathOrder": 3
  }
]

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