Receive a cash letter from the operator: a presentment of checks drawn on the bank, or a return of the bank's deposits

POST/rails/check/inbound

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.

Returns

200 OK

cash_letterobjectRequired

CashLetter is an image cash letter file sent or received.

10 child attributes

business_datestring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired

directionstringRequired

Outbound or inbound

idstringRequired

item_countintegerRequired

kindstringRequired

Forward or return

rail_refstringOptional

settlement_datestring · dateOptional

A business date, YYYY-MM-DD

statusstringRequired

Built, sent, send_failed, settled, received

total_amountintegerRequired

itemsarray of objectsOptional

23 child attributes

account_idstringOptional

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

cash_letter_idstringRequired

created_atstring · date-timeRequired

decide_bystring · date-time or nullOptional

decided_atstring · date-time or nullOptional

decided_bystringOptional

decisionstringOptional

exception_reasonstringOptional

No_issue, amount_mismatch, payee_mismatch, duplicate_issue, void_issue, sanctions_screening or sanctions_screening_unavailable

has_imagesbooleanRequired

idstringRequired

journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

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

official_check_idstringOptional

payeestringOptional

pending_actorstringOptional

pending_decisionstringOptional

presented_onstring · dateRequired

A business date, YYYY-MM-DD

return_cash_letter_idstringOptional

return_reasonstringOptional

return_reason_textstringOptional

sequence_numberstringRequired

statusstringRequired

Paid, returned, exception

replayedbooleanRequired

return_cash_letterobject or nullOptional

CashLetter is an image cash letter file sent or received.

10 child attributes

business_datestring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired

directionstringRequired

Outbound or inbound

idstringRequired

item_countintegerRequired

kindstringRequired

Forward or return

rail_refstringOptional

settlement_datestring · dateOptional

A business date, YYYY-MM-DD

statusstringRequired

Built, sent, send_failed, settled, received

total_amountintegerRequired

returnsarray of objectsOptional

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

Errors

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

400401403404409412413422424429500503