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

Get balances

Request

Get balances for local and remote accounts owned by a RippleNet address.

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

Responses

Successfully returned balances.

Bodyapplication/json
local_balanceArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address.

institutionstringrequired

RippleNet unique internal ID of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
institution_addressstringrequired

RippleNet address of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
currency_balancesArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.

currencystringrequired

Currency of the balances provided.

Example: "USD"
aggregate_balancenumberrequired

Aggregated balance for the given currrency.

Example: 0
account_balancesArray of objectsrequired

Provides balance details for accounts that support the given currency.

account_namestring

Name of the account, which acts as the account's unique identifier on RippleNet.

Example: "trans_usd_sf"
balancenumber

Balance available in the account.

Example: -909
ownerstring

RippleNet address of the owner of the account.

Example: "rn.us.ca.san_francisco"
currencystring

Currency supported by the account.

Example: "USD"
minimum_allowed_balancenumber

Minimum balance allowed for the account.

Example: -1500000
maximum_allowed_balancenumber

Maximum balance allowed for the account.

Example: 1000000
low_liquidity_thresholdnumber

When the balance value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level.

Example: 1000
owner_min_allowed_balancenumber

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.

owner_max_allowed_balancenumber

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: 1000000
pool_account_balancesArray of objects

Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.

pool_account_namestring

Name of the pool account.

balancenumber

Aggregated balance of linked accounts which form this pool account.

ownerstring

The RippleNet peer who owns this pool account.

currencystring

The currency of pool account.

linked_accountsArray of strings

Accounts linked to this pool account.

remote_balancesArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address.

institutionstringrequired

RippleNet unique internal ID of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
institution_addressstringrequired

RippleNet address of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
currency_balancesArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.

currencystringrequired

Currency of the balances provided.

Example: "USD"
aggregate_balancenumberrequired

Aggregated balance for the given currrency.

Example: 0
account_balancesArray of objectsrequired

Provides balance details for accounts that support the given currency.

account_namestring

Name of the account, which acts as the account's unique identifier on RippleNet.

Example: "trans_usd_sf"
balancenumber

Balance available in the account.

Example: -909
ownerstring

RippleNet address of the owner of the account.

Example: "rn.us.ca.san_francisco"
currencystring

Currency supported by the account.

Example: "USD"
minimum_allowed_balancenumber

Minimum balance allowed for the account.

Example: -1500000
maximum_allowed_balancenumber

Maximum balance allowed for the account.

Example: 1000000
low_liquidity_thresholdnumber

When the balance value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level.

Example: 1000
owner_min_allowed_balancenumber

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.

owner_max_allowed_balancenumber

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: 1000000
pool_account_balancesArray of objects

Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.

pool_account_namestring

Name of the pool account.

balancenumber

Aggregated balance of linked accounts which form this pool account.

ownerstring

The RippleNet peer who owns this pool account.

currencystring

The currency of pool account.

linked_accountsArray of strings

Accounts linked to this pool account.

errorsArray of stringsrequired

Lists any errors encountered when returning balance details.

Response
application/json
{
  "local_balance": [
    { … }
  ],
  "remote_balances": [
    { … }
  ],
  "errors": [
    "string"
  ]
}

Get ledger balances

Request

Get balances for ledger owned by a RippleNet address.

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

Responses

Successfully returned balances.

Bodyapplication/json
local_balanceArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address.

institutionstringrequired

RippleNet unique internal ID of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
institution_addressstringrequired

RippleNet address of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
currency_balancesArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.

currencystringrequired

Currency of the balances provided.

Example: "USD"
aggregate_balancenumberrequired

Aggregated balance for the given currrency.

Example: 0
account_balancesArray of objectsrequired

Provides balance details for accounts that support the given currency.

account_namestring

Name of the account, which acts as the account's unique identifier on RippleNet.

Example: "trans_usd_sf"
balancenumber

Balance available in the account.

Example: -909
ownerstring

RippleNet address of the owner of the account.

Example: "rn.us.ca.san_francisco"
currencystring

