LEledgerhq
Pledges

GET /pledges/{pledge_id}

Get a pledge by id

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

pledge_idinteger required

pledge's id

Response

pledge object

account_idinteger required
amountinteger required
idstring uuid required
pendinginteger required
pledge_subaccount_idinteger required
state'ASSIGNED_TO_SETTLEMENT' | 'OUTBOUND_TRANSACTION_CONFIRMED' | 'OUTBOUND_TRANSACTION_FAILED' | 'PLEDGE_APPROVED' | 'PLEDGE_CONSUMED' | 'PLEDGE_INCREMENT_PENDING_APPROVAL' | 'PLEDGE_READY' | 'PLEDGE_REJECTED' | 'RECOVERING_FROM_FAILURE' | 'REPLEDGE_APPROVED' | 'REPLEDGE_PENDING_APPROVAL' | 'REPLEDGE_REJECTED' | 'UNPLEDGE_APPROVED' | 'UNPLEDGE_PENDING_APPROVAL' | 'UNPLEDGE_REJECTED' required

Changes

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