Corgi BankDocumentation
OpenAPI

List exception holds and notices

GET/accounts/{id}/exception-holds

Path parameters

idstringRequired

Returns

200 OK

dataarray of objectsRequired
12 child attributes
account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

The amount held past the schedule

available_onstring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired
credit_idstringRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

hold_idsarray of stringsRequired
idstringRequired
noticeobjectRequired

HoldNotice is what 229.16(c)(1) requires the customer be told: the account, the date and amount of the deposit, the amount held, the reason and the day the funds will be available.

8 child attributes
account_number_last4stringRequired
available_onstring · dateRequired

A business date, YYYY-MM-DD

citationstringRequired
deposit_amountintegerRequired
deposited_onstring · dateRequired

A business date, YYYY-MM-DD

held_amountintegerRequired
reasonstringRequired
reason_textstringRequired
placed_bystringRequired
reasonstringRequired

New_account, large_deposit, redeposited, repeated_overdraft, doubtful_collectability, emergency

statusstringRequired
has_morebooleanRequired

Whether another page follows

Errors

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

400401403404409412413422424429500503

to move to open esc to close