Currency supported by the account.

Example: "USD"
minimum_allowed_balancenumber

Minimum balance allowed for the account.

Example: -1500000
maximum_allowed_balancenumber

Maximum balance allowed for the account.

Example: 1000000
low_liquidity_thresholdnumber

When the balance value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level.

Example: 1000
owner_min_allowed_balancenumber

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.

owner_max_allowed_balancenumber

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: 1000000
pool_account_balancesArray of objects

Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.

pool_account_namestring

Name of the pool account.

balancenumber

Aggregated balance of linked accounts which form this pool account.

ownerstring

The RippleNet peer who owns this pool account.

currencystring

The currency of pool account.

linked_accountsArray of strings

Accounts linked to this pool account.

remote_balancesArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address.

institutionstringrequired

RippleNet unique internal ID of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
institution_addressstringrequired

RippleNet address of the institution that owns the balances provided in the currency_balances array.

Example: "rn.us.ca.san_francisco"
currency_balancesArray of objectsrequired

Provides balance details for accounts owned by a RippleNet address. The response does not guarantee a fixed number of elements, or a fixed order of elements, in the returned list.

currencystringrequired

Currency of the balances provided.

Example: "USD"
aggregate_balancenumberrequired

Aggregated balance for the given currrency.

Example: 0
account_balancesArray of objectsrequired

Provides balance details for accounts that support the given currency.

account_namestring

Name of the account, which acts as the account's unique identifier on RippleNet.

Example: "trans_usd_sf"
balancenumber

Balance available in the account.

Example: -909
ownerstring

RippleNet address of the owner of the account.

Example: "rn.us.ca.san_francisco"
currencystring

Currency supported by the account.

Example: "USD"
minimum_allowed_balancenumber

Minimum balance allowed for the account.

Example: -1500000
maximum_allowed_balancenumber

Maximum balance allowed for the account.

Example: 1000000
low_liquidity_thresholdnumber

When the balance value for a sender account meets or is less than this amount after payment settlement execution, a low-liquidity message is logged at the INFO level.

Example: 1000
owner_min_allowed_balancenumber

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.

owner_max_allowed_balancenumber

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: 1000000
pool_account_balancesArray of objects

Provides balance details of pool accounts, along with RippleNet accounts linked to those pool accounts.

pool_account_namestring

Name of the pool account.

balancenumber

Aggregated balance of linked accounts which form this pool account.

ownerstring

The RippleNet peer who owns this pool account.

currencystring

The currency of pool account.

linked_accountsArray of strings

Accounts linked to this pool account.

errorsArray of stringsrequired

Lists any errors encountered when returning balance details.

Response
application/json
{
  "local_balance": [
    { … }
  ],
  "remote_balances": [
    { … }
  ],
  "errors": [
    "string"
  ]
}

Get statement

Request

Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.

Security
Bearer
Path
account_name_with_addressstringrequired

The RippleNet account name and address that you want to return a statement for. Use the format accountname@ripplenetaddress. For example, san_francisco@rn.us.ca.san_francisco.

Query
start-datestringrequired

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-datestringrequired

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

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 payment and transfer objects to return per page, with a limit of 100 per page.

For example, a query with "size": "100" results in "totalPages": "43" when the query result is "totalElements": "4290".

Default 10
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/statement/{account_name_with_address}?start-date=string&end-date=string&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returns an account statement.

Bodyapplication/json
account_namestringrequired

Name of the account the statement covers.

Example: "trans_usd_sf"
start_datetimestring(date-time)required

Lower bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2018-08-06T23:13:55.997Z"
end_datetimestring(date-time)required

Upper bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2020-08-06T23:13:55.997Z"
generated_atstring(date-time)required

Time at which the statement was generated, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:58:23.621Z"
currencystringrequired

Currency supported by the account.

Example: "USD"
ownerstringrequired

Owner of the account

Example: "rn.us.ca.san_francisco"
opening_balancenumberrequired

Opening balance of the account for the given date range.

Example: 0
closing_balancenumberrequired

