Cancel a Settlement Request

post

Cancel a settlement by id. Only Settlement with an outbound transaction in status FAILED_TO_BROADCAST or SIGNED can be canceled. Only Exchange (Liquidity Provider) user can cancel a settlement.

Authorizations

Ledger_API_UserLedger_API_Key & Ledger_API_UserLedger_API_User & Ledger_Store_Auth_TokenLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

settlement_idintegerRequired

settlement's id

Responses

200

settlement object

application/json

from_pledge_idstring · uuidRequired

idstring · uuidRequired

statestringRequired

400

Settlement cannot be canceled

application/json

404

Settlement not found

application/json

post/settlements/{settlement_id}/cancel

HTTPcURLJavaScriptPython

POST /settlements/{settlement_id}/cancel HTTP/1.1
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "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"
}