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

Create pool account

Request

Creates a Ripplenet pool account, which points to one or more RippleNet accounts using the same currency. With pool accounts, you can view the combined balance of all RippleNet accounts within the pool.

Security

Bearer

Bodyapplication/jsonrequired

pool_account_namestringrequired

The name of the pool account.

currencystringrequired

The currency of the pool account.

Example: "USD"

ownerstringrequired

The RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

descriptionstring<= 512 characters

The description of the pool account.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/pool_accounts \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "pool_account_name": "string",
    "currency": "USD",
    "owner": "rn.us.ca.san_francisco",
    "description": "string"
  }'

Responses

Successfully created pool account.

Bodyapplication/json

pool_account_idstring(uuid)

The Account ID of the pool account.

pool_account_namestring

The name of the pool account.

currencystring

Currency of the pool account.

descriptionstring

Description of the pool account.

ownerstring

RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

linkedAccountNamesArray of strings

RippleNet accounts linked to the pool account.

Response

application/json

{
  "pool_account_id": "8bb116e3-309b-4f1e-9150-ea3b31a4e22f",
  "pool_account_name": "string",
  "currency": "string",
  "description": "string",
  "owner": "rn.us.ca.san_francisco",
  "linkedAccountNames": [
    "string"
  ]
}

Get all pool accounts

Request

Returns a list of all pool accounts on a RippleNet node.

Security

Bearer

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

Responses

List of all pool accounts.

Bodyapplication/jsonArray [

pool_account_idstring(uuid)

The Account ID of the pool account.

pool_account_namestring

The name of the pool account.

currencystring

Currency of the pool account.

descriptionstring

Description of the pool account.

ownerstring

RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

linkedAccountNamesArray of strings

RippleNet accounts linked to the pool account.

]

Response

application/json

[
  {
    "pool_account_id": "8bb116e3-309b-4f1e-9150-ea3b31a4e22f",
    "pool_account_name": "string",
    "currency": "string",
    "description": "string",
    "owner": "rn.us.ca.san_francisco",
    "linkedAccountNames": [ … ]
  }
]

Get pool account by pool account ID

Request

Get a pool account by its pool account ID.

Security

Bearer

Path

pool_account_idstring(uuid)required

Unique name to identify the pool account.

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

Responses

Returns pool account for the given pool account ID.

Bodyapplication/json

pool_account_idstring(uuid)

The Account ID of the pool account.

pool_account_namestring

The name of the pool account.

currencystring

Currency of the pool account.

descriptionstring

Description of the pool account.

ownerstring

RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

linkedAccountNamesArray of strings

RippleNet accounts linked to the pool account.

Response

application/json

{
  "pool_account_id": "8bb116e3-309b-4f1e-9150-ea3b31a4e22f",
  "pool_account_name": "string",
  "currency": "string",
  "description": "string",
  "owner": "rn.us.ca.san_francisco",
  "linkedAccountNames": [
    "string"
  ]
}

Update pool account

Request

Updates a pool account.

Security

Bearer

Path

pool_account_idstring(uuid)required

Unique name to identify the pool account.

Bodyapplication/jsonrequired

descriptionstring<= 512 characters

The description of the pool account.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/pool_accounts/{pool_account_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "string"
  }'

Responses

Successfully updated pool account.

Bodyapplication/json

pool_account_idstring(uuid)

The Account ID of the pool account.

pool_account_namestring

The name of the pool account.

currencystring

Currency of the pool account.

descriptionstring

Description of the pool account.

ownerstring

RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

linkedAccountNamesArray of strings

RippleNet accounts linked to the pool account.

Response

application/json

{
  "pool_account_id": "8bb116e3-309b-4f1e-9150-ea3b31a4e22f",
  "pool_account_name": "string",
  "currency": "string",
  "description": "string",
  "owner": "rn.us.ca.san_francisco",
  "linkedAccountNames": [
    "string"
  ]
}

Delete pool account by ID

Request

Deletes a pool account by its pool account ID.

Security

Bearer

Path

pool_account_idstring(uuid)required

Unique name to identify the pool account.

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

Responses

Deleted pool account successfully.

Response

No content

Link accounts to pool account

Request

Links accounts to the pool account.

Security

Bearer

Path

pool_account_idstring(uuid)required

Unique name to identify the pool account.

Bodyapplication/jsonrequired

account_names_to_linkArray of stringsrequired

Provide the RippleNet accounts to be linked to this pool account.

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/pool_accounts/{pool_account_id}/linked_accounts' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_names_to_link": [
      "string"
    ]
  }'

Responses

Successfully linked accounts to the pool account.

Bodyapplication/json

pool_account_idstring(uuid)

The Account ID of the pool account.

pool_account_namestring

The name of the pool account.

currencystring

Currency of the pool account.

descriptionstring

Description of the pool account.

ownerstring

RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

linkedAccountNamesArray of strings

RippleNet accounts linked to the pool account.

Response

application/json

{
  "pool_account_id": "8bb116e3-309b-4f1e-9150-ea3b31a4e22f",
  "pool_account_name": "string",
  "currency": "string",
  "description": "string",
  "owner": "rn.us.ca.san_francisco",
  "linkedAccountNames": [
    "string"
  ]
}

Unlink accounts from pool account

Request

Unlinks accounts from the pool account.

Security

Bearer

Path

pool_account_idstring(uuid)required

Unique name to identify the pool account.

Bodyapplication/jsonrequired

account_names_to_unlinkArray of stringsrequired

Provide the RippleNet accounts to be unlinked from this pool account.

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/pool_accounts/{pool_account_id}/linked_accounts' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "account_names_to_unlink": [
      "string"
    ]
  }'

Responses

Successfully unlinked accounts from the pool account.

Bodyapplication/json

pool_account_idstring(uuid)

The Account ID of the pool account.

pool_account_namestring

The name of the pool account.

currencystring

Currency of the pool account.

descriptionstring

Description of the pool account.

ownerstring

RippleNet address of the owner of the pool account.

Example: "rn.us.ca.san_francisco"

linkedAccountNamesArray of strings

RippleNet accounts linked to the pool account.

Response

application/json

{
  "pool_account_id": "8bb116e3-309b-4f1e-9150-ea3b31a4e22f",
  "pool_account_name": "string",
  "currency": "string",
  "description": "string",
  "owner": "rn.us.ca.san_francisco",
  "linkedAccountNames": [
    "string"
  ]
}

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

Non-orchestration payments

Notifications

ODL flags configuration

Orchestration payments

Payment expiration

Payout method

Platform accounts

Pool accounts

Create pool account

Request

Responses

Was this page helpful?

Get all pool accounts

Request

Responses

Was this page helpful?

Get pool account by pool account ID

Request

Responses

Was this page helpful?

Update pool account

Request

Responses

Was this page helpful?

Delete pool account by ID

Request

Responses

Was this page helpful?

Link accounts to pool account

Request

Responses

Was this page helpful?

Unlink accounts from pool account

Request

Responses

Was this page helpful?

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