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

Get orchestration payment without user info

Request

Gets orchestration payment without user info by unique reference number.

Security
Bearer
Path
uniqueReferenceNumberstring(String)[ 1 .. 64 ] characters^[a-zA-Z0-9@_,:\s-]*$required

Unique reference number of the orchestration payment to fetch.

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

Responses

Successfully returned orchestration payment.

Body*/*
uuidstring(uuid)

Unique Identifier of the orchestration payment.

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

Unique reference number.

Example: "00310000015"
sender_end_to_end_idstring

Sender end-to-end ID.

Example: "00310000015"
payment_typestring

The payment type for the payment.

Enum"REGULAR""RETURN""REVERSAL"
connector_rolestring

The connector role for payment.

Enum"SENDING""RECEIVING""INTERMEDIARY"
payment_idstring

Payment ID for the transaction in RippleNet.

Example: "26bf269b-1a2b-c3d4-872a-7f18d7dcf9f2"
payment_statusstring

Status of the payment.

Example: "SUCCESS"
previous_payment_statusstring

Previous status of the payment.

Example: "EXECUTED"
orchestration_templatestring

Template name used for executing the orchestration payment.

Example: "default_template"
orchestration_statusstring

Status of the orchestration payment.

Example: "RUNNING"
current_activitystring

Current activity which is being executed.

Example: "get_quote_v1"
current_activity_statusstring

Status of the current activity.

Example: "SUCCESS"
initial_contextobject

Initial context for the orchestration payment.

current_contextobject

Current context of the orchestration payment.

error_messageobject

Error message in case of any error.

activity_listobject

Activity list of the activities executed so far.

created_atstring(date-time)

Date and time at which the orchestration payment 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 orchestration payment was modified, as an ISO-8601 timestamp in UTC.

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

Orchestration internal notifications

Operations