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

[Events](https://increase.com/documentation/events.md) will be generated for this resource. The possible event categories are: `inbound_ach_transfer.created`  and `inbound_ach_transfer.updated`.

## The Inbound ACH Transfer object
### Example
```json
{
  "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.

  - `acceptance.accepted_at` (string)
    The time at which the transfer was accepted.

  - `acceptance.transaction_id` (string)
    The id of the transaction for the accepted transfer.

- `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.

  - `addenda.category` (enum)
    The type of addendum.
    Cases:
    * `freeform` (Unstructured addendum.)

  - `addenda.freeform` (dictionary, nullable)
    Unstructured `payment_related_information` passed through by the originator.

      - `addenda.freeform.entries` (array of objects)
        Each entry represents an addendum received from the originator.

            - `addenda.freeform.entries.payment_related_information` (string)
              The payment related information passed in the addendum.

- `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](https://en.wikipedia.org/wiki/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.

  - `decline.declined_at` (string)
    The time at which the transfer was declined.

  - `decline.declined_transaction_id` (string)
    The id of the transaction for the declined transfer.

  - `decline.reason` (enum)
    The reason for the transfer decline.
    Cases:
    * `ach_route_canceled` (The account number is canceled.)
    * `ach_route_disabled` (The account number is disabled.)
    * `breaches_limit` (The transaction would cause an Increase limit to be exceeded.)
    * `entity_not_active` (The account's entity is not active.)
    * `group_locked` (Your account is inactive.)
    * `transaction_not_allowed` (The transaction is not allowed per Increase's terms.)
    * `returned_per_odfi_request` (The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.)
    * `user_initiated` (Your integration declined this transfer via the API.)
    * `insufficient_funds` (Your account contains insufficient funds.)
    * `authorization_revoked_by_customer` (The customer no longer authorizes this transaction.)
    * `payment_stopped` (The customer asked for the payment to be stopped.)
    * `customer_advised_unauthorized_improper_ineligible_or_incomplete` (The customer advises that the debit was unauthorized.)
    * `representative_payee_deceased_or_unable_to_continue_in_that_capacity` (The payee is deceased.)
    * `beneficiary_or_account_holder_deceased` (The account holder is deceased.)
    * `credit_entry_refused_by_receiver` (The customer refused a credit entry.)
    * `duplicate_entry` (The account holder identified this transaction as a duplicate.)
    * `corporate_customer_advised_not_authorized` (The corporate customer no longer authorizes this transaction.)

- `direction` (enum)
  The direction of the transfer.
  Cases:
  * `credit` (Credit)
  * `debit` (Debit)

- `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.

  - `international_addenda.destination_country_code` (string)
    The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the destination country.

  - `international_addenda.destination_currency_code` (string)
    The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the destination bank account.

  - `international_addenda.foreign_exchange_indicator` (enum)
    A description of how the foreign exchange rate was calculated.
    Cases:
    * `fixed_to_variable` (The originator chose an amount in their own currency. The settled amount in USD was converted using the exchange rate.)
    * `variable_to_fixed` (The originator chose an amount to settle in USD. The originator's amount was variable; known only after the foreign exchange conversion.)
    * `fixed_to_fixed` (The amount was originated and settled as a fixed amount in USD. There is no foreign exchange conversion.)

  - `international_addenda.foreign_exchange_reference` (string, nullable)
    Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a reference to a well-known rate.

  - `international_addenda.foreign_exchange_reference_indicator` (enum)
    An instruction of how to interpret the `foreign_exchange_reference` field for this Transaction.
    Cases:
    * `foreign_exchange_rate` (The ACH file contains a foreign exchange rate.)
    * `foreign_exchange_reference_number` (The ACH file contains a reference to a well-known foreign exchange rate.)
    * `blank` (There is no foreign exchange for this transfer, so the `foreign_exchange_reference` field is blank.)

  - `international_addenda.foreign_payment_amount` (integer)
    The amount in the minor unit of the foreign payment currency. For dollars, for example, this is cents.

  - `international_addenda.foreign_trace_number` (string, nullable)
    A reference number in the foreign banking infrastructure.

  - `international_addenda.international_transaction_type_code` (enum)
    The type of transfer. Set by the originator.
    Cases:
    * `annuity` (Sent as `ANN` in the Nacha file.)
    * `business_or_commercial` (Sent as `BUS` in the Nacha file.)
    * `deposit` (Sent as `DEP` in the Nacha file.)
    * `loan` (Sent as `LOA` in the Nacha file.)
    * `miscellaneous` (Sent as `MIS` in the Nacha file.)
    * `mortgage` (Sent as `MOR` in the Nacha file.)
    * `pension` (Sent as `PEN` in the Nacha file.)
    * `remittance` (Sent as `REM` in the Nacha file.)
    * `rent_or_lease` (Sent as `RLS` in the Nacha file.)
    * `salary_or_payroll` (Sent as `SAL` in the Nacha file.)
    * `tax` (Sent as `TAX` in the Nacha file.)
    * `accounts_receivable` (Sent as `ARC` in the Nacha file.)
    * `back_office_conversion` (Sent as `BOC` in the Nacha file.)
    * `machine_transfer` (Sent as `MTE` in the Nacha file.)
    * `point_of_purchase` (Sent as `POP` in the Nacha file.)
    * `point_of_sale` (Sent as `POS` in the Nacha file.)
    * `represented_check` (Sent as `RCK` in the Nacha file.)
    * `shared_network_transaction` (Sent as `SHR` in the Nacha file.)
    * `telphone_initiated` (Sent as `TEL` in the Nacha file.)
    * `internet_initiated` (Sent as `WEB` in the Nacha file.)

  - `international_addenda.originating_currency_code` (string)
    The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the originating bank account.

  - `international_addenda.originating_depository_financial_institution_branch_country` (string)
    The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originating branch country.

  - `international_addenda.originating_depository_financial_institution_id` (string)
    An identifier for the originating bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number.

  - `international_addenda.originating_depository_financial_institution_id_qualifier` (enum)
    An instruction of how to interpret the `originating_depository_financial_institution_id` field for this Transaction.
    Cases:
    * `national_clearing_system_number` (A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number.)
    * `bic_code` (The SWIFT Bank Identifier Code (BIC) of the bank.)
    * `iban` (An International Bank Account Number.)

  - `international_addenda.originating_depository_financial_institution_name` (string)
    The name of the originating bank. Sometimes this will refer to an American bank and obscure the correspondent foreign bank.

  - `international_addenda.originator_city` (string)
    A portion of the originator address. This may be incomplete.

  - `international_addenda.originator_country` (string)
    A portion of the originator address. The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originator country.

  - `international_addenda.originator_identification` (string)
    An identifier for the originating company. This is generally stable across multiple ACH transfers.

  - `international_addenda.originator_name` (string)
    Either the name of the originator or an intermediary money transmitter.

  - `international_addenda.originator_postal_code` (string, nullable)
    A portion of the originator address. This may be incomplete.

  - `international_addenda.originator_state_or_province` (string, nullable)
    A portion of the originator address. This may be incomplete.

  - `international_addenda.originator_street_address` (string)
    A portion of the originator address. This may be incomplete.

  - `international_addenda.payment_related_information` (string, nullable)
    A description field set by the originator.

  - `international_addenda.payment_related_information2` (string, nullable)
    A description field set by the originator.

  - `international_addenda.receiver_city` (string)
    A portion of the receiver address. This may be incomplete.

  - `international_addenda.receiver_country` (string)
    A portion of the receiver address. The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiver country.

  - `international_addenda.receiver_identification_number` (string, nullable)
    An identification number the originator uses for the receiver.

  - `international_addenda.receiver_postal_code` (string, nullable)
    A portion of the receiver address. This may be incomplete.

  - `international_addenda.receiver_state_or_province` (string, nullable)
    A portion of the receiver address. This may be incomplete.

  - `international_addenda.receiver_street_address` (string)
    A portion of the receiver address. This may be incomplete.

  - `international_addenda.receiving_company_or_individual_name` (string)
    The name of the receiver of the transfer. This is not verified by Increase.

  - `international_addenda.receiving_depository_financial_institution_country` (string)
    The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiving bank country.

  - `international_addenda.receiving_depository_financial_institution_id` (string)
    An identifier for the receiving bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number.

  - `international_addenda.receiving_depository_financial_institution_id_qualifier` (enum)
    An instruction of how to interpret the `receiving_depository_financial_institution_id` field for this Transaction.
    Cases:
    * `national_clearing_system_number` (A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number.)
    * `bic_code` (The SWIFT Bank Identifier Code (BIC) of the bank.)
    * `iban` (An International Bank Account Number.)

  - `international_addenda.receiving_depository_financial_institution_name` (string)
    The name of the receiving bank, as set by the sending financial institution.

- `notification_of_change` (dictionary, nullable)
  If you initiate a notification of change in response to the transfer, this will contain its details.

  - `notification_of_change.updated_account_number` (string, nullable)
    The new account number provided in the notification of change.

  - `notification_of_change.updated_routing_number` (string, nullable)
    The new routing number provided in the notification of change.

- `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.

  - `settlement.settled_at` (string)
    When the funds for this transfer settle at the recipient bank at the Federal Reserve.

  - `settlement.settlement_schedule` (enum)
    The settlement schedule this transfer follows.
    Cases:
    * `same_day` (The transfer is expected to settle same-day.)
    * `future_dated` (The transfer is expected to settle on a future date.)

- `standard_entry_class_code` (enum)
  The Standard Entry Class (SEC) code of the transfer.
  Cases:
  * `corporate_credit_or_debit` (Corporate Credit and Debit (CCD).)
  * `corporate_trade_exchange` (Corporate Trade Exchange (CTX).)
  * `prearranged_payments_and_deposit` (Prearranged Payments and Deposits (PPD).)
  * `internet_initiated` (Internet Initiated (WEB).)
  * `point_of_sale` (Point of Sale (POS).)
  * `telephone_initiated` (Telephone Initiated (TEL).)
  * `customer_initiated` (Customer Initiated (CIE).)
  * `accounts_receivable` (Accounts Receivable (ARC).)
  * `machine_transfer` (Machine Transfer (MTE).)
  * `shared_network_transaction` (Shared Network Transaction (SHR).)
  * `represented_check` (Represented Check (RCK).)
  * `back_office_conversion` (Back Office Conversion (BOC).)
  * `point_of_purchase` (Point of Purchase (POP).)
  * `check_truncation` (Check Truncation (TRC).)
  * `destroyed_check` (Destroyed Check (XCK).)
  * `international_ach_transaction` (International ACH Transaction (IAT).)

- `status` (enum)
  The status of the transfer.
  Cases:
  * `pending` (The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken.)
  * `declined` (The Inbound ACH Transfer has been declined.)
  * `accepted` (The Inbound ACH Transfer is accepted.)
  * `returned` (The Inbound ACH Transfer has been returned.)

- `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](https://increase.com/documentation/ach-returns#ach-returns).

- `transfer_return` (dictionary, nullable)
  If your transfer is returned, this will contain details of the return.

  - `transfer_return.reason` (enum)
    The reason for the transfer return.
    Cases:
    * `insufficient_funds` (The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01.)
    * `returned_per_odfi_request` (The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request. The Nacha return code is R06.)
    * `authorization_revoked_by_customer` (The customer no longer authorizes this transaction. The Nacha return code is R07.)
    * `payment_stopped` (The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.)
    * `customer_advised_unauthorized_improper_ineligible_or_incomplete` (The customer advises that the debit was unauthorized. The Nacha return code is R10.)
    * `representative_payee_deceased_or_unable_to_continue_in_that_capacity` (The payee is deceased. The Nacha return code is R14.)
    * `beneficiary_or_account_holder_deceased` (The account holder is deceased. The Nacha return code is R15.)
    * `credit_entry_refused_by_receiver` (The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.)
    * `duplicate_entry` (The account holder identified this transaction as a duplicate. The Nacha return code is R24.)
    * `corporate_customer_advised_not_authorized` (The corporate customer no longer authorizes this transaction. The Nacha return code is R29.)

  - `transfer_return.returned_at` (string)
    The time at which the transfer was returned.

  - `transfer_return.transaction_id` (string)
    The id of the transaction for the returned transfer.

- `type` (string)
  A constant representing the object's type. For this resource it will always be `inbound_ach_transfer`.

## List Inbound ACH Transfers
GET /inbound_ach_transfers

### Example
```curl
curl \
  --url "${INCREASE_URL}/inbound_ach_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### Query Parameters
- `cursor` (string, optional)
  Return the page of entries after this one.

- `limit` (integer, optional)
  Limit the size of the list that is returned. The default (and maximum) is 100 objects.

- `account_id` (string, optional)
  Filter Inbound ACH Transfers to ones belonging to the specified Account.

- `account_number_id` (string, optional)
  Filter Inbound ACH Transfers to ones belonging to the specified Account Number.

- `created_at.after` (string, optional)
  Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.before` (string, optional)
  Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_after` (string, optional)
  Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `created_at.on_or_before` (string, optional)
  Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.

- `status.in` (array of enums, optional)
  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`.
  Cases:
  * `pending` (The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken.)
  * `declined` (The Inbound ACH Transfer has been declined.)
  * `accepted` (The Inbound ACH Transfer is accepted.)
  * `returned` (The Inbound ACH Transfer has been returned.)

### Returns a Inbound ACH Transfer List object:
```json
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}
```

## Retrieve an Inbound ACH Transfer
GET /inbound_ach_transfers/{inbound_ach_transfer_id}

### Example
```curl
curl \
  --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```
### Path 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
POST /inbound_ach_transfers/{inbound_ach_transfer_id}/create_notification_of_change

### Example
```curl
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"
  }'
```
### Path Parameters
- `inbound_ach_transfer_id` (string, required)
  The identifier of the Inbound ACH Transfer for which to create a notification of change.

### Body Parameters
- `updated_account_number` (string, optional)
  The updated account number to send in the notification of change.

- `updated_routing_number` (string, optional)
  The updated routing number to send in the notification of change.

## Decline an Inbound ACH Transfer
POST /inbound_ach_transfers/{inbound_ach_transfer_id}/decline

### Example
```curl
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"
  }'
```
### Path Parameters
- `inbound_ach_transfer_id` (string, required)
  The identifier of the Inbound ACH Transfer to decline.

### Body Parameters
- `reason` (enum, optional)
  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.
  Cases:
  * `insufficient_funds` (The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01.)
  * `authorization_revoked_by_customer` (The customer no longer authorizes this transaction. The Nacha return code is R07.)
  * `payment_stopped` (The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.)
  * `customer_advised_unauthorized_improper_ineligible_or_incomplete` (The customer advises that the debit was unauthorized. The Nacha return code is R10.)
  * `representative_payee_deceased_or_unable_to_continue_in_that_capacity` (The payee is deceased. The Nacha return code is R14.)
  * `beneficiary_or_account_holder_deceased` (The account holder is deceased. The Nacha return code is R15.)
  * `credit_entry_refused_by_receiver` (The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.)
  * `duplicate_entry` (The account holder identified this transaction as a duplicate. The Nacha return code is R24.)
  * `corporate_customer_advised_not_authorized` (The corporate customer no longer authorizes this transaction. The Nacha return code is R29.)

## Return an Inbound ACH Transfer
POST /inbound_ach_transfers/{inbound_ach_transfer_id}/transfer_return

### Example
```curl
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"
  }'
```
### Path Parameters
- `inbound_ach_transfer_id` (string, required)
  The identifier of the Inbound ACH Transfer to return to the originating financial institution.

### Body Parameters
- `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.
  Cases:
  * `insufficient_funds` (The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01.)
  * `authorization_revoked_by_customer` (The customer no longer authorizes this transaction. The Nacha return code is R07.)
  * `payment_stopped` (The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.)
  * `customer_advised_unauthorized_improper_ineligible_or_incomplete` (The customer advises that the debit was unauthorized. The Nacha return code is R10.)
  * `representative_payee_deceased_or_unable_to_continue_in_that_capacity` (The payee is deceased. The Nacha return code is R14.)
  * `beneficiary_or_account_holder_deceased` (The account holder is deceased. The Nacha return code is R15.)
  * `credit_entry_refused_by_receiver` (The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.)
  * `duplicate_entry` (The account holder identified this transaction as a duplicate. The Nacha return code is R24.)
  * `corporate_customer_advised_not_authorized` (The corporate customer no longer authorizes this transaction. The Nacha return code is R29.)

## Sandbox: Create an Inbound ACH Transfer
POST /simulations/inbound_ach_transfers
> 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](https://increase.com/documentation/receiving-ach-transfers). Alternatively, if you don't pass the `resolve_at` parameter the result will contain either a [Transaction](#transactions) or a [Declined Transaction](#declined-transactions) depending on whether or not the transfer is allowed.
### Example
```curl
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
  }'
```

### Body Parameters
- `account_number_id` (string, required)
  The identifier of the Account Number the inbound ACH Transfer is for.

- `addenda` (dictionary, optional)
  Additional information to include in the transfer.

  - `addenda.category` (enum, required)
    The type of addenda to simulate being sent with the transfer.
    Cases:
    * `freeform` (Unstructured `payment_related_information` passed through with the transfer.)

  - `addenda.freeform` (dictionary, optional)
    Unstructured `payment_related_information` passed through with the transfer.

      - `addenda.freeform.entries` (array of objects, required)
        Each entry represents an addendum sent with the transfer.

            - `addenda.freeform.entries.payment_related_information` (string, required)
              The payment related information passed in the addendum.

- `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, optional)
  The description of the date of the transfer.

