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.

Refund

The Refund method issues a credit card refund to a customer.

Arguments

Name	Type	Description
Credentials	MerchantCredentials	A MerchantCredentials object used to authenticate against Merchantware.
PaymentData	PaymentData	A PaymentData object containing the payment details of the card used to process the transaction.
Request	RefundRequest	A RefundRequest object containing the transactional data used to perform a refund.

Response

A TransactionResponse46 object is returned.

Allowed Payment Data Sources

Reader, Keyed, Vault, PreviousTransaction

Notes

Credit refunds can be partial and are specified by the amount parameter.
The lookup can only be performed using the token from a previous transaction.

This method issues a refund to a credit or debit card from a prior sale transaction. While it is possible to set a custom amount, this method is limited to the original amount of the sale transaction by default. It is possible to enable an override on a per account basis so that refunds for higher than the original amount can be made. No on-hand credit card information is required to use this method.

For example, with a prior sale for $10.00, you may reuse the token from that sale transaction to issue refunds up until the original total has been met, whether all at once ($10.00) or over several transactions ($5.00, $3.00, $2.00). Unless the account has had refunds for higher than the original amount enabled.

This method is useful in cases where you need to return money to a credit card and you have already batched the original sale. Using this method allows you to better support your customers without having to store card data.

If the original sale has not been batched yet, it is better to void the sale to return money or undo a transaction, as this will prevent activity at the processor and avoid incurring transaction fees.

Example Keyed SOAP Request

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>
        <Refund xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>KEYED</Source>
                <CardNumber>4012000033330026</CardNumber>
                <ExpirationDate>0820</ExpirationDate>
                <CardHolder>John Doe</CardHolder>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>REF123</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Refund>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet

<?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>
        <RefundResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <RefundResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971262333</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 2:57:36 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard>False</FsaCard>
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
            </RefundResult>
        </RefundResponse>
    </soap12:Body>
</soap12:Envelope>

Example Encrypted Keyed SOAP Request

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>
        <Refund xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>KEYED</Source>
                <EncryptedKeyedData>02A00085000000000519B9F8AF611ED7FC811A01E8AE7B8BE6B17A2D6B6BF51C6FD49D8BCDEB5B5288FC155CC95CDEBD8461F6A388BE10872FA55A60D62C0432303130053330333037629949144C002620002C787403</EncryptedKeyedData>
                <CardHolder>John Doe</CardHolder>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>REF123</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Refund>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet

<?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>
        <RefundResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <RefundResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971264603</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:01:33 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard>False</FsaCard>
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
            </RefundResult>
        </RefundResponse>
    </soap12:Body>
</soap12:Envelope>

Example Previous Transaction SOAP Request

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>
        <Refund xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>PREVIOUSTRANSACTION</Source>
                <Token>1971226796</Token>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>REF123</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Refund>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet

<?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>
        <RefundResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <RefundResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971266443</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:04:18 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber />
                <Cardholder />
                <CardType>4</CardType>
                <FsaCard>False</FsaCard>
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
            </RefundResult>
        </RefundResponse>
    </soap12:Body>
</soap12:Envelope>

Example Swiped Reader SOAP Request

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>
        <Refund xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>READER</Source>
                <TrackData>TRACKDATA</TrackData>
                <CardHolder>John Doe</CardHolder>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>REF123</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Refund>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet

<Need to generate>

Example Vault SOAP Request

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>
        <Refund xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>VAULT</Source>
                <VaultToken>100000101RT3C3AZNTGX</VaultToken>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>REF123</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoredCardReason>Unscheduledcit</StoredCardReason>
            </Request>
        </Refund>
    </soap12:Body>
</soap12:Envelope>

Sample Return Packet

<?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>
        <RefundResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <RefundResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971281119</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:25:51 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>TEST CARD/GENIUS</Cardholder>
                <CardType>4</CardType>
                <FsaCard>False</FsaCard>
                <ReaderEntryMode>8</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin />
            </RefundResult>
        </RefundResponse>
    </soap12:Body>
</soap12:Envelope>

Refund | Global Payments

Policies

Connect

Additional Resources

Refund

Arguments

Response

Allowed Payment Data Sources

Notes

Example Keyed SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Encrypted Keyed SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Previous Transaction SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Swiped Reader SOAP Request

Sample Request Packet (raw)

Sample Return Packet

Example Vault SOAP Request

Sample Request Packet (raw)

Sample Return Packet