Get Collection Account

Retrieves the details of an existing collection account by its unique ID.

get/v3/collection_account/{id}

Request

Base URL
https://service-sandbox.tazapay.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/tazapay/apis/sandbox/docs/v3/collection_account/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Unique ID of the collection account to retrieve.

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

No recorded changes to this operation across all 1 revision of this API.