For the complete documentation index, see llms.txt. This page is also available as Markdown.

Virtual Account APIs

Virtual Account APIs provide a complete lifecycle for applying, managing, and monitoring multi-currency collection (virtual) accounts. A virtual account is a dedicated bank account number issued in the merchant's name that can receive cross-border funds in one or more currencies. Merchants apply for a virtual account through the platform, submit any required KYC material, and receive the assigned account number and bank details once the application is approved.

By integrating with these APIs, organizations can:

  • Open multi-currency collection accounts: Submit a virtual account application specifying the registration country, intended use, and the currencies to accept — all through a single API call.

  • Fulfill KYC requirements seamlessly: When a virtual account application requires supplementary material, submit the additional KYC details using the dedicated supplement endpoint so the review can proceed without manual intervention.

  • Track application progress in real time: Poll the detail and request-record endpoints to monitor every stage of the application lifecycle — from initial submission through to final approval and bank detail assignment.

  • List and filter your account portfolio: Retrieve a paginated view of all virtual account applications with filters for status, currency, date range, and sub-merchant, making reconciliation and reporting straightforward.

  • Monitor material review outcomes: Check the review status of submitted supplementary material and retrieve reviewer feedback to resolve any rejection quickly and resubmit corrected information.

  • Support sub-merchant collections: Associate virtual accounts with specific sub-merchants, enabling platforms to manage collection accounts on behalf of their end-business clients.

  • Review common service questions: Read the VA Service Q&A for clarifications on settlement, documentation, limits, fees, and account allocation rules.

In essence, Virtual Account APIs empower you to automate the full virtual account workflow — from application and KYC fulfilment through to live collection-account management — without any manual portal intervention.

Endpoints

Method
Endpoint
Description

POST

Apply for a new multi-currency collection account.

POST

Submit additional KYC material for a pending application.

GET

Retrieve the current status and bank details of a virtual account application.

GET

Retrieve a paginated list of virtual account applications.

GET

Retrieve the history of all submitted requests for a virtual account application.

GET

Retrieve the review status of supplementary KYC material.

-

Common questions and answers about VA service rules and requirements.

Last updated

Was this helpful?