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

Simulate a check deposit adjustment

Simulates an adjustment to a check deposit. The check deposit must have a submitted status; amount defaults to the negative of the deposit amount, and reason defaults to non_conforming_item. The response contains the check deposit with its adjustment details.

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

1 parameter · 2 body fields
check_deposit_idstringrequired
The identifier of the check deposit to adjust.

Optional adjustment details for the check deposit.

amountintegeroptional
The adjustment amount in the minor unit of the Check Deposit's currency (e.g., cents). A negative amount means that the funds are being clawed back by the other bank and is a debit to your account. Defaults to the negative of the Check Deposit amount.
reasonstringoptional
The reason for the adjustment.
Allowed:late_returnwrong_payee_creditadjusted_amountnon_conforming_itempaidDefault:non_conforming_item

3 status codes
200Returns the updated check deposit, including any adjustment 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 submitted status. amount must be an integer from -1,000,000,000 to 1,000,000,000, and reason must be one of late_return, wrong_payee_credit, adjusted_amount, non_conforming_item, or paid.