Corgi BankDocumentation
OpenAPI

The Check Transfer object

CheckDeposit is a check a customer deposited.

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

to move to open esc to close