Decide a check deposit sanctions screening parked on the transit account: approve (the funds go to the customer under the deposit's Reg CC availability) or block (they stay on the transit account as blocked property)

POST/transfers/checks/deposits/{id}/review

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

actorstringOptional

Names the reviewer only on the open local stack

decisionstringRequired

Approve or block

Returns

200 OK

decided_bystringRequired

decisionstringRequired

Approved or blocked

depositobjectRequired

CheckDeposit is a check a customer deposited.

22 child attributes

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

cash_letter_idstringOptional

channelstringRequired

created_atstring · date-timeRequired

currency_codestringRequired

customer_idstringOptional

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

deposited_onstring · date or nullOptional

A business date, YYYY-MM-DD

has_imagesbooleanRequired

hold_idstringOptional

Example hold_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

lockbox_remittance_idstringOptional

microbjectRequired

MICR is a check's magnetic line.

4 child attributes

aux_on_usstringOptional

check_numberstringOptional

on_usstringRequired

Account number, "/" and serial as printed

payor_routing_numberstringRequired

payeestringOptional

return_journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

return_reasonstringOptional

return_reason_textstringOptional

screeningstringOptional

Held (parked on transit for sanctions review), released or blocked

screening_reasonstringOptional

What screening found and, once blocked, the blocked-property note

sequence_numberstringRequired

statusstringRequired

Deposited, presented, settled, returned

deposit_idstringRequired

hold_idsarray of stringsOptional

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

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

400401403404409412413422424429500503