Read a committed hold and its current status by idempotency key

GET/ledger/holds/by-key

Query parameters

keystringRequired

Original operation key; at most 2000 UTF-8 bytes.

Max length 2000.

Returns

200 OK

The Hold object.

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X GET 'https://api.dev.bank.corgi.com/ledger/holds/by-key?key=string' \
  -H "Authorization: Bearer $TOKEN"

Response200

{
  "amount": 10000,
  "currency_code": "USD",
  "expires_at": "2026-09-17T14:30:00Z",
  "id": "string",
  "kind": "string",
  "ledger_account_id": "lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "require_available": false,
  "source_ref": "string",
  "source_service": "string",
  "status": "string"
}