Skip to main content
GET
Get Virtual Account Metadata

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 (starts with ent_, 24 characters). 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.

payment_method_type
string

Filter to a single rail, for example local_bank_transfer_sgd or wire_transfer.

fund_transfer_network
string

Filter to capabilities that support a specific fund transfer network.

Response

200 - application/json

Virtual account metadata for the given filters.

capabilities
object[]

List of virtual account capabilities available for the given filters.