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

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

Get orchestration notifications by unique reference number for internal

Request

Gets orchestration payment notifications with a given unique reference number for internal

Security
Bearer
Path
uniqueReferenceNumberstring(string)required

The sender_end_to_end_id of the orchestration payment notification in case of sender and payment_id in case of receiver.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/internal/payment/notification/urn/{uniqueReferenceNumber}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched orchestration payment notifications.

Body*/*Array [
uuidstring(uuid)

Unique Identifier of the orchestration payment notification.

Example: "5492648d-2132-4e70-9ded-2fc86f22b321"
notification_typestring

Type of the orchestration payment notification.

Example: "PAYMENT_SUCCESS"
notification_versionstring

Version of the orchestration payment notification.

Example: 1
notification_statusstring

Orchestration payment notification status.

Enum"NEW""SENT""ACK"
notification_payloadobject

Orchestration payment notification payload.

created_atstring(date-time)

Date and time at which the message was created, as an ISO-8601 timestamp in UTC.

Example: "2018-04-06T20:33:35Z"
modified_atstring(date-time)

Date and time at which the message was modified, as an ISO-8601 timestamp in UTC.

Example: "2018-04-06T20:33:35Z"
]