API Reference — Increase

{
  "account_holder": "business",
  "account_number": "987654321",
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Landlord",
  "funding": "checking",
  "id": "external_account_ukk55lr923a3ac0pp7iv",
  "idempotency_key": null,
  "routing_number": "101050001",
  "status": "active",
  "type": "external_account"
}

Attributes

account_holder

enum

The type of entity that owns the External Account.

account_number

string

The destination account number.

created_at

string

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

description

string

The External Account's description for display purposes.

funding

enum

The type of the account to which the transfer will be sent.

string

The External Account'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.

routing_number

string

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

status

enum

The External Account's status.

type

string

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

List External Accounts

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

Filter External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

routing_number

string

Filter External Accounts to those with the specified Routing Number.

9 character maximum

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 External Account

curl -X "POST" \
  --url "${INCREASE_URL}/external_accounts" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_holder": "business",
    "account_number": "987654321",
    "description": "Landlord",
    "routing_number": "101050001"
  }'

Parameters

account_holder

enum

The type of entity that owns the External Account.

account_number

string

Required

The account number for the destination account.

17 character maximum

description

string

Required

The name you choose for the Account.

200 character maximum

funding

enum

The type of the destination account. Defaults to checking.

routing_number

string

Required

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

9 character maximum

Retrieve an External Account

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

Parameters

external_account_id

string

Required

The identifier of the External Account.

Update an External Account

curl -X "PATCH" \
  --url "${INCREASE_URL}/external_accounts/external_account_ukk55lr923a3ac0pp7iv" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "description": "New description"
  }'

Parameters

external_account_id

string

Required

The external account identifier.

account_holder

enum

The type of entity that owns the External Account.

description

string

The description you choose to give the external account.

200 character maximum

funding

enum

The funding type of the External Account.

status

enum

The status of the External Account.