Get a Pledge by ID

get

Get a pledge by id

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

pledge_idintegerRequired

pledge's id

Responses

200

pledge object

application/json

404

pledge not found

application/json

get

/pledges/{pledge_id}

HTTPcURLJavaScriptPython

GET /pledges/{pledge_id} HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "account_id": 1,
  "amount": 1,
  "asset_manager": {
    "code": "text",
    "id": "text",
    "name": "text",
    "role": "text"
  },
  "custodian": {
    "code": "text",
    "id": "text",
    "name": "text",
    "role": "text"
  },
  "exchange": {
    "code": "text",
    "id": "text",
    "name": "text",
    "role": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pending": 1,
  "pledge_subaccount_id": 1,
  "state": "ASSIGNED_TO_SETTLEMENT"
}