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.
RippleNet Server API (4.0.0)
All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.
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 |
Languages
Servers
Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/
https://[domainPrefix].ripplexcurrent.com/v4/
Query
Operator to filter balance by range.
Default "EQUAL_TO"
Enum"EQUAL_TO""GREATER_THAN""LESS_THAN""BETWEEN"
Returns disabled accounts by default. To hide disabled accounts, set to false.
Default true
Attribute for how to sort the results.
Default "LAST_MODIFIED_DATE"
Enum"ACCOUNT_NAME""CURRENCY""BALANCE""LAST_MODIFIED_DATE"
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
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts
https://[domainPrefix].ripplexcurrent.com/v4/config/accounts
- curl
- Python
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts?account_names=string&balance=0&balance_upper_limit=0&balance_range_operator=EQUAL_TO&disabled=true&owner=string¤cy=string&sort_field=ACCOUNT_NAME&sort_direction=ASC&page=0&size=10&external_account_ids=string' \
-H 'Authorization: YOUR_API_KEY_HERE'Successfuly returned list of accounts.
Sort details of this page
Indicates whether the account is disabled (true) or active (false).
Example: false
Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the owner_min_allowed_balance to set the account balance minimum.
Example: -1000000
Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the owner_max_allowed_balance to set the account balance maximum.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Determines whether calculations for this account are rounded up or down to maintain precision.
Default "HALF_UP"
Enum"HALF_UP""HALF_DOWN""DOWN"
Example: "HALF_UP"
Number of decimal places used when calculating rounding for this account.
Example: 2
When the sender's account balance is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level.
Example: 1000
Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the minimum_allowed_balance to set the account balance minimum.
Example: -100000
Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the maximum_allowed_balance to set the account balance maximum.
Example: 72036854775
Customer's account ID on their systems associated with this RippleNet account.
Response
application/json
{ "first": true, "last": true, "number": 0, "numberOfElements": 0, "size": 0, "totalElements": 0, "totalPages": 0, "sort": [ { … } ], "content": [ { … } ] }
Bodyapplication/jsonrequired
Provide the name of the account. This value must be unique within the xCurrent instance.
Example: "conct_usd_sf"
Provide the RippleNet address of the owner of the account.
Example: "rn.us.ca.san_francisco"
Provide the currency of the account. Ripple recommends using ISO-4217 currency codes, although no formal constraint is enforced.
Example: "USD"
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Set to determine whether calculations for this account should be rounded up or down to maintain precision.
Default "HALF_UP"
Enum"HALF_UP""HALF_DOWN""DOWN"
Set to the number of decimal places to be used when calculating rounding for this account. The allowable range is 0-9.
Default 2
If the balance of a sender account meets or goes below this low_liquidity_threshold value after settlement execution, a low-liquidity message is logged at the INFO level.
Example: 1000
Set to the maximum balance allowed for the account.
Default 72036854775
Used to link a customer’s account ID on their systems to their RippleNet account.
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts
https://[domainPrefix].ripplexcurrent.com/v4/config/accounts
- curl
- Python
curl -i -X POST \
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "conct_usd_sf",
"owner": "rn.us.ca.san_francisco",
"currency": "USD",
"core_ledger_ref": "bitso",
"rounding_mode": "HALF_UP",
"scale": 2,
"low_liquidity_threshold": 1000,
"minimum_allowed_balance": -100000,
"maximum_allowed_balance": 72036854775,
"platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
"external_account_id": "string",
"account_description": "string"
}'Successfully created account.
Indicates whether the account is disabled (true) or active (false).
Example: false
Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the owner_min_allowed_balance to set the account balance minimum.
Example: -1000000
Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the owner_max_allowed_balance to set the account balance maximum.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Determines whether calculations for this account are rounded up or down to maintain precision.
Default "HALF_UP"
Enum"HALF_UP""HALF_DOWN""DOWN"
Example: "HALF_UP"
Number of decimal places used when calculating rounding for this account.
Example: 2
When the sender's account balance is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level.
Example: 1000
Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the minimum_allowed_balance to set the account balance minimum.
Example: -100000
Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the maximum_allowed_balance to set the account balance maximum.
Example: 72036854775
Customer's account ID on their systems associated with this RippleNet account.
Response
application/json
{ "name": "conct_usd_sf", "balance": 0, "owner": "rn.us.ca.san_francisco", "currency": "USD", "disabled": false, "minimum_allowed_balance": -1000000, "maximum_allowed_balance": 9999999999999900000, "core_ledger_ref": "bitso", "rounding_mode": "HALF_UP", "scale": 2, "low_liquidity_threshold": 1000, "owner_min_allowed_balance": -100000, "owner_max_allowed_balance": 72036854775, "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad", "external_account_id": "string", "account_description": "string" }
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}
https://[domainPrefix].ripplexcurrent.com/v4/config/accounts/{account_name}
- curl
- Python
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}' \
-H 'Authorization: YOUR_API_KEY_HERE'Successfully returned the named account.
Indicates whether the account is disabled (true) or active (false).
Example: false
Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the owner_min_allowed_balance to set the account balance minimum.
Example: -1000000
Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the owner_max_allowed_balance to set the account balance maximum.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Determines whether calculations for this account are rounded up or down to maintain precision.
Default "HALF_UP"
Enum"HALF_UP""HALF_DOWN""DOWN"
Example: "HALF_UP"
Number of decimal places used when calculating rounding for this account.
Example: 2
When the sender's account balance is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level.
Example: 1000
Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the minimum_allowed_balance to set the account balance minimum.
Example: -100000
Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the maximum_allowed_balance to set the account balance maximum.
Example: 72036854775
Customer's account ID on their systems associated with this RippleNet account.
Response
application/json
{ "name": "conct_usd_sf", "balance": 0, "owner": "rn.us.ca.san_francisco", "currency": "USD", "disabled": false, "minimum_allowed_balance": -1000000, "maximum_allowed_balance": 9999999999999900000, "core_ledger_ref": "bitso", "rounding_mode": "HALF_UP", "scale": 2, "low_liquidity_threshold": 1000, "owner_min_allowed_balance": -100000, "owner_max_allowed_balance": 72036854775, "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad", "external_account_id": "string", "account_description": "string" }
Bodyapplication/jsonrequired
Set to the minimum balance allowed for the account. Updates the value of minimum_allowed_balance for the account.
Example: -1000000
Set to the maximum balance allowed for the account. Updates the value of maximum_allowed_balance for the account.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Indicates whether the account should be disabled (false) or active (true).
Default true
Example: true
Used to link a customer’s account ID on their systems to their RippleNet account.
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}
https://[domainPrefix].ripplexcurrent.com/v4/config/accounts/{account_name}
- curl
- Python
curl -i -X PUT \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"minimum_allowed_balance": -1000000,
"maximum_allowed_balance": 9999999999999900000,
"core_ledger_ref": "bitso",
"enable": true,
"platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
"external_account_id": "string",
"account_description": "string"
}'Successfully updated the account.
Indicates whether the account is disabled (true) or active (false).
Example: false
Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the owner_min_allowed_balance to set the account balance minimum.
Example: -1000000
Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the owner_max_allowed_balance to set the account balance maximum.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Determines whether calculations for this account are rounded up or down to maintain precision.
Default "HALF_UP"
Enum"HALF_UP""HALF_DOWN""DOWN"
Example: "HALF_UP"
Number of decimal places used when calculating rounding for this account.
Example: 2
When the sender's account balance is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level.
Example: 1000
Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the minimum_allowed_balance to set the account balance minimum.
Example: -100000
Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the maximum_allowed_balance to set the account balance maximum.
Example: 72036854775
Customer's account ID on their systems associated with this RippleNet account.
Response
application/json
{ "name": "conct_usd_sf", "balance": 0, "owner": "rn.us.ca.san_francisco", "currency": "USD", "disabled": false, "minimum_allowed_balance": -1000000, "maximum_allowed_balance": 9999999999999900000, "core_ledger_ref": "bitso", "rounding_mode": "HALF_UP", "scale": 2, "low_liquidity_threshold": 1000, "owner_min_allowed_balance": -100000, "owner_max_allowed_balance": 72036854775, "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad", "external_account_id": "string", "account_description": "string" }
Request
Updates minimum and maximum allowed balance limits on a nostro account owned by this financial institution on a ledger on a peered xCurrent instance. Allows owner of nostro account to restrict balance range to less than the account maximum and greater than the account minimum set by partner.
Security
Bearer
Path
Bodyapplication/jsonrequiredThe RippleNet address of the nostro account. Use the format accountname@ripplenetaddress where accountname represents the nostro account and ripplenetaddress represents the the peered xCurrent instance that contains the nostro account. For example, sf-aus@rn.us.tx.austin.
Set to the minimum balance allowed for the account. Updates the value of minimum_allowed_balance for the account.
Example: -1000000
Set to the maximum balance allowed for the account. Updates the value of maximum_allowed_balance for the account.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Indicates whether the account should be disabled (false) or active (true).
Default true
Example: true
Used to link a customer’s account ID on their systems to their RippleNet account.
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{nostroAccountAddress}/nostro-account-update
https://[domainPrefix].ripplexcurrent.com/v4/config/accounts/{nostroAccountAddress}/nostro-account-update
- curl
- Python
curl -i -X PUT \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{nostroAccountAddress}/nostro-account-update' \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"minimum_allowed_balance": -1000000,
"maximum_allowed_balance": 9999999999999900000,
"core_ledger_ref": "bitso",
"enable": true,
"platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad",
"external_account_id": "string",
"account_description": "string"
}'Response
No content- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}/disable
https://[domainPrefix].ripplexcurrent.com/v4/config/accounts/{account_name}/disable
- curl
- Python
curl -i -X POST \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/config/accounts/{account_name}/disable' \
-H 'Authorization: YOUR_API_KEY_HERE'Successfully disabled account.
Indicates whether the account is disabled (true) or active (false).
Example: false
Minimum balance allowed for the account. For nostro accounts, RippleNet Server uses the greater of this value and the owner_min_allowed_balance to set the account balance minimum.
Example: -1000000
Maximum balance allowed for the account. For nostro accounts, RippleNet Server uses the lesser of this value and the owner_max_allowed_balance to set the account balance maximum.
Example: 9999999999999900000
Core ledger reference key. This could be a bank account number for fiat, exchange name for exchange accounts, or a ledger reference for digital accounts. This field is required for exchange accounts
Example: "bitso"
Determines whether calculations for this account are rounded up or down to maintain precision.
Default "HALF_UP"
Enum"HALF_UP""HALF_DOWN""DOWN"
Example: "HALF_UP"
Number of decimal places used when calculating rounding for this account.
Example: 2
When the sender's account balance is less than or equal to this amount, after payment settlement execution, a low-liquidity message is logged at the INFO level.
Example: 1000
Minimum balance allowed by the owner of a nostro account. RippleNet Server uses the greater of this value and the minimum_allowed_balance to set the account balance minimum.
Example: -100000
Maximum balance allowed by the owner of a nostro account. RippleNet Server uses the lesser of this value and the maximum_allowed_balance to set the account balance maximum.
Example: 72036854775
Customer's account ID on their systems associated with this RippleNet account.
Response
application/json
{ "name": "conct_usd_sf", "balance": 0, "owner": "rn.us.ca.san_francisco", "currency": "USD", "disabled": false, "minimum_allowed_balance": -1000000, "maximum_allowed_balance": 9999999999999900000, "core_ledger_ref": "bitso", "rounding_mode": "HALF_UP", "scale": 2, "low_liquidity_threshold": 1000, "owner_min_allowed_balance": -100000, "owner_max_allowed_balance": 72036854775, "platform_account_id": "8301de71-1ac1-4edb-8119-73ff911eb9ad", "external_account_id": "string", "account_description": "string" }
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/info
https://[domainPrefix].ripplexcurrent.com/v4/v4/orchestration/info
- curl
- Python
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'Response
application/json
{ "name": "Integration Module", "version": "1.2.0" }