Void
Cancel a transaction that has been authorised, but not captured.
Void a transaction
Request example
Use the following request to void a captured transaction.
{
"merchant": "MERCHANT-1",
"site": "SITE-1",
"merchantTransactionId": "TRANSACTION-2",
"merchantTransactionDate": "2025-01-27T08:51:02.826Z",
"amounts": {
"transaction": 24.99
},
"operation": "Void"
}
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 Void operations, this should match the original transaction value. |
operation string required | The type of modification that you want to make. Set this to Void . Possible values:
|
Response example
If your request is successful, you'll receive a 200
request containing a new systemTransactionId
and an updated state
. You'll also receive a Transaction (Card Cancelled) webhook notification.
{
"state": "Cancelled",
"stateData": {},
"approvalCode": "515378",
"merchantTransactionDate": "2025-03-27T10:38:43.708Z",
"merchantTransactionId": "430e6a5d-eb60-48c3-97a8-d6ee15644543",
"systemTransactionId": "b58c50c5-e86b-4376-af81-ad36a245a2af",
"fundingData": {
"cardScheme": "MasterCard",
"primaryAccountNumber": "526600******0075",
"expiryMonth": "12",
"expiryYear": "2031",
"gatewayTokenId": "5fbd77ce-02c1-40ed-94bc-1016660b7512",
"providerResponse": {
"provider": "pxpfinancial",
"code": "00",
"electronicCommerceIndicatorAdjustment": "07",
"merchantAdvice": {},
"authorisedAmount": 0
},
"processorTransactionId": "33f6bdb3-b39b-46f3-a4b0-eb00afc69e48"
}
}
Updated about 1 month ago