increase-test
POST/inbound_check_deposits/{inbound_check_deposit_id}/return

Return an inbound check deposit

Returns an inbound check deposit to the presenting institution. Provide a reason that identifies why the deposit is being returned, using one of the supported return reasons. The response contains the updated inbound check deposit.

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

1 parameter · 1 body field
inbound_check_deposit_idstringrequired
The identifier of the inbound check deposit to return.

Details for returning the inbound check deposit.

reasonstringrequired
The reason to return the Inbound Check Deposit.
Allowed:altered_or_fictitiousnot_authorizedduplicate_presentmentendorsement_missingendorsement_irregularrefer_to_maker

3 status codes
200Returns the updated inbound check deposit object with its return 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 encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The inbound_check_deposit_id path parameter must identify an existing inbound check deposit. reason is required and must be one of: altered_or_fictitious, not_authorized, duplicate_presentment, endorsement_missing, endorsement_irregular, or refer_to_maker.