Skip to navigation

Mobile Check Deposit

Let customers deposit a paper check by submitting photos of the front and back from their phone.
View as Markdown

Overview

The Mobile Check Deposit API lets customers deposit paper checks without visiting a branch or ATM. Your app captures images of the front and back of the check, submits them with the deposit details, and receives real-time validation and funds-availability information.


Deposit a check

1

Authenticate

Obtain an access token with the payments:write scope. See the Authentication guide.

2

Capture the check

Guide the customer to photograph the front and back. Ensure the check is endorsed “For mobile deposit only.”

3

Submit the deposit

Send the images, the deposit amount, and the destination accountRef.

4

Confirm availability

Return the hold details so the customer knows when funds will be available.

{
"toAccountRef": "acct_884201",
"amount": { "value": 250.00, "currency": "USD" },
"frontImage": "base64…",
"backImage": "base64…"
}
{
"depositId": "dep_66f1",
"status": "ACCEPTED",
"availableOn": "2026-04-25",
"heldAmount": 25.00
}

A portion of larger deposits may be held for a short period. Surface availableOn and heldAmount so the customer knows exactly when their funds will clear.


Deposit status

StatusMeaning
ACCEPTEDImages passed validation; deposit is processing
REVIEWDeposit flagged for manual review
REJECTEDImages failed validation (e.g. blurry or unsigned)
POSTEDFunds credited to the account

Ask customers to keep the paper check until the deposit shows POSTED and funds are confirmed available, in case re-submission is needed.


Security requirements

Requests require an OAuth 2.0 access token with the payments:write scope. See the Authentication guide.