Skip to main content
GET
Fetch Virtual Accounts

When to Use

Call this after a merchant has been activated on PayGlocal, to retrieve their assigned global virtual accounts. Accounts are grouped by collection label (e.g. general) and within each label by currency code. The best trigger is the VIRTUAL_ACCOUNT_PROVISIONED webhook.
A merchant with no active virtual accounts yet (for example, still in onboarding) does not get an error. You receive HTTP 200 with no data and the message Found 0 ACTIVE VAs provisioned to merchant. Always check that data is present before reading it.

Authentication

Send both headers on every request:
  • The digest is computed over the request path only, with no host and no scheme. If the request has a query string, include it: path?query.
  • Sign with your API secret and Base64-encode the result.
  • This is a GET, so there is no body to sign.
  • See Authentication for the full signing specification and code samples.

Which Merchant IDs You Can Query

The merchantId must belong to your partner account (your own merchant ID or one of the merchants onboarded under it). Any other merchant ID returns 403.

Response Structure

The data object is a two-level map:
  • A currency key appears only if an active account exists for it. Do not assume every currency is present.
  • OTHER holds the merchant’s global account for currencies not listed individually.
  • An extra amazon label appears only for merchants enabled for Amazon collections.
Each VirtualAccount contains: id, accountId, accountNumber, accountHolderName, bankName, bankAddress, bankCountry, currency, paymentType, routingCode, routingCodeType, createdAt and updatedAt. Some accounts also carry fedwireRoutingCode. Fields that do not apply to an account are null.
The success response carries "status": "201 CREATED" and "reasonCode": "GL-201-001" even though the HTTP status is 200. Rely on the HTTP status code, not the status text.

Error Scenarios

Error responses use the standard envelope with gid, status, reasonCode and errors.detailedMessage. Quote the gid when you contact support. A plain-text 403 that mentions “geographic constraints” is not an API error. See Troubleshooting.

Authorizations

x-gl-auth
string
header
required

Static API Key generated from the PayGlocal Partner Dashboard.

x-gl-digest
string
header
required

Per-request HmacSHA256 signature, Base64-encoded, using your API Secret as the HMAC key.

  • For GET requests: sign the request URI path (e.g. /gcc/v2/partner/merchant/onboard/business-category), including query string if present.
  • For POST/PUT requests: sign the exact raw request body.

Path Parameters

merchantId
string
required

Identifier of the onboarded merchant.

Response

Virtual accounts retrieved successfully.

gid
string
Example:

"REQ-XXXXX"

status
string
Example:

"201 CREATED"

timestamp
string
Example:

"08/10/2025 16:25:33"

reasonCode
string
Example:

"GL-201-001"

data
object

Keyed by collection label, then by currency code.

errors
object | null