---
title: "Get Virtual Account Metadata"
method: GET
path: "/v3/metadata/collection_accounts/virtual_account"
---

# Get Virtual Account Metadata

`GET /v3/metadata/collection_accounts/virtual_account`

## Request

- Base URL: `https://service-sandbox.tazapay.com`
- URL: `https://service-sandbox.tazapay.com/v3/metadata/collection_accounts/virtual_account`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/tazapay/apis/sandbox/docs/v3/metadata/collection_accounts/virtual_account/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns metadata about the virtual accounts that can be created for a given country, currency, and entity. Use this to discover available payment method types, transfer limits, fund transfer networks, and on_behalf_of support.

## Query parameters

- `country` string
- `currencies` string[]
- `entity` string
- `on_behalf_of` boolean

## Response `200`

Virtual account metadata for the given filters.

- object
  - `capabilities` VirtualAccountCapability[]: List of virtual account capabilities available for the given filters.
    - `payment_method_type` string: Type of payment method.
    - `currencies` string[]: Currencies supported by this virtual account type.
    - `transfer_limit` TransferLimit: Minimum and maximum transfer limits.
      - `minimum` object
        - `amount` number
        - `ccy` string
      - `maximum` object
        - `amount` number
        - `ccy` string
      - `currency` string: Currency in which the limits are specified.
    - `on_behalf_of` VirtualAccountOnBehalfOf: on_behalf_of collection support details for a virtual account capability.
      - `support` boolean: Whether on_behalf_of collections can be created.
      - `restricted_industry_verticals` string[]: Industry verticals restricted for on_behalf_of collections.
      - `additional_requirements` string[]: Additional requirements for on_behalf_of collections.
      - `restricted_remitter_countries` string[]: Sender countries restricted for on_behalf_of collections.
      - `restricted_account_holder_countries` string[]: Account holder countries restricted for on_behalf_of collections.
    - `local` object: Local fund transfer network details.
      - `fund_transfer_networks` FundTransferNetwork[]: Fund transfer networks available for this account.
        - `name` string: Name of the fund transfer network.
        - `transfer_limit` TransferLimit: Minimum and maximum transfer limits.
          - `minimum` object
            - `amount` number
            - `ccy` string
          - `maximum` object
            - `amount` number
            - `ccy` string
          - `currency` string: Currency in which the limits are specified.
        - `additional_information` string: Additional info about the network (TAT, availability, etc.).
    - `setup_time` 'instant' | 'same_day' | 't_plus_1' | 't_plus_2' | 't_plus_3' | 'extended': Time required to set up the virtual account.
    - `account_reenablement_supported` boolean: Whether the account can be re-enabled after being disabled.

---

[API](https://skmtc.dev/tazapay/apis/sandbox.md) - [All operations](https://skmtc.dev/tazapay/apis/sandbox/llms.txt) - [OpenAPI document](https://skmtc.dev/tazapay/apis/sandbox/revisions/bf5f4b8f6f5d?raw)
