increase-test
POST/simulations/check_deposits/{check_deposit_id}/submit

Simulate submission of a check deposit

Simulates submission of a check deposit to the Federal Reserve. The check deposit must have a pending status; you can optionally provide scan values to set the simulated MICR data instead of using random values. The response contains the updated check deposit with its submission details.

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

1 parameter · 1 body field
check_deposit_idstringrequired
The identifier of the check deposit to submit.

Optional simulated MICR scan data for the check; if omitted, the simulation uses random values.

scanobjectoptional
If set, the simulation will use these values for the check's scanned MICR data. If not set, the simulation will use random values.

3 status codes
200Returns the updated check deposit, including its submission details.
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 API reports a client error; the response contains structured error details.
5XXReturned when the API reports a server error; the response contains structured error details.

Error handling

The check_deposit_id path parameter must identify a check deposit with a pending status. If you provide scan, it must include account_number and routing_number; each supplied scan value must contain 1 to 200 characters.