Sign in

v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-012382333.4 MB

Retrieve an ACH Prenotification

get/ach_prenotifications/{ach_prenotification_id}

Path parameters

ach_prenotification_idstring required

The identifier of the ACH Prenotification to retrieve.

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' | 'requires_attention' | 'returned' | 'submitted' 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": null,
  "account_number": "987654321",
  "addendum": null,
  "company_descriptive_date": null,
  "company_discretionary_data": null,
  "company_entry_description": null,
  "company_name": null,
  "created_at": "2020-01-31T23:59:59Z",
  "credit_debit_indicator": null,
  "effective_date": null,
  "id": "ach_prenotification_ubjf9qqsxl3obbcn1u34",
  "idempotency_key": null,
  "individual_id": null,
  "individual_name": null,
  "notifications_of_change": [],
  "prenotification_return": null,
  "routing_number": "101050001",
  "standard_entry_class_code": null,
  "status": "submitted",
  "type": "ach_prenotification"
}