LEledgerhq
Settlements

POST /settlements/{settlement_id}/cancel

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.

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Ledger-API-User
    • or API key in header X-Ledger-API-User and API key in header X-Ledger-API-Key
    • or API key in header X-Ledger-API-User and Ledger_Store_Auth_Token (a scheme the document does not define)
    • or API key in header X-Ledger-API-User and API key in header X-Ledger-API-Key and Ledger_Store_Auth_Token (a scheme the document does not define)

Path parameters

settlement_idinteger required

settlement's id

Response

settlement object

from_pledge_idstring uuid required
idstring uuid required
metaobject required
statestring required

Changes

No recorded changes to this operation across all 1 revision of this API.