Return a presented check held as a positive pay exception

POST/transfers/checks/{id}/return

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

operatorstringRequired

Who acted

Returns

200 OK

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

Errors

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

400401403404409412413422424429500503