Skip to main content
GET
/
v3
/
collection_account
/
{id}
Get Collection Account
curl --request GET \
  --url https://service-sandbox.tazapay.com/v3/collection_account/{id} \
  --header 'Authorization: Basic <encoded-value>'
{ "id": "cva_crqinja9chqqs7moi8rg", "object": "collection_account", "type": "virtual_account", "payment_method_type": "local_bank_transfer_cad", "country": "CA", "currencies": [ "CAD" ], "status": "enabled", "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": "succeeded", "requested_currencies": [ "CAD" ], "created_at": "2024-09-26T09:39:25.03501Z", "updated_at": "2024-09-26T09:39:30.03501Z", "status_description": "Account enabled successfully." } ], "status_description": "", "metadata": { "usecase": "This account is used for CAD collections" }, "created_at": "2024-09-26T09:39:25.03501Z", "updated_at": "2024-09-26T09:41:43.349835Z" }

Documentation Index

Fetch the complete documentation index at: https://developer.tazapay.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique ID of the collection account to retrieve.

Response

200 - application/json

Collection account retrieved 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.