Record a day's lockbox mail: JSON batches, or a transmission in the bank's remittance layout as text; every check is deposited to the lockbox's account
POST
/lockboxes/{id}/remittancesPath parameters
idstringRequiredHeaders
Idempotency-KeystringOptionalSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
batchesarray of objectsRequired2 child attributes
itemsarray of objectsRequired6 child attributes
amountintegerRequiredback_imagestring · byteOptionalfront_imagestring · byteOptionalinvoicesarray of objectsOptional2 child attributes
amountintegerRequirednumberstringRequiredmicrobjectRequiredMICR is a check's magnetic line.
4 child attributes
aux_on_usstringOptionalcheck_numberstringOptionalon_usstringRequiredAccount number, "/" and serial as printed
payor_routing_numberstringRequiredremitterstringOptionalnumberintegerOptionalReturns
200 OK
batch_countintegerRequiredbusiness_datestring · dateRequiredA business date, YYYY-MM-DD
created_atstring · date-timeRequiredidstringRequireditem_countintegerRequireditemsarray of objectsOptional8 child attributes
amountintegerRequiredbatch_numberintegerRequiredcheck_deposit_idstringOptionalidstringRequiredinvoicesarray of objectsOptional2 child attributes
amountintegerRequirednumberstringRequireditem_numberintegerRequiredmicrobjectRequiredMICR is a check's magnetic line.
4 child attributes
aux_on_usstringOptionalcheck_numberstringOptionalon_usstringRequiredAccount number, "/" and serial as printed
payor_routing_numberstringRequiredremitterstringOptionallockbox_idstringRequiredstatusstringRequiredtotal_amountintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503