increase-test
PATCH/accounts/{account_id}

Update an Account

Updates an Account's name or loan credit limit. Supply only the fields you want to change; if you include loan, provide its required credit_limit.

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

1 parameter · 2 body fields
account_idstringrequired
The identifier of the Account to update.

Account fields to update. Both fields are optional; if you provide loan, its credit_limit is required.

loanobjectoptional
The loan details for the account.
namestringoptional
The new name of the Account.

3 status codes
200Returns the updated Account object, including its current name, loan details, and other Account properties.
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

The account_id path parameter must identify an existing Account. name, when supplied, must contain 1 to 200 characters; if you supply loan, it must include credit_limit, which must be at least 0.