increase-test
POST/accounts

Create an Account

Creates an Account for an Entity. Supply name and configure optional ownership, funding, Program, and loan details as needed; funding must be loan or deposits.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Account creation details. name is required; all other fields are optional.

entity_idstringoptional
The identifier for the Entity that will own the Account.
fundingstringoptional
Whether the Account is funded by a loan or by deposits.
Allowed:loandeposits
informational_entity_idstringoptional
The identifier of an Entity that, while not owning the Account, is associated with its activity. This is generally the beneficiary of the funds.
loanobjectoptional
The loan details for the account.
namestringrequired
The name you choose for the Account.
program_idstringoptional
The identifier for the Program that this Account falls under. Required if your Group operates more than one Program. List your [Programs](#programs) to find their identifiers.

3 status codes
200Returns the created Account object, including its identifier, name, ownership, funding type, Program, and status.
account_revenue_ratestringrequired
The account revenue rate currently being earned on the account, as a string containing a decimal number. For example, a 1% account revenue rate would be represented as "0.01". Account revenue is a type of non-interest income accrued on the account.
bankstringrequired
The bank the Account is with.
Allowed:core_bankfirst_internet_bankgrasshopper_bankincrease_bank
closed_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was closed.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was created.
currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency.
Allowed:USD
entity_idstringrequired
The identifier for the Entity the Account belongs to.
fundingstringrequired
Whether the Account is funded by a loan or by deposits.
Allowed:loandeposits
idstringrequired
The Account identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
informational_entity_idstringrequired
The identifier of an Entity that, while not owning the Account, is associated with its activity.
interest_ratestringrequired
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".
loanobjectrequired
The Account's loan-related information, if the Account is a loan account.
namestringrequired
The name you choose for the Account.
program_idstringrequired
The identifier of the Program determining the compliance and commercial terms of this Account.
statusstringrequired
The status of the Account.
Allowed:closedopen
typestringrequired
A constant representing the object's type. For this resource it will always be `account`.
Allowed:account
4XXReturned when the request encounters a client-side error.
5XXReturned when the request encounters a server-side error.

Error handling

name is required and must contain 1 to 200 characters. funding must be loan or deposits; if you provide loan, credit_limit is required and must be at least 0, and statement_day_of_month must be between 1 and 28. statement_payment_type must be balance or interest_until_maturity, and maturity_date must use the ISO 8601 date format.