Closing balance of the account for the given date range.

Example: -909
transactionsobjectrequired

Provides a content array of statement record objects and a set of pagination information fields.

contentArray of objectsrequired

Provides an array of statement record objects.

transaction_idstring(uuid)required

ID of the payment or transfer that caused an account balance change.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"
transaction_typestringrequired

Type of transaction that caused an account balance change.

Enum"PAYMENT""TRANSFER""EXCHANGE_TRANSFER"
Example: "PAYMENT"
transaction_statestringrequired

Current state of the payment or transfer.

Example: "COMPLETED"
balance_changenumberrequired

Account balance change caused by the transaction.

Example: -15
balance_resultnumberrequired

Account balance after the transaction.

Example: -909
created_atstring(date-time)required

Time at which the transaction was created, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:28:28.354Z"
end_to_end_idstringrequired

ID that the sender of a transaction can specify. Persisted on all xCurrent instances that participated in the transaction.

Example: "91ecb6bd-4dd8-4b53-a900-72b79f3064e4"
internal_idstringrequired

Internal identifier that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID.

Example: "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c"
venue_idstring

The id from an exchange associated with a transaction involving an exchange account.

Example: "nz7RpAujYgnQtjEM"
transaction_hashstring

Hash representing the unique identifier for the transfer of funds in the XRP ledger.

Example: "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6"
returns_payment_with_idstring(uuid)required

The payment_id of the original payment that this payment returns, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

returned_by_payment_with_idstring(uuid)required

The payment_id of the return payment that returned this payment, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

balance_change_created_atstring(date-time)

Timestamp of when the balance change was created

Example: "2019-10-01T21:28:28.354Z"
sender_addressstringrequired

RippleNet address of the sending account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.us.ca.san_francisco"
receiver_addressstringrequired

RippleNet address of the recieving account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.mx.mexico"
total_elementsinteger(int64)required

total elements in paginated response

Example: 1
sortstringrequired

retained for backward compatibility

firstbooleanrequired

true if this is the first page.

Example: true
lastbooleanrequired

true if this is the last page.

Example: true
numberintegerrequired

page number

Example: 0
numberOfElementsintegerrequired

Number Of elements in this request

Example: 1
sizeintegerrequired

page size

Example: 10
totalPagesintegerrequired

Total number of pages for the given request

Example: 1
Response
application/json
{
  "account_name": "trans_usd_sf",
  "start_datetime": "2018-08-06T23:13:55.997Z",
  "end_datetime": "2020-08-06T23:13:55.997Z",
  "generated_at": "2019-10-01T21:58:23.621Z",
  "currency": "USD",
  "owner": "rn.us.ca.san_francisco",
  "opening_balance": 0,
  "closing_balance": -909,
  "transactions": {
    "content": [ … ],
    "total_elements": 1,
    "sort": "string",
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 1,
    "size": 10,
    "totalPages": 1
  }
}

Get statement by external account ID

Request

Gets a statement for an account that lists payments and transfers that impacted the account's balance during a specified date-time range.

Security
Bearer
Path
external_account_idstringrequired

The external account ID associated with the account.

Query
start-datestringrequired

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-datestringrequired

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:15:13.218Z.

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 payment and transfer objects to return per page.

Default 10
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/statement/external_account_id/{external_account_id}?start-date=string&end-date=string&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returns an account statement.

Bodyapplication/json
account_namestringrequired

Name of the account the statement covers.

Example: "trans_usd_sf"
start_datetimestring(date-time)required

Lower bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2018-08-06T23:13:55.997Z"
end_datetimestring(date-time)required

Upper bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2020-08-06T23:13:55.997Z"
generated_atstring(date-time)required

Time at which the statement was generated, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:58:23.621Z"
currencystringrequired

Currency supported by the account.

Example: "USD"
ownerstringrequired

Owner of the account

Example: "rn.us.ca.san_francisco"
opening_balancenumberrequired

Opening balance of the account for the given date range.

Example: 0
closing_balancenumberrequired

