Skip to main content
GET
/
v3
/
metadata
/
collection_accounts
/
virtual_account
Get Virtual Account Metadata
curl --request GET \
  --url https://service-sandbox.tazapay.com/v3/metadata/collection_accounts/virtual_account \
  --header 'Authorization: Basic <encoded-value>'
{
  "capabilities": [
    {
      "payment_method_type": "local_bank_transfer_cad",
      "currencies": [
        "CAD"
      ],
      "transfer_limit": {
        "minimum": {
          "amount": 100,
          "ccy": "CAD"
        },
        "maximum": {
          "amount": 1000000,
          "ccy": "CAD"
        },
        "currency": "CAD"
      },
      "on_behalf_of": {
        "support": true,
        "restricted_industry_verticals": [
          "gambling",
          "firearms"
        ],
        "additional_requirements": [
          "entity_approval_required"
        ],
        "restricted_remitter_countries": [
          "US",
          "CN"
        ],
        "restricted_account_holder_countries": [
          "RU",
          "IR"
        ]
      },
      "local": {
        "fund_transfer_networks": [
          {
            "name": "EFT",
            "transfer_limit": {
              "minimum": {
                "amount": 100,
                "ccy": "CAD"
              },
              "maximum": {
                "amount": 500000,
                "ccy": "CAD"
              },
              "currency": "CAD"
            },
            "additional_information": "Settlement TAT: T+1 business days. Available Monday to Friday."
          }
        ]
      },
      "setup_time": "instant",
      "account_reenablement_supported": true
    },
    {
      "payment_method_type": "wire_transfer",
      "currencies": [
        "USD"
      ],
      "transfer_limit": {
        "minimum": {
          "amount": 1000,
          "ccy": "USD"
        },
        "maximum": {
          "amount": 5000000,
          "ccy": "USD"
        },
        "currency": "USD"
      },
      "on_behalf_of": {
        "support": true,
        "restricted_industry_verticals": [
          "crypto",
          "adult_content"
        ],
        "additional_requirements": [
          "entity_submission_required"
        ],
        "restricted_remitter_countries": [
          "KP"
        ],
        "restricted_account_holder_countries": [
          "RU",
          "BY"
        ]
      },
      "local": {
        "fund_transfer_networks": [
          {
            "name": "SWIFT",
            "transfer_limit": {
              "minimum": {
                "amount": 1000,
                "ccy": "USD"
              },
              "maximum": {
                "amount": 5000000,
                "ccy": "USD"
              },
              "currency": "USD"
            },
            "additional_information": "Settlement TAT: T+2 business days."
          }
        ]
      },
      "setup_time": "t_plus_1",
      "account_reenablement_supported": false
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

country
string

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

currencies
string[]

Currencies in ISO format.

entity
string

Entity identifier. Set entity id to get VA capabilities available for this particular entity. Capabilities not available for this entity wil be filtered out.

on_behalf_of
boolean

Set to true to get metadata for an on_behalf_of merchant. Set to false for a direct merchant.

Response

200 - application/json

Virtual account metadata for the given filters.

capabilities
object[]

List of virtual account capabilities available for the given filters.