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

Create SSA configuration

Request

Creates a Sender Segregated Account (SSA) configuration. A SSA configuration contains funds from returns and failed payments that have been pushed forward.

Security
Bearer
Bodyapplication/jsonrequired
ssa_accountstringrequired

RippleNet address of the SSA account

source_accountstringrequired

RippleNet address of the host used to fund the ssa_account

ssa_currencystringrequired

Currency code of the SSA account

payment_sender_hoststring

RippleNet host address of the payment sender for which this SSA config should apply. This field is marked optional but is mandatory if you have multiple senders requiring ssa config for same currency

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/ssa_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ssa_account": "string",
    "source_account": "string",
    "ssa_currency": "string",
    "payment_sender_host": "string"
  }'

Responses

Successfully created Sender Segregated Account (SSA) configuration.

Bodyapplication/json
ssa_accountstring

RippleNet address of the SSA account

source_accountstring

RippleNet address of the host used to fund the ssa_account

ssa_currencystring

Currency code of the SSA account

ssa_config_idstring(uuid)

Unique identifier for the SSA configuration record

payment_sender_hoststring

RippleNet host address of the payment sender for which this SSA config should apply

Response
application/json
{
  "ssa_account": "string",
  "source_account": "string",
  "ssa_currency": "string",
  "ssa_config_id": "3f91872c-024e-4642-8e8d-c148c44a0d17",
  "payment_sender_host": "string"
}

Get all SSA configurations

Request

Returns all Sender Segregated (SSA) configurations.

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

Responses

Returns a list of Sender Segregated Account (SSA) configurations.

Bodyapplication/jsonArray [
ssa_accountstring

RippleNet address of the SSA account

source_accountstring

RippleNet address of the host used to fund the ssa_account

ssa_currencystring

Currency code of the SSA account

ssa_config_idstring(uuid)

Unique identifier for the SSA configuration record

payment_sender_hoststring

RippleNet host address of the payment sender for which this SSA config should apply

]
Response
application/json
[
  {
    "ssa_account": "string",
    "source_account": "string",
    "ssa_currency": "string",
    "ssa_config_id": "3f91872c-024e-4642-8e8d-c148c44a0d17",
    "payment_sender_host": "string"
  }
]

Get SSA configuration by ID

Request

Returns a Sender Segregated Account (SSA) configuration by its ID.

Security
Bearer
Path
ssa_config_idstring(uuid)required

The ID of the SSA configuration you want returned.

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

Responses

Returns a Sender Segregated Account (SSA) configuration by its ID.

Bodyapplication/json
ssa_accountstring

RippleNet address of the SSA account

source_accountstring

RippleNet address of the host used to fund the ssa_account

ssa_currencystring

Currency code of the SSA account

ssa_config_idstring(uuid)

Unique identifier for the SSA configuration record

payment_sender_hoststring

RippleNet host address of the payment sender for which this SSA config should apply

Response
application/json
{
  "ssa_account": "string",
  "source_account": "string",
  "ssa_currency": "string",
  "ssa_config_id": "3f91872c-024e-4642-8e8d-c148c44a0d17",
  "payment_sender_host": "string"
}

Update SSA configuration

Request

Updates an existing Sender Segregated Account (SSA) configuration.

Security
Bearer
Path
ssa_config_idstring(uuid)required

Provide the ssa_config_id of the SSA configuration you want to update.

Bodyapplication/jsonrequired
ssa_accountstring

RippleNet address of SSA account

source_accountstring

RippleNet address of the host used to fund the ssa_account

ssa_currencystring

Currency code of the SSA account

payment_sender_hoststring

RippleNet host address of the payment sender for which this SSA config should apply

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/ssa_config/{ssa_config_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "ssa_account": "string",
    "source_account": "string",
    "ssa_currency": "string",
    "payment_sender_host": "string"
  }'

Responses

Successfully updated Sender Segregated Account (SSA) configuration.

Bodyapplication/json
ssa_accountstring

RippleNet address of the SSA account

source_accountstring

RippleNet address of the host used to fund the ssa_account

ssa_currencystring

Currency code of the SSA account

ssa_config_idstring(uuid)

Unique identifier for the SSA configuration record

payment_sender_hoststring

RippleNet host address of the payment sender for which this SSA config should apply

Response
application/json
{
  "ssa_account": "string",
  "source_account": "string",
  "ssa_currency": "string",
  "ssa_config_id": "3f91872c-024e-4642-8e8d-c148c44a0d17",
  "payment_sender_host": "string"
}

Delete SSA configuration

Request

Deletes a Sender Segregated Account (SSA) configuration by its ID.

Security
Bearer
Path
ssa_config_idstring(uuid)required

Provide the ssa_config_id of the SSA configuration you want to delete.

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

Responses

Successfully deleted Sender Segregated Account (SSA) configuration.

Response
No content

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