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

Create an activity

Request

Creates an activity.

Security
Bearer
Bodyapplication/jsonrequired
namestring[ 1 .. 64 ] characters^[a-zA-Z0-9_]*$required

Name of the activity. It must start with 'custom'.

Example: "custom_get_quote_v1"
context_namestring[ 1 .. 32 ] characters^[a-zA-Z0-9_]*$required

Context name used for accessing request/response of activities.

Example: "get_quote"
bean_namestring[ 1 .. 32 ] characters^[a-zA-Z0-9]*$required

Bean name used for activity execution.

Example: "getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Default false
Example: false
notification_typestring[ 1 .. 128 ] characters^[a-zA-Z0-9_:]*$required

notification_type used for validating messages in queue when activity in execution.

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

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/activity \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "custom_get_quote_v1",
    "context_name": "get_quote",
    "bean_name": "getQuoteV1",
    "end_activity": false,
    "notification_type": "string",
    "activity_description": "string",
    "retry_interval": 0
  }'

Responses

Successfully created activity.

Bodyapplication/json
uuidstring(uuid)

Unique Identifier of the activity.

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

Activity name.

Example: "get_quote_v1"
context_namestring

Context name used for accessing request/response of activities.

Example: "get_quote"
bean_namestring

Bean name used for activity execution.

Example: "getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Example: false
activity_descriptionstring<= 256 characters

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

created_atstring(date-time)

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

Example: "2018-04-06T20:33:35Z"
Response
application/json
{
  "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "name": "get_quote_v1",
  "context_name": "get_quote",
  "bean_name": "getQuoteV1",
  "end_activity": false,
  "activity_description": "string",
  "retry_interval": 0,
  "created_at": "2018-04-06T20:33:35Z"
}

Get all activities

Request

Gets a list of activities.

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/activity?page=0&size=10&sort=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully fetched all activities.

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
uuidstring(uuid)

Unique Identifier of the activity.

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

Activity name.

Example: "get_quote_v1"
context_namestring

Context name used for accessing request/response of activities.

Example: "get_quote"
bean_namestring

Bean name used for activity execution.

Example: "getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Example: false
activity_descriptionstring<= 256 characters

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

created_atstring(date-time)

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

Example: "2018-04-06T20:33:35Z"
Response
application/json
{
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "size": 0,
  "totalElements": 0,
  "totalPages": 0,
  "sort": [
    { … }
  ],
  "content": [
    { … }
  ]
}

Get activity by name

Request

Gets activity by name.

Security
Bearer
Path
namestring(String)[ 1 .. 64 ] characters^[a-zA-Z0-9_]*$required

Name of the activity to fetch.

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

Responses

Successfully fetched activity.

Bodyapplication/json
uuidstring(uuid)

Unique Identifier of the activity.

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

Activity name.

Example: "get_quote_v1"
context_namestring

Context name used for accessing request/response of activities.

Example: "get_quote"
bean_namestring

Bean name used for activity execution.

Example: "getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Example: false
activity_descriptionstring<= 256 characters

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

created_atstring(date-time)

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

Example: "2018-04-06T20:33:35Z"
Response
application/json
{
  "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "name": "get_quote_v1",
  "context_name": "get_quote",
  "bean_name": "getQuoteV1",
  "end_activity": false,
  "activity_description": "string",
  "retry_interval": 0,
  "created_at": "2018-04-06T20:33:35Z"
}

update activity for retry interval change

Request

Updates activity for retry interval change.

Security
Bearer
Path
namestring(String)[ 1 .. 64 ] characters^[a-zA-Z0-9_]*$required

Name of the activity to fetch.

Bodyapplication/jsonrequired
retry_intervalintegerrequired

Retry interval time of the activity, in minutes.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/activity/{name}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "retry_interval": 0
  }'

Responses

Successfully fetched activity.

Bodyapplication/json
uuidstring(uuid)

Unique Identifier of the activity.

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

Activity name.

Example: "get_quote_v1"
context_namestring

Context name used for accessing request/response of activities.

Example: "get_quote"
bean_namestring

Bean name used for activity execution.

Example: "getQuoteV1"
end_activityboolean

Flag to denote whether the activity is an end acitvity.

Example: false
activity_descriptionstring<= 256 characters

Description of the activity.

retry_intervalinteger

Retry interval time of the activity in minutes.

created_atstring(date-time)

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

Example: "2018-04-06T20:33:35Z"
Response
application/json
{
  "uuid": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "name": "get_quote_v1",
  "context_name": "get_quote",
  "bean_name": "getQuoteV1",
  "end_activity": false,
  "activity_description": "string",
  "retry_interval": 0,
  "created_at": "2018-04-06T20:33:35Z"
}

Get tenant by tenant ID

Request

Gets tenant by tenant ID.

Security
Bearer
Path
tenantIdstringrequired

Tenant ID of the tenant.

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

Responses

Successfully fetched 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 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