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

Hold a Transaction

POST
/transactions/{id}/hold

This request will change the transaction status to PENDING_REVIEW (HELD). If the transaction was successful and due to be included in the next settlement file, this will prevent its inclusion until such a time that the transaction is released. If you're using Delayed Capture (the original capture_mode is set to LATER), the transaction must be released and then captured before it will be batched. This functionality is only available for Card Not Present (CNP) transactions in the UK, US, CA and EU.

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

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

reason_code?string

A code indicating the reason for the latest action against the transaction. This can relate to reasons for fraud related actions such as holding or releasing a transaction. It can also relate to the reason a transaction is disputed.

Value in

  • "FRAUD"
  • "NON_DELIVERY"
  • "GOODS_BROKEN"
  • "FALSE_POSITIVE"
  • "IN_STOCK"
  • "OTHER"
  • "NOT_GIVEN"
  • "OUT_OF_STOCK"

Response Body

application/json

curl -X POST "https://example.com/transactions/string/hold" \  -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",  "risk_assessment": [    {      "result": "ACCEPTED",      "message": "string"    }  ],  "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"  }}

Challenge a Disputed Transaction POST

Upload documentation to challenge a disputed transaction. (Availability in production depends on your live configuration.)

Release a Transaction POST

This request will return a transaction to it's previous state before it was set to to PENDING_REVIEW (HELD). If a transaction is set to PENDING_REVIEW (Held), the release request will return the transaction to its original status. For example, if a transaction was set to automatically capture (capture_mode=AUTO), then the release request will return it to a status of CAPTURED. If you're using differect capture_modes, MULTIPLE or LATER, the transaction will simply return to the PREAUTHRORIZED status. Transactions that are held must be released before they are captured. This functionality is only available for Card Not Present (CNP) transactions in the UK, US, CA and EU.