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

Base URL
https://api.onboard.payglocal.in
Auth
API key in header x-gl-auth and API key in header x-gl-digest
TypeScript
https://skmtc.dev/payglocal/apis/payglocal-api/docs/gcc/v2/partner/merchant/onboard/post.ts
A function with typed inputs. Its response is checked against the schema.

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"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.