v4

OpenAPI 3.1.02026-08-012402353.8 MB

Return an Inbound Check Deposit

post/inbound_check_deposits/{inbound_check_deposit_id}/return

Path parameters

inbound_check_deposit_idstring required

The identifier of the Inbound Check Deposit to return.

Request body

The reason to return the Inbound Check Deposit.

Example request

{
  "reason": "altered_or_fictitious"
}

Response

Inbound Check Deposit

accepted_atstring date-time nullable required

If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.

account_idstring required

The Account the check is being deposited against.

account_number_idstring nullable required

The Account Number the check is being deposited against.

amountinteger required

The deposited amount in USD cents.

automatically_resolves_atstring date-time required

The 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_idstring nullable required

The ID for the File containing the image of the back of the check.

bank_of_first_deposit_routing_numberstring nullable required

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.

check_numberstring nullable required

The check number printed on the check being deposited.

check_transfer_idstring nullable required

If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.

created_atstring date-time required

The ISO 8601 date and time at which the deposit was attempted.

currency'USD' required

The ISO 4217 code for the deposit.

declined_atstring date-time nullable required

If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.

declined_transaction_idstring nullable required

If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.

front_image_file_idstring nullable required

The ID for the File containing the image of the front of the check.

idstring required

The deposit's identifier.

payee_name_analysis'name_matches' | 'does_not_match' | 'not_evaluated' required

Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.

status'pending' | 'accepted' | 'declined' | 'returned' | 'requires_attention' required

The status of the Inbound Check Deposit.

transaction_idstring nullable required

If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.

type'inbound_check_deposit' required

A constant representing the object's type. For this resource it will always be inbound_check_deposit.

Example response

{
  "accepted_at": "2020-01-31T23:59:59Z",
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "adjustments": [],
  "amount": 1000,
  "automatically_resolves_at": "2020-01-31T23:59:59Z",
  "back_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "bank_of_first_deposit_routing_number": "101050001",
  "check_number": "123",
  "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5",
  "created_at": "2020-01-31T23:59:59Z",
  "currency": "USD",
  "declined_at": null,
  "declined_transaction_id": null,
  "deposit_return": null,
  "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "inbound_check_deposit_zoshvqybq0cjjm31mra",
  "payee_name_analysis": "name_matches",
  "status": "accepted",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "inbound_check_deposit"
}