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.

Seamless Flow (PayDirect)

PayDirect is PayGlocal’s server-to-server integration mode for merchants who are PCI DSS certified. In this flow, card details are collected by the merchant’s application. The merchant then securely sends the card information to PayGlocal, where the transaction is completed. Card data (or network tokens) travel in the API request body. PayGlocal handles 3DS authentication, intelligent routing, and settlement on the back end.
Not PCI DSS certified? Use Checkout Flow (PayCollect) instead — card details are collected on a PayGlocal-hosted page, and you do not need to handle card information in your application.

Key characteristics

  • Can only be used by PCI DSS certified merchants.
  • Used when the customer enters card details on the merchant’s own checkout page.
  • For any new payment methods introduced, merchants need to perform a technical integration.
  • All API calls must be made over server-to-server communication channels.

Authentication & keys

For PayDirect, download an RSA key from the GCC Dashboard. All PayDirect payment calls use this key to generate a JWS token passed in the x-gl-token-external header.
TopicDetails
Headerx-gl-token-external
Token typeRSA-signed JWS
SetupKey Management · Constructing API Requests
Payment APIs use RSA-signed JWS — not the HmacSHA256 scheme used by the Merchant Onboarding API.

Base URLs

EnvironmentBase URL
Productionhttps://api.payglocal.in
Sandboxhttps://api.uat.payglocal.in

Supported payment methods

MethodDomesticInternationalNotes
CardsSend cardData or tokenData in the request body
Apple PayInternational cards only
PayDirect does not support UPI, net banking, or global alternative payment methods. Those are available on Checkout Flow (PayCollect).

Transaction flows

GPI, authorize payment, SI on demand, and SI auto debit all use the same initiation endpoint: POST /gl/v1/payments/initiate. Only the request body changes.

GPI

PayGlocal Payment Initiate — single-step sale.

Authorize payment (auth only)

Hold funds first; capture or reverse later.

SI — ONDEMAND

Subsequent debits via SI sale (FIXED or VARIABLE).

SI — AUTO DEBIT

Scheduled FIXED debits; no SI sale API.

GPI (PayGlocal Payment Initiate — sale)

Single-step payment. Funds are authorised and captured in one call. Use this for standard e-commerce checkouts where fulfilment is immediate. GPI (complete request payload)

Authorize payment (auth only)

Two-step payment. Set captureTxn: false to hold funds without capturing. Capture when you are ready to settle, or reverse to release the hold. Cards and international Apple Pay only — UPI and net banking are not supported for auth. Authorize Payment (Auth Only)

Standing instructions (international cards)

ModelSubsequent debitsAmount
ONDEMANDYou call SI sale when you choose (weekly/monthly/etc. is up to you)FIXED or VARIABLE; no startDate
AUTO DEBITPayGlocal scheduler (WEEKLY, MONTHLY, …) — no SI saleFIXED only; startDate required
Store mandateId from the initiate response — it is not returned on later transactions.
After initiateAPI
Transaction statusGet transaction status
SI sale (on-demand)SI subsequent payment
Mandate statusCheck mandate status
Cancel mandateCancel standing instruction
Capture / reversalCapture · Auth reversal
RefundRefund (after SENT_FOR_CAPTURE)