Capture a transaction

POST

/v1/pos-transactions/{systemTransactionId}/modifications

Request example

Use the following request to capture a previously authorised transaction.

{
  "merchant": "MERCHANT-1",
  "site": "SITE-1",
  "merchantTransactionId": "POS_002",
  "merchantTransactionDate": "2025-01-27T08:51:02.826Z",
  "amounts": {
    "transaction": 24.99,
    "currencyCode": "GBP",
    "gratuity": 0
  },
  "operation": "Capture"
}

Parameter	Description
`merchant` string (≤ 20 characters) required	Your unique merchant identifier, as assigned by PXP.
`site` string (≤ 20 characters) required	Your unique site identifier, as assigned by PXP.
`merchantTransactionId` string (≤ 50 characters) required	The unique identifier for this transaction, as chosen by you.
`merchantTransactionDate` date-time required	The date and time when the initial transaction happened, in ISO 8601 format.
`amounts` object required	Details about the transaction amount.
`amounts.transaction` number required	The value of the transaction. This can't be more than the original transaction value.
`amounts.currencyCode` string required	The currency code associated with the transaction, in ISO 4217 format.
`amounts.gratuity` number	The optional gratuity amount.
`operation` string required	The type of modification that you want to make. Set this to `Capture`. Possible values: `Capture` `Refund` `Incremental` `Void`

Response example

If your request is successful, you'll receive a 200 response containing a new systemTransactionId. The state will also be updated to Captured. You'll also receive a Transaction (Card Captured) webhook notification.

{
  "state": "Captured",
  "stateData": {},
  "approvalCode": "",
  "merchantTransactionId": "POS_002",
  "systemTransactionId": "fff4cf23-9c69-40cc-8a8b-b5c86b302b74",
  "merchantTransactionDate": "2025-04-08T09:51:02.826445+01:00",
  "fundingData": {
    "maskedPrimaryAccountNumber": "476173******0027",
    "expiryMonth": "12",
    "expiryYear": "2025",
    "cardScheme": "Visa",
    "gatewayTokenId": "2ae96210-c8a3-459e-8ad8-7d481a90ff71",
    "providerResponse": {
      "provider": "PXP Financial",
      "code": "",
      "message": "",
      "merchantId": "",
      "terminalId": "",
      "paymentAccountReference": "",
      "schemeTransactionId": "",
      "merchantAdvice": {
        "code": "",
        "message": ""
      },
      "settlementDate": "2025-04-08T11:58:17.234175+01:00"
    }
  }
}