increase-test
PATCH/external_accounts/{external_account_id}

Update an external account

Updates the description, account holder type, funding type, or status of a stored external account. Supply only the fields you want to change; the account number and routing number are not updated by this operation.

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

1 parameter · 4 body fields
external_account_idstringrequired
The identifier of the external account to update.

Fields to change on the external account; all fields are optional.

account_holderstringoptional
The type of entity that owns the External Account.
Allowed:businessindividual
descriptionstringoptional
The description you choose to give the external account.
fundingstringoptional
The funding type of the External Account.
Allowed:checkingsavingsgeneral_ledgerother
statusstringoptional
The status of the External Account.
Allowed:activearchived

3 status codes
200Returns the updated external account object, including its identifier, description, routing and account numbers, funding type, and status.
account_holderstringrequired
The type of entity that owns the External Account.
Allowed:businessindividualunknown
account_numberstringrequired
The destination account number.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External Account was created.
descriptionstringrequired
The External Account's description for display purposes.
fundingstringrequired
The type of the account to which the transfer will be sent.
Allowed:checkingsavingsgeneral_ledgerother
idstringrequired
The External Account's 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).
routing_numberstringrequired
The American Bankers' Association (ABA) Routing Transit Number (RTN).
statusstringrequired
The External Account's status.
Allowed:activearchived
typestringrequired
A constant representing the object's type. For this resource it will always be `external_account`.
Allowed:external_account
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the service encounters a server-side error.

Error handling

The external_account_id path parameter must identify an external account. account_holder must be business or individual, funding must be checking, savings, general_ledger, or other, and status must be active or archived. description, if provided, must be 1 to 200 characters.