Deposit a check: MICR line, amount and images; on the account at once under its Reg CC hold, collected through the next cash letter

POST/transfers/checks/deposit

Channel is branch, mobile, atm (a proprietary ATM only), or lockbox. nonproprietary_atm is explicitly refused with payments.unsupported_deposit_channel. An integrator unable to establish that the bank operates the ATM must use nonproprietary_atm. The opening minimum of an unfunded certificate also applies.

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

account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

amountintegerRequired

Minor units of the currency (cents for USD)

back_imagestring · byteOptional

channelstringOptional

Branch, mobile, atm (proprietary only), or lockbox; nonproprietary_atm is explicitly refused with payments.unsupported_deposit_channel

One of branch, mobile, atm, lockbox, nonproprietary_atm.

currency_codestringRequired

ISO 4217 code

drawerstringOptional

Who wrote the check, as captured; screened with the payee

front_imagestring · byteOptional

TIFF, base64 in JSON

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

Returns

200 OK

The Check Transfer object.

Errors

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

400401403404409412413422424429500503