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/reference/openapi/

https://[domainPrefix].ripplexcurrent.com/v4/

Auditing

Use these operations to audit your accounts.

Operation	Method	Description
Get audits	GET	Gets an audit trail of user actions and configuration changes (to accounts, fees, and rates) on a RippleNet instance.
Get event trail for payment	GET	Gets an audit trail of a payment's state changes on a local RippleNet instance.

Operations

Balances and statements

Use these operations to view balances and statements for a ledger.

Operation	Method	Description
Get balances	GET	Get balances for local and remote accounts owned by a RippleNet address.
Get ledger balances	GET	Get balances for ledger owned by a RippleNet address.
Get statement	GET	Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
Get statement by external account ID	GET	Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.
Get ledger account statement	GET	Get statement for a specified Ledger Account

Operations

Beneficiary confirmation

Use these operations to perform beneficiary confirmations.

Operation	Method	Description
Get account lookup by status	GET	Get Account Lookup entities by status and other filters.
Initiate account lookup	POST	Creates an Account Lookup request to validate a beneficiary's account details before sending a payment.
Complete account lookup	POST	Posts an Account Lookup response to validate a beneficiary's account details before payment.
Get account lookup by ID	GET	Gets an Account Lookup entity for its `account_lookup_id` value.

Operations

Diagnostics

Use these operations to view RippleNet Server health.

Operation	Method	Description
Check health	GET	Gets the health status of the xCurrent server.
Check heartbeat	GET	Gets the health status of the xCurrent server's peers.

Operations

Exchange transfers

Use these operations to manage exchange transfers.

Operation	Method	Description
Get exchange transfers	GET	List all exchange transfers.
Execute exchange transfer	POST	Execute an exchange transfer to move funds from one of your accounts in one currency, to another one of your accounts in another currency.
Get exchange transfer quote	POST	Requests a quote for an exchange transfer.
Complete exchange transfer	POST	Updates the status of an exchange transfer to `COMPLETED`. Make this request once the exchange transfer has been made on both the ledger and on internal systems.
Get exchange transfer by ID	GET	Gets an exchange transfer by ID.

Operations

Fees

Use these operations to configure fees.

Operation	Method	Description
Get fees	GET	List all fees.
Create fee	POST	Creates a fee.
Get fee by ID	GET	Gets a fee by ID.
Update fee	PUT	Updates an existing fee.
Delete fee	DELETE	Deletes a fee. Once deleted, a fee cannot be accessed.

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/reference/openapi/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/reference/openapi/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/reference/openapi/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
  }
]

Orchestration payments

Operations

Payment expiration

Use these operations to manage payment expirations.

Operation	Method	Description
Get payment expiry by ID	GET	Gets the time to live (ttl) of a payment expiry in seconds.
Update payment expiry	PUT	Updates the time to live (ttl) of a payment expiry in seconds.
Delete payment expiry	DELETE	Deletes a payment expiry.
Get payment expiries	GET	Returns all configured payment expiries.
Create payment expiry	POST	Creates a payment expiration window, or time to live (ttl), in seconds.

Operations

Payout method

Payout Method operations let receivers create and manage payout methods. Senders can generate quotes based on these receiver payout methods.

Operation	Method	Description
Create payout method	POST	Creates a payout method. For example, `LOCAL_RAILS`.
Get payout methods	GET	Returns a list of payout methods created by a receiving partner.
Get payout method by ID	GET	Returns a payout method by its ID.
Update payout method	PUT	Updates a payout method.
Delete payout method	DELETE	Deletes a payout method.
Get all categories	GET	Returns all the payout method categories.

Operations

Platform accounts

Use these operations to configure your RippleNet platform accounts.

