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

Add RPO Schema

Request

Adds a schema to a receiver address.

Security

Bearer

Bodyapplication/jsonrequired

sender_addressstring<= 64 characters

RippleNet sender address.

Example: "test.ros.com"

receiver_addressstring<= 64 charactersrequired

RippleNet receiver address.

Example: "test.ros.com"

schema_namestring<= 64 charactersrequired

customer schema name.

Example: "schema1"

schemaobjectrequired

RPO schema.

schema_descriptionstring<= 256 characters

RPO schema description.

receiver_currencystring= 3 characters^[a-zA-Z0-9_]*$required

Receiver currency code for schema.

payment_methodstring[ 2 .. 32 ] characters^[a-zA-Z0-9@_,:\s-]*$

Payment method for schema.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/schema \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender_address": "test.ros.com",
    "receiver_address": "test.ros.com",
    "schema_name": "schema1",
    "schema": {},
    "schema_description": "string",
    "receiver_currency": "str",
    "payment_method": "string"
  }'

Responses

Successfully created RPO schema.

Bodyapplication/json

schema_idstring(uuid)required

Unique Identifier of an RPO schema.

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

sender_addressstring<= 64 charactersrequired

RippleNet sender address.

Example: "test.ros.com"

receiver_addressstringrequired

RippleNet receiver address.

Example: "test.ros.com"

schema_namestringrequired

customer schema name.

Example: "schema1"

schema_descriptionstringrequired

RPO schema description.

receiver_currencystringrequired

receiver currency code for schema.

payment_methodstringrequired

payment method for schema.

created_atstring(date-time)required

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

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

schemaobjectrequired

RPO schema.

Response

application/json

{
  "schema_id": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "sender_address": "test.ros.com",
  "receiver_address": "test.ros.com",
  "schema_name": "schema1",
  "schema_description": "string",
  "receiver_currency": "string",
  "payment_method": "string",
  "created_at": "2018-04-06T20:33:35Z",
  "schema": {}
}

Get All RPO Schemas

Request

Gets a list of configured RPO schemas.

Security

Bearer

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

Responses

Successfully returned list of RPO schemas.

Bodyapplication/jsonArray [

receiver_addressstringrequired

RippleNet receiver address.

Example: "test.ros.com"

schemasArray of objectsrequired

RPO schema details.

schema_idstring(uuid)required

Unique Identifier of an RPO schema.

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

schema_namestringrequired

customer schema name.

Example: "schema1"

schema_descriptionstring<= 255 characters

RPO schema description.

receiver_currencystringrequired

receiver currency code for schema.

payment_methodstringrequired

payment method for schema.

created_atstring(date-time)required

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

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

schemaobjectrequired

RPO schema.

]

Response

application/json

[
  {
    "receiver_address": "test.ros.com",
    "schemas": [ … ]
  }
]

Update RPO Schemas by schema_uuid

Request

Updates an existing RPO Schemas by schema_uuid.

Security

Bearer

Path

schema_uuidstring(uuid)required

The schema_uuid of the RPO Schema.

Example: 328b3e50-7983-46d5-94a0-ef004d78db1d

Bodyapplication/jsonrequired

sender_addressstring<= 64 characters

RippleNet sender address.

Example: "test.ros.com"

receiver_addressstring<= 64 charactersrequired

RippleNet receiver address.

Example: "test.ros.com"

schema_namestring<= 64 charactersrequired

customer schema name.

Example: "schema1"

schemaobjectrequired

RPO schema.

schema_descriptionstring<= 256 characters

RPO schema description.

receiver_currencystring= 3 characters^[a-zA-Z0-9_]*$required

Receiver currency code for schema.

payment_methodstring[ 2 .. 32 ] characters^[a-zA-Z0-9@_,:\s-]*$

Payment method for schema.

curl -i -X PUT \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/schema/328b3e50-7983-46d5-94a0-ef004d78db1d \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "sender_address": "test.ros.com",
    "receiver_address": "test.ros.com",
    "schema_name": "schema1",
    "schema": {},
    "schema_description": "string",
    "receiver_currency": "str",
    "payment_method": "string"
  }'

Responses

Successfully updated RPO Schema.

Bodyapplication/json

