Sign in

v1

latestOpenAPI 3.0.32026-07-26206388.3 KB
Payment

Reverse Authorized Transaction

Voids an authorization-only transaction before it's captured. Full reversal only — no partial. Not valid against captured transactions (use Refund instead).

post/gl/v1/payments/{gid}/auth-reversal

Path parameters

gidstring required

PayGlocal gid of the authorized transaction.

Request body

merchantTxnIdstring

Merchant's unique transaction identifier. Required for /initiate and SI sale.

merchantUniqueIdstring

Merchant's secondary unique reference.

refundType'F' | 'P'

Full or partial refund indicator (used on refund calls).

refundActionstring

Refund lifecycle action.

captureType'F' | 'P'

Full or partial capture indicator (used on capture calls).

captureTxnboolean

If true on /initiate, the transaction is auto-captured post-auth.

merchantCallbackURLstring uri

URL PayGlocal redirects to after payment completion.

merchantCustomPayloadobject

Opaque merchant metadata echoed back in callbacks.

dcc_indicatorboolean

Set true to enable Dynamic Currency Conversion.

dccReferenceGidstring

PayGlocal DCC quote reference (when dcc_indicator=true).

Example request

{
  "merchantTxnId": "order_1712345678",
  "refundType": "F",
  "captureType": "F",
  "paymentData": {
    "totalAmount": "100.00",
    "txnCurrency": "INR",
    "cardData": {
      "number": "4111111111111111",
      "expiryMonth": "12",
      "expiryYear": "2030",
      "securityCode": "123",
      "type": "VISA"
    },
    "billingData": {
      "firstName": "John",
      "lastName": "Doe",
      "emailId": "john.doe@example.com",
      "callingCode": "+91",
      "phoneNumber": "9999999999",
      "addressStreet1": "221B Baker Street",
      "addressCity": "Bengaluru",
      "addressState": "Karnataka",
      "addressStateCode": "KA",
      "addressPostalCode": "560001",
      "addressCountry": "IND"
    },
    "authenticationData": {
      "type": "3DS"
    }
  },
  "riskData": {
    "customerData": {
      "merchantAssignedCustomerId": "cust_12345"
    },
    "shippingData": {
      "addressCountry": "IND"
    }
  },
  "standingInstruction": {
    "data": {
      "maxAmount": "15000",
      "amount": "15000",
      "numberOfPayments": "N",
      "mode": "REGISTER",
      "startDate": "20260903",
      "endDate": "20280911"
    }
  }
}

Response

Authorization reversed.

gidstring

PayGlocal global transaction ID.

statusstring

High-level status of this API response.

messagestring

Human-readable message.

timestampstring

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

reasonCodestring

Empty on success; populated on failure.

dataobject

Operation-specific payload. Shape varies by endpoint.

errorsobject

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

Example response

{
  "gid": "gl_9c2645ed09edb22e",
  "status": "SUCCESS",
  "timestamp": "10/01/2026 15:00:00"
}