Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

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.

post/simulations/inbound_ach_transfers

Request body

account_number_idstring required

The identifier of the Account Number the inbound ACH Transfer is for.

amountinteger required

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_datestring

The description of the date of the transfer.

company_discretionary_datastring

Data associated with the transfer set by the sender.

company_entry_descriptionstring

The description of the transfer set by the sender.

company_idstring

The sender's company ID.

company_namestring

The name of the sender. This corresponds to the originator_company_name field on the resulting Inbound ACH Transfer.

receiver_id_numberstring

The ID of the receiver of the transfer.

receiver_namestring

The name of the receiver of the transfer.

resolve_atstring date-time

The time at which the transfer should be resolved. If not provided will resolve immediately.

standard_entry_class_code'corporate_credit_or_debit' | 'corporate_trade_exchange' | 'prearranged_payments_and_deposit' | 'internet_initiated' | 'point_of_sale' | 'telephone_initiated' | 'customer_initiated' | 'accounts_receivable' | 'machine_transfer' | 'shared_network_transaction' | 'represented_check' | 'back_office_conversion' | 'point_of_purchase' | 'check_truncation' | 'destroyed_check' | 'international_ach_transaction'

The standard entry class code for the transfer.

Example request

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 1000
}

Response

Inbound ACH Transfer

account_idstring required

The Account to which the transfer belongs.

account_number_idstring required

The identifier of the Account Number to which this transfer was sent.

amountinteger required

The transfer amount in USD cents.

automatically_resolves_atstring date-time required

The time at which the transfer will be automatically resolved.

created_atstring date-time required

The ISO 8601 date and time at which the inbound ACH transfer was created.

direction'credit' | 'debit' required

The direction of the transfer.

effective_datestring date required

The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability.

idstring required

The inbound ACH transfer's identifier.

originator_company_descriptive_datestring nullable required

The descriptive date of the transfer.

originator_company_discretionary_datastring nullable required

The additional information included with the transfer.

originator_company_entry_descriptionstring required

The description of the transfer.

originator_company_idstring required

The id of the company that initiated the transfer.

originator_company_namestring required

The name of the company that initiated the transfer.

originator_routing_numberstring required

The American Banking Association (ABA) routing number of the bank originating the transfer.

receiver_id_numberstring nullable required

The id of the receiver of the transfer.

receiver_namestring nullable required

The name of the receiver of the transfer.

standard_entry_class_code'corporate_credit_or_debit' | 'corporate_trade_exchange' | 'prearranged_payments_and_deposit' | 'internet_initiated' | 'point_of_sale' | 'telephone_initiated' | 'customer_initiated' | 'accounts_receivable' | 'machine_transfer' | 'shared_network_transaction' | 'represented_check' | 'back_office_conversion' | 'point_of_purchase' | 'check_truncation' | 'destroyed_check' | 'international_ach_transaction' required

The Standard Entry Class (SEC) code of the transfer.

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

The status of the transfer.

trace_numberstring required

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.

type'inbound_ach_transfer' required

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

Example response

{
  "acceptance": {
    "accepted_at": "2020-01-31T23:59:59Z",
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  },
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "addenda": null,
  "amount": 100,
  "automatically_resolves_at": "2020-01-31T23:59:59Z",
  "created_at": "2020-01-31T23:59:59Z",
  "decline": null,
  "direction": "credit",
  "effective_date": "2023-04-02",
  "id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev",
  "international_addenda": null,
  "notification_of_change": null,
  "originator_company_descriptive_date": "230401",
  "originator_company_discretionary_data": "WEB AUTOPAY",
  "originator_company_entry_description": "INVOICE 2468",
  "originator_company_id": "0987654321",
  "originator_company_name": "PAYROLL COMPANY",
  "originator_routing_number": "101050001",
  "receiver_id_number": null,
  "receiver_name": "Ian Crease",
  "settlement": {
    "settled_at": "2020-01-31T23:59:59Z",
    "settlement_schedule": "same_day"
  },
  "standard_entry_class_code": "internet_initiated",
  "status": "accepted",
  "trace_number": "021000038461022",
  "transfer_return": null,
  "type": "inbound_ach_transfer"
}