Partner APIs: MCA
Fetch Virtual Accounts
Returns all global virtual account details assigned to a fully activated merchant, grouped by collection label and settlement currency.
GET
/
gcc
/
v3
/
merchants
/
{merchantId}
/
ffms
/
virtualAccounts
Fetch Virtual Accounts
curl --request GET \
--url https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts \
--header 'x-gl-auth: <api-key>' \
--header 'x-gl-digest: <api-key>'import requests
url = "https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts"
headers = {
"x-gl-auth": "<api-key>",
"x-gl-digest": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts")
.header("x-gl-auth", "<api-key>")
.header("x-gl-digest", "<api-key>")
.asString();const url = 'https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts';
const options = {method: 'GET', headers: {'x-gl-auth': '<api-key>', 'x-gl-digest': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"gid": "REQ-XXXXX",
"status": "201 CREATED",
"timestamp": "08/10/2025 16:25:33",
"reasonCode": "GL-201-001",
"data": {
"general": {
"USD": {
"id": "acct_abc123",
"accountId": null,
"accountNumber": "XXXXXXXXXX4490",
"accountNumberType": "Local",
"accountHolderName": "Acme Exports",
"bankName": "Citibank, N.A.",
"bankAddress": "One Penns Way, New Castle, DE 19720",
"bankCountry": "US",
"currency": "USD",
"paymentType": null,
"routingCode": "31100209",
"routingCodeType": "ABA Number",
"createdAt": "1752649980511",
"updatedAt": null
},
"AUD": {
"id": "acct_def456",
"accountId": null,
"accountNumber": "XXXXXX4490",
"accountNumberType": "Local",
"accountHolderName": "Acme Exports",
"bankName": "BC Payments",
"bankAddress": "Level 11/10 Carrington St, Sydney NSW 2000, Australia",
"bankCountry": "AU",
"currency": "AUD",
"paymentType": null,
"routingCode": "252000",
"routingCodeType": "BSB Number",
"createdAt": "1752649980511",
"updatedAt": null
}
}
},
"errors": null
}{
"status": "REQUEST_ERROR",
"message": "MERCHANT ID NOT VALID",
"gid": "REQ-XXXXX",
"timestamp": "2024-11-18T12:34:56Z"
}{
"status": "REQUEST_ERROR",
"message": "MERCHANT NOT ACTIVATED",
"gid": "REQ-XXXXX",
"timestamp": "2024-11-18T12:34:56Z"
}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:x-gl-auth: <your API key>
x-gl-digest: base64(HMAC_SHA256(secret, "/gcc/v3/merchants/<merchantID>/ffms/virtualAccounts"))
- 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
ThemerchantId 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
Thedata object is a two-level map:
data
└── general (collection label)
└── <currency_code> (USD, CAD, AUD, EUR, GBP, OTHER)
└── VirtualAccount (one object per currency, not a list)
- A currency key appears only if an active account exists for it. Do not assume every currency is present.
OTHERholds the merchant’s global account for currencies not listed individually.- An extra
amazonlabel appears only for merchants enabled for Amazon collections.
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
| Scenario | HTTP Code |
|---|---|
x-gl-auth missing or invalid, API key inactive, or x-gl-digest missing or wrong | 401 |
merchantId does not belong to your partner account | 403 |
| Request path not recognised | 400 |
Unexpected server error (also seen for a merchantId that does not exist) | 500 |
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
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.
Fetch Virtual Accounts
curl --request GET \
--url https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts \
--header 'x-gl-auth: <api-key>' \
--header 'x-gl-digest: <api-key>'import requests
url = "https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts"
headers = {
"x-gl-auth": "<api-key>",
"x-gl-digest": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts")
.header("x-gl-auth", "<api-key>")
.header("x-gl-digest", "<api-key>")
.asString();const url = 'https://api.onboard.payglocal.in/gcc/v3/merchants/{merchantId}/ffms/virtualAccounts';
const options = {method: 'GET', headers: {'x-gl-auth': '<api-key>', 'x-gl-digest': '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"gid": "REQ-XXXXX",
"status": "201 CREATED",
"timestamp": "08/10/2025 16:25:33",
"reasonCode": "GL-201-001",
"data": {
"general": {
"USD": {
"id": "acct_abc123",
"accountId": null,
"accountNumber": "XXXXXXXXXX4490",
"accountNumberType": "Local",
"accountHolderName": "Acme Exports",
"bankName": "Citibank, N.A.",
"bankAddress": "One Penns Way, New Castle, DE 19720",
"bankCountry": "US",
"currency": "USD",
"paymentType": null,
"routingCode": "31100209",
"routingCodeType": "ABA Number",
"createdAt": "1752649980511",
"updatedAt": null
},
"AUD": {
"id": "acct_def456",
"accountId": null,
"accountNumber": "XXXXXX4490",
"accountNumberType": "Local",
"accountHolderName": "Acme Exports",
"bankName": "BC Payments",
"bankAddress": "Level 11/10 Carrington St, Sydney NSW 2000, Australia",
"bankCountry": "AU",
"currency": "AUD",
"paymentType": null,
"routingCode": "252000",
"routingCodeType": "BSB Number",
"createdAt": "1752649980511",
"updatedAt": null
}
}
},
"errors": null
}{
"status": "REQUEST_ERROR",
"message": "MERCHANT ID NOT VALID",
"gid": "REQ-XXXXX",
"timestamp": "2024-11-18T12:34:56Z"
}{
"status": "REQUEST_ERROR",
"message": "MERCHANT NOT ACTIVATED",
"gid": "REQ-XXXXX",
"timestamp": "2024-11-18T12:34:56Z"
}
