View a virtual account

Get virtual account details. You can query by virtual bank account number (path parameter), currency (query parameter), or unique reference (query parameter).

Authentication: Bearer token required

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customer_idstringRequired
Unique Customer Identifier
vban_numberstringRequired

Virtual bank account number. Alternatively, you can query by currency or unique-ref using query parameters on the base endpoint /v1/customers/{customer_id}/virtual-accounts.

Query parameters

currencystringOptional=3 characters
Three-letter currency code (as specified by [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)). Use this query parameter to filter virtual accounts by currency.
unique-refstringOptional
Unique reference identifier for the virtual account. Use this query parameter to retrieve a specific virtual account by its unique reference.

Response

OK
customer_idstring
Customer number.
customer_namestring
Name of the customer.
virtual_account_detailslist of objects
Array of virtual accounts.

Errors