# ACH Prenotifications

ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).

## Events

Your application can listen to [webhooks](/content/documentation/api/events/index.html) about this resource. The events about ACH Prenotifications will have the categories "ach_prenotification.created" or "ach_prenotification.updated".

## The ACH Prenotification object

```json
{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "addendum": null,
  "company_descriptive_date": null,
  "company_discretionary_data": null,
  "company_entry_description": "Account Funding",
  "company_name": "National Phonograph Company",
  "created_at": "2020-01-31T23:59:59Z",
  "credit_debit_indicator": "credit",
  "effective_date": "2020-01-31T23:59:59Z",
  "id": "ach_prenotification_ubjf9qqsxl3obbcn1u34",
  "idempotency_key": null,
  "individual_id": null,
  "individual_name": "Ian Crease",
  "notifications_of_change": [],
  "prenotification_return": null,
  "routing_number": "101050001",
  "standard_entry_class_code": "corporate_credit_or_debit",
  "status": "submitted",
  "type": "ach_prenotification"
}
```

### Attributes
- **account_id** (string, Nullable): The account that sent the ACH Prenotification. More about [Accounts](/content/documentation/api/accounts/index.html).

- **account_number** (string): The destination account number.

- **addendum** (string, Nullable): Additional information for the recipient.

- **company_descriptive_date** (string, Nullable): The description of the date of the notification.

- **company_discretionary_data** (string, Nullable): Optional data associated with the notification.

- **company_entry_description** (string, Nullable): The description of the notification.

- **company_name** (string, Nullable): The name by which you know the company.

- **created_at** (string): The ISO 8601 date and time at which the prenotification was created.

- **credit_debit_indicator** (enum, Nullable): If the notification is for a future credit or debit. Possible values: `credit`, `debit`.

- **effective_date** (string, Nullable): The effective date in ISO 8601 format.

- **id** (string): The ACH Prenotification’s identifier.

- **idempotency_key** (string, Nullable): The idempotency key you chose for this object.

- **individual_id** (string, Nullable): Your identifier for the recipient.

- **individual_name** (string, Nullable): The name of the recipient.

- **notifications_of_change** (array): If the receiving bank notifies that future transfers should use different details, this will contain those details.

- **prenotification_return** (dictionary, Nullable): If your prenotification is returned, this will contain details of the return.

- **routing_number** (string): The American Bankers’ Association (ABA) Routing Transit Number (RTN).

- **standard_entry_class_code** (enum, Nullable): The Standard Entry Class (SEC) code to use for the ACH Prenotification. Possible values: [list of values]

- **status** (enum): The lifecycle status of the ACH Prenotification. Possible values: [list of values]

- **type** (string): A constant representing the object’s type. For this resource, it will always be `ach_prenotification`.

## List ACH Prenotifications

```bash
curl \
  --url "${INCREASE_URL}/ach_prenotifications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

### cURL Example
```bash
{
  "data": [
    { /* ACH Prenotification object */ },
    { /* ACH Prenotification object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d"
}
```

### Create an ACH Prenotification

```bash
curl -X "POST" \
  --url "${INCREASE_URL}/ach_prenotifications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{"account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "routing_number": "101050001"}'
```

### Parameters
- **account_id** (string, Required): The Increase identifier for the account that will send the ACH Prenotification.

- **account_number** (string, Required): The account number for the destination account.

- **routing_number** (string, Required): The ABA Routing Transit Number (RTN) for the destination account.

- **addendum** (string): Additional information that will be sent to the recipient.

- **company_descriptive_date** (string)

- **company_discretionary_data** (string)

- **company_entry_description** (string)

- **company_name** (string)

- **credit_debit_indicator** (enum): Whether the Prenotification is for a future debit or credit. Defaults to `debit`.

- **effective_date** (string)

- **individual_id** (string)

- **individual_name** (string)

- **standard_entry_class_code** (enum)

## Retrieve an ACH Prenotification

```bash
curl \
  --url "${INCREASE_URL}/ach_prenotifications/ach_prenotification_ubjf9qqsxl3obbcn1u34" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

## Parameters
- **ach_prenotification_id** (string, Required): The identifier of the ACH Prenotification to retrieve.