increase-test
GET/ach_prenotifications/{ach_prenotification_id}

Retrieve an ACH prenotification

Retrieves an ACH prenotification by its identifier. Use the ach_prenotification_id path parameter to select the prenotification whose account and routing details you want to verify.

1 parameter
ach_prenotification_idstringrequired
The identifier of the ACH prenotification to retrieve.

3 status codes
200Returns the ACH prenotification, including its account details, creation time, and any notifications of change.
account_idstringrequired
The account that sent the ACH Prenotification.
account_numberstringrequired
The destination account number.
addendumstringrequired
Additional information for the recipient.
company_descriptive_datestringrequired
The description of the date of the notification.
company_discretionary_datastringrequired
Optional data associated with the notification.
company_entry_descriptionstringrequired
The description of the notification.
company_namestringrequired
The name by which you know the company.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the prenotification was created.
credit_debit_indicatorstringrequired
If the notification is for a future credit or debit.
Allowed:creditdebit
effective_datestringrequired
The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
idstringrequired
The ACH Prenotification's identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
individual_idstringrequired
Your identifier for the recipient.
individual_namestringrequired
The name of the recipient. This value is informational and not verified by the recipient's bank.
notifications_of_changearray<ACHPrenotificationACHNotificationOfChange>required
If the receiving bank notifies that future transfers should use different details, this will contain those details.
prenotification_returnobjectrequired
If your prenotification is returned, this will contain details of the return.
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN).
standard_entry_class_codestringrequired
The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the ACH Prenotification.
Allowed:corporate_credit_or_debitcorporate_trade_exchangeprearranged_payments_and_depositinternet_initiated
statusstringrequired
The lifecycle status of the ACH Prenotification.
Allowed:pending_submittingreturnedsubmittedrequires_attention
typestringrequired
A constant representing the object's type. For this resource it will always be `ach_prenotification`.
Allowed:ach_prenotification
4XXReturned when the request results in a client error.
5XXReturned when the request results in a server error.

Error handling

The ach_prenotification_id path parameter must identify an existing ACH prenotification.