Checks
Overview
A Check is a paper check that Stable finds inside a Mail Item. Stable transcribes each Check it finds (amount, payer, payee, check number, and the other printed details) and adds it to the Mail Item's checks array. See the Checks reference for every field on the object.
Stable can deposit a Check into a bank account you connect in the Stable dashboard. You can request a deposit for one Mail Item's Checks or automatically for every Check at an address using auto-deposit rules configured in the dashboard. Checks are deposited into two types of bank accounts (Mail-In and Electronic).
Deposit requests via the API are coming soon.
How Stable finds Checks
Stable detects Checks after it opens and scans a Mail Item. A check inside an envelope that hasn't been scanned will not appear in the API. One Mail Item can contain more than one Check.
Deposit methods
Destination bank accounts are one of two types:
electronic: Stable deposits the Check by mobile deposit into a holding account. Funds move from the holding account to your bank account by ACH on the schedule you choose. Electronic deposits are available to U.S. businesses, and the check must be made out to the business's verified legal name or DBA.mailIn: Stable endorses the check and mails it to your bank's mail-in deposit address. The Mail Item'sdepositDetails.trackingNumberscontains the tracking numbers for that envelope. Stable can't see what happens after the bank receives it.
Learn more about holding accounts and eligibility in the support center.
Check status
A Check's status represents the state of its deposit request:
status | Electronic | Mail-in |
|---|---|---|
notRequested | No deposit has been requested. | No deposit has been requested. |
processing | The deposit is in progress. | The deposit is in progress. |
completed | The funds were credited to the holding account. | The check left Stable's facility for the bank. |
failed | The deposit was rejected or reversed. | Does not apply. |
Failed deposits and reversals
An electronic deposit can fail in two ways:
- From
processing: the deposit was rejected, and no funds reached the holding account. - From
completed: the check was reversed after the funds were credited, for example after a stop payment. Stable deducts the funds from the holding account.
failureDetails.code contains the reason for any failures. See Failure reason details for every code.
Tracking Checks in the API
Checks are read through the Mail Item that contains them. Filter List mail items by check.status to find Mail Items with Checks in a given status, or by none to find Mail Items with no Checks.
To follow deposits as they happen, subscribe to the check events:
Further reading
Updated about 2 hours ago
