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.
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.

Environment
Domain Prefix
Domain
Base URL
Test liquidation-test.pub.prod ripplenet.com
liquidation-test.pub.prod.ripplenet.com
Production liquidation.pub.prod ripplenet.com 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.

Authentication with Smart Liquidation Service

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

Domain prefixes with Smart Liquidation Service

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

Get liquidations

List all liquidations by date range

SecurityBearer
Request
query Parameters
start_date
string <date-time>

Start date (inclusive) of first activity. Specified in ISO-8601 format, for example 2018-08-06T23:13:55.997Z

end_date
string <date-time>

End date (exclusive) of last activity. Specified in ISO-8601 format, for example 2018-08-06T23:13:55.997Z

payment_id
Array of strings <uuid>

RippleNet payment ID(s)

reference_id
Array of strings

Unique reference ID(s)

status
string

Liquidation status

page
integer
Default: 0

The page number for paginated results. The value is zero-based, where 0 represents the first page.
Set it to 0 to get the first page of results.

size
integer [ 1 .. 200 ]
Default: 50

Number of liquidations to return per page.

Responses
200

Returns a paginated list of liquidations

400

Bad liquidation request

401

Authorization has expired for user to get liquidations

403

User is not authorized to get all liquidations

get/liquidations
Request samples 
Response samples 
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "sort": [
    • {
      • "direction": "ASC",
      • "property": "string",
      • "ascending": true,
      • "descending": false
      }
    ],
  • "results": [
    • {
      • "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"
      }
    ]
}
Get liquidation by Id
Get a specific liquidation by its unique Id value


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
Unique identifier of the liquidation. Obtain this value by performing a GET liquidations operation.


 
Responses 
200
Returns a liquidation


400
Bad Request


401
Authorization has expired for user to get liquidations by ID


403
User is not authorized to get liquidation by ID


404
Liquidation not found


get/liquidations/{id}
Request samples 
Response samples 
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": [
    • {
      • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      • "account_id": "string",
      • "created_at": "2018-04-06T20:33:35Z",
      • "modified_at": "2018-04-06T20:33:35Z",
      • "liquidation_id": "string",
      • "sequence_number": 0,
      • "odl_payment_id": "string",
      • "status": "CREATED",
      • "bridge_currency_code": "string",
      • "destination_amount": 0,
      • "destination_currency": "string",
      • "destination_venue": "string",
      • "expires_at": "2018-04-06T20:33:35Z",
      • "xrp_deposit_amount": 0,
      • "trade_executions": [
        • {
          • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          • "account_id": "string",
          • "created_at": "2018-04-06T20:33:35Z",
          • "modified_at": "2018-04-06T20:33:35Z",
          • "trade_request_id": "string",
          • "venue": "string",
          • "venue_id": "string",
          • "amount": 0,
          • "adjusted_amount": 0,
          • "proceeds": 0,
          • "adjusted_proceeds": 0,
          • "start_date": "2018-04-06T20:33:35Z",
          • "end_date": "2018-04-06T20:33:35Z",
          • "incentive_type": "string",
          • "incentive_value": 0,
          • "is_pushed_forward": true,
          • "adjusted_trade_difference": 0,
          • "executed_slippage_bps": 0
          }
        ],
      • "error_message": "string",
      • "estimated_trade_displacement_bps": 0
      }
    ],
  • "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
    }
}
Get liquidations by payment Id
Get a list of liquidations associated with a ripplenet_payment_id


SecurityBearer 
Request 
path Parameters
ripplenet_payment_id
required
string <uuid> 
Unique identifier for a RippleNet payment. Obtain this value by performing a GET liquidations operation.


 
Responses 
200
Returns a list of liquidations associated with the given ripplenet_payment_id


400
Bad Request


401
Authorization has expired for user to get liquidations by Ripplenet Payment ID


403
User is not authorized to get liquidations by Ripplenet Payment ID


get/liquidations/ripplenet-payment-id/{ripplenet_payment_id}
Request samples 
Response samples 
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": [
      • {
        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "account_id": "string",
        • "created_at": "2018-04-06T20:33:35Z",
        • "modified_at": "2018-04-06T20:33:35Z",
        • "liquidation_id": "string",
        • "sequence_number": 0,
        • "odl_payment_id": "string",
        • "status": "CREATED",
        • "bridge_currency_code": "string",
        • "destination_amount": 0,
        • "destination_currency": "string",
        • "destination_venue": "string",
        • "expires_at": "2018-04-06T20:33:35Z",
        • "xrp_deposit_amount": 0,
        • "trade_executions": [
          • {
            • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            • "account_id": "string",
            • "created_at": "2018-04-06T20:33:35Z",
            • "modified_at": "2018-04-06T20:33:35Z",
            • "trade_request_id": "string",
            • "venue": "string",
            • "venue_id": "string",
            • "amount": 0,
            • "adjusted_amount": 0,
            • "proceeds": 0,
            • "adjusted_proceeds": 0,
            • "start_date": "2018-04-06T20:33:35Z",
            • "end_date": "2018-04-06T20:33:35Z",
            • "incentive_type": "string",
            • "incentive_value": 0,
            • "is_pushed_forward": true,
            • "adjusted_trade_difference": 0,
            • "executed_slippage_bps": 0
            }
          ],
        • "error_message": "string",
        • "estimated_trade_displacement_bps": 0
        }
      ],
    • "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
      }
    }
]