Place a Reg CC exception hold

POST/accounts/{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 business date, YYYY-MM-DD

credit_idstringRequired

explanationstringOptional

operatorstringRequired

reasonstringRequired

return_referencestringOptional

Redeposited: the ledger idempotency key of the committed check_return journal that charged the earlier deposit back

returned_credit_idstringOptional

Redeposited: the earlier deposit of the same check that was returned

Returns

200 OK

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

Errors

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

400401403404409412413422424429500503