On This Page

Void a Payment

This section describes how to void a payment that was submitted but not yet processed by the processor. A payment is also known as a sale, which is an authorization and capture in one API request. Include the payment ID in the void request endpoint to cancel the payment.

Endpoint

Production:

POST https://api.cybersource.com/pts/v2/payments/{id}
/voids

Test:

POST https://apitest.cybersource.com/pts/v2/payments/{id}
/voids

The

{id}

is the transaction ID returned in the sale response.

Required Fields for Voiding a Payment

clientReferenceInformation.code

REST Example: Voiding a Payment

Request

{
    "clientReferenceInformation": {
        "code": "123456789012"
    }
}

Response to a Successful Request

{
    "submitTimeUtc": "2025-03-11T16:39:30Z",
    "processorInformation": {
        "approvalCode": "OK1272",
        "responseCode": "000"
    },
    "consumerAuthenticationResponse": {
        "systemTraceAuditNumber": "500036"
    },
    "orderInformation": {
        "amountDetails": {
            "authorizedAmount": "110.00"
        }
    },
    "message": "Successful transaction.",
    "clientReferenceInformation": {
        "code": "123456789012"
    },
    "reconciliationId": "000000050000771",
    "id": "7417111702443232235535",
    "_links": {
        "self": {
            "method": "GET",
            "href": "/pts/v2/voids/7417111702443232235535"
        }
    },
    "status": "VOIDED"
}