v1

latestOpenAPI 3.0.32026-07-26206388.3 KB

Merchant Onboarding

Create Onboarding

Creates a new merchant onboarding record. This is always the first API call in the onboarding sequence. The onboardingId returned is required for all subsequent calls.

post/gcc/v2/partner/merchant/onboard

Request body

externalOnboardingIdstring required

Partner's unique identifier for this merchant. Must be unique per merchant.

panNumberstring required

PAN of the business entity. Valid types — P (Individual), C (Company), T (Trust), F (Firm).

Example request

{
  "externalOnboardingId": "partner-merchant-001",
  "panNumber": "ABCDE1234F"
}

Response

Merchant onboarding record created successfully.

gidstring

PayGlocal global transaction ID.

timestampstring

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

reasonCodestring

Empty string on success.

Example response

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "data": {
    "merchantInfo": {
      "onboardingId": "pg_onboard_abc123",
      "partnerOnboardingId": "partner-merchant-001",
      "businessDetails": {
        "businessRegisteredAddress": {
          "stateCode": "MH",
          "state": "Maharashtra"
        },
        "businessOperatingAddress": {
          "stateCode": "MH",
          "state": "Maharashtra"
        }
      }
    }
  }
}