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.

Balance Enquiry

The BalanceInquiry method inquires about balances on a stored value card.

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	BalanceInquiryRequest	A BalanceInquiry object containing the data used to inquire about balances on a stored value card.

Response

A GiftResponse46 is returned.

Example 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>
        <BalanceInquiry 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>;6033590009112245098=64120000000000000?</TrackData>
            </PaymentData>
            <Request>
                <InvoiceNumber>GIFT123</InvoiceNumber>
            </Request>
        </BalanceInquiry>
    </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>
        <BalanceInquiryResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <BalanceInquiryResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <CardNumber>***************5098</CardNumber>
                <ErrorMessage />
                <ExpirationDate>1264</ExpirationDate>
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <ReaderEntryMode>2</ReaderEntryMode>
                <Token>1970169847</Token>
                <TransactionDate>01/22/2020 16:24:34</TransactionDate>
                <Gift>
                    <GiftBalance>256.96</GiftBalance>
                    <RewardsBalance>37.00</RewardsBalance>
                    <RedeemableBalance>293.96</RedeemableBalance>
                </Gift>
                <Loyalty>
                    <PointsBalance>3006</PointsBalance>
                </Loyalty>
            </BalanceInquiryResult>
        </BalanceInquiryResponse>
    </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>
        <BalanceInquiry 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>          
                <CardNumber>6033590009112245098</CardNumber>
            </PaymentData>
            <Request>
                <InvoiceNumber>GIFT123</InvoiceNumber>
            </Request>
        </BalanceInquiry>
    </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>
        <BalanceInquiryResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <BalanceInquiryResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <CardNumber>***************5098</CardNumber>
                <ErrorMessage />
                <ExpirationDate />
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <ReaderEntryMode>1</ReaderEntryMode>
                <Token>1970172834</Token>
                <TransactionDate>01/22/2020 16:27:32</TransactionDate>
                <Gift>
                    <GiftBalance>256.96</GiftBalance>
                    <RewardsBalance>37.00</RewardsBalance>
                    <RedeemableBalance>293.96</RedeemableBalance>
                </Gift>
                <Loyalty>
                    <PointsBalance>3006</PointsBalance>
                </Loyalty>
            </BalanceInquiryResult>
        </BalanceInquiryResponse>
    </soap12:Body>
</soap12:Envelope>