v4

OpenAPI 3.1.02026-08-012402353.8 MB

Create an ACH Prenotification

post/ach_prenotifications

Request body

account_idstring required

The Increase identifier for the account that will send the ACH Prenotification.

account_numberstring required

The account number for the destination account.

addendumstring

Additional information that will be sent to the recipient.

company_descriptive_datestring

The description of the date of the ACH Prenotification.

company_discretionary_datastring

The data you choose to associate with the ACH Prenotification.

company_entry_descriptionstring

The description you wish to be shown to the recipient.

company_namestring

The name by which the recipient knows you.

credit_debit_indicator'credit' | 'debit'

Whether the Prenotification is for a future debit or credit.

effective_datestring date

The ACH Prenotification effective date in ISO 8601 format.

individual_idstring

Your identifier for the recipient.

individual_namestring

The name of the recipient. This value is informational and not verified by the recipient's bank.

routing_numberstring required

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

standard_entry_class_code'corporate_credit_or_debit' | 'corporate_trade_exchange' | 'prearranged_payments_and_deposit' | 'internet_initiated'

The Standard Entry Class (SEC) code to use for the ACH Prenotification.

Example request

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "routing_number": "101050001"
}

Response

ACH Prenotification

account_idstring nullable required

The account that sent the ACH Prenotification.

account_numberstring required

The destination account number.

addendumstring nullable required

Additional information for the recipient.

company_descriptive_datestring nullable required

The description of the date of the notification.

company_discretionary_datastring nullable required

Optional data associated with the notification.

company_entry_descriptionstring nullable required

The description of the notification.

company_namestring nullable required

The name by which you know the company.

created_atstring date-time required

The ISO 8601 date and time at which the prenotification was created.

credit_debit_indicator'credit' | 'debit' nullable required

If the notification is for a future credit or debit.

effective_datestring date-time nullable required

The effective date in ISO 8601 format.

idstring required

The ACH Prenotification's identifier.

idempotency_keystring nullable required

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.

individual_idstring nullable required

Your identifier for the recipient.

individual_namestring nullable required

The name of the recipient. This value is informational and not verified by the recipient's bank.

routing_numberstring required

The American Bankers' Association (ABA) Routing Transit Number (RTN).

standard_entry_class_code'corporate_credit_or_debit' | 'corporate_trade_exchange' | 'prearranged_payments_and_deposit' | 'internet_initiated' nullable required

The Standard Entry Class (SEC) code to use for the ACH Prenotification.

status'pending_submitting' | 'returned' | 'submitted' | 'requires_attention' required

The lifecycle status of the ACH Prenotification.

type'ach_prenotification' required

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

Example response

{
  "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"
}