increase-test
POST/simulations/inbound_check_deposits/{inbound_check_deposit_id}/adjustment

Create an inbound check deposit adjustment in the sandbox

Simulates an adjustment to an Inbound Check Deposit in the sandbox. Use this operation for a deposit with status accepted; the adjustment reason defaults to wrong_payee_credit.

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

1 parameter · 2 body fields
inbound_check_deposit_idstringrequired
The identifier of the accepted Inbound Check Deposit to adjust.

Optional adjustment details for the Inbound Check Deposit.

amountintegeroptional
The adjustment amount in cents. A positive amount means that the funds are being returned to you by the other bank and is a credit to your account, as happens for a `wrong_payee_credit`. A negative amount is a debit to your account, as happens for a `late_return`. Defaults to the amount of the Inbound Check Deposit.
reasonstringoptional
The reason for the adjustment. Defaults to `wrong_payee_credit`.
Allowed:late_returnwrong_payee_credit

3 status codes
200Returns the updated Inbound Check Deposit, including the adjustment details.
accepted_atstringrequired
If the Inbound Check Deposit was accepted, the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.
account_idstringrequired
The Account the check is being deposited against.
account_number_idstringrequired
The Account Number the check is being deposited against.
adjustmentsarray<InboundCheckDepositAdjustmentsElement>required
If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.
amountintegerrequired
The deposited amount in USD cents.
automatically_resolves_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Inbound Check Deposit will be automatically resolved if it has not been actioned by then.
back_image_file_idstringrequired
The ID for the File containing the image of the back of the check.
bank_of_first_deposit_routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check 21 and the value will be null.
check_numberstringrequired
The check number printed on the check being deposited.
check_transfer_idstringrequired
If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit was attempted.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
Allowed:USD
declined_atstringrequired
If the Inbound Check Deposit was declined, the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place.
declined_transaction_idstringrequired
If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.
deposit_returnobjectrequired
If you requested a return of this deposit, this will contain details of the return.
front_image_file_idstringrequired
The ID for the File containing the image of the front of the check.
idstringrequired
The deposit's identifier.
payee_name_analysisstringrequired
Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.
Allowed:name_matchesdoes_not_matchnot_evaluated
statusstringrequired
The status of the Inbound Check Deposit.
Allowed:pendingaccepteddeclinedreturnedrequires_attention
transaction_idstringrequired
If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_check_deposit`.
Allowed:inbound_check_deposit
4XXReturned when the request cannot be processed because of a client error.
5XXReturned when the request cannot be processed because of a server error.

Error handling

The inbound_check_deposit_id path parameter must identify an Inbound Check Deposit with status accepted. amount must be an integer between -1000000000 and 1000000000, and reason must be late_return or wrong_payee_credit if provided.