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

The Sale method charges a credit or debit card.

Important: There is a pre-existing SurchargeAmount property in MerchantWare 4.6 for a Sale request. You should not use this property as MerchantWare 4.6 calculates the surcharge amount based on your merchant account settings. If you submit a Sale transaction that meets the eligibility rules (US-issued credit card and surcharging enabled on your merchant account), and the transaction request contains the SurchargeAmount property, the transaction will fail and return with the error Invalid SurchargeAmount value.

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	SaleRequest	A SaleRequest object containing the transactional data used to perform a sale.

Response

A TransactionResponse46 object is returned.

Allowed Payment Data Sources

Reader, Keyed, Vault, Wallet

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/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>KEYED</Source>
                <CardNumber>************</CardNumber>
                <ExpirationDate>1226</ExpirationDate>
                <CardHolder>Test</CardHolder>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>NotPresent</CardPresence>
            </PaymentData>
            <Request>
                <Amount>10.00</Amount>
                <CashbackAmount>0</CashbackAmount>
                <TaxAmount>0</TaxAmount>
                <InvoiceNumber>123</InvoiceNumber>
                <PurchaseOrderNumber>43043</PurchaseOrderNumber>
                <CustomerCode>4092</CustomerCode>
                <CardAcceptorTerminalId>42</CardAcceptorTerminalId>
                <ForceDuplicate>False</ForceDuplicate>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ExtensionPoint>59f1ebd8e37c7j</ExtensionPoint>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971287926</Token>
                <AuthorizationCode>TAS928</AuthorizationCode>
                <TransactionDate>9/18/2024 1:34:15 PM</TransactionDate>
                <Amount>10.30</Amount>
                <RemainingCardBalance />
                <CardNumber>****************</CardNumber>
                <Cardholder>Test</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <SurchargeAmount>0.30</SurchargeAmount>
            </SaleResult>
        </SaleResponse>
    </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>
        <Sale 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>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoreCardInVault>False</StoreCardInVault>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971292279</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:40:08 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </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>
        <Sale 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>
            </PaymentData>
            <Request>
                <Amount>5.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoreCardInVault>False</StoreCardInVault>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971294634</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:42:53 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>TEST CARD/GENIUS</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>2</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

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>
        <Sale 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>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoredCardReason>Unscheduledmit</StoredCardReason>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971296981</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:45:33 PM</TransactionDate>
                <Amount>5.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>TEST CARD/GENIUS</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>8</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Example Healthcare 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/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>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>100.00</Amount>
                <HealthCareAmountDetails>
                    <CopayAmount>0.00</CopayAmount>
                    <ClinicalAmount>100.00</ClinicalAmount>
                    <DentalAmount>0.00</DentalAmount>
                    <HealthCareTotalAmount>100.00</HealthCareTotalAmount>
                    <PrescriptionAmount>0.00</PrescriptionAmount>
                    <VisionAmount>0.00</VisionAmount>
                </HealthCareAmountDetails>                
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoreCardInVault>False</StoreCardInVault>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971300475</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:49:43 PM</TransactionDate>
                <Amount>100.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard>False</FsaCard>
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Example Wallet SOAP Request

Note: Amount is not included in the SaleRequest object for Apple Pay. It is part of the EncryptedPaymentData.

Sample Encrypted 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/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>Wallet</Source>
                <WalletId>ApplePay</WalletId>
                <EncryptedPaymentData>ew0KCSJ2ZXJzaW9uIjogIkVDX3YxIiwNCgkiZ</EncryptedPaymentData>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
            </PaymentData>
            <Request>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Sale>
    </soap12:Body>
</soap12:Envelope>

