Skip to main content
POST

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
type
enum<string>
required

Type of collection account to create.

Available options:
virtual_account,
wallet
payment_method_type
string
required

Type of payment method for the collection account, for example local_bank_transfer_cad, wire_transfer or stablecoin_usdt. The set of accepted values depends on the capabilities available to you — call the virtual account or wallet metadata endpoint to discover them, or see the payment method type reference.

description
string

Usecase description for opening this account.

on_behalf_of
string

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

country
string

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

currencies
string[]

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

wallet
object

Wallet-specific details. Required when type is wallet.

alias
string

Nickname for the account.

metadata
object

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

Response

Collection account created successfully.

status
string
message
string
data
object

Represents a collection account (virtual account or stablecoin wallet).