Object Structure
Virtual account
{
"id": "cva_crqinja9chqqs7moi8rg",
"object": "virtual_account",
"type": "virtual_account",
"status": "enabled",
"status_description": "",
"payment_method_type": "local_bank_transfer_cad",
"country": "CA",
"ftn": [
{
"name": "eft",
"transfer_limit": {
"currency": "CAD",
"min_limit": 1,
"max_limit": 2500000
},
"additional_information": ""
}
],
"currencies": [
"CAD"
],
"alias": "CAD Collection Account",
"description": "This account is used for CAD collections",
"on_behalf_of": "ent_d72h4h5hq6qriqd392e0",
"is_reenablement_supported": true,
"is_temporarily_disabled": false,
"virtual_account": {
"account_holder_name": "John Doe",
"account_number": "1234567890-56-7890",
"iban": "",
"bank_name": "Bank of America",
"bank_branch": "Downtown Branch",
"bank_address": {
"address_line_1": "123 Main Street",
"address_line_2": "Suite 500",
"city": "Toronto",
"state": "ON",
"country": "United States of America",
"postal_code": "M5H 2N2"
},
"bank_codes": {
"ach_routing_number": "021000021",
"bank_code": "001",
"bsb_code": "033-001",
"fedwire_routing_number": "021000021",
"routing_code": "021000021",
"sort_code": "12-34-56",
"swift_code": "BOFAUS3N"
}
},
"fee_details": {
"one_time_setup_fee": 5000,
"maintenance_fee": 2000,
"maintenance_fee_frequency": "yearly"
},
"balance_transaction": "btr_d1jp5v0f3uhv3dumbkhg",
"metadata": {},
"created_at": "2025-06-17 10:39:25.03501 +0000 UTC",
"updated_at": "2025-06-17 10:41:43.349835 +0000 UTC"
}
Wallet
{
"id": "cwa_crltnagotd3175aonav0",
"object": "wallet",
"type": "wallet",
"status": "enabled",
"status_description": "",
"payment_method_type": "stablecoin_usdt",
"currencies": [
"USD"
],
"alias": "USDT Wallet",
"description": "USDT Ethereum wallet for collections",
"is_reenablement_supported": false,
"is_temporarily_disabled": false,
"wallet": {
"type": "Ethereum",
"deposit_address": "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B",
},
"metadata": {},
"created_at": "2024-09-19 08:07:06.576777 +0000 UTC",
"updated_at": "2024-09-19 08:07:06.576777 +0000 UTC"
}
Object Parameters
collection_account
| Parameter | Type | Description |
|---|---|---|
| id | string | Unique identifier (ID) associated with the collection_account. 24 characters, prefixed cva_ (virtual account), cwa_ (wallet) or cta_ (Tazapay account) |
| object | enum | virtual_account, wallet or tazapay_account. Mirrors type |
| type | enum | Type of collection account: virtual_account, wallet or tazapay_account |
| status | enum | Current status of the collection account — enabled or disabled. A newly created account is always disabled until its enablement request reaches succeeded |
| status_description | string | Description of the current status, for example the disablement reason |
| payment_method_type | enum | Payment Method Type used for the account. Refer List |
| country | string | Country in which the account is opened. Empty for wallets |
| ftn | array of object | Fund transfer networks supported by this account’s country and provider. Please check ftn. Present for virtual accounts on a local rail; absent for swift virtual accounts, wallets, and Tazapay accounts |
| currencies | array of string | List of supported currencies the collection account can receive funds in (ISO 4217) |
| alias | string | Nickname you gave the account |
| description | string | Usecase description for this account |
| on_behalf_of | string | ID of the entity this account is configured on behalf of, prefixed ent_. Empty for direct accounts |
| is_reenablement_supported | boolean | Whether the account can be re-enabled after being disabled |
| is_temporarily_disabled | boolean | Whether the account is temporarily disabled and cannot currently receive funds |
| virtual_account/wallet/tazapay_account | object | Consists of all the bank account/wallet/deposit-address details. Please check virtual_account, wallet, tazapay_account |
| requests | array of object | Enablement, disablement and re-enablement requests attached to this account. Returned on the retrieve and list responses only — not on the update response |
| documents | array of object | Supporting documents attached to this account’s requests |
| fee_details | object | Pricing resolved for this account. Please check fee_details |
| balance_transaction | string | ID of the balance transaction linked to this collection account |
| metadata | json | Set of key-value pairs attached to the collection_account object |
| created_at | string | Collection Account creation timestamp. See Timestamp formats |
| updated_at | string | Collection account last updated timestamp. See Timestamp formats |
ftn
| Parameter | Type | Description |
|---|---|---|
| name | string | Name of the fund transfer network |
| transfer_limit | object | currency (ISO 4217), min\_limit, and max\_limit — the smallest and largest amount accepted, in the smallest unit of currency |
| additional_information | string | Additional info about the network (TAT, availability, etc.) |
virtual_account
| Parameter | Type | Description |
|---|---|---|
| account_holder_name | string | Name of the account holder |
| account_number | string | Account number of the collection account |
| bank_address | json | Bank address of the collection account bank |
| bank_codes | json | Bank codes of the collection account bank |
| bank_branch | string | Bank branch of the collection account bank |
| bank_name | string | Bank name of the collection account bank |
| iban | string | IBAN of the collection account bank |
wallet
| Parameter | Type | Description |
|---|---|---|
| type | string | Type of wallet |
| deposit address | string | Deposit address of wallet |
tazapay_account
| Parameter | Type | Description |
|---|---|---|
| deposit_address | string | Deposit address for the Tazapay account |