Corgi BankDocumentation
OpenAPI

The Hold object

An amount set aside on a ledger account (card authorization, Reg CC availability, pending debit, legal) so available is posted less holds.

Attributes

amountintegerRequired

Minor units of the currency (cents for USD)

currency_codestringRequired

ISO 4217 code

expires_atstring · date-time or nullOptional
idstringRequired
kindstringRequired
ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

require_availablebooleanOptional
source_refstringRequired
source_servicestringOptional

The service that placed it; only its journals and releases touch it

statusstringRequired

to move to open esc to close