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.

​
What Are the Payment APIs?

The Payment APIs handle the full transaction lifecycle: initiating payments, tracking status, issuing refunds, and managing recurring Standing Instructions. They are separate from the Merchant Onboarding API and use a different authentication mechanism.
The interactive API explorer on each endpoint page lets you test requests directly. Set your x-gl-merchantid and key signing headers in the authentication panel to make live Sandbox calls.

​
Authentication: RSA-signed JWS

The Payment APIs use RSA-signed JWS (and optionally JWE payload encryption) — not the HmacSHA256 used by the Onboarding API. These are two different auth systems.
API AreaAuth methodPrimary headers
Merchant Onboarding APIHmacSHA256x-gl-auth, x-gl-digest
Payment APIsRSA-signed JWS in x-gl-token-externalx-gl-token-external (see Key Management)
You use your PVT-KEY to sign requests; PUBCERT verifies responses and may encrypt the body when your integration requires JWE. See Key Management and Constructing API Requests for setup.

​
The GID — Central Transaction Identifier

Every Payment API call creates or consumes a GID (PayGlocal ID):
  • Always starts with gl-
  • Returned in every GPI response
  • Used as the path parameter for Get Status, Refund, Capture, and Reversal
  • Your merchantUniqueId can be used interchangeably with the GID in most endpoints
GPI (POST /initiate)
  └── Returns gid: "gl-13bbd3c4-..."
        │
        ├── GET /payments/{gid}/status     ← Get Status
        ├── POST /payments/{gid}/refund    ← Refund
        ├── POST /payments/{gid}/capture   ← Standalone Capture
        └── POST /payments/{gid}/auth-reversal  ← Reversal

​
UPI (India)

Hosted PayCollect supports UPI and UPI Intent for INR. Product overview, screenshots, and a funds-flow diagram live on UPI. Request and response shapes (minimal vs enriched body, initiation vs statusData after success, headers, callbacks) are documented on UPI Intent.

UPI

Checkout experience and how money moves from customer to settlement.

UPI Intent

PayCollect payloads, two response phases, headers, and post-success statusData.

​
Endpoint Reference

​
Payment Initiation

EndpointMethodWhen to Use
GPI (Checkout Flow)POSTNon-PCI merchants — PayGlocal collects card data
PCI-certified PayDirect initiate is documented under Seamless Flow (PayDirect) → GPI in the sidebar.

​
Transaction Management

EndpointMethodWhen to Use
Get Transaction StatusGETAfter GPI, after callback fails, anytime you need status
RefundPOSTFor captured payments requiring full or partial refund

​
Auth & Capture (Separate Flow)

EndpointMethodWhen to Use
Standalone CapturePOSTCapture a previously authorized payment (initiated with captureTxn=false)
Authorization ReversalPOSTVoid an authorization before capture

​
Standing Instructions

EndpointMethodWhen to Use
Subsequent Payment (SI Sale)POSTCharge a customer using an existing mandate
Cancel MandatePUTRevoke a mandate to stop future debits
Get Mandate StatusPOSTCheck mandate status and payment history

​
Two Processing Models

Your MID can be configured for one of two models:
ModelWhat happens during GPI redirectYour action
Auth + Capture (default)Full payment processed automaticallyCheck status after callback
Auth Only3DS authentication onlySend separate Auth + Capture calls
Contact PayGlocal merchant support to configure your preferred model.

Which integration is right for you?

PayCollect vs PayDirect vs Standalone vs Standing Instructions.

Payment Flow Overview

End-to-end sequence diagram for the GPI payment flow.