v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

List ACH Prenotifications

get/ach_prenotifications

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

ACH Prenotification List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}