Accounts

Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.

The Account object
{ "bank": "first_internet_bank", "closed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "id": "account_in71c4amph0vgo2qllky", "idempotency_key": null, "informational_entity_id": null, "interest_accrued": "0.01", "interest_accrued_at": "2020-01-31", "interest_rate": "0.055", "name": "My first account!", "program_id": "program_i2v2os4mwza1oetokh9i", "status": "open", "type": "account" }
Attributes
bank
enum

The bank the Account is with.

closed_at
string
Nullable

The ISO 8601 time at which the Account was closed.

created_at
string

The ISO 8601 time at which the Account was created.

currency
enum

The ISO 4217 code for the Account currency.

entity_id
string
Nullable

The identifier for the Entity the Account belongs to.

id
string

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

informational_entity_id
string
Nullable

The identifier of an Entity that, while not owning the Account, is associated with its activity.

interest_accrued
string

The interest accrued but not yet paid, expressed as a string containing a floating-point value.

interest_accrued_at
string
Nullable

The latest ISO 8601 date on which interest was accrued.

interest_rate
string

The Interest Rate currently being earned on the account, as a string containing a decimal number. For example, a 1% interest rate would be represented as "0.01".

name
string

The name you choose for the Account.

program_id
string

The identifier of the Program determining the compliance and commercial terms of this Account.

status
enum

The status of the Account.

type
string

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

List Accounts
curl \ --url "${INCREASE_URL}/accounts?entity_id=entity_n8y8tnk2p9339ti393yi" \ -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.

entity_id
string

Filter Accounts for those belonging to the specified Entity.

informational_entity_id
string

Filter Accounts for those belonging to the specified Entity as informational.

program_id
string

Filter Accounts for those in a specific Program.

status.in
array of strings

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

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
curl -X "POST" \ --url "${INCREASE_URL}/accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "entity_id": "entity_n8y8tnk2p9339ti393yi", "name": "New Account!", "program_id": "program_i2v2os4mwza1oetokh9i" }'
Parameters
entity_id
string

The identifier for the Entity that will own the Account.

informational_entity_id
string

The identifier of an Entity that, while not owning the Account, is associated with its activity. Its relationship to your group must be informational.

name
string
Required

The name you choose for the Account.

200 character maximum
program_id
string

The identifier for the Program that this Account falls under. Required if you operate more than one Program.

Retrieve an Account
curl \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_id
string
Required

The identifier of the Account to retrieve.

Update an Account
curl -X "PATCH" \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "name": "My renamed account" }'
Parameters
account_id
string
Required

The identifier of the Account to update.

credit_limit
integer

The new credit limit of the Account, if and only if the Account is a loan account.

name
string

The new name of the Account.

200 character maximum
Retrieve an Account Balance

Retrieve the current and available balances for an account in minor units of the account's currency. Learn more about account balances.

curl \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/balance" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a Balance Lookup object:
{ "account_id": "account_in71c4amph0vgo2qllky", "available_balance": 100, "current_balance": 100, "type": "balance_lookup" }
Parameters
account_id
string
Required

The identifier of the Account to retrieve.

at_time
string

The moment to query the balance at. If not set, returns the current balances.

Close an Account
curl -X "POST" \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/close" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_id
string
Required

The identifier of the Account to close. The account must have a zero balance.

Sandbox: Create an interest payment

Simulates an interest payment to your account. In production, this happens automatically on the first of each month.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/interest_payments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000 }'
Returns a Transaction object:
{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "inbound_ach_transfer", "inbound_ach_transfer": { "addenda": null, "amount": 100, "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" } }, "type": "transaction" }
Parameters
account_id
string
Required

The identifier of the Account the Interest Payment should be paid to is for.

accrued_on_account_id
string

The identifier of the Account the Interest accrued on. Defaults to account_id.

amount
integer
Required

The interest amount in cents. Must be positive.

period_end
string

The end of the interest period. If not provided, defaults to the current time.

period_start
string

The start of the interest period. If not provided, defaults to the current time.