Skip to main content
A check (chk_*) mails a paper check in USD from a wallet to an external party. To learn more, see Pay over a specific rail.

Example

GET /check/{checkId}
The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.

Fields

string
required
Resource type. Always check.
string
required
Check ID (chk_*).
object
required
The check’s details.
object
required
Related resources, each by type and ID.

Statuses

Events

  • check.created: A check payment was created and is waiting to be issued.
  • check.processing: A check payment was submitted to money movement and is being issued, printed, mailed, or awaiting deposit.
  • check.completed: A check was deposited and settled; the wallet was debited.
  • check.returned: A settled check was returned by the paying bank; the funds were restored to the wallet.
  • check.canceled: A check was canceled before submission, or a requested stop payment was confirmed.
  • check.expired: A check was not cashed before its void date and expired; the escrow was released.
  • check.rejected: The bank rejected a check payment at issuance; details are in failure.
  • check.failed: A check payment failed before issuance; details are in failure.
  • check.returnedToSender: A mailed check was undeliverable and returned to sender; the check stays outstanding.

Errors

See the error codes these endpoints return.

Sandbox simulations