Skip to main content

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.

​
Standing Instructions (SI)

Standing Instructions enable merchants to charge customers on a recurring basis with pre-authorized mandates. Perfect for subscriptions, EMI payments, utility bills, and any scenario requiring automatic recurring charges.
Key Concept: Customers authorize once during the initial payment, and the returned Mandate ID allows subsequent charges without re-authentication.

Mandate-Based

One-time authorization for multiple payments.

Flexible Types

Fixed amount or Variable within ceiling.

Auto or Manual

AutoDebit or ONDEMAND merchant control.

Secure & Compliant

PCI DSS compliant automated billing.
Standing Instructions are supported for international cards only. Available for both Checkout Flow (PayCollect) and Seamless Flow (PayDirect) integrations.

​
Creating a Mandate (SI Initiate)

SI Initiate is the foundation of recurring payments. It creates a mandate during the first payment, giving you permission for future charges. Always the first step. Include the standingInstruction.data block in your initial GPI request: 
{
  "merchantTxnId": "23AEE8CB6B62EE2AF07",
  "paymentData": {
    "totalAmount": "89",
    "txnCurrency": "USD"
  },
  "standingInstruction": {
    "data": {
      "amount":           "89",
      "maxAmount":        "500",
      "numberOfPayments": "12",
      "frequency":        "MONTHLY",
      "type":             "FIXED",
      "startDate":        "20260601"
    }
  },
  "merchantCallbackURL": "https://www.yoursite.com/callback"
}

​
Response

{
  "gid": "gl-13bbd3c4-9817-4786-96c6-12fa6191f118",
  "status": "CREATED",
  "data": {
    "redirectUrl": "https://...",
    "mandateId":   "md_94f0bb40-2664-4851-ab83-b86c618d3e15"
  }
}
Store the Mandate ID — you’ll need it for all future operations: charging, pausing, activating, or checking status.

​
Fixed vs Variable Mandates

Fixed SI

Same amount charged every time. Perfect for subscriptions, EMIs, predictable recurring billing.Required: amount, numberOfPayments, frequency

Variable SI

Each charge can vary up to a ceiling. Perfect for utility bills, usage-based services.Required: maxAmount, numberOfPayments, frequency

​
Frequency Options

ONDEMAND · DAILY · WEEKLY · BIWEEKLY · MONTHLY · QUARTERLY · HALFYEARLY · YEARLY

​
Auto Debit vs On-Demand

Fixed + Auto Debit

frequency: DAILY / WEEKLY / MONTHLYPayGlocal automatically debits the fixed amount on schedule. Zero merchant intervention after mandate setup.

Variable + On-Demand

frequency: ONDEMANDYOU control both timing AND amount via the SI On-Demand API.
When Auto Debit is enabled for your MID: ONDEMAND frequency and VARIABLE type are not supported.

​
Auto Debit Webhook Notifications

When Auto Debit is enabled, PayGlocal POSTs to your webhook URL after each automatic debit. 
{
  "gid":       "gl-13bbd3c4-9817-4786-96c6-12fa6191f118",
  "status":    "SUCCESS",
  "type":      "STANDING_INSTRUCTION",
  "siId":      "si_cd2f0a1c-4dec-44d5-b0f3-297aee590d32",
  "timestamp": "2026-04-12T07:47:18Z",
  "statusUrl": "https://api.prod.payglocal.in/gl/v1/payments/.../status"
}
For FAILURE, the shape is identical with "status": "FAILURE". Always call statusUrl for complete details.

​
Cancel Mandate

Permanently revoke a mandate. 
PUT /gl/v1/payments/si/status

{
  "merchantTxnId": "REVOKE-23AEE8CB6B62EE2AF07",
  "standingInstruction": {
    "action":    "REVOKE",
    "mandateId": "md_94f0bb40-2664-4851-ab83-b86c618d3e15"
  }
}
Mandates can also be cancelled through the PayGlocal Control Center.

​
Mandate Statuses

StatusDescription
ACTIVEMandate is active and available for subsequent payments
PAUSEDMandate temporarily suspended (instant or scheduled)
INACTIVEMandate revoked via API or Control Center
EXHAUSTEDAll configured payments have been processed

​
Manage Your Mandates

SI On-Demand

Trigger a sale against an existing Variable mandate.

SI Status Check

Check mandate status, payment history, and next billing date.

SI Pause

Temporarily suspend a mandate — instantly or scheduled from a future date.

SI Activate

Resume a paused mandate.