Corgi BankDocumentation
OpenAPI

Place the Reg CC redeposited-check exception hold (12 CFR 229.13(c)) on a check deposit, grounded in the committed return of the earlier deposit of the same item

POST/transfers/checks/deposits/{id}/exception-holds

Path parameters

idstringRequired

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

available_onstring · date or nullOptional

A shorter hold the bank chooses, within the exception period

explanationstringOptional
operatorstringOptional

Names the staff member only on the open local stack

return_referencestringRequired
returned_deposit_idstringRequired

Returns

200 OK

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired
available_onstring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired
customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

deposit_idstringRequired
hold_idsarray of stringsRequired
idstringRequired
noticeobjectRequired

CheckHoldNotice is the 229.16(c)(1) notice of an exception hold.

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
return_referencestringRequired
returned_deposit_idstringRequired
statusstringRequired

Errors

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

400401403404409412413422424429500503

to move to open esc to close