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

Required Fields for Voiding a Payment

merchantID
merchantReferenceCode
voidService_voidRequestID: Set this field to the request ID that was included in the sale response message.
voidService_run: Set the value to
true
.

Simple Order Example: Void a Payment

Request

<requestMessage>
    <merchantID>Napa Valley Vacations</merchantID>
    <merchantReferenceCode>482046C3A7E94F5</merchantReferenceCode>
    <voidService run="true">
        <voidRequestID>098123456789</voidRequestID>
    </voidService>
</requestMessage>

Response to a Successful Request

<c:replyMessage>
    <c:requestID>0305782650000167905080</c:requestID>
    <c:decision>ACCEPT</c:decision>
    <c:reasonCode>100</c:reasonCode>
    <c:merchantReferenceCode>482046C3A7E94F5</c:merchantReferenceCode>
    <c:voidReply>
        <c:reconciliationID>ABCDE12345FGHIJ67890</c:reconciliationID>
        <c:reasonCode>100</c:reasonCode>
        <c:amount>100.00</c:amount>
        <c:currency>USD</c:currency>
    </c:voidReply>
</c:replyMessage>