Check Deposit Resources

CheckDeposit

The CheckDeposit resource represents a check deposit request.

For the full resource schema and attributes, see CheckDeposit in the API Resources documentation.

Attribute	Type	Description
id	string	Unique identifier of the check deposit.
createdAt	string	Date and time when the check deposit was created (ISO 8601 format).
amount	integer	The check amount in cents.
description	string	Description of the check deposit (maximum 50 characters).
status	string	Current status of the check deposit. See Check Deposit Status.
reason	string	Reason for rejection or return (when applicable).
reasonCode	string	Machine-readable reason code.
checkNumber	string	The check number extracted from the check image.
clearingDaysOverride	number	Custom clearing period in days (if set).
tags	object	Custom key-value pairs attached to the resource.

Relationship	Type	Description
account	DepositAccount	The deposit account receiving the check deposit.
customer	Customer	The customer who owns the account.
transaction	Transaction	The credit transaction created when the check deposit is sent.

When a check deposit is successfully processed and moves to Sent status, a credit transaction is created in the associated deposit account.

For the full transaction resource schema, see CheckDepositTransaction in the API Resources documentation.

Attribute	Type	Description
id	string	Unique identifier of the transaction.
createdAt	string	Date and time when the transaction was created (ISO 8601 format).
amount	integer	The transaction amount in cents (positive for credit).
balance	integer	Account balance after the transaction in cents.
summary	string	Human-readable description of the transaction.

Relationship	Type	Description
account	DepositAccount	The deposit account that received the credit.
customer	Customer	The customer who owns the account.
checkDeposit	CheckDeposit	The check deposit that created this transaction.