Skip to main content
GET
/
gcc
/
v2
/
partner
/
merchant
/
onboard
/
{onboardingId}
/
status
Get Onboarding Status
curl --request GET \
  --url https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard/{onboardingId}/status \
  --header 'x-gl-auth: <api-key>' \
  --header 'x-gl-digest: <api-key>'
{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "",
  "data": {
    "merchantInfo": {
      "onboardingId": "pg_onboard_abc123",
      "partnerOnboardingId": "partner-merchant-001",
      "onboardingStatus": "PENDING_REVIEW"
    },
    "merchantOnboardingCheckListStatus": {
      "businessDetails": "COMPLETE",
      "beneficialOwners": "COMPLETE",
      "bankDetails": "COMPLETE",
      "authorisedSignatory": "COMPLETE",
      "vkyc": "COMPLETE",
      "digiLocker": "COMPLETE",
      "tncAcknowledged": "COMPLETE",
      "documents": "COMPLETE",
      "products": "COMPLETE",
      "documentsToBeUploaded": []
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://payglocal.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
When to Use

Retrieves the current onboarding status and all submitted information for a merchant.
After the merchant completes the iFrame verification flow, always call this endpoint server-to-server to confirm vkyc and digiLocker are COMPLETE. Do not rely on the callback redirect alone.

​
Error Scenarios

ScenarioHTTP Code
onboardingId does not exist404
onboardingId does not belong to this partner403

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

​
onboardingId
string
required

Response

Onboarding status retrieved successfully.

​
gid
string

PayGlocal global transaction ID.

Example:

"gl_9c2645ed09edb22e"

​
timestamp
string

Response timestamp (DD/MM/YYYY HH:MM:SS).

Example:

"10/01/2026 15:00:00"

​
reasonCode
string

Empty string on success.

Example:

""

​
data
object