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

Create liquidation configuration

Request

Creates a new liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account.

Security

Bearer

Bodyapplication/jsonrequired

namestring

Display name for this Liquidaton Configuration.

source_addressstringrequired

Full RippleNet address of the source account in the form acccountname@host.

destination_addressstringrequired

Full RippleNet address of the destination account in the form acccountname@host.

liquidation_modestringrequired

Mode in which this Liquidation Configuration operates.

Enum"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestringrequired

Price guarantee for the Liquidation quote.

Enum"FIRM""INDICATIVE"

liquidation_typestringrequired

Indicates the amount the liquidation is based on.

Enum"SENDER""RECEIVER""XRP"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/liquidation_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "source_address": "string",
    "destination_address": "string",
    "liquidation_mode": "PER_PAYMENT",
    "price_guarantee": "FIRM",
    "liquidation_type": "SENDER"
  }'

Responses

Successfully created liquidation configuration

Bodyapplication/json

liquidation_config_idstring(uuid)

The unique identifier for this Liquidation Configuration.

namestring

Display name for this Liquidaton Configuration.

source_addressstring

Full RippleNet address of the source account in the form accountname@host.

destination_addressstring

Full RippleNet address of the destination account in the form accountname@host.

liquidation_modestring

Mode in which this Liquidation Configuration operates.

Enum"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestring

Price guarantee for the Liquidation quote.

Enum"FIRM""INDICATIVE"

liquidation_typestring

Indicates the amount the liquidation is based on

Enum"SENDER""RECEIVER""XRP"

Response

application/json

{
  "liquidation_config_id": "ce732202-aed8-4051-a58e-204364537ee9",
  "name": "string",
  "source_address": "string",
  "destination_address": "string",
  "liquidation_mode": "PER_PAYMENT",
  "price_guarantee": "FIRM",
  "liquidation_type": "SENDER"
}

Get all liquidation configurations

Request

Returns all liquidation configurations.

Security

Bearer

Query

pageinteger

The page number for paginated results. The value is zero-based, where 0 represents the first page.<br/> Set it to 0 to get the first page of results.

Default 0

sizeinteger[ 1 .. 100 ]

Number of payments to return per page.

Default 10

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

Responses

Returns a paged list of liquidation configurations

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

liquidation_config_idstring(uuid)

The unique identifier for this Liquidation Configuration.

namestring

Display name for this Liquidaton Configuration.

source_addressstring

Full RippleNet address of the source account in the form accountname@host.

destination_addressstring

Full RippleNet address of the destination account in the form accountname@host.

liquidation_modestring

Mode in which this Liquidation Configuration operates.

Enum"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestring

Price guarantee for the Liquidation quote.

Enum"FIRM""INDICATIVE"

liquidation_typestring

Indicates the amount the liquidation is based on

Enum"SENDER""RECEIVER""XRP"

Response

application/json

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

Get liquidation configuration by ID

Request

Returns a liquidation configuration by ID.

Security

Bearer

Path

liquidation_config_idstring(uuid)required

ID of the liquidation configuration you want to retrieve.

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

Responses

Liquidation Configuration

Bodyapplication/json

liquidation_config_idstring(uuid)

The unique identifier for this Liquidation Configuration.

namestring

Display name for this Liquidaton Configuration.

source_addressstring

Full RippleNet address of the source account in the form accountname@host.

destination_addressstring

Full RippleNet address of the destination account in the form accountname@host.

liquidation_modestring

Mode in which this Liquidation Configuration operates.

Enum"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestring

Price guarantee for the Liquidation quote.

Enum"FIRM""INDICATIVE"

liquidation_typestring

Indicates the amount the liquidation is based on

Enum"SENDER""RECEIVER""XRP"

Response

application/json

{
  "liquidation_config_id": "ce732202-aed8-4051-a58e-204364537ee9",
  "name": "string",
  "source_address": "string",
  "destination_address": "string",
  "liquidation_mode": "PER_PAYMENT",
  "price_guarantee": "FIRM",
  "liquidation_type": "SENDER"
}

Update liquidation configuration

Request

Updates an existing liquidation configuration. A liquidation configuration defines a transfer path between two RippleNet accounts for liquidating payments (when they arrive in a source account) to a destination account.

Security

Bearer

Path

liquidation_config_idstring(uuid)required

ID of the liquidation configuration you want to update.

Bodyapplication/jsonrequired

namestring

Display name for this Liquidaton Configuration.

source_addressstring

Full RippleNet address of the source account in the form accountname@host.

destination_addressstring

Full RippleNet address of the destination account in the form accountname@host.

liquidation_modestring

Mode in which this Liquidation Configuration operates.

Enum"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestring

Price guarantee for the Liquidation quote.

Enum"FIRM""INDICATIVE"

liquidation_typestring

Indicates the amount the liquidation is based on.

Enum"SENDER""RECEIVER""XRP"

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/liquidation_config/{liquidation_config_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "source_address": "string",
    "destination_address": "string",
    "liquidation_mode": "PER_PAYMENT",
    "price_guarantee": "FIRM",
    "liquidation_type": "SENDER"
  }'

Responses

Updated Liquidation Configration

Bodyapplication/json

liquidation_config_idstring(uuid)

The unique identifier for this Liquidation Configuration.

namestring

Display name for this Liquidaton Configuration.

source_addressstring

Full RippleNet address of the source account in the form accountname@host.

destination_addressstring

Full RippleNet address of the destination account in the form accountname@host.

liquidation_modestring

Mode in which this Liquidation Configuration operates.

Enum"PER_PAYMENT""SMART_LIQUIDATION_PER_PAYMENT"

price_guaranteestring

Price guarantee for the Liquidation quote.

Enum"FIRM""INDICATIVE"

liquidation_typestring

Indicates the amount the liquidation is based on

Enum"SENDER""RECEIVER""XRP"

Response

application/json

{
  "liquidation_config_id": "ce732202-aed8-4051-a58e-204364537ee9",
  "name": "string",
  "source_address": "string",
  "destination_address": "string",
  "liquidation_mode": "PER_PAYMENT",
  "price_guarantee": "FIRM",
  "liquidation_type": "SENDER"
}

Delete liquidation configuration

Request

Deletes a liquidation configuration by its ID.

Security

Bearer

Path

liquidation_config_idstring(uuid)required

ID of the liquidation configuration you want to delete.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/liquidation_config/{liquidation_config_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Deleted Liquidation Config successfully

Response

No content

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

RippleNet Server API (4.0.0)

Authentication

API environments

Account configuration

Auditing

Balances and statements

Beneficiary confirmation

Diagnostics

Exchange transfers

Fees

Liquidation configuration

Create liquidation configuration

Request

Responses

Was this page helpful?

Get all liquidation configurations

Request

Responses

Was this page helpful?

Get liquidation configuration by ID

Request

Responses

Was this page helpful?

Update liquidation configuration

Request

Responses

Was this page helpful?

Delete liquidation configuration

Request

Responses

Was this page helpful?

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

Orchestration internal action

Orchestration internal payments

Orchestration internal notifications