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.

Sale | Global Payments

Sale

The Sale method withdraws from a card's stored dollar value.

Arguments

Name	Type	Description
Credentials	MerchantCredentials	A MerchantCredentials object used to authenticate against Merchantware.
PaymentData	GiftPaymentData	A PaymentData object containing the payment details of the card used to process the transaction.
Request	GiftSaleRequest	A Sale object containing the data used to withdraw from a card's stored dollar value.

Response

A GiftResponse46 is returned.

Example Reader SOAP Request w/ Partial Approval

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>
        <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>READER</Source>           
                <TrackData>%1234567890123456^GIFTCARD/TEST^00000000000000000?;1234567890123456=00000000000000000?</TrackData>
            </PaymentData>
            <Request>
                <Amount>1.29</Amount>
                <InvoiceNumber>Transaction1000</InvoiceNumber>
                <EnablePartialAuthorization>True</EnablePartialAuthorization>
                <MerchantTransactionId>a1234</MerchantTransactionId>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <ResponseMessage>928061</ResponseMessage>
                <Token>MC0110</Token>
                <InvoiceNumber>Transaction1000</InvoiceNumber>
                <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
                <ExpirationDate>080729</ExpirationDate>
                <CardNumber>***********3456</CardNumber>
                <ReaderEntryMode>2</ReaderEntryMode>
                <Gift>
                    <ApprovedAmount>1.00</ApprovedAmount>
                    <RequestedAmount>1.29</RequestedAmount>
                    <RedeemableBalance>100.00</RedeemableBalance>
                </Gift>
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

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>
        <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>KEYED</Source>
                <GiftCardPin>1234</GiftCardPin>
                <CardNumber>6033590009112245098</CardNumber>
            </PaymentData>
            <Request>
                <Amount>10.00</Amount>
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <EnablePartialAuthorization></EnablePartialAuthorization>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CustomerEmailAddress>na@yahoo.com</CustomerEmailAddress>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <ResponseMessage>928061</ResponseMessage>
                <Token>MC0110</Token>
                <InvoiceNumber>Transaction1000</InvoiceNumber>
                <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
                <ExpirationDate>080729</ExpirationDate>
                <CardNumber>***********3456</CardNumber>
                <ReaderEntryMode>1</ReaderEntryMode>
                <Gift>
                    <ApprovedAmount>10.00</ApprovedAmount>
                    <RequestedAmount>10.00</RequestedAmount>
                    <RedeemableBalance>100.00</RedeemableBalance>
                </Gift>
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Policies

Connect

Additional Resources

Sale

Arguments

Response

Example Reader SOAP Request w/ Partial Approval

Sample Request Packet (raw)

Sample Return Packet (raw)

Example Keyed SOAP Request

Sample Request Packet (raw)

Sample Return Packet (raw)