For AI agents: the complete documentation index is at /llms.txt, and the full text of every page is at /llms-full.txt. Most pages are also available as Markdown by adding .md to the URL.

Void

The Void method voids a prior transaction.

For more guidance, see our Best Practices guide on Void Failure Handling.

Arguments

Name	Type	Description
Credentials	MerchantCredentials	A MerchantCredentials object used to authenticate against Merchantware.
Request	GiftVoidRequest	A gift void object containing the transactional data used to void a previous transaction.

Response

A GiftResponse46 is returned.

Example SOAP Request using a Token

Sample Request Packet (raw)

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <Void xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <Request>
                <Token>1970177862</Token>
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
            </Request>
        </Void>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet (raw)

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
    <soap12:Body>
        <VoidResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <VoidResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <CardNumber />
                <ErrorMessage />
                <ExpirationDate />
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <ReaderEntryMode>1</ReaderEntryMode>
                <ResponseMessage>00GMJR</ResponseMessage>
                <Token>1970198881</Token>
                <TransactionDate>01/22/2020 16:51:38</TransactionDate>
                <Gift>
                    <RedeemableBalance>283.96</RedeemableBalance>
                </Gift>
                <Loyalty>
                    <PointsBalance />
                </Loyalty>
                <CustomerEmailAddress>na@yahoo.com</CustomerEmailAddress>
            </VoidResult>
        </VoidResponse>
    </soap12:Body>
</soap12:Envelope>

Policies

Connect