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

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

Create a new tenant

Request

Creates a new tenant.

Security

Bearer

Bodyapplication/jsonrequired

tenant_idstringrequired

Tenant ID of the tenant.

Example: "urn:ripplexcurrent-prod:name"

callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Default false

Example: false

callback_urlstring[ 1 .. 256 ] characters^(http[s]?:\/\/)[\w@%.\\+~#=-]{2,256}(:[0-9]{...

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_client_idstring[ 1 .. 256 ] characters^[a-zA-Z0-9@_,.\s-]*$

Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_passwordstring[ 1 .. 256 ] characters^[a-zA-Z0-9@_,.\s-]*$

Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_connection_timeoutinteger(int32)

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

Default 10000

xcurrent_socket_timeoutinteger(int32)

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

Default 60000

xcurrent_urlstring[ 1 .. 256 ] characters^(http[s]?:\/\/)[\w@%.\\+~#=-]{2,256}(:[0-9]{...required

URL of the RippleNet (RN node) system to which orchestration service connects.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/tenant \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenant_id": "urn:ripplexcurrent-prod:name",
    "callback_enabled": false,
    "callback_url": "string",
    "xcurrent_client_id": "string",
    "xcurrent_password": "string",
    "xcurrent_connection_timeout": 10000,
    "xcurrent_socket_timeout": 60000,
    "xcurrent_url": "string"
  }'

Responses

Successfully created tenant.

Bodyapplication/json

tenant_idstring

Tenant ID of the tenant.

Example: "urn:ripplexcurrent-prod:name"

callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Example: false

callback_urlstring

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_client_idstring

Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_passwordstring

Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_connection_timeoutinteger

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

xcurrent_socket_timeoutinteger

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

xcurrent_urlstring

URL of the RippleNet (RN node) system to which orchestration service connects.

Response

application/json

{
  "tenant_id": "urn:ripplexcurrent-prod:name",
  "callback_enabled": false,
  "callback_url": "string",
  "xcurrent_client_id": "string",
  "xcurrent_password": "string",
  "xcurrent_connection_timeout": 0,
  "xcurrent_socket_timeout": 0,
  "xcurrent_url": "string"
}

Get all tenants

Request

Gets a list of tenants.

Security

Bearer

Query

pageinteger

The page number for paginated results.

The value is zero-based, where 0 represents the first page.

Set it to 0 to get the first page of results.

sizeinteger[ 1 .. 100 ]

Number of objects to return per page.

Default 10

sortstring

Name of the property on which you want to sort the results. Add diection by appending a comma (,) to the the property name plus either asc or desc.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/tenant?page=0&size=10&sort=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched all tenants.

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

tenant_idstring

Tenant ID of the tenant.

Example: "urn:ripplexcurrent-prod:name"

callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Example: false

callback_urlstring

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_client_idstring

Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_passwordstring

Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_connection_timeoutinteger

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

xcurrent_socket_timeoutinteger

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

xcurrent_urlstring

URL of the RippleNet (RN node) system to which orchestration service connects.

Response

application/json

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

Update a tenant

Request

Updates a tenant.

Security

Bearer

Path

tenantIdstringrequired

Tenant ID of the tenant.

Bodyapplication/jsonrequired

callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Default false

Example: false

callback_urlstring[ 1 .. 256 ] characters^(http[s]?:\/\/)[\w@%.\\+~#=-]{2,256}(:[0-9]{...

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_connection_timeoutinteger(int32)

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

xcurrent_socket_timeoutinteger(int32)

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

xcurrent_urlstring[ 1 .. 256 ] characters^(http[s]?:\/\/)[\w@%.\\+~#=-]{2,256}(:[0-9]{...

URL of the RippleNet (RN node) system to which orchestration service connects.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/tenant/{tenantId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "callback_enabled": false,
    "callback_url": "string",
    "xcurrent_connection_timeout": 0,
    "xcurrent_socket_timeout": 0,
    "xcurrent_url": "string"
  }'

Responses

Successfully updated tenant.

Bodyapplication/json

tenant_idstring

Tenant ID of the tenant.

Example: "urn:ripplexcurrent-prod:name"

callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Example: false

callback_urlstring

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_client_idstring

Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_passwordstring

Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_connection_timeoutinteger

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

xcurrent_socket_timeoutinteger

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

xcurrent_urlstring

URL of the RippleNet (RN node) system to which orchestration service connects.

Response

application/json

{
  "tenant_id": "urn:ripplexcurrent-prod:name",
  "callback_enabled": false,
  "callback_url": "string",
  "xcurrent_client_id": "string",
  "xcurrent_password": "string",
  "xcurrent_connection_timeout": 0,
  "xcurrent_socket_timeout": 0,
  "xcurrent_url": "string"
}

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

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

Create a new tenant

Request

Responses

Was this page helpful?

Get all tenants

Request

Responses

Was this page helpful?

Update a tenant

Request

Responses

Was this page helpful?

Orchestration internal action

Orchestration internal payments

Orchestration internal notifications