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

Create ODL flag configuration

Request

Create a new flag configuration to decide which flags will be passed to ODL

Security
Bearer
Bodyapplication/jsonrequired
flagstringrequired

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/odl_flags_config \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "flag": "string",
    "flag_value": "string",
    "exchange": "string",
    "sender_host": "string"
  }'

Responses

Successfully created ODLFlag configuration

Bodyapplication/json
odl_flag_config_idstring(uuid)

The unique identifier for this ODL Flag Configuration.

flagstring

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

Response
application/json
{
  "odl_flag_config_id": "9470ee9d-472f-4159-939a-670c84b91ca6",
  "flag": "string",
  "flag_value": "string",
  "exchange": "string",
  "sender_host": "string"
}

Get all ODL flag configurations

Request

Returns all ODL Flag 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
flagstring

Filter responses by flag

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

Responses

Returns a paged list of ODL FLag 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
odl_flag_config_idstring(uuid)

The unique identifier for this ODL Flag Configuration.

flagstring

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

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

Get ODL flag configuration by ID

Request

Returns a ODL Flag configuration by ID.

Security
Bearer
Path
odl_flag_config_idstring(uuid)required

ID of the odl flag configuration you want to retrieve.

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

Responses

ODL Flag Configuration

Bodyapplication/json
odl_flag_config_idstring(uuid)

The unique identifier for this ODL Flag Configuration.

flagstring

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

Response
application/json
{
  "odl_flag_config_id": "9470ee9d-472f-4159-939a-670c84b91ca6",
  "flag": "string",
  "flag_value": "string",
  "exchange": "string",
  "sender_host": "string"
}

Update ODL flag configuration

Request

Updates an existing ODL Flag configuration.

Security
Bearer
Path
odl_flag_config_idstring(uuid)required

ID of the odl flag configuration you want to retrieve.

Bodyapplication/jsonrequired
flagstring

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/odl_flags_config/{odl_flag_config_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "flag": "string",
    "flag_value": "string",
    "exchange": "string",
    "sender_host": "string"
  }'

Responses

Updated ODL Flag Configration

Bodyapplication/json
odl_flag_config_idstring(uuid)

The unique identifier for this ODL Flag Configuration.

flagstring

Flag to be passed to ODL in payment/estimate requests.

flag_valuestring

flag value to be passed to ODL in payment/estimate requests.

exchangestring

Exchange name for which this flag should be added to the ODL payment/estimate request

sender_hoststring

Sender host ripplenet hostname who sends the payment for which this flag is to be applied

Response
application/json
{
  "odl_flag_config_id": "9470ee9d-472f-4159-939a-670c84b91ca6",
  "flag": "string",
  "flag_value": "string",
  "exchange": "string",
  "sender_host": "string"
}

Delete ODL flag configuration

Request

Deletes an ODL Flag configuration by its ID.

Security
Bearer
Path
odl_flag_config_idstring(uuid)required

ID of the odl flag configuration you want to retrieve.

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

Responses

Deleted ODL Flag Config successfully

Response
No content

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