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 Get Detail Virtual Account to monitor every stage of the application lifecycle — from initial submission through to final approval and bank detail assignment (including
openedVaInfoand thesupplementDatasubmission history) — or listen for the webhook events.Monitor material review outcomes: Check the review status of submitted supplementary material via the
supplementDatafield on Get Detail Virtual Account 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.
Get List Virtual Accounts, Get Virtual Account Request Records, and Get Supplement Material Status are either not publicly exposed or don't exist as separate endpoints. See the notices on those pages — the relevant data is available through Get Detail Virtual Account instead.
Endpoints
GET
Retrieve the current status, bank details, and supplement history of a virtual account application.
Last updated
Was this helpful?