Closing balance of the account for the given date range.

Example: -909
transactionsobjectrequired

Provides a content array of statement record objects and a set of pagination information fields.

contentArray of objectsrequired

Provides an array of statement record objects.

transaction_idstring(uuid)required

ID of the payment or transfer that caused an account balance change.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"
transaction_typestringrequired

Type of transaction that caused an account balance change.

Enum"PAYMENT""TRANSFER""EXCHANGE_TRANSFER"
Example: "PAYMENT"
transaction_statestringrequired

Current state of the payment or transfer.

Example: "COMPLETED"
balance_changenumberrequired

Account balance change caused by the transaction.

Example: -15
balance_resultnumberrequired

Account balance after the transaction.

Example: -909
created_atstring(date-time)required

Time at which the transaction was created, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:28:28.354Z"
end_to_end_idstringrequired

ID that the sender of a transaction can specify. Persisted on all xCurrent instances that participated in the transaction.

Example: "91ecb6bd-4dd8-4b53-a900-72b79f3064e4"
internal_idstringrequired

Internal identifier that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID.

Example: "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c"
venue_idstring

The id from an exchange associated with a transaction involving an exchange account.

Example: "nz7RpAujYgnQtjEM"
transaction_hashstring

Hash representing the unique identifier for the transfer of funds in the XRP ledger.

Example: "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6"
returns_payment_with_idstring(uuid)required

The payment_id of the original payment that this payment returns, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

returned_by_payment_with_idstring(uuid)required

The payment_id of the return payment that returned this payment, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

balance_change_created_atstring(date-time)

Timestamp of when the balance change was created

Example: "2019-10-01T21:28:28.354Z"
sender_addressstringrequired

RippleNet address of the sending account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.us.ca.san_francisco"
receiver_addressstringrequired

RippleNet address of the recieving account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.mx.mexico"
total_elementsinteger(int64)required

total elements in paginated response

Example: 1
sortstringrequired

retained for backward compatibility

firstbooleanrequired

true if this is the first page.

Example: true
lastbooleanrequired

true if this is the last page.

Example: true
numberintegerrequired

page number

Example: 0
numberOfElementsintegerrequired

Number Of elements in this request

Example: 1
sizeintegerrequired

page size

Example: 10
totalPagesintegerrequired

Total number of pages for the given request

Example: 1
Response
application/json
{
  "account_name": "trans_usd_sf",
  "start_datetime": "2018-08-06T23:13:55.997Z",
  "end_datetime": "2020-08-06T23:13:55.997Z",
  "generated_at": "2019-10-01T21:58:23.621Z",
  "currency": "USD",
  "owner": "rn.us.ca.san_francisco",
  "opening_balance": 0,
  "closing_balance": -909,
  "transactions": {
    "content": [ … ],
    "total_elements": 1,
    "sort": "string",
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 1,
    "size": 10,
    "totalPages": 1
  }
}

Get ledger account statementDeprecated

Request

Get statement for a specified Ledger account.

Note: This operation is deprecated. Use the Reports API to view your statements.

Security
Bearer
Path
account_name_with_addressstringrequired

The RippleNet account name and address that you want to return a statement for. Use the format accountname@ripplenetaddress. For example, san_francisco@rn.us.ca.san_francisco.

Query
start-datestringrequired

The lower bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC. For example, 2018-08-06T23:13:55.997Z.

end-datestringrequired

The upper bound of the date-time range you want to return statement information for, as an ISO-8601 timestamp in UTC For example, 2018-08-06T23:15:13.218Z.

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 payment and transfer objects to return per page.

Default 10
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/statement/ledger/{account_name_with_address}?start-date=string&end-date=string&page=0&size=10' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successfully returned statement for a specified ledger account.

Bodyapplication/json
account_namestringrequired

Name of the account the statement covers.

Example: "trans_usd_sf"
start_datetimestring(date-time)required

Lower bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2018-08-06T23:13:55.997Z"
end_datetimestring(date-time)required

