increase-test
POST/simulations/inbound_ach_transfers

Sandbox: Create an Inbound ACH Transfer

Simulates an inbound ACH transfer to your account. This imitates initiating a transfer to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the amount is positive or negative. The result of calling this API will contain the created transfer. You can pass a resolve_at parameter to allow for a window to action on the Inbound ACH Transfer. Alternatively, if you don't pass the resolve_at parameter the result will contain either a Transaction or a Declined Transaction depending on whether or not the transfer is allowed.

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

12 body fields
account_number_idstringrequired
The identifier of the Account Number the inbound ACH Transfer is for.
addendaobjectoptional
Additional information to include in the transfer.
amountintegerrequired
The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.
company_descriptive_datestringoptional
The description of the date of the transfer.
company_discretionary_datastringoptional
Data associated with the transfer set by the sender.
company_entry_descriptionstringoptional
The description of the transfer set by the sender.
company_idstringoptional
The sender's company ID.
company_namestringoptional
The name of the sender. This corresponds to the `originator_company_name` field on the resulting Inbound ACH Transfer.
receiver_id_numberstringoptional
The ID of the receiver of the transfer.
receiver_namestringoptional
The name of the receiver of the transfer.
resolve_atstringoptional
The time at which the transfer should be resolved. If not provided will resolve immediately.
standard_entry_class_codestringoptional
The standard entry class code for the transfer.
Allowed:corporate_credit_or_debitcorporate_trade_exchangeprearranged_payments_and_depositinternet_initiatedpoint_of_saletelephone_initiatedcustomer_initiatedaccounts_receivablemachine_transfershared_network_transactionrepresented_checkback_office_conversion

3 status codes
200Inbound ACH Transfer
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
4XXError
5XXError