increase-test
POST/ach_prenotifications

Create an ACH Prenotification

Creates an ACH Prenotification to verify destination account and routing numbers through ACH. Supply account_id, account_number, and routing_number; optional fields let you set recipient and company details and configure the prenotification type.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

13 body fields

ACH Prenotification details. account_id, account_number, and routing_number are required.

account_idstringrequired
The Increase identifier for the account that will send the ACH Prenotification.
account_numberstringrequired
The account number for the destination account.
addendumstringoptional
Additional information that will be sent to the recipient.
company_descriptive_datestringoptional
The description of the date of the ACH Prenotification.
company_discretionary_datastringoptional
The data you choose to associate with the ACH Prenotification.
company_entry_descriptionstringoptional
The description you wish to be shown to the recipient.
company_namestringoptional
The name by which the recipient knows you.
credit_debit_indicatorstringoptional
Whether the Prenotification is for a future debit or credit.
Allowed:creditdebitDefault:debit
effective_datestringoptional
The ACH Prenotification effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
individual_idstringoptional
Your identifier for the recipient.
individual_namestringoptional
The name of the recipient. This value is informational and not verified by the recipient's bank.
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
standard_entry_class_codestringoptional
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_initiatedDefault:corporate_credit_or_debit

3 status codes
200Returns the created ACH Prenotification object, including its identifier, destination account details, effective date, and creation time.
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 encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

account_id, account_number, and routing_number are required. account_number must contain 1 to 200 alphanumeric characters, and routing_number must be exactly 9 digits. credit_debit_indicator must be credit or debit, and standard_entry_class_code must be one of the four accepted values.