increase-test
POST/inbound_ach_transfers/{inbound_ach_transfer_id}/transfer_return

Return an inbound ACH transfer

Returns an inbound ACH transfer to the originating financial institution. Provide a reason that identifies why the transfer is being returned, using one of the supported ACH return codes. The response contains the updated inbound ACH transfer.

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

1 parameter · 1 body field
inbound_ach_transfer_idstringrequired
The identifier of the inbound ACH transfer to return to the originating financial institution.

Details for returning the inbound ACH transfer.

reasonstringrequired
The reason why this transfer will be returned. The most usual return codes are `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
Allowed:insufficient_fundsauthorization_revoked_by_customerpayment_stoppedcustomer_advised_unauthorized_improper_ineligible_or_incompleterepresentative_payee_deceased_or_unable_to_continue_in_that_capacitybeneficiary_or_account_holder_deceasedcredit_entry_refused_by_receiverduplicate_entrycorporate_customer_advised_not_authorized

3 status codes
200Returns the updated inbound ACH transfer object with its return details.
acceptanceobjectrequired
If your transfer is accepted, this will contain details of the acceptance.
account_idstringrequired
The Account to which the transfer belongs.
account_number_idstringrequired
The identifier of the Account Number to which this transfer was sent.
addendaobjectrequired
Additional information sent from the originator.
amountintegerrequired
The transfer amount in USD cents.
automatically_resolves_atstringrequired
The time at which the transfer will be automatically resolved.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound ACH transfer was created.
declineobjectrequired
If your transfer is declined, this will contain details of the decline.
directionstringrequired
The direction of the transfer.
Allowed:creditdebit
effective_datestringrequired
The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability.
idstringrequired
The inbound ACH transfer's identifier.
international_addendaobjectrequired
If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.
notification_of_changeobjectrequired
If you initiate a notification of change in response to the transfer, this will contain its details.
originator_company_descriptive_datestringrequired
The descriptive date of the transfer.
originator_company_discretionary_datastringrequired
The additional information included with the transfer.
originator_company_entry_descriptionstringrequired
The description of the transfer.
originator_company_idstringrequired
The id of the company that initiated the transfer.
originator_company_namestringrequired
The name of the company that initiated the transfer.
originator_routing_numberstringrequired
The American Bankers' Association (ABA) routing number of the bank originating the transfer.
receiver_id_numberstringrequired
The id of the receiver of the transfer.
receiver_namestringrequired
The name of the receiver of the transfer.
settlementobjectrequired
A subhash containing information about when and how the transfer settled at the Federal Reserve.
standard_entry_class_codestringrequired
The Standard Entry Class (SEC) code of the transfer.
Allowed:corporate_credit_or_debitcorporate_trade_exchangeprearranged_payments_and_depositinternet_initiatedpoint_of_saletelephone_initiatedcustomer_initiatedaccounts_receivablemachine_transfershared_network_transactionrepresented_checkback_office_conversion
statusstringrequired
The status of the transfer.
Allowed:pendingdeclinedacceptedreturned
trace_numberstringrequired
A 15 digit number set by the sending bank and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer. ACH trace numbers are not unique, but are [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns).
transfer_returnobjectrequired
If your transfer is returned, this will contain details of the return.
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_ach_transfer`.
Allowed:inbound_ach_transfer
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

The inbound_ach_transfer_id path parameter must identify an existing inbound ACH transfer. reason is required and must be one of: insufficient_funds, authorization_revoked_by_customer, payment_stopped, customer_advised_unauthorized_improper_ineligible_or_incomplete, representative_payee_deceased_or_unable_to_continue_in_that_capacity, beneficiary_or_account_holder_deceased, credit_entry_refused_by_receiver, duplicate_entry, or corporate_customer_advised_not_authorized.