Operation	Method	Description
Create platform	POST	Creates a RippleNet platform that represents a financial entity that holds accounts in the real world. For example, a Bank, Exchange, or Wallet provider.
Get all platforms	GET	Returns a list of all active RippleNet platforms.
Get platform by platform ID	GET	Get a RippleNet platform by its platform ID.
Update platform	PUT	Updates a RippleNet platform.
Delete platform by platform ID	DELETE	Deletes a RippleNet platform by its platform ID.
Create platform account	POST	Creates a RippleNet platform account, which represents a real-world account owned by a financial entity.
Get platform accounts	GET	Returns a paged list of all active RippleNet platform accounts.
Get platform account by platform account ID	GET	Gets a RippleNet platform account by its platform account ID.
Update platform account	PUT	Updates a RippleNet platform account.
Delete platform account by platform account ID	DELETE	Deletes a RippleNet platform account by its platform account ID.
Get platform accounts balances	GET	Get balances for local Platform Accounts
Get platform account statement	GET	Get statement for a specified Platform Account

Operations

Pool accounts

Use these operations to configure your RippleNet pool accounts.

Operation	Method	Description
Get all pool accounts	GET	Returns a list of all pool accounts on a RippleNet node.
Get pool account by pool account ID	GET	Get a pool account by its pool account ID.

Operations

Quote expiration

Use these operations to manage quote expirations.

Operation	Method	Description
List quote expiries	GET	Returns all configured quote expiries.
Create quote expiry	POST	Creates a quote expiration window, or time to live (ttl), in seconds.
Get quote expiry	GET	Gets the configured quote expiration window, or time to live (ttl), in seconds.
Update quote expiry	PUT	Sets a quote expiration window, or time to live (ttl), in seconds.

Operations

Quotes

Use these operations to manage your quotes.

Operation	Method	Description
Accept quote	POST	Accepts a quote ID to start the payment process.
Get quotes	GET	Gets a list of quotes.
Get quote by quote ID	GET	Gets a quote by ID.
Create quote collection	POST	Creates a collection of quotes for a proposed payment.
Get quote collection by ID	GET	Gets a quote collection that was created for a proposed payment.

Operations

Rates

Use these operations to manage your rates.

Operation	Method	Description
Get rates	GET	Gets a list of configured exchange rates.
Create rate	POST	Creates an exchange rate for a specified currency pair.
Get rate by ID	GET	Gets a configured exchange rate by ID.
Update rate	PUT	Updates an existing exchange rate.
Delete rate	DELETE	Deletes an exchange rate. Once deleted, an exchange rate cannot be accessed.

Operations

Request for payment

Use these operations to interact with your payment requests.

Operation	Method	Description
Get requests for payment	GET	Gets requests for payment that match the query parameters.
Send request for payment	POST	Sends a new request for payment.
Get request for payment by ID	GET	Gets a request for payment by request for payment ID.
Accept request for payment	POST	Accepts a request for payment.
Fail request for payment	POST	Fails a request for payment.

Operations

Transfers

Use these operations to manage your transfers.

Operation	Method	Description
Get transfers	GET	Gets a list of transfers.
Get transfer estimate	GET	Get an estimate of the fee to make an "outbound" transfer from an exchange (connected to xRapid) to an another account outside of RippleNet (such as a bank account).
Get transfer by ID	GET	Gets a transfer by ID.
Execute transfer	POST	Transfers funds between accounts.
Complete transfer	POST	Updates the state of a transfer to `COMPLETED`.
Add transfer labels	PUT	Adds a list of labels to the transfer. To retrieve transfers by label, see Get transfers
Delete transfer labels	DELETE	Deletes one or more existing labels from the transfer.

Operations

RippleNet Server API (4.0.0)

Authentication

API environments

Auditing

Balances and statements

Beneficiary confirmation

Diagnostics

Exchange transfers

Fees

Non-orchestration payments

Add payment labels

Request

Responses

Was this page helpful?

Delete payment labels

Request

Responses

Was this page helpful?

Get payment node status

Request

Responses

Was this page helpful?

Orchestration payments

Payment expiration

Payout method

Platform accounts

Pool accounts

Quote expiration

Quotes

Rates

Request for payment

Transfers