> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payglocal.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Overview of PayGlocal's Payment APIs — how authentication works, the GID lifecycle, and quick links to all payment endpoints.

## 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.

<Note>
  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.
</Note>

***

## Authentication: RSA-signed JWS

<Warning>
  **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.
</Warning>

| API Area                | Auth method                             | Primary headers                                                        |
| ----------------------- | --------------------------------------- | ---------------------------------------------------------------------- |
| Merchant Onboarding API | HmacSHA256                              | `x-gl-auth`, `x-gl-digest`                                             |
| Payment APIs            | RSA-signed JWS in `x-gl-token-external` | `x-gl-token-external` (see [Key Management](/key-management/overview)) |

You use your **PVT-KEY** to sign requests; **PUBCERT** verifies responses and may encrypt the body when your integration requires JWE. See [Key Management](/key-management/overview) and [Constructing API Requests](/key-management/request-construction) 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](/api-reference/payment/upi)**. Request and response shapes (minimal vs enriched body, initiation vs `statusData` after success, headers, callbacks) are documented on **[UPI Intent](/api-reference/payment/upi-intent)**.

<CardGroup cols={2}>
  <Card title="UPI" icon="wallet" href="/api-reference/payment/upi">
    Checkout experience and how money moves from customer to settlement.
  </Card>

  <Card title="UPI Intent" icon="bolt" href="/api-reference/payment/upi-intent">
    PayCollect payloads, two response phases, headers, and post-success `statusData`.
  </Card>
</CardGroup>

***

## Endpoint Reference

### Payment Initiation

| Endpoint                                                         | Method | When to Use                                      |
| ---------------------------------------------------------------- | ------ | ------------------------------------------------ |
| [GPI (Checkout Flow)](/api-reference/payments-v2/paycollect/gpi) | POST   | Non-PCI merchants — PayGlocal collects card data |

PCI-certified PayDirect initiate is documented under **[Seamless Flow (PayDirect) → GPI](/api-reference/payments-v2/paydirect/gpi)** in the sidebar.

### Transaction Management

| Endpoint                                                                           | Method | When to Use                                              |
| ---------------------------------------------------------------------------------- | ------ | -------------------------------------------------------- |
| [Get Transaction Status](/api-reference/payments-v2/common/get-transaction-status) | GET    | After GPI, after callback fails, anytime you need status |
| [Refund](/api-reference/payment/refund)                                            | POST   | For captured payments requiring full or partial refund   |

### Auth & Capture (Separate Flow)

| Endpoint                                                             | Method | When to Use                                                                 |
| -------------------------------------------------------------------- | ------ | --------------------------------------------------------------------------- |
| [Standalone Capture](/api-reference/payment/standalone-capture)      | POST   | Capture a previously authorized payment (initiated with `captureTxn=false`) |
| [Authorization Reversal](/api-reference/payment/standalone-reversal) | POST   | Void an authorization before capture                                        |

### Standing Instructions

| Endpoint                                                                                   | Method | When to Use                                 |
| ------------------------------------------------------------------------------------------ | ------ | ------------------------------------------- |
| [Subsequent Payment (SI Sale)](/api-reference/standing-instructions/si-subsequent-payment) | POST   | Charge a customer using an existing mandate |
| [Cancel Mandate](/api-reference/standing-instructions/si-cancellation)                     | PUT    | Revoke a mandate to stop future debits      |
| [Get Mandate Status](/api-reference/standing-instructions/si-status)                       | POST   | Check mandate status and payment history    |

***

## Two Processing Models

Your MID can be configured for one of two models:

| Model                        | What happens during GPI redirect     | Your action                        |
| ---------------------------- | ------------------------------------ | ---------------------------------- |
| **Auth + Capture** (default) | Full payment processed automatically | Check status after callback        |
| **Auth Only**                | 3DS authentication only              | Send separate Auth + Capture calls |

Contact PayGlocal merchant support to configure your preferred model.

<CardGroup cols={2}>
  <Card title="Which integration is right for you?" icon="map" href="/guides/integration-chooser">
    PayCollect vs PayDirect vs Standalone vs Standing Instructions.
  </Card>

  <Card title="Payment Flow Overview" icon="diagram-project" href="/integration/payment-flow">
    End-to-end sequence diagram for the GPI payment flow.
  </Card>
</CardGroup>