The Smart Liquidation service splits large XRP liquidations into smaller liquidations over a specified time period. For more information, see Smart Liquidation.
Check out the best practices and tutorials.
Smart Liquidation API (1.0.0)
All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.
The Smart Liquidation API assigns a [domainPrefix] based on the environment. Your tenant information is automatically derived from your API credentials.
| Environment | Domain Prefix | Domain | Base URL |
|---|---|---|---|
| Test | liquidation-test.pub.prod | ripplenet.com | <div style="font-size: 13px;font-family:'Red Hat Mono'; !important">liquidation-test.pub.prod.ripplenet.com</div> |
| Production | liquidation.pub.prod | ripplenet.com | liquidation.pub.prod.ripplenet.com |
For more information about base URLs, see API base URLs.
Languages
Servers
Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi/
Test environment<br/>Learn about <a href="https://docs.ripple.com/ripplenet/implementation/baseurls/#base-url-by-api-environment" class="api-console-href">API environments</a>
https://liquidation-test.pub.prod.ripplenet.com/
Production environment
https://liquidation.pub.prod.ripplenet.com/
Liquidations
Use these operations to retrieve liquidations from the Smart Liquidation service.
| Operation | Method | Description |
|---|---|---|
| Get liquidations | GET | List all liquidations by date range. |
| Get liquidation by Liquidation Id | GET | Gets a liquidation by Id. |
| Get liquidation by RippleNet Payment Id | GET | Gets a liquidation by ripplenet_payment_id. |
Note: To configure liquidation, contact your RippleNet liaison.
Operations
All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.
| Environment | Domain Prefix | Request URL |
|---|---|---|
| Test | liquidation-test.pub.prod | https://liquidation-test.pub.prod.ripplenet.com |
| Production | liquidation.pub.prod | https://liquidation.pub.prod.ripplenet.com |
Query
Start date (inclusive) of first activity. Specified in ISO-8601 format, for example 2018-08-06T23:13:55.997Z
End date (exclusive) of last activity. Specified in ISO-8601 format, for example 2018-08-06T23:13:55.997Z
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/smart_liquidation/reference/openapi/liquidations
- Test environment<br/>Learn about <a href="https://docs.ripple.com/ripplenet/implementation/baseurls/#base-url-by-api-environment" class="api-console-href">API environments</a>
https://liquidation-test.pub.prod.ripplenet.com/liquidations
- Production environment
https://liquidation.pub.prod.ripplenet.com/liquidations
- curl
- Python
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z&payment_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&reference_id=string&status=string&page=0&size=50' \
-H 'Authorization: YOUR_API_KEY_HERE'Returns a paginated list of liquidations
Sort details of this page
Array of all liquidation objects that match the specified query parameters, if any
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
RippleNet address of the sender
Example: "sf_gbp@rn.us.ca.san_francisco"
RippleNet address of the receiver
Example: "sf_gbp@rn.us.ca.san_francisco"
The total amount available for withdrawal after all fees have been collected
Example: 10000
The 3-letter currency code of the destination currency
Example: "usd"
The name of the exchange where XRP is liquidated into fiat currency
Example: "bitso"
Response
application/json
{ "first": true, "last": true, "number": 0, "numberOfElements": 0, "size": 0, "totalElements": 0, "totalPages": 0, "sort": [ { … } ], "results": [ { … } ] }
Path
Unique identifier of the liquidation. Obtain this value by performing a GET liquidations operation.
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/{id}
- Test environment<br/>Learn about <a href="https://docs.ripple.com/ripplenet/implementation/baseurls/#base-url-by-api-environment" class="api-console-href">API environments</a>
https://liquidation-test.pub.prod.ripplenet.com/liquidations/{id}
- Production environment
https://liquidation.pub.prod.ripplenet.com/liquidations/{id}
- curl
- Python
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/{id}' \
-H 'Authorization: YOUR_API_KEY_HERE'Returns a liquidation
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
RippleNet address of the sender
Example: "sf_gbp@rn.us.ca.san_francisco"
RippleNet address of the receiver
Example: "sf_gbp@rn.us.ca.san_francisco"
The total amount available for withdrawal after all fees have been collected
Example: 10000
The 3-letter currency code of the destination currency
Example: "usd"
The name of the exchange where XRP is liquidated into fiat currency
Example: "bitso"
An array of trade objects representing the trades of the liquidation
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Enum"CREATED""QUEUED""THROTTLED""QUOTED""STARTED""COMPLETED""PARTIALLY_COMPLETED""FAILED""FAILED_RETRYABLE"
The total amount available for withdrawal after all fees have been collected
The 3-letter currency code of the destination currency of the trade
The name of the trade exchange where XRP is liquidated into fiat currency
The expiration time of the liquidation trade
Example: "2018-04-06T20:33:35Z"
The trade execution objects
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
True if the funds from a failed trade will be made available in fiat currency
The trade execution strategy
The trade execution summary
Total fiat amount available for withdrawal after all fees have been collected
The trading summary
the total amount of fiat in flight (started but not yet finished trades)
the total amount of fiat that was not successfully confirmed to have been delivered due to unknown trade failures
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "account_id": "string", "created_at": "2018-04-06T20:33:35Z", "modified_at": "2018-04-06T20:33:35Z", "unique_reference_id": "string", "ripplenet_payment_id": "7bb2080a-9fd7-4f64-af96-119671501c9c", "ripplenet_payment_created_at": "2019-08-24T14:15:22Z", "ripplenet_sender_address": "sf_gbp@rn.us.ca.san_francisco", "ripplenet_receiver_address": "sf_gbp@rn.us.ca.san_francisco", "destination_amount": 10000, "destination_currency": "usd", "destination_venue": "bitso", "estimate_type": "firm", "expires_at": "2018-04-06T20:33:35Z", "liquidation_source": "xrrn", "status": "CREATED", "trade_requests": [ { … } ], "execution_strategy": { "maxAmountPerTrade": 0, "minimumTradeInterval": 0 }, "execution_summary": { "total_xrp": 0, "total_fiat": 0, "total_slippage": 0, "total_sender_fees": 0, "total_receiver_fees": 0, "total_trades": 0, "fx_rate": 0, "incentive_type": "string" }, "trading_summary": { "total_fiat_executed": 0, "total_fiat_in_flight": 0, "total_fiat_non_deliverable": 0, "total_fiat_remaining_deliverable": 0 } }
Path
Unique identifier for a RippleNet payment. Obtain this value by performing a GET liquidations operation.
- Mock server
https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/ripplenet-payment-id/{ripplenet_payment_id}
- Test environment<br/>Learn about <a href="https://docs.ripple.com/ripplenet/implementation/baseurls/#base-url-by-api-environment" class="api-console-href">API environments</a>
https://liquidation-test.pub.prod.ripplenet.com/liquidations/ripplenet-payment-id/{ripplenet_payment_id}
- Production environment
https://liquidation.pub.prod.ripplenet.com/liquidations/ripplenet-payment-id/{ripplenet_payment_id}
- curl
- Python
curl -i -X GET \
'https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/reference/openapi/liquidations/ripplenet-payment-id/{ripplenet_payment_id}' \
-H 'Authorization: YOUR_API_KEY_HERE'Returns a list of liquidations associated with the given ripplenet_payment_id
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
RippleNet address of the sender
Example: "sf_gbp@rn.us.ca.san_francisco"
RippleNet address of the receiver
Example: "sf_gbp@rn.us.ca.san_francisco"
The total amount available for withdrawal after all fees have been collected
Example: 10000
The 3-letter currency code of the destination currency
Example: "usd"
The name of the exchange where XRP is liquidated into fiat currency
Example: "bitso"
An array of trade objects representing the trades of the liquidation
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Enum"CREATED""QUEUED""THROTTLED""QUOTED""STARTED""COMPLETED""PARTIALLY_COMPLETED""FAILED""FAILED_RETRYABLE"
The total amount available for withdrawal after all fees have been collected
The 3-letter currency code of the destination currency of the trade
The name of the trade exchange where XRP is liquidated into fiat currency
The expiration time of the liquidation trade
Example: "2018-04-06T20:33:35Z"
The trade execution objects
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
Date specified in ISO-8601 format, for example 2018-04-06T20:33:35Z
Example: "2018-04-06T20:33:35Z"
True if the funds from a failed trade will be made available in fiat currency
The trade execution strategy
The trade execution summary
Total fiat amount available for withdrawal after all fees have been collected
The trading summary
the total amount of fiat in flight (started but not yet finished trades)
the total amount of fiat that was not successfully confirmed to have been delivered due to unknown trade failures
Response
application/json
[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "account_id": "string", "created_at": "2018-04-06T20:33:35Z", "modified_at": "2018-04-06T20:33:35Z", "unique_reference_id": "string", "ripplenet_payment_id": "7bb2080a-9fd7-4f64-af96-119671501c9c", "ripplenet_payment_created_at": "2019-08-24T14:15:22Z", "ripplenet_sender_address": "sf_gbp@rn.us.ca.san_francisco", "ripplenet_receiver_address": "sf_gbp@rn.us.ca.san_francisco", "destination_amount": 10000, "destination_currency": "usd", "destination_venue": "bitso", "estimate_type": "firm", "expires_at": "2018-04-06T20:33:35Z", "liquidation_source": "xrrn", "status": "CREATED", "trade_requests": [ … ], "execution_strategy": { … }, "execution_summary": { … }, "trading_summary": { … } } ]