Skip to content

Smart Liquidation API (1.0.0)

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.

Authentication

All API operations require a bearer access token for your target environment.<br>Learn how to request the access token.

API environments

The Smart Liquidation API assigns a [domainPrefix] based on the environment. Your tenant information is automatically derived from your API credentials.

EnvironmentDomain PrefixDomainBase URL
Testliquidation-test.pub.prodripplenet.com<div style="font-size: 13px;font-family:'Red Hat Mono'; !important">liquidation-test.pub.prod.ripplenet.com</div>
Productionliquidation.pub.prodripplenet.comliquidation.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/smart_liquidation/

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

Operations

bridgeAssets

Operations

Prioritizes which bridge-assets (xrp, btc, etc.) should be used for converting to fiat

Request

Security
Bearer
Headers
X-CORRELATION-IDstring
Bodyapplication/jsonrequired
sender_idstring

A unique identifier for the customer sending the funds

receiver_idstring

A unique identifier for the customer receiving the funds

bridge_asset_prioritization_optionsArray of objectsrequired

Describes the different bridge assets to pick from

bridge_currency_codestringrequired
bridge_currency_amountnumber(decimal)required
destination_exchangestringrequired
destination_currency_codestringrequired
destination_currency_amountnumber(decimal)required
digital_asset_originationbooleanrequired

Whether Wallet Send will be used

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/smart_liquidation/smart_liquidation/bridgeAssets/v1/prioritize \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -H 'X-CORRELATION-ID: string' \
  -d '{
    "sender_id": "string",
    "receiver_id": "string",
    "bridge_asset_prioritization_options": [
      {
        "bridge_currency_code": "string",
        "bridge_currency_amount": 0,
        "destination_exchange": "string",
        "destination_currency_code": "string",
        "destination_currency_amount": 0,
        "digital_asset_origination": true
      }
    ]
  }'

Responses

Returns the bridge assets to prioritize using

Bodyapplication/json
prioritized_bridge_asset_liquidation_optionsArray of objectsrequired

A sorted list prioritizing which bridge assets to use from BridgeAssetPrioritizationRequest#bridge_asset_liquidation_options. Some options may be missing if they shouldn't be used.

selected_indexintegerrequired

zero-based index from the BridgeAssetPrioritizationRequest#bridge_asset_liquidation_options list

Response
application/json
{
  "prioritized_bridge_asset_liquidation_options": [
    { … }
  ]
}

liquidations

Operations