Skip to main content
POST
/
v3
/
collection_account
curl --request POST \
  --url https://service-sandbox.tazapay.com/v3/collection_account \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "virtual_account",
  "payment_method_type": "local_bank_transfer_cad",
  "country": "CA",
  "currencies": [
    "CAD"
  ],
  "description": "This account is used for CAD collections",
  "alias": "CAD Collection Account"
}
'
{
  "id": "cva_crqinja9chqqs7moi8rg",
  "object": "collection_account",
  "type": "virtual_account",
  "payment_method_type": "local_bank_transfer_cad",
  "country": "CA",
  "currencies": [
    "CAD"
  ],
  "status": "disabled",
  "alias": "CAD Collection Account",
  "description": "This account is used for CAD collections",
  "virtual_account": {
    "account_holder_name": "John Doe",
    "account_number": "1234567890-56-7890",
    "iban": "",
    "bank_name": "RBC Royal Bank",
    "bank_branch": "Main Branch",
    "bank_address": {
      "address_line_1": "100 Main St",
      "city": "Toronto",
      "country": "Canada"
    },
    "bank_codes": {
      "routing_code": "026009593",
      "swift_code": "ROYCCAT2"
    },
    "account_reenablement_supported": true
  },
  "requests": [
    {
      "id": "req_cva001enablement",
      "object": "collection_account_request",
      "collection_account_id": "cva_crqinja9chqqs7moi8rg",
      "type": "enablement",
      "status": "processing",
      "requested_currencies": [
        "CAD"
      ],
      "created_at": "2024-09-26T09:39:25.03501Z",
      "updated_at": "2024-09-26T09:39:25.03501Z",
      "status_description": "Activation in progress."
    }
  ],
  "status_description": "",
  "metadata": {},
  "created_at": "2024-09-26T09:39:25.03501Z",
  "updated_at": "2024-09-26T09:39:25.03501Z"
}

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
enum<string>
required

Type of payment method for the collection account.

Available options:
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
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

200 - application/json

Collection account created successfully.

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

id
string

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

object
string

Always "collection_account".

type
enum<string>

Type of collection account.

Available options:
virtual_account,
wallet
description
string

Usecase description for this account.

on_behalf_of
string

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

country
string

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

currencies
string[]

List of currencies enabled for this account.

payment_method_type
string

Type of payment method for this account.

virtual_account
object

Virtual account bank details. Present when type is virtual_account.

wallet
object

Wallet details. Present when type is wallet.

status
enum<string>

Current status of the collection account.

Available options:
disabled,
enabled
requests
object[]

Enablement, disablement, or reenablement requests attached to this account.

status_description
string

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

alias
string

Nickname for the account.

balance_transaction
string

ID of the balance transaction linked to this collection account.

metadata
object

Key-value pairs attached to the collection account.

created_at
string<date-time>

Timestamp when the account was created.

updated_at
string<date-time>

Timestamp when the account was last updated.