Corgi BankDocumentation
OpenAPI

Create a hold

POST/ledger/holds

Place a hold

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

expires_atstring · date-time or nullOptional
kindstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
source_refstringRequired

Returns

201 Created

The Hold object.

Errors

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

400401403404409412413422424429500503

to move to open esc to close