Global Payments API
GP Developer PortalGP API reference
HomeAPI ReferenceSDKsContext Plugin
Transactions

Capture a Sale

POST
/transactions/{id}/capture

Capture a Sale transaction that has a status of PREAUTHORIZED to receive funds for that transaction. The transaction can be captured for a different amount than what was authorized but if no amount specified the full amount will be captured. Also it can be captured in multiple segments to facilitate split shipment. (Availability of multiple captures in production depends on your live configuration.)

Authorization

bearerAuth
AuthorizationBearer <token>

Access token from POST /accesstoken, sent as Authorization: Bearer <token>.

In: header

Path Parameters

id*string

A unique identifier that is used to identify and reference an instance of this resource. It is generated by Global Payments to identify the transaction and must be used to action that transaction in future.

Length1 <= length <= 50

Header Parameters

X-GP-Idempotency?string

Integrator generated value submitted in the request header that is checked to ensure the same value has not been seen in the last 24 hours. It is used to ensure idempotency is maintained with this action.

Length1 <= length <= 50
X-GP-Version*string

The version of the API to execute the request.

Length1 <= length <= 50
Default"2021-03-22"

Request Body

application/json

amount?string

The amount to transfer between Payer and Merchant for a SALE or a REFUND. It is always represented in the lowest denomination of the related currency. and with no decimal point.

Length1 <= length <= 50
gratuity_amount?string

The amount of the gratuity for a transaction.

Length1 <= length <= 50
capture_sequence?string

Indicates whether the request is the first,a subsequent or the last capture request when capturing multiple amounts separately.

Length1 <= length <= 50

Value in

  • "FIRST"
  • "SUBSEQUENT"
  • "LAST"
total_capture_count?number

Indicates the total or expected total of captures that will executed against a transaction that can be captured multiple times.

lodging?
payment_method?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/transactions/TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d/capture" \  -H "X-GP-Version: 2021-03-22" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "TRN_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",  "time_created": "2026-05-03T21:23:39.718Z",  "type": "SALE",  "status": "CAPTURED",  "amount": "11099",  "currency": "USD",  "country": "US",  "reference": "becf9f3e-4d33-459c-8ed2-0c4affc9555e",  "payment_method": {    "result": "string",    "message": "string",    "card": {      "authcode": "string",      "brand_reference": "string"    },    "bnpl": {      "provider": "KLARNA",      "result": "201 CREATED"    }  },  "order": {    "taxes": [      {        "type": "VAT",        "amount": "10",        "percentage": "1"      }    ],    "duty_amount": "1000",    "shipping_amount": "100"  },  "batch_id": "BAT_234234234",  "action": {    "id": "ACT_uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "type": "AUTHORIZE",    "time_created": "2026-05-03T21:23:39.718Z",    "result_code": "SUCCESS",    "app_id": "uzFr7t4VOqxdLDI44hHmXIjHtOOE8d",    "app_name": "my_lovely_app"  }}

Reverse a Sale or Refund POST

Cancel a transaction before funds are exchanged. Transactions can be reversed in full or partially reversed. An attempt to restore Payer's spending limit is always made. If no amount is included in the request body, the full value of the transaction will be reversed. In timeout scenarios, where the integrator does not recieve a response at all, the reference field can be used in place of the id in the URL Availability of partial reversals depends on your live configuration.

Increment an Auth POST

Increment the amount of an existing transaction. Increment the amount for an existing transaction. Use this action to add a charge to an existing transaction before it is batched. This action does not change the status of a transaction and if successful it increases the amount of the existing transaction. (Availability in production depends on your live configuration.)'