Sample Decrypted 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/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>Wallet</Source>
                <WalletId>ApplePay</WalletId>
                <CardNumber>4012000033330026</CardNumber>
                <ExpirationDate>0820</ExpirationDate>
                <CardHolder>John Doe</CardHolder>
                <PaymentCryptogram>9AwEHBG0wawIBAQQgCPSuFr4iSIaQprj</PaymentCryptogram>
                <PaymentCryptogramType>3DS</PaymentCryptogramType>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
            </PaymentData>
            <Request>
                <Amount>150.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971306762</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 3:56:58 PM</TransactionDate>
                <Amount>150.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>7</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Example Level 3 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>
        <Sale 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>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>25.00</Amount>
                <InvoiceNumber>1</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>1000</MerchantTransactionId>
                <CardAcceptorTerminalId>3</CardAcceptorTerminalId>>
                <EnablePartialAuthorization>True</EnablePartialAuthorization>
                <TaxAmount>0.00</TaxAmount>
                <PurchaseOrderNumber>17801</PurchaseOrderNumber>
                <CustomerCode>20</CustomerCode>
                <Invoice>
                    <TaxIndicator>Provided</TaxIndicator>
                    <ProductDescription>Misc Goods</ProductDescription>
                    <DiscountAmount>1.00</DiscountAmount>
                    <ShippingAmount>6.00</ShippingAmount>
                    <DutyAmount>0.00</DutyAmount>
                    <DestinationPostalCode>06033</DestinationPostalCode>
                    <DestinationCountryCode>840</DestinationCountryCode>
                    <ShipFromPostalCode>06030</ShipFromPostalCode>
                    <LineItems>
                        <LineItem>
                            <CommodityCode>030</CommodityCode>
                            <Description>Misc Good</Description>
                            <Upc>012345678901</Upc>
                            <Quantity>2.5</Quantity>
                            <UnitOfMeasure>kg</UnitOfMeasure>
                            <UnitCost>10.00</UnitCost>
                            <DiscountAmount>0.00</DiscountAmount>
                            <TotalAmount>25.00</TotalAmount>
                            <TaxAmount>0.00</TaxAmount>
                            <ExtendedAmount>25.00</ExtendedAmount>
                            <DebitOrCreditIndicator>Credit</DebitOrCreditIndicator>
                            <NetOrGrossIndicator>Gross</NetOrGrossIndicator>
                        </LineItem>
                    </LineItems>
                </Invoice>
                <CustomerEmailAddress>na@email.com</CustomerEmailAddress>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971316939</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 4:07:41 PM</TransactionDate>
                <Amount>25.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
                <Invoice>
                    <TaxIndicator>Provided</TaxIndicator>
                    <ProductDescription>Misc Goods</ProductDescription>
                    <DiscountAmount>1.00</DiscountAmount>
                    <ShippingAmount>6.00</ShippingAmount>
                    <DutyAmount>0.00</DutyAmount>
                    <DestinationPostalCode>06033</DestinationPostalCode>
                    <DestinationCountryCode>840</DestinationCountryCode>
                    <ShipFromPostalCode>06030</ShipFromPostalCode>
                    <LineItems>
                        <LineItem>
                            <CommodityCode>030</CommodityCode>
                            <Description>Misc Good</Description>
                            <Upc>012345678901</Upc>
                            <Quantity>2.5</Quantity>
                            <UnitOfMeasure>kg</UnitOfMeasure>
                            <UnitCost>10.00</UnitCost>
                            <DiscountAmount>0.00</DiscountAmount>
                            <TotalAmount>25.00</TotalAmount>
                            <TaxAmount>0.00</TaxAmount>
                            <ExtendedAmount>25.00</ExtendedAmount>
                            <DebitOrCreditIndicator>Credit</DebitOrCreditIndicator>
                            <NetOrGrossIndicator>Gross</NetOrGrossIndicator>
                        </LineItem>
                    </LineItems>
                </Invoice>
                <CustomerEmailAddress>na@email.com</CustomerEmailAddress>
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Example Initial Store Card 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/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>1220</ExpirationDate>
                <CardHolder>John Doe</CardHolder>
                <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
                <AvsZipCode>02110</AvsZipCode>
                <CardVerificationValue>123</CardVerificationValue>
                <CardPresence>Present</CardPresence>
            </PaymentData>
            <Request>
                <Amount>1.00</Amount>
                <CashbackAmount>0.00</CashbackAmount>
                <SurchargeAmount>0.00</SurchargeAmount>
                <TaxAmount>0.00</TaxAmount>
                <InvoiceNumber>1556</InvoiceNumber>
                <PurchaseOrderNumber>17801</PurchaseOrderNumber>
                <CustomerCode>20</CustomerCode>
                <RegisterNumber>35</RegisterNumber>
                <MerchantTransactionId>166901</MerchantTransactionId>
                <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
                <EnablePartialAuthorization>False</EnablePartialAuthorization>
                <ForceDuplicate>True</ForceDuplicate>
                <StoredCardReason>RECURRING</StoredCardReason>
                <StoreCardInVault>TRUE</StoreCardInVault>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1972689513</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/24/2020 5:19:18 PM</TransactionDate>
                <Amount>1.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>John Doe</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>1</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <DebitTraceNumber />
                <CardBin /> 
                <VaultBoardingResponse>
                    <VaultToken>100000101S2XUEUAIMTA</VaultToken>
                    <ErrorCode />
                    <ErrorMessage />
                </VaultBoardingResponse>
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Example Subsequent Recurring 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/v46/">
            <Credentials>
                <MerchantName>Zero Inc</MerchantName>
                <MerchantSiteId>00000000</MerchantSiteId>
                <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
            </Credentials>
            <PaymentData>
                <Source>VAULT</Source>
                <VaultToken>100000101S2XUEUAIMTA</VaultToken>
            </PaymentData>
            <Request>
                <Amount>10.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoredCardReason>Recurring</StoredCardReason>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971328388</Token>
                <AuthorizationCode>NC1000</AuthorizationCode>
                <TransactionDate>1/23/2020 4:18:27 PM</TransactionDate>
                <Amount>10.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>TEST CARD/GENIUS</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>8</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Example Subsequent Installment 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/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>50.00</Amount>
                <InvoiceNumber>CREDIT12</InvoiceNumber>
                <RegisterNumber>1</RegisterNumber>
                <MerchantTransactionId>TRX123</MerchantTransactionId>
                <CardAcceptorTerminalId>32</CardAcceptorTerminalId>
                <StoredCardReason>Installment</StoredCardReason>
                <BillingSequenceNumber>2</BillingSequenceNumber>
                <BillingSequenceCount>10</BillingSequenceCount>
            </Request>
        </Sale>
    </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>
        <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/">
            <SaleResult>
                <ApprovalStatus>APPROVED</ApprovalStatus>
                <Token>1971325811</Token>
                <AuthorizationCode>OK9999</AuthorizationCode>
                <TransactionDate>1/23/2020 4:16:09 PM</TransactionDate>
                <Amount>50.00</Amount>
                <RemainingCardBalance />
                <CardNumber>************0026</CardNumber>
                <Cardholder>TEST CARD/GENIUS</Cardholder>
                <CardType>4</CardType>
                <FsaCard />
                <ReaderEntryMode>8</ReaderEntryMode>
                <AvsResponse />
                <CvResponse />
                <ErrorMessage />
                <ExtraData />
                <Rfmiq>10000003WM</Rfmiq>
                <DebitTraceNumber />
                <CardBin /> 
            </SaleResult>
        </SaleResponse>
    </soap12:Body>
</soap12:Envelope>

Sale | Global Payments