Sign in

v1

latestOpenAPI 3.1.02026-07-266133267.6 KB

Create Collection Account

Create a new virtual account or stablecoin wallet for collecting funds.

post/v3/collection_account

Request body

type'virtual_account' | 'wallet' required

Type of collection account to create.

descriptionstring

Usecase description for opening this account.

on_behalf_ofstring

ID of the entity in case the collection account is being configured on behalf of an entity.

countrystring

Country in which the account is opened (ISO 3166 alpha-2). Mandatory for virtual accounts.

currenciesstring[]

Currencies to enable for the account, in ISO format. Mandatory for virtual accounts.

payment_method_type'wire_transfer' | 'local_bank_transfer_cad' | 'local_bank_transfer_sgd' | 'local_bank_transfer_krw' | 'local_bank_transfer_dkk' | 'local_bank_transfer_ngn' | 'local_bank_transfer_vnd' | 'local_bank_transfer_gbp' | 'local_bank_transfer_eur' | 'local_bank_transfer_usd' | 'local_bank_transfer_php' | 'local_bank_transfer_idr' | 'local_bank_transfer_aud' | 'stablecoin_usdt' | 'stablecoin_usdc' required

Type of payment method for the collection account.

aliasstring

Nickname for the account.

metadataobject

Set of key-value pairs to attach to the collection account object.

Response

Collection account created successfully.

idstring

Unique identifier. Starts with cva_ (virtual account), cwa_ (wallet), or cta_.

objectstring

Always "collection_account".

type'virtual_account' | 'wallet'

Type of collection account.

descriptionstring

Usecase description for this account.

on_behalf_ofstring

ID of the entity this account is configured on behalf of.

countrystring

Country in which the account is opened (ISO 3166 alpha-2).

currenciesstring[]

List of currencies enabled for this account.

payment_method_typestring

Type of payment method for this account.

status'disabled' | 'enabled'

Current status of the collection account.

status_descriptionstring

Description of the current status (e.g. disablement reason).

aliasstring

Nickname for the account.

balance_transactionstring

ID of the balance transaction linked to this collection account.

metadataobject

Key-value pairs attached to the collection account.

created_atstring date-time

Timestamp when the account was created.

updated_atstring date-time

Timestamp when the account was last updated.