schema_idstring(uuid)required

Unique Identifier of an RPO schema.

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

sender_addressstring<= 64 charactersrequired

RippleNet sender address.

Example: "test.ros.com"

receiver_addressstringrequired

RippleNet receiver address.

Example: "test.ros.com"

schema_namestringrequired

customer schema name.

Example: "schema1"

schema_descriptionstringrequired

RPO schema description.

receiver_currencystringrequired

receiver currency code for schema.

payment_methodstringrequired

payment method for schema.

created_atstring(date-time)required

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

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

schemaobjectrequired

RPO schema.

Response

application/json

{
  "schema_id": "5492648d-2132-4e70-9ded-2fc86f22b321",
  "sender_address": "test.ros.com",
  "receiver_address": "test.ros.com",
  "schema_name": "schema1",
  "schema_description": "string",
  "receiver_currency": "string",
  "payment_method": "string",
  "created_at": "2018-04-06T20:33:35Z",
  "schema": {}
}

Delete RPO Schemas by 'schema_uuid'

Request

Deletes an existing RPO Schema by 'schema_uuid'.

Security

Bearer

Path

schema_uuidstring(uuid)required

The schema_uuid of the rposchRpo Schema.

Example: 328b3e50-7983-46d5-94a0-ef004d78db1d

curl -i -X DELETE \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/schema/328b3e50-7983-46d5-94a0-ef004d78db1d \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully deleted RPO Schema.

Get RPO Schemas by Address

Request

Gets a list of configured RPO schemas by RippleNet Receiver Address.

Security

Bearer

Path

receiverAddressstring(string)<= 64 charactersrequired

The receiverAddress of the schema you want to retrieve.

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

Responses

Successfully returned list of RPO schemas.

Bodyapplication/json

receiver_addressstringrequired

RippleNet receiver address.

Example: "test.ros.com"

schemasArray of objectsrequired

RPO schema details.

schema_idstring(uuid)required

Unique Identifier of an RPO schema.

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

schema_namestringrequired

customer schema name.

Example: "schema1"

schema_descriptionstring<= 255 characters

RPO schema description.

receiver_currencystringrequired

receiver currency code for schema.

payment_methodstringrequired

payment method for schema.

created_atstring(date-time)required

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

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

schemaobjectrequired

RPO schema.

Response

application/json

{
  "receiver_address": "test.ros.com",
  "schemas": [
    { … }
  ]
}

Get RPO Schemas by Address and Currency

Request

Gets a list of configured RPO schemas by RippleNet Receiver Address and Currency.

Security

Bearer

Path

receiverAddressstring(String)<= 64 charactersrequired

The receiverAddress of the schema you want to retrieve.

receiverCurrencystring(String)= 3 charactersrequired

The receiverCurrency of the schema you want to retrieve.

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

Responses

Successfully returned list of RPO schemas.

Bodyapplication/json

receiver_addressstringrequired

RippleNet receiver address.

Example: "test.ros.com"

schemasArray of objectsrequired

RPO schema details.

schema_idstring(uuid)required

Unique Identifier of an RPO schema.

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

schema_namestringrequired

customer schema name.

Example: "schema1"

schema_descriptionstring<= 255 characters

RPO schema description.

receiver_currencystringrequired

receiver currency code for schema.

payment_methodstringrequired

payment method for schema.

created_atstring(date-time)required

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

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

schemaobjectrequired

RPO schema.

Response

application/json

{
  "receiver_address": "test.ros.com",
  "schemas": [
    { … }
  ]
}

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

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

Add RPO Schema

Request

Responses

Was this page helpful?

Get All RPO Schemas

Request

Responses

Was this page helpful?

Update RPO Schemas by schema_uuid

Request

Responses

Was this page helpful?

Delete RPO Schemas by 'schema_uuid'

Request

Responses

Was this page helpful?

Get RPO Schemas by Address

Request

Responses

Was this page helpful?

Get RPO Schemas by Address and Currency

Request

Responses

Was this page helpful?

activity

Orchestration Template

diagnostics

payment

Get application info

Request

Responses

Was this page helpful?

tenant

Orchestration internal action

Orchestration internal payments

Orchestration internal notifications