Skip to main content
POST
/
gl
/
v1
/
payments
/
{gid}
/
capture
Capture Authorized Transaction
curl --request POST \
  --url https://api.payglocal.in/gl/v1/payments/{gid}/capture \
  --header 'Content-Type: application/json' \
  --header 'x-gl-token-external: <api-key>' \
  --data '
{
  "captureType": "F"
}
'
{
  "gid": "gl_9c2645ed09edb22e",
  "status": "SENT_FOR_CAPTURE",
  "timestamp": "10/01/2026 15:00:00",
  "reasonCode": "",
  "data": {
    "gid": "gl_9c2645ed09edb22e",
    "status": "SENT_FOR_CAPTURE",
    "capturedAmount": "100.00"
  }
}

Documentation Index

Fetch the complete documentation index at: https://payglocal.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
When to Use

Capture an AUTHORIZED transaction (i.e., one initiated with captureTxn=false). Until captured, the authorization holds funds on the customer’s card but does not settle them to you.

​
Full vs Partial

  • captureType=F — full capture of the authorized amount. Omit paymentData.totalAmount.
  • captureType=P — partial capture. paymentData.totalAmount is required and must be ≤ the authorized amount.
Only one capture is allowed per authorization. The remaining authorized amount is released after the first capture.

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.

Path Parameters

​
gid
string
required

PayGlocal gid of the authorized transaction.

Body

application/json

Unified request body for payment initiation, capture, refund, reversal, and SI operations. Most fields are optional — which fields are required depends on the operation. See each endpoint's required: list for operation-specific rules.

Note: required: lists are best-effort and derived from current integration examples — validate against your integration spec or contact your PayGlocal implementation lead.

​
captureType
enum<string>
required

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

Available options:
F,
P
Example:

"F"

​
merchantTxnId
string

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

Example:

"order_1712345678"

​
merchantUniqueId
string

Merchant's secondary unique reference.

​
refundType
enum<string>

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

Available options:
F,
P
Example:

"F"

​
refundAction
string

Refund lifecycle action.

​
captureTxn
boolean

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

​
paymentData
object

Payment instrument + amount details for a transaction.

​
riskData
object

Risk & analytics payload forwarded to fraud engines.

​
standingInstruction
object

Mandatory when registering a standing instruction on initiate. Omit for GPI-only sales without a mandate.

​
merchantCallbackURL
string<uri>

URL PayGlocal redirects to after payment completion.

​
merchantCustomPayload
object

Opaque merchant metadata echoed back in callbacks.

​
dcc_indicator
boolean

Set true to enable Dynamic Currency Conversion.

​
dccReferenceGid
string

PayGlocal DCC quote reference (when dcc_indicator=true).

Response

Capture accepted.

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