Upper bound of the date-time range the statement covers, as an ISO-8601 timestamp in UTC.

Example: "2020-08-06T23:13:55.997Z"
generated_atstring(date-time)required

Time at which the statement was generated, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:58:23.621Z"
currencystringrequired

Currency supported by the account.

Example: "USD"
ownerstringrequired

Owner of the account

Example: "rn.us.ca.san_francisco"
opening_balancenumberrequired

Opening balance of the account for the given date range.

Example: 0
closing_balancenumberrequired

Closing balance of the account for the given date range.

Example: -909
transactionsobjectrequired

Provides a content array of statement record objects and a set of pagination information fields.

contentArray of objectsrequired

Provides an array of statement record objects.

transaction_idstring(uuid)required

ID of the payment or transfer that caused an account balance change.

Example: "9eca588f-e89d-4629-82fa-da9c4646310f"
transaction_typestringrequired

Type of transaction that caused an account balance change.

Enum"PAYMENT""TRANSFER""EXCHANGE_TRANSFER"
Example: "PAYMENT"
transaction_statestringrequired

Current state of the payment or transfer.

Example: "COMPLETED"
balance_changenumberrequired

Account balance change caused by the transaction.

Example: -15
balance_resultnumberrequired

Account balance after the transaction.

Example: -909
created_atstring(date-time)required

Time at which the transaction was created, as an ISO-8601 timestamp in UTC.

Example: "2019-10-01T21:28:28.354Z"
end_to_end_idstringrequired

ID that the sender of a transaction can specify. Persisted on all xCurrent instances that participated in the transaction.

Example: "91ecb6bd-4dd8-4b53-a900-72b79f3064e4"
internal_idstringrequired

Internal identifier that the sender can optionally specify. Only visible to the sender. Only the sending xCurrent instance stores this ID.

Example: "8afd8e99-4ad4-4f4e-9bb7-018ad8c3a89c"
venue_idstring

The id from an exchange associated with a transaction involving an exchange account.

Example: "nz7RpAujYgnQtjEM"
transaction_hashstring

Hash representing the unique identifier for the transfer of funds in the XRP ledger.

Example: "DB0AFC09E0A94FC1D11F8CBABA48A184E27094F8DD32FCBC46F316E98011E2A6"
returns_payment_with_idstring(uuid)required

The payment_id of the original payment that this payment returns, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

returned_by_payment_with_idstring(uuid)required

The payment_id of the return payment that returned this payment, if this is a returned payment. Always set to null if the transaction_type is set to TRANSFER.

balance_change_created_atstring(date-time)

Timestamp of when the balance change was created

Example: "2019-10-01T21:28:28.354Z"
sender_addressstringrequired

RippleNet address of the sending account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.us.ca.san_francisco"
receiver_addressstringrequired

RippleNet address of the recieving account. Always set to null if the transaction_type is set to TRANSFER.

Example: "rn.mx.mexico"
total_elementsinteger(int64)required

total elements in paginated response

Example: 1
sortstringrequired

retained for backward compatibility

firstbooleanrequired

true if this is the first page.

Example: true
lastbooleanrequired

true if this is the last page.

Example: true
numberintegerrequired

page number

Example: 0
numberOfElementsintegerrequired

Number Of elements in this request

Example: 1
sizeintegerrequired

page size

Example: 10
totalPagesintegerrequired

Total number of pages for the given request

Example: 1
Response
application/json
{
  "account_name": "trans_usd_sf",
  "start_datetime": "2018-08-06T23:13:55.997Z",
  "end_datetime": "2020-08-06T23:13:55.997Z",
  "generated_at": "2019-10-01T21:58:23.621Z",
  "currency": "USD",
  "owner": "rn.us.ca.san_francisco",
  "opening_balance": 0,
  "closing_balance": -909,
  "transactions": {
    "content": [ … ],
    "total_elements": 1,
    "sort": "string",
    "first": true,
    "last": true,
    "number": 0,
    "numberOfElements": 1,
    "size": 10,
    "totalPages": 1
  }
}

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

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