Recover a Settlement Request

Recover a Settlement by ID

post

Used to accelerate on-chain confirmation of an Outbound Settlement transaction stuck pending in a mempool. This is only applicable to a settlement with an outbound transaction in status SUBMITTED. Only Exchange (Liquidity Provider) operators can recover a settlement and is only applicable to currencies supporting Replace by Fees (RBF) or Replace by Nonce (RBN).

Authorizations

Ledger_API_UserLedger_API_KeyLedger_Store_Auth_Token

Path parameters

settlement_idintegerRequired

settlement's id

Body

fee_strategyone ofRequired

The new fee strategy to apply on the outbound transaction

or

or

max_feestringRequired

The new max fee to apply on the outbound transaction

Example: 234

Responses

200

settlement object

application/json

400

Settlement cannot be recovered

application/json

404

Settlement not found

application/json

post

HTTPcURLJavaScriptPython

POST /settlements/{settlement_id}/recover HTTP/1.1
Host: 
X-Ledger-API-User: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "fee_strategy": {
    "data": {
      "fees_per_byte": "30"
    },
    "type": "CUSTOM"
  },
  "max_fee": "234"
}

{
  "from_pledge_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "inbound_transaction_intent": {
    "amount": 1,
    "to_account_id": 1,
    "to_address": "text"
  },
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "outbound_transaction": {
    "request_id": 1,
    "transaction_hash": "text",
    "transaction_id": 1
  },
  "repledge": {
    "repledge_id": 1,
    "request_id": 1
  },
  "repledge_intent": {
    "account_name": "text",
    "amount": "text",
    "contract_address": "text",
    "currency": "text",
    "exchange_name": "text",
    "pledge_subaccount_id": 1,
    "to_address": "text",
    "transaction_hash": "text"
  },
  "state": "text"
}