increase-test
POST/check_deposits

Create a check deposit

Creates a check deposit in the specified account using images of the front and back of a paper check. Provide account_id, amount, front_image_file_id, and back_image_file_id; the amount is in USD cents and must be at least 1. You can optionally supply a display description of up to 200 characters.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

5 body fields

Check deposit details, including the account, amount, and file identifiers for both check images.

account_idstringrequired
The identifier for the Account to deposit the check in.
amountintegerrequired
The deposit amount in USD cents.
back_image_file_idstringrequired
The File containing the check's back image.
descriptionstringoptional
The description you choose to give the Check Deposit, for display purposes only.
front_image_file_idstringrequired
The File containing the check's front image.

3 status codes
200Returns the created check deposit object, including its identifier, account, amount, check image file identifiers, creation time, and deposit status.
account_idstringrequired
The Account the check was deposited into.
amountintegerrequired
The deposited amount in USD cents.
back_image_file_idstringrequired
The ID for the File containing the image of the back of the check.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
deposit_acceptanceobjectrequired
Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.
deposit_adjustmentsarray<CheckDepositCheckDepositAdjustment>required
If the deposit or the return was adjusted by the receiving institution, this will contain details of the adjustments.
deposit_rejectionobjectrequired
If your deposit is rejected by Increase, this will contain details as to why it was rejected.
deposit_returnobjectrequired
If your deposit is returned, this will contain details as to why it was returned.
deposit_submissionobjectrequired
After the check is parsed, it is submitted to the Check 21 network for processing. This will contain details of the submission.
descriptionstringrequired
The description of the Check Deposit, for display purposes only.
front_image_file_idstringrequired
The ID for the File containing the image of the front of the check.
idstringrequired
The deposit's identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
inbound_funds_holdobjectrequired
Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.
inbound_mail_item_idstringrequired
If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.
lockbox_recipient_idstringrequired
If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox Recipient, this will contain the identifier of the Lockbox Recipient that received it.
statusstringrequired
The status of the Check Deposit.
Allowed:pendingsubmittedrejectedreturned
transaction_idstringrequired
The ID for the Transaction created by the deposit.
typestringrequired
A constant representing the object's type. For this resource it will always be `check_deposit`.
Allowed:check_deposit
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

account_id, amount, front_image_file_id, and back_image_file_id are required. amount must be at least 1 USD cent, and description, if provided, must be between 1 and 200 characters.