Checks

{
  id: string;
  amount: number;
  currency: string;
  checkNumber?: string;
  createdAt: string;
  mailItemId: string;
  payer?: string;
  payee?: string;
  status: 'notRequested' | ' processing' | 'completed' | 'failed';
  statusTransitions: {
    processing: string | null;
    completed: string | null;
    failed: string | null;
  };
}

Attributes

id string
Unique identifier for the object.

amount number

Amount in cents.

currency string

Three-letter ISO currency code .

checkNumber string

Unique identifier consisting of a set of numbers printed on the check.

createdAt string

Time at which the object was created.

mailItemId string

ID of the MailItem that is associated with the object.

payer string

Person or entity that issues the check.

payee string

Person or entity to whom the check is made payable to.

status string

Current deposit status of the check. Depending on the deposit type, the status can have different meanings:

• notRequested
  • A deposit request has not yet been made for the check.
• processing
  • The deposit request has been initiated and is currently in progress.
• completed
  • Mail-in deposit: The check has left our mail processing facility and has been sent to the bank.
  • Electronic deposit: The funds have been successfully credited to the Stable holding account.
• failed
  • Mail-in deposit: This status does not apply to mail-in deposits.
  • Electronic deposit: The check could not be electronically deposited or was reversed after being credited.

Additional details about failed checks:

• A check can transition from completed to failed, but the reverse transition is not possible.
• If a check moves from completed to failed, this indicates a check reversal, and funds will have been deducted from your account.
• If a check moves from processing to failed, this means the transaction was unsuccessful and will not appear in your dashboard.

statusTransitions object

Contains timestamps of when the object transitioned to a particular status. Attributes are null if the transition has not occurred.

• processing

  • The time at which the check changed to the processing status.

• completed

  • The time at which the check changed to the completed status.

• failed

  • The time at which the check changed to the failed status.