Create an account

post deprecated

https://sandbox.alloy.co/v1/accounts

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The body must contain either an external_account_id or account_number.

entities

array of objects

Array of objects wherein each object represents an entity linked to the account. Each entity must already have been created. (For PATCH /accounts calls, if entities is passed in, the account's entities will be replaced with the newly passed in entities. If no entities field is passed in, the entities will not change. If entities is an empty array, all entities will be removed from the account.)

entities

external_account_id

string

required

length ≤ 60

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

account_number

string

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

account_class

string

enum

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

Allowed:

account_name

string

Name of the account.

routing_number

string

Routing number associated with the account.

account_type

string | null

enum

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

Allowed:

is_linked_account

boolean | null

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

link_timestamp

date-time | null

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

unlink_timestamp

date-time | null

ISO 8601 date. Cannot be future-dated.

opening_date

date | null

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

country_code

string | null

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

account_snapshot

object

JSON object. Account snapshots are upserted according to their timestamp value. If a snapshot already exists for a given account and timestamp value, it will be updated; otherwise, a new account snapshot will be created.

product_code

string | null

Identifier of the product name.

product_name

string | null

Name of the product associated with the account.

product_number

string | null

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

maturity_date

date | null

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_date

date | null

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

cif_number

string | null

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

card_network

string | null

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

expiration_date

string | null

tokenization_method

string | null

method of tokenization used to anonymize account information.

merchant_category_code

string | null

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

name_on_card

string | null

ame on the card used in this transaction.

account_number_last4

string | null

Last four digits of account number

avs

string | null

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

currency

string | null

ISO-4217 currency code.

201Account has been created