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.
Checkout Flow (PayCollect)
PayCollect is PayGlocal’s hosted integration mode. You initiate the payment from your server with amount, currency, and callback URL. The customer is redirected to PayGlocal’s checkout, where they enter card details or choose a supported method (UPI, net banking, Apple Pay, global alternative payments, and more). No card data or tokens are sent in your initiate request. PayGlocal collects payment details, runs 3DS where required, and completes the transaction.PCI DSS certified and want your own checkout UI? Use Seamless Flow (PayDirect) instead — you collect card data on your page and send it server-to-server.
Key characteristics of PayCollect
- Can be used by merchants without PCI DSS certification for card collection.
- The customer completes payment on a PayGlocal-hosted page (
redirectUrl). - Multiple payment methods (cards, UPI, net banking, Apple Pay, global alt pays) without separate initiate APIs — the customer selects the method at checkout.
- All initiation calls use server-to-server APIs; the browser only follows the redirect to PayGlocal.
Authentication & keys
PayCollect uses the same payment authentication as PayDirect: download an RSA key from the GCC Dashboard and send a JWS token inx-gl-token-external on every request.
| Topic | Details |
|---|---|
| Header | x-gl-token-external |
| Token type | RSA-signed JWS |
| Setup | Key Management · Constructing API Requests |
Base URLs
| Environment | Base URL |
|---|---|
| Production | https://api.payglocal.in |
| Sandbox | https://api.uat.payglocal.in |
Supported payment methods
The customer selects the method on the hosted page. You do not send a payment-method field in the initiate request.| Method | Domestic | International | Notes |
|---|---|---|---|
| Cards | ✓ | ✓ | No cardData / tokenData in your request |
| UPI / UPI Intent | ✓ | — | INR; see UPI · UPI Intent |
| Net banking | ✓ | — | Selected on hosted page |
| Apple Pay | — | ✓ | International cards only |
| Global alternative payments | — | ✓ | Requires riskData.shippingData.addressCountry and emailId |
Transaction flows
GPI, authorize payment, SI on demand, and SI auto debit all use the same initiation endpoint:POST /gl/v1/payments/initiate/paycollect. Only the request body changes.
GPI
PayGlocal Payment Initiate — hosted single-step sale.
Authorize payment (auth only)
Hold funds on hosted checkout; capture or reverse later.
SI — on demand
Hosted mandate; subsequent debits via SI sale.
SI — auto debit
Hosted mandate; scheduled FIXED debits.
GPI (PayGlocal Payment Initiate — sale)
Single-step payment on PayGlocal’s hosted page. Funds are authorised and captured in one flow after the customer pays. Use this when you do not send card data in your API request. → GPIAuthorize payment (auth only)
Two-step payment on hosted checkout. SetcaptureTxn: 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)
| Model | Subsequent debits | Amount |
|---|---|---|
| On demand | You call SI sale when you choose | FIXED or VARIABLE; no startDate |
| Auto debit | PayGlocal scheduler (WEEKLY, MONTHLY, …) — no SI sale | FIXED only; startDate required |
mandateId from the initiate response — it is not returned on later transactions.
| After initiate | API |
|---|---|
| Transaction status | Get transaction status |
| SI sale (on-demand) | SI subsequent payment |
| Mandate status | Check mandate status |
| Cancel mandate | Cancel standing instruction |
| Capture / reversal | Capture · Auth reversal |
| Refund | Refund (after SENT_FOR_CAPTURE) |

