Cancel Standing Instruction

Revoke an active mandate to prevent future recurring debits.

PUT /gl/v1/payments/si/status

SI Cancellation

cURL

curl --request PUT \
  --url https://api.payglocal.in/gl/v1/payments/si/status \
  --header 'Content-Type: application/json' \
  --header 'x-gl-token-external: <api-key>' \
  --data '
{
  "mandateId": "mandate_abc123",
  "action": "REVOKE"
}
'

200

{
  "gid": "gl_si_revoke_001",
  "status": "SUCCESS",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "",
  "data": {
    "mandateId": "mandate_abc123",
    "mandateStatus": "REVOKED"
  }
}

When to Use

Revoke an active standing-instruction mandate. Future scheduled or on-demand debits will not be attempted. Once revoked, the mandate cannot be reactivated — register again via PayDirect or PayCollect initiate. See Standing Instruction Sale in the API Reference sidebar.

Common Failure Responses

Already inactive:

{ "status": "REQUEST_ERROR", "message": "Mandate was inactive" }

Not found:

{ "status": "REQUEST_ERROR", "message": "Mandate id not found" }

Authorizations

x-gl-token-external · string · header · required

RSA-signed JWS (JSON Web Signature) token carrying the request payload.

• Header: { "alg": "RS256", "kid": "<merchant-key-id>", "iss": "<merchant-id>", "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.

Body

application/json

mandateId · string · required

Example:

"mandate_abc123"

action · enum<string> · required

Available options: REVOKE

Example:

"REVOKE"

Response

200

application/json

Mandate revoked.

Standard PayGlocal response envelope (GlocalApiResponse).

gid · string

PayGlocal global transaction ID.

Example:

"gl_9c2645ed09edb22e"

status · string

High-level status of this API response.

Example:

"SUCCESS"

message · string

Human-readable message.

timestamp · string

Response timestamp (DD/MM/YYYY HH:MM:SS).

Example:

"10/01/2026 15:00:00"

reasonCode · string

Empty on success; populated on failure.

Example:

""

data · object

Operation-specific payload. Shape varies by endpoint.

errors · object

Field-level validation errors (populated on 4xx).

Show child attributes