Skip to main content

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.

This API is for Partners onboarding their own sub-merchants onto PayGlocal. If you are a merchant looking to accept payments, see Checkout Flow (PayCollect) or Seamless Flow (PayDirect) instead.

​
What Is the Partner Merchant Onboarding API?

The Partner Merchant Onboarding API lets technology partners programmatically onboard sub-merchants onto the PayGlocal platform. It handles the full compliance lifecycle: KYC data collection, document upload, bank account verification, product configuration, and triggered VKYC.
The interactive API explorer on each endpoint page lets you test requests directly from this portal. Set your x-gl-auth and x-gl-digest headers in the authentication panel (top-right of the endpoint page) to make live Sandbox calls.

​
Call Sequence

The Onboarding API is sequential and stateful. Each step enriches the merchant record and PayGlocal validates completeness before the final verification step can be triggered. 
Partner System                          PayGlocal API
      │                                       │
      │  POST /onboard  ─────────────────────▶│  Creates merchant record
      │◀────────────────  onboardingId  ───────│
      │                                       │
      │  PUT /business-details ──────────────▶│
      │  PUT /beneficial-owner ──────────────▶│
      │  PUT /bank-details ──────────────────▶│  Penny drop validation
      │  PUT /auth-signatory ────────────────▶│
      │  PUT /docs (repeat per doc) ─────────▶│
      │  PUT /products ──────────────────────▶│
      │                                       │
      │  PUT /verification/{id}/redirect ────▶│  Generates VKYC URL
      │◀──────────────── redirectLink ──────────│
      │                                       │
      │  GET /status ────────────────────────▶│  Confirm final outcome
      │◀─────────────────────────────────────│

​
Endpoint Reference

StepEndpointMethodNotes
1Create OnboardingPOSTReturns onboardingId — required for all subsequent calls
2Update Business DetailsPUTCannot update after T&C acknowledgement
3Add Beneficial OwnerPUTArray replaces existing UBOs — always send all together
4Update Bank DetailsPUTPenny drop verification runs automatically
5Update Auth SignatoryPUTPhone/email used for VKYC — must be accurate
6Upload DocumentsPUTOne call per document
7Configure ProductsPUTSelect products and configure fee structures
8Get Verification RedirectPUTReturns redirectLink for iFrame verification (24h session token)
9Get Onboarding StatusGETAlways confirm server-side after VKYC redirect
—Get Business CategoriesGETLookup table for natureOfBusiness field

​
Authentication

The Onboarding API uses HmacSHA256 request signing:
  • x-gl-auth — your static API Key
  • x-gl-digest — per-request HMAC-SHA256 signature, Base64-encoded
See Authentication for the full signing specification and multi-language code examples.

​
Onboarding Status Lifecycle

StatusMeaning
INITIATEDOnboarding record created, details not yet submitted
IN_PROGRESSOne or more detail sections submitted
PENDING_VERIFICATIONAll details submitted, awaiting merchant VKYC
PENDING_REVIEWVKYC complete, under PayGlocal compliance review
APPROVEDMerchant fully onboarded and activated
REJECTEDOnboarding rejected after review
RFIRequest for Information — additional data required

​
Key Constraints

  • externalOnboardingId must be unique per merchant — it cannot be reused.
  • Business details and auth signatory cannot be updated after T&C acknowledgement.
  • Beneficial owner and bank details cannot be updated after verification is complete.
  • Calling the verification redirect endpoint before all required steps are complete returns 400 Bad Request.

Onboarding Flow Guide

Step-by-step walkthrough with state transitions explained.

iFrame Verification

How to embed the VKYC and DigiLocker flow in your product.

Events & Webhooks

UI postMessage and server-side webhook notifications.