Refund a purchase transaction

POST

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

Request example

Use the following request to return funds from a purchase transaction back to the original payment method.

ℹ️
You can also perform a refund by initiating a transaction and setting the intent to Refund.

{
  "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": "Refund"
}

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` string required	The value of the transaction. For `Refund` operations, 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 `Refund`. Possible values: `Capture` `Refund` `Incremental` `Void`

Response example

If your request is successful, you'll receive a 200 response containing a new systemTransactionId. You'll also receive a Transaction (Authorised) webhook notification.

{
  "state": "Authorised",
  "stateData": {},
  "approvalCode": "991721",
  "merchantTransactionId": "ngtest250411_m12",
  "systemTransactionId": "c2bacf16-c6f9-4709-b03a-6916504c730b",
  "merchantTransactionDate": "2025-04-11T09:51:02.826445+01:00",
  "fundingData": {
    "maskedPrimaryAccountNumber": "",
    "expiryMonth": "",
    "expiryYear": "",
    "cardScheme": "AmericanExpress",
    "gatewayTokenId": "31759b1c-9057-4306-900e-a944e189c79c",
    "providerResponse": {
      "provider": "American Express",
      "code": "000",
      "message": "",
      "merchantId": "0371518531",
      "terminalId": "12345678",
      "paymentAccountReference": "99999999999999999999999999999999999",
      "schemeTransactionId": "000003530991721",
      "merchantAdvice": {
        "code": "",
        "message": ""
      },
      "settlementDate": "2025-04-11T09:42:54.369310+01:00"
    }
  }
}