API Reference — Increase

Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.

The Account Number object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "account_number_v18nkfqm6afpsrvy82b2",
  "idempotency_key": null,
  "inbound_ach": {
    "debit_status": "blocked"
  },
  "inbound_checks": {
    "status": "check_transfers_only"
  },
  "name": "ACH",
  "routing_number": "101050001",
  "status": "active",
  "type": "account_number"
}

Attributes

account_id

string

The identifier for the account this Account Number belongs to.

account_number

string

The account number.

created_at

string

The ISO 8601 time at which the Account Number was created.

string

The Account Number 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.

inbound_ach

dictionary

Properties related to how this Account Number handles inbound ACH transfers.

inbound_checks

dictionary

Properties related to how this Account Number should handle inbound check withdrawals.

name

string

The name you choose for the Account Number.

routing_number

string

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

status

enum

This indicates if payments can be made to the Account Number.

type

string

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

List Account Numbers

curl \
  --url "${INCREASE_URL}/account_numbers" \
  -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.

status.in

array of strings

The status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

ach_debit_status.in

array of strings

The ACH Debit status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

account_id

string

Filter Account Numbers to those belonging to the specified Account.

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.

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

Create an Account Number

curl -X "POST" \
  --url "${INCREASE_URL}/account_numbers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "name": "Rent payments"
  }'

Parameters

account_id

string

Required

The Account the Account Number should belong to.

inbound_ach

dictionary

Options related to how this Account Number should handle inbound ACH transfers.

inbound_checks

dictionary

Options related to how this Account Number should handle inbound check withdrawals.

name

string

Required

The name you choose for the Account Number.

200 character maximum

Retrieve an Account Number

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

Parameters

account_number_id

string

Required

The identifier of the Account Number to retrieve.

Update an Account Number

curl -X "PATCH" \
  --url "${INCREASE_URL}/account_numbers/account_number_v18nkfqm6afpsrvy82b2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "inbound_ach": {
      "debit_status": "blocked"
    },
    "status": "disabled"
  }'

Parameters

account_number_id

string

Required

The identifier of the Account Number.

inbound_ach

dictionary

Options related to how this Account Number handles inbound ACH transfers.

inbound_checks

dictionary

Options related to how this Account Number should handle inbound check withdrawals.

name

string

The name you choose for the Account Number.

200 character maximum

status

enum

This indicates if transfers can be made to the Account Number.