Skip to main content

Overview

Once a merchant completes onboarding and is activated by PayGlocal, one or more global virtual accounts are provisioned for them, one per enabled currency. These accounts are what the merchant shares with their overseas customers to receive payments. As a partner, you call the Fetch Virtual Accounts API to retrieve these details and show them in your own dashboard or send them to the merchant.

When to Call This

  • When you receive the VIRTUAL_ACCOUNT_PROVISIONED webhook for a merchant. This is the signal that accounts are ready.
  • When a merchant asks to view or refresh their account details.
  • When you need to display account details in your partner dashboard.
Calling this for a merchant whose accounts are not provisioned yet does not return an error. You get HTTP 200 with no data and the message Found 0 ACTIVE VAs provisioned to merchant. Treat a missing data as “not ready yet” and wait for the VIRTUAL_ACCOUNT_PROVISIONED webhook.

How to Call It

The digest is computed over the request path only (no host). The sandbox host is https://api.onboard.uat.payglocal.in. Full signing details are in Authentication. The merchantId must belong to your partner account, otherwise the call returns 403.

What You Get Back

The response is organised by collection label (general, plus amazon for merchants enabled for Amazon collections) and within each label by currency code. Each currency has exactly one account object. Currencies you can see: USD, CAD, AUD, EUR, GBP, and OTHER (a global account for other currencies). A currency appears only when an active account exists for it, so do not assume all of them are present. For each account you receive: Other fields in the object (id, accountId, paymentType, fedwireRoutingCode, createdAt, updatedAt) are for your records and may be null. Do not show them to merchants.

Example: Displaying USD Account Details

Your merchant would share this with a US-based customer who can then initiate a domestic ACH or wire transfer.

Routing Codes by Currency

Different currencies use different routing code types. Read the type from routingCodeType rather than assuming it from the currency:

What to Do with This Data

  1. Store it. Cache the account details so you do not need a live call every time you display them.
  2. Display it. Show the merchant their collection accounts per currency in a readable format.
  3. Refresh on demand. Let merchants refresh in case details change.

If Something Goes Wrong

For the full API spec and interactive playground, see Fetch Virtual Accounts.