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

Create Onboarding

cURL

curl --request POST \
  --url https://api.onboard.payglocal.in/gcc/v2/partner/merchant/onboard \
  --header 'Content-Type: application/json' \
  --header 'x-gl-auth: <api-key>' \
  --header 'x-gl-digest: <api-key>' \
  --data '
{
  "externalOnboardingId": "partner-merchant-001",
  "panNumber": "ABCDE1234F"
}
'

201

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "",
  "data": {
    "merchantInfo": {
      "onboardingId": "pg_onboard_abc123",
      "partnerOnboardingId": "partner-merchant-001",
      "onboardingStatus": "INITIATED"
    }
  }
}

When to Use

Always the first API call in the onboarding sequence. The onboardingId returned in the response is required as a path parameter for every subsequent call.

A merchant is uniquely identified by their PAN. Each PAN can have only one active onboarding record in the PayGlocal system.

Valid PAN types: P (Individual), C (Company), T (Trust), F (Firm).

Error Scenarios

Scenario	HTTP Code
Required fields missing or empty	400
Invalid field format	400
PAN type is not one of P, C, T, F	400
PAN already exists in the PayGlocal system	400
PAN does not exist (invalid PAN)	400

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.

Body

application/json

externalOnboardingId · string · required

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

Example:

"partner-merchant-001"

panNumber · string · required

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

Example:

"ABCDE1234F"

Response

201

application/json

Merchant onboarding record created 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

Show child attributes