API Reference — Increase

{
  "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,
  "notifications_of_change": [],
  "prenotification_return": null,
  "routing_number": "101050001",
  "status": "submitted",
  "type": "ach_prenotification"
}

Attributes

account_number

string

The destination account number.

addendum

string

Nullable

Additional information for the recipient.

company_descriptive_date

string

Nullable

The description of the date of the notification.

company_discretionary_data

string

Nullable

Optional data associated with the notification.

company_entry_description

string

Nullable

The description of the notification.

company_name

string

Nullable

The name by which you know the company.

created_at

string

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

credit_debit_indicator

enum

Nullable

If the notification is for a future credit or debit.

effective_date

string

Nullable

The effective date in ISO 8601 format.

string

The ACH Prenotification's identifier.

idempotency_key

string

Nullable

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.

notifications_of_change

array

If the receiving bank notifies that future transfers should use different details, this will contain those details.

prenotification_return

dictionary

Nullable

If your prenotification is returned, this will contain details of the return.

routing_number

string

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

status

enum

The lifecycle status of the ACH Prenotification.

type

string

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

List ACH Prenotifications

curl \
  --url "${INCREASE_URL}/ach_prenotifications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

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

idempotency_key

string

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.

200 character maximum

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

Create an ACH Prenotification

curl -X "POST" \
  --url "${INCREASE_URL}/ach_prenotifications" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "account_number": "987654321",
    "routing_number": "101050001"
  }'

Parameters

account_id

string

Required

The Increase identifier for the account that will send the transfer.

account_number

string

Required

The account number for the destination account.

200 character maximum

addendum

string

Additional information that will be sent to the recipient.

80 character maximum

company_descriptive_date

string

The description of the date of the transfer.

6 character maximum

company_discretionary_data

string

The data you choose to associate with the transfer.

20 character maximum

company_entry_description

string

The description of the transfer you wish to be shown to the recipient.

10 character maximum

company_name

string

The name by which the recipient knows you.

16 character maximum

credit_debit_indicator

enum

Whether the Prenotification is for a future debit or credit.

effective_date

string

The transfer effective date in ISO 8601 format.

individual_id

string

Your identifier for the transfer recipient.

22 character maximum

individual_name

string

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

22 character maximum

routing_number

string

Required

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

9 character maximum

standard_entry_class_code

enum

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

Retrieve an ACH Prenotification

curl \
  --url "${INCREASE_URL}/ach_prenotifications/ach_prenotification_ubjf9qqsxl3obbcn1u34" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

ach_prenotification_id

string

Required

The identifier of the ACH Prenotification to retrieve.