- `company_discretionary_data` (string, optional)
  Data associated with the transfer set by the sender.

- `company_entry_description` (string, optional)
  The description of the transfer set by the sender.

- `company_id` (string, optional)
  The sender's company ID.

- `company_name` (string, optional)
  The name of the sender.

- `receiver_id_number` (string, optional)
  The ID of the receiver of the transfer.

- `receiver_name` (string, optional)
  The name of the receiver of the transfer.

- `resolve_at` (string, optional)
  The time at which the transfer should be resolved. If not provided will resolve immediately.

- `standard_entry_class_code` (enum, optional)
  The standard entry class code for the transfer.
  Cases:
  * `corporate_credit_or_debit` (Corporate Credit and Debit (CCD).)
  * `corporate_trade_exchange` (Corporate Trade Exchange (CTX).)
  * `prearranged_payments_and_deposit` (Prearranged Payments and Deposits (PPD).)
  * `internet_initiated` (Internet Initiated (WEB).)
  * `point_of_sale` (Point of Sale (POS).)
  * `telephone_initiated` (Telephone Initiated (TEL).)
  * `customer_initiated` (Customer Initiated (CIE).)
  * `accounts_receivable` (Accounts Receivable (ARC).)
  * `machine_transfer` (Machine Transfer (MTE).)
  * `shared_network_transaction` (Shared Network Transaction (SHR).)
  * `represented_check` (Represented Check (RCK).)
  * `back_office_conversion` (Back Office Conversion (BOC).)
  * `point_of_purchase` (Point of Purchase (POP).)
  * `check_truncation` (Check Truncation (TRC).)
  * `destroyed_check` (Destroyed Check (XCK).)
  * `international_ach_transaction` (International ACH Transaction (IAT).)