Accounts

Update an account

Changed on Nov 3, 2026

<Callout type="warning" title="Deprecated Warning"> This endpoint is deprecated in favor of the Events API using an event of type "bank_account_updated". </Callout>

patch/accounts/{bank_account_token}

Request

Base URL
https://sandbox.alloy.co/v1
Auth
- OAuth 2
  Client credentials
  Token URL/oauth/bearer
- or HTTP basic
TypeScript
https://skmtc.dev/alloy/apis/alloy-api/docs/accounts/:bank_account_token/patch.ts
A function with typed inputs. Its response is checked against the schema.

Request body

bank_account_tokenstring

Alloy-generated unique identifier for the account

external_account_idstring

Unique identifier associated with the account. At least one of external_account_id or account_number must be provided.

account_numberstring

Bank account number. At least one of account_number or external_account_id must be provided.

account_class'deposit' | 'credit' | 'brokerage'

Allowed values are ("deposit", "credit", "brokerage").

account_namestring

Name of the account.

routing_numberstring

Routing number associated with the account.

account_type'merchant account' | 'person' nullable

Allowed values are ("merchant account", "person", null).

is_linked_accountboolean nullable

Determines whether the account is a funding source or linked account.

link_timestampstring date-time nullable

ISO 8601 date. Required when is_linked_account is true. Cannot be future-dated.

unlink_timestampstring date-time nullable

ISO 8601 date. Cannot be future-dated.

opening_datestring date nullable

UTC/ISO dates both accepted. Strings are converted to ISO timestamps. Date the account was opened.

country_codestring nullable

2-character ISO Code (mainly used for merchant accounts).

product_codestring nullable

Identifier of the product name.

product_namestring nullable

Name of the product associated with the account.

product_numberstring nullable

Product number that corresponds to the product_name associated with the account.

maturity_datestring date nullable

UTC/ISO dates are both accepted. Strings are converted to ISO timestamps. Date on which the final payment is due on a loan or other financial instrument, such as a bond or term deposit, at which point the principal is due to be paid.

closing_datestring date nullable

UTC/ISO dates both accepted. Strings are converted to ISO timestamps. Date the account was closed.

cif_numberstring nullable

Unique identifier used by bank cores to refer to a customer.

card_networkstring nullable

Card network of the card that was used in this transaction.

expiration_datestring nullable

tokenization_methodstring nullable

method of tokenization used to anonymize account information.

merchant_category_codestring nullable

The merchant category code (MCC) is used to classify a business by the purposes it serves or the products it sells.

name_on_cardstring nullable

Name on the card used in this transaction.

account_number_last4string nullable

Last four digits of account number

avsstring nullable

Verifies the numeric portions of the address against the billing address.

currencystring nullable

ISO-4217 currency code.

metaobject nullable

JSON object with any meta information related to the account

Example request

{
  "external_account_id": "test-account-001",
  "account_class": "deposit",
  "entities": [
    {
      "external_entity_id": "entity-01",
      "account_holder_type": "primary"
    }
  ],
  "account_snapshot": {
    "timestamp": "2022-03-21T21:50:07.623Z",
    "details": {
      "status": "Active"
    }
  }
}

Response

Account has been updated