Check Deposit

The Check Deposit resource represents a check in the sense of a paper document that orders a bank to transfer a specific amount of money. Check Deposits are created in the API by uploading pictures of the front and back of a signed check and specifying metadata about the check. After the Check Deposit resource is created, a backend process validates the images and data, processes the check, and finally credits the deposit into the account. Banks refer to this process as "remote deposit capture".

⚠️

Check deposit is currently only available to limited partnerships at select banks. Contact your Treasury Prime Account Manager for details.

Workflow

When you create a Check Deposit object, the initial status is pending_review. Check Deposit images are verified asynchronously after the Check Deposit object is created. If the images and data are valid, the Check Deposit's status changes to submitted.

Common image errors include bad cropping, blurry images, or invalid front or back images. The specific image error will be written to the error field when this occurs. For more information on testing check deposit errors, see the Check Deposit Testing section.

The Check Deposit will remain in the status of submitted until the payment is processed and funds are released to the receiving account. Depending on the amount of the deposit, funds may either immediately be made available to the receiving account, or they may be released on a schedule taking up to five business days. At that point, the status will be automatically updated to sent.

The possible status values are:

• pending_review

  Initial status after object creation. The check has not been submitted for remote deposit yet.

• submitted

  Images and data have been verified. Submitted check deposits are queued for processing, which happens periodically throughout the day. Checks deposits cannot be cancelled after they are submitted.

• sent

  The check deposit was processed and approved. The amount has been credited to the receiving account. The check deposit will remain in this state unless it is returned.

• canceled_OCR

  The check deposit was declined to issues with reading/validating the uploaded check images. The amount will not be credited to the account. The error field will describe the reason why the check image was not valid. The check will remain in this state perpetuity.

• error

  The check deposit was declined. The amount will not be credited to the account. The error field will describe the reason for rejection. The check will remain in this state in perpetuity.

• returned

  The deposit has been declined because the payment was unable to be processed from the originating account. This may result from a stop payment order, or from the originating account being locked, closed, or having insufficient funds.

⚠️

The check deposit amount may change after processing if it does not match the amount on the front image.