> ## 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 instruction — auto debit
> AUTO DEBIT standing instructions — scheduled FIXED debits after PayCollect mandate registration on hosted checkout.
## AUTO DEBIT standing instructions
**AUTO DEBIT** standing instructions automatically process subsequent debits based on the configured schedule after successful mandate registration.
Registration uses the same PayCollect initiate endpoint as [GPI](/api-reference/payments-v2/paycollect/gpi) with a `standingInstruction` block. The customer completes mandate setup on the **hosted checkout** page.
### Key points
* Register the mandate using the **Initiate API** with **`startDate`** and a scheduled **`frequency`** such as `WEEKLY`, `BIWEEKLY`, `MONTHLY`, `QUARTERLY`, `HALFYEARLY`, or `YEARLY` (not `ONDEMAND`).
* After successful registration, subsequent debit transactions are **automatically initiated** according to the configured schedule.
* **No [SI sale API](/api-reference/standing-instructions/si-subsequent-payment) calls** are required for subsequent debit transactions.
* The amount for subsequent debits must be **`FIXED`**.
When **Auto Debit** is enabled for your MID, `ONDEMAND` frequency and `VARIABLE` type are not supported.
***
## Supported payment methods
| Method | Domestic | International |
| ------ | :------: | :-----------: |
| Cards | — | ✓ |
Standing instruction registration on hosted checkout supports **international cards** only. UPI, net banking, and domestic-only methods are not supported for SI.
## Notes
* Do **not** send **`cardData`** or **`tokenData`** — the customer registers the mandate on the PayGlocal hosted page.
***
## API
| | |
| -------------- | ----------------------------------------------------------------- |
| **Method** | `POST` |
| **Path** | `/gl/v1/payments/initiate/paycollect` |
| **Production** | `https://api.payglocal.in/gl/v1/payments/initiate/paycollect` |
| **Sandbox** | `https://api.uat.payglocal.in/gl/v1/payments/initiate/paycollect` |
GPI, on-demand SI, auto-debit, and authorize all call this path. Only the JSON request body differs.
***
## Headers
Same as [GPI](/api-reference/payments-v2/paycollect/gpi).
Set `standingInstruction.data` (`amount`, scheduled `frequency`, `type: FIXED`, `startDate`) in **Request body** below.
## Next actions
PayGlocal debits on your configured schedule. **Do not** call [SI subsequent payment](/api-reference/standing-instructions/si-subsequent-payment) for scheduled debits.
| Action | API |
| -------------------- | ----------------------------------------------------------------------------------------------------------------- |
| Mandate status | [Check mandate status](/api-reference/standing-instructions/si-status) |
| Cancel mandate | [Cancel standing instruction](/api-reference/standing-instructions/si-cancellation) |
| Each scheduled debit | [Get transaction status](/api-reference/payments-v2/common/get-transaction-status) and your `merchantCallbackURL` |
## OpenAPI
````yaml openapi-v2-paycollect-si-auto-debit.yaml POST /gl/v1/payments/initiate/paycollect
openapi: 3.0.3
info:
title: PayCollect initiate — SI auto debit (Payments V2)
version: 1.0.0
description: >-
Payments V2 documentation slice. Production calls use `POST
/gl/v1/payments/initiate/paycollect`.
servers:
- url: https://api.payglocal.in
description: Production
- url: https://api.uat.payglocal.in
description: Sandbox
security: []
paths:
/gl/v1/payments/initiate/paycollect:
post:
tags:
- Payment
summary: PayCollect AUTO DEBIT standing instruction (request body)
description: >
**Endpoint:** `POST /gl/v1/payments/initiate/paycollect` — same URL for
GPI, on-demand SI, auto-debit, and authorize; only the request body
differs.
Scheduled auto debit mandate. **International cards only** on hosted
checkout. `type: FIXED`, scheduled `frequency`, `startDate`.
operationId: paycollectInitiateSIAutoDebit
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionRequestPayCollectSIAutoDebit'
examples:
si_auto_debit_monthly:
summary: AUTO DEBIT — MONTHLY FIXED
value:
merchantTxnId: 23AEE8CB6B62EE2AF07
merchantUniqueId: IFNN939494NJFJ
merchantCallbackURL: >-
https://api.prod.payglocal.in/gl/v1/payments/merchantCallback
standingInstruction:
data:
amount: '15000'
numberOfPayments: 'N'
frequency: MONTHLY
type: FIXED
startDate: '20260903'
paymentData:
totalAmount: '10.00'
txnCurrency: INR
billingData:
firstName: John
lastName: Doe
addressStreet1: 221B Baker Street
addressCity: Bengaluru
addressCountry: IND
emailId: john.doe@example.com
callingCode: '+91'
phoneNumber: '9999999999'
responses:
'200':
description: >
Returned immediately from initiate. Redirect the customer to
`data.redirectUrl`, then poll `data.statusUrl` or [Get Transaction
Status](/api-reference/payments-v2/common/get-transaction-status).
When mandate registration succeeds, `data.mandateId` may be present
in `data`.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponsePayCollectInitiateSI'
example:
gid: gl_o-a057c4d6b6c620741apzp0ZX2
status: INPROGRESS
message: Transaction Created Successfully
timestamp: 02/06/2026 21:47:33
reasonCode: '200'
data:
redirectUrl: >-
https://api.uat.payglocal.in/gl/payflow-ui/?x-gl-token=example
statusUrl: >-
https://api.uat.payglocal.in/gl/v1/payments/gl_o-a057c4d6b6c620741apzp0ZX2/status?x-gl-token=example
merchantTxnId: 23AEE8CB6B62EE2AF07
mandateId: md_925996a0-9da6-42df-b968-8a14729885fd
errors: null
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
security:
- JwsTokenAuth: []
components:
schemas:
TransactionRequestPayCollectSIAutoDebit:
allOf:
- $ref: '#/components/schemas/PayCollectInitiateFieldsSI'
- type: object
description: >
PayCollect auto debit standing instruction registration.
**International cards only** on hosted checkout (no UPI, net
banking, or domestic-only methods).
Do **not** send `cardData` or `tokenData` in `paymentData`.
required:
- merchantTxnId
- paymentData
- merchantCallbackURL
- standingInstruction
properties:
paymentData:
$ref: '#/components/schemas/PaymentPayCollectInitiateHostedSI'
standingInstruction:
$ref: '#/components/schemas/StandingInstructionAutoDebit'
ApiResponsePayCollectInitiateSI:
type: object
description: >
Response envelope for PayCollect standing instruction initiate (`200`).
`data` may include `mandateId`.
No fields in this envelope are marked required.
properties:
gid:
type: string
description: PayGlocal transaction ID. Use for status, capture, and refund APIs.
example: gl_o-a057c4d6b6c620741apzp0ZX2
status:
type: string
description: >-
High-level status. Typically `INPROGRESS` immediately after
initiate.
example: INPROGRESS
message:
type: string
description: Human-readable status message.
example: Transaction Created Successfully
timestamp:
type: string
description: Response timestamp (`DD/MM/YYYY HH:MM:SS`).
example: 02/06/2026 21:47:33
reasonCode:
type: string
description: >-
Success code on initiate (e.g. `200`). See `4xx` responses for error
codes.
example: '200'
data:
$ref: '#/components/schemas/InitiateResponseDataPayCollectSI'
errors:
type: object
nullable: true
description: '`null` on success.'
additionalProperties:
type: string
PayCollectInitiateFieldsSI:
type: object
properties:
merchantTxnId:
type: string
description: Merchant's unique transaction identifier. Alphanumeric only.
minLength: 4
maxLength: 50
example: 23AEE8CB6B62EE2AF07
merchantUniqueId:
type: string
description: >-
Optional stable merchant-side ID for idempotency and reconciliation.
Alphanumeric only.
minLength: 15
maxLength: 40
example: IFNN939494NJFJ
riskData:
allOf:
- $ref: '#/components/schemas/Risk'
description: Recommended for fraud checks and processor compliance.
merchantCallbackURL:
type: string
format: uri
description: Customers are redirected here post payment completion.
example: https://api.prod.payglocal.in/gl/v1/payments/merchantCallback
PaymentPayCollectInitiateHostedSI:
type: object
description: >
Hosted checkout payment details for PayCollect standing instruction
registration.
Do **not** send `cardData`, `tokenData`, or `authenticationData` — the
customer registers the mandate on `redirectUrl`.
required:
- totalAmount
- txnCurrency
properties:
totalAmount:
type: string
description: >-
Transaction amount as a decimal string. Supports up to 4 decimal
places.
example: '10.00'
txnCurrency:
type: string
description: >-
ISO 4217 currency code. Must be uppercase (e.g. `INR`, `USD`,
`EUR`).
example: INR
billingData:
allOf:
- $ref: '#/components/schemas/Billing'
description: >
Cardholder billing address. Required for digital product / service
transactions
and flight bookings. Preferred for all other transaction types.
StandingInstructionAutoDebit:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/SIDataAutoDebit'
InitiateResponseDataPayCollectSI:
allOf:
- $ref: '#/components/schemas/InitiateResponseDataPayCollect'
- type: object
description: >
Standing instruction registration may also return **`mandateId`** in
`data` — store it for SI sale, status, and cancel.
properties:
mandateId:
type: string
description: >
PayGlocal mandate identifier when `standingInstruction` was
sent. Not returned on later transactions.
example: md_925996a0-9da6-42df-b968-8a14729885fd
CommonErrorResponse:
type: object
properties:
gid:
type: string
example: gl_9c2645ed09edb22e
timestamp:
type: string
example: 10/01/2026 15:00:00
reasonCode:
type: string
example: VALIDATION_ERROR
data:
type: object
errors:
type: object
errorDetails:
type: array
items:
$ref: '#/components/schemas/ErrorDetail'
Risk:
type: object
description: Risk & analytics payload forwarded to fraud engines.
properties:
customerData:
$ref: '#/components/schemas/Customer'
shippingData:
$ref: '#/components/schemas/Shipping'
orderData:
type: array
items:
$ref: '#/components/schemas/RiskItem'
Billing:
type: object
description: Billing address + contact details of the payer.
properties:
firstName:
type: string
example: John
lastName:
type: string
example: Doe
emailId:
type: string
format: email
example: john.doe@example.com
callingCode:
type: string
example: '+91'
phoneNumber:
type: string
example: '9999999999'
addressStreet1:
type: string
example: 221B Baker Street
addressStreet2:
type: string
addressCity:
type: string
example: Bengaluru
addressState:
type: string
example: Karnataka
addressStateCode:
type: string
example: KA
addressPostalCode:
type: string
example: '560001'
addressCountry:
type: string
description: ISO 3166-1 alpha-3 country code.
example: IND
SIDataAutoDebit:
type: object
description: Mandate fields for auto debit (`standingInstruction.data`).
required:
- amount
- numberOfPayments
- frequency
- type
- startDate
properties:
amount:
type: string
example: '15000'
numberOfPayments:
type: string
description: >-
Total recurring debits allowed. Any positive integer from `1` to
`N`, or `"N"` for unlimited / infinite recurring debits.
example: 'N'
frequency:
type: string
enum:
- WEEKLY
- BIWEEKLY
- MONTHLY
- QUARTERLY
- HALFYEARLY
- YEARLY
type:
type: string
enum:
- FIXED
startDate:
type: string
description: First debit date (`yyyyMMdd`). Must be after the current date.
example: '20260903'
endDate:
type: string
description: Optional (`yyyyMMdd`).
InitiateResponseDataPayCollect:
type: object
properties:
redirectUrl:
type: string
format: uri
description: >-
Hosted checkout URL — redirect the customer's browser here via
**HTTP GET** to complete payment.
example: https://api.uat.payglocal.in/gl/payflow-ui/?x-gl-token=example
statusUrl:
type: string
format: uri
description: >-
Pre-authenticated URL to poll status after the customer completes
payment.
example: >-
https://api.uat.payglocal.in/gl/v1/payments/gl_9c2645ed09edb22e/status?x-gl-token=example
merchantTxnId:
type: string
description: Echo of `merchantTxnId` from the initiate request body.
example: order_1712345678
ErrorDetail:
type: object
properties:
field:
type: string
description: Name of the field that failed validation.
example: panNumber
message:
type: string
description: Human-readable error message.
example: Required field is missing
Customer:
type: object
description: Payer identity for risk evaluation.
properties:
merchantAssignedCustomerId:
type: string
example: cust_12345
firstName:
type: string
lastName:
type: string
emailId:
type: string
format: email
callingCode:
type: string
mobileNumber:
type: string
Shipping:
type: object
description: Shipping address for physical-goods orders.
properties:
firstName:
type: string
lastName:
type: string
emailId:
type: string
format: email
addressStreet1:
type: string
addressStreet2:
type: string
addressCity:
type: string
addressState:
type: string
addressPostalCode:
type: string
addressCountry:
type: string
example: IND
RiskItem:
type: object
description: Single line-item in the cart for risk analytics.
properties:
itemId:
type: string
itemName:
type: string
itemQuantity:
type: integer
itemPrice:
type: string
itemCategory:
type: string
responses:
BadRequest:
description: Validation error — missing or invalid fields.
content:
application/json:
schema:
$ref: '#/components/schemas/CommonErrorResponse'
examples:
validationError:
summary: Validation error example
value:
gid: gl_9c2645ed09edb22e
timestamp: 10/01/2026 15:00:00
reasonCode: VALIDATION_ERROR
data: {}
errors: null
errorDetails:
- fieldName: paymentData.totalAmount
message: This field is required
Unauthorized:
description: Authentication failed — invalid API key or digest.
content:
application/json:
schema:
$ref: '#/components/schemas/CommonErrorResponse'
examples:
unauthorizedError:
summary: Unauthorized error example
value:
gid: gl_9c2645ed09edb22e
timestamp: 10/01/2026 15:00:00
reasonCode: UNAUTHORIZED
data: {}
errors: null
errorDetails:
- fieldName: authorization
message: Invalid x-gl-token-external
securitySchemes:
JwsTokenAuth:
type: apiKey
in: header
name: x-gl-token-external
description: >
RSA-signed JWS (JSON Web Signature) token carrying the request payload.
- Header: `{ "alg": "RS256", "kid": "", "iss":
"", "x-gl-enc": "false", "is-digested": "true" }`
- Payload: the exact JSON body sent in the request (or its SHA-256
digest when `is-digested=true`).
- Signed with the merchant's RSA private key; PayGlocal verifies with
the matching public key.
Used by all `/gl/v1/payments/*` endpoints.
````