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
Call this endpoint after all data-collection steps are complete to obtain a redirectLink for the merchant verification iFrame. The URL loads the PayGlocal partner onboarding experience where the merchant completes T&C acknowledgement, DigiLocker, and VKYC.
Use this as step 8 in the onboarding sequence — after Configure Products and before polling Get Onboarding Status.
This endpoint can only be called when every pre-verification checklist step is complete. Calling it earlier returns 400 Bad Request. It cannot be called again after DigiLocker, VKYC, and T&C are all complete.
Preconditions
The following checklist fields must not be INCOMPLETE before calling this endpoint:
Poll GET /status and confirm documentsToBeUploaded is empty before calling redirect.
Notes
- Authenticate with
x-gl-auth and x-gl-digest — sign the raw JSON request body (same as other PUT endpoints). See Authentication.
- Request field is
callBackUrl (camelCase with capital B).
- Response field is
redirectLink, not redirectUrl.
redirectLink format: {baseUrl}?token={sessionToken}&onboardingId={onboardingId}. The session token is valid for 24 hours and must not be cached or reused.callBackUrl is persisted on the merchant record and used as the post-verification redirect target. Its domain must be whitelisted.- Environment base URLs for
redirectLink:
| Environment | Base URL |
|---|
| UAT | https://uat.dashboard.payglocal.in/app/partner-onboarding |
| Production | https://dashboard.payglocal.in/app/partner-onboarding |
What Happens Server-Side
- Validates the onboarding checklist via
isVerificationAllowed().
- Stores
callBackUrl on the merchant record.
- Generates a single-use session token (24-hour TTL).
- Returns the composed
redirectLink for iFrame embedding.
See iFrame Integration for embed instructions and Partner Onboarding Events for completion signals.
Error Scenarios
| Scenario | HTTP Code |
|---|
| One or more pre-verification checklist steps are incomplete | 400 |
| Verification already completed (DigiLocker + VKYC + T&C all complete) | 400 |
Missing or invalid callBackUrl | 400 |
Invalid or missing x-gl-auth / x-gl-digest | 401 |
onboardingId does not exist | 404 |
