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.

Add Value

The Add Value method adds value to 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	AddValueRequest	An Add Value object containing the data used to add value to 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>
        <AddValue 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>
                <Amount>3.00</Amount>
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CustomerEmailAddress>na@yahoo.com</CustomerEmailAddress>
            </Request>
        </AddValue>
    </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>
        <AddValueResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <AddValueResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <CardNumber>***************5098</CardNumber>
                <ErrorMessage />
                <ExpirationDate>1264</ExpirationDate>
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <ReaderEntryMode>2</ReaderEntryMode>
                <ResponseMessage>00GMJO</ResponseMessage>
                <Token>1970164239</Token>
                <TransactionDate>01/22/2020 16:18:53</TransactionDate>
                <Gift>
                    <ApprovedAmount>3.00</ApprovedAmount>
                    <RequestedAmount>3.00</RequestedAmount>
                    <RedeemableBalance>253.96</RedeemableBalance>
                </Gift>
                <CustomerEmailAddress>na@yahoo.com</CustomerEmailAddress>
            </AddValueResult>
        </AddValueResponse>
    </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>
        <AddValue 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>
                <Amount>3.00</Amount>
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CustomerEmailAddress>na@yahoo.com</CustomerEmailAddress>
            </Request>
        </AddValue>
    </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>
        <AddValueResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/46/Giftcard">
            <AddValueResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <CardNumber>***************5098</CardNumber>
                <ErrorMessage />
                <ExpirationDate />
                <InvoiceNumber>GIFT123</InvoiceNumber>
                <ReaderEntryMode>1</ReaderEntryMode>
                <ResponseMessage>00GMJP</ResponseMessage>
                <Token>1970165895</Token>
                <TransactionDate>01/22/2020 16:20:38</TransactionDate>
                <Gift>
                    <ApprovedAmount>3.00</ApprovedAmount>
                    <RequestedAmount>3.00</RequestedAmount>
                    <RedeemableBalance>256.96</RedeemableBalance>
                </Gift>
                <CustomerEmailAddress>na@yahoo.com</CustomerEmailAddress>
            </AddValueResult>
        </AddValueResponse>
    </soap12:Body>
</soap12:Envelope>