Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Update an Account

patch/accounts/{account_id}

Path parameters

account_idstring required

The identifier of the Account to update.

Request body

namestring

The new name of the Account.

Example request

{
  "name": "My renamed account"
}

Response

Account

account_revenue_ratestring nullable required

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.

bank'core_bank' | 'first_internet_bank' | 'grasshopper_bank' | 'increase_bank' required

The bank the Account is with.

closed_atstring date-time nullable required

The ISO 8601 time at which the Account was closed.

created_atstring date-time required

The ISO 8601 time at which the Account was created.

currency'USD' required

The ISO 4217 code for the Account currency.

entity_idstring required

The identifier for the Entity the Account belongs to.

funding'loan' | 'deposits' required

Whether the Account is funded by a loan or by deposits.

idstring required

The Account identifier.

idempotency_keystring nullable required

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_idstring nullable required

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

interest_ratestring required

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".

namestring required

The name you choose for the Account.

program_idstring required

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

status'closed' | 'open' required

The status of the Account.

type'account' required

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

Example response

{
  "account_revenue_rate": null,
  "bank": "first_internet_bank",
  "closed_at": null,
  "created_at": "2020-01-31T23:59:59Z",
  "currency": "USD",
  "entity_id": "entity_n8y8tnk2p9339ti393yi",
  "funding": "deposits",
  "id": "account_in71c4amph0vgo2qllky",
  "idempotency_key": null,
  "informational_entity_id": null,
  "interest_rate": "0.055",
  "loan": null,
  "name": "My first account!",
  "program_id": "program_i2v2os4mwza1oetokh9i",
  "status": "open",
  "type": "account"
}