Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Inbound ACH Transfers

An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.

The Inbound ACH Transfer object
{
  "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"
}
Attributes
acceptance
dictionary
Nullable

If your transfer is accepted, this will contain details of the acceptance.

account_id
string

The Account to which the transfer belongs.

account_number_id
string

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

addenda
dictionary
Nullable

Additional information sent from the originator.

amount
integer

The transfer amount in USD cents.

automatically_resolves_at
string

The time at which the transfer will be automatically resolved.

created_at
string

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

decline
dictionary
Nullable

If your transfer is declined, this will contain details of the decline.

direction
enum

The direction of the transfer.

effective_date
string

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

id
string

The inbound ACH transfer's identifier.

international_addenda
dictionary
Nullable

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_change
dictionary
Nullable

If you initiate a notification of change in response to the transfer, this will contain its details.

originator_company_descriptive_date
string
Nullable

The descriptive date of the transfer.

originator_company_discretionary_data
string
Nullable

The additional information included with the transfer.

originator_company_entry_description
string

The description of the transfer.

originator_company_id
string

The id of the company that initiated the transfer.

originator_company_name
string

The name of the company that initiated the transfer.

originator_routing_number
string

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

receiver_id_number
string
Nullable

The id of the receiver of the transfer.

receiver_name
string
Nullable

The name of the receiver of the transfer.

settlement
dictionary

A subhash containing information about when and how the transfer settled at the Federal Reserve.

standard_entry_class_code
enum

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

status
enum

The status of the transfer.

trace_number
string

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.

transfer_return
dictionary
Nullable

If your transfer is returned, this will contain details of the return.

type
string

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

List Inbound ACH Transfers
curl \
  --url "${INCREASE_URL}/inbound_ach_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound ACH Transfers to ones belonging to the specified Account.

account_number_id
string

Filter Inbound ACH Transfers to ones belonging to the specified Account Number.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status.in
array of strings

Filter Inbound ACH Transfers to those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

Retrieve an Inbound ACH Transfer
curl \
  --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to get details for.

Create a notification of change for an Inbound ACH Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/create_notification_of_change" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "updated_account_number": "987654321",
    "updated_routing_number": "101050001"
  }'
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer for which to create a notification of change.

updated_account_number
string

The updated account number to send in the notification of change.

200 character maximum
updated_routing_number
string

The updated routing number to send in the notification of change.

200 character maximum
Decline an Inbound ACH Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/decline" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "reason": "payment_stopped"
  }'
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to decline.

reason
enum

The reason why this transfer will be returned. If this parameter is unset, the return codes will be payment_stopped for debits and credit_entry_refused_by_receiver for credits.

Return an Inbound ACH Transfer
curl -X "POST" \
  --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/transfer_return" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "reason": "payment_stopped"
  }'
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to return to the originating financial institution.

reason
enum
Required

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.

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.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_ach_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "amount": 1000
  }'
Parameters
account_number_id
string
Required

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

addenda
dictionary

Additional information to include in the transfer.

amount
integer
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_date
string

The description of the date of the transfer.

6 character maximum
company_discretionary_data
string

Data associated with the transfer set by the sender.

20 character maximum
company_entry_description
string

The description of the transfer set by the sender.

10 character maximum
company_id
string

The sender's company ID.

15 character maximum
company_name
string

The name of the sender.

16 character maximum
receiver_id_number
string

The ID of the receiver of the transfer.

200 character maximum
receiver_name
string

The name of the receiver of the transfer.

200 character maximum
resolve_at
string

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

standard_entry_class_code
enum

The standard entry class code for the transfer.