Sale

Sale

The Sale method charges a credit or debit card.

Arguments

Name Type Description
Credentials MerchantCredentials A MerchantCredentials object used to authenticate against Merchantware.
PaymentData PaymentData A PaymentData object containing the payment 
Request SaleRequest A SaleRequest object containing the transactional data used to perform a sale.

Response

A TransactionResponse45 object is returned.

Allowed Payment Data Sources

Reader, Keyed, Vault

Example Keyed SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <Credentials>
            <MerchantName>Zero Inc</MerchantName>
            <MerchantSiteId>00000000</MerchantSiteId>
            <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
         </Credentials>
         <PaymentData>
            <Source>Keyed</Source>
            
            <!--Keyed Fields-->
            <CardNumber>4012000033330026</CardNumber>
            <ExpirationDate>1218</ExpirationDate>
            <CardHolder>John Doe</CardHolder>
            <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
            <AvsZipCode>02110</AvsZipCode>
            <CardVerificationValue>123</CardVerificationValue>
          </PaymentData>
         <Request>
            <Amount>1.05</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>False</ForceDuplicate>
         </Request>
      </Sale>
   </soap:Body>
</soap:Envelope>

Sample Return Packet
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <SaleResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608957</Token>
            <AuthorizationCode>OK775C</AuthorizationCode>
            <TransactionDate>3/14/2016 7:57:22 PM</TransactionDate>
            <Amount>1.05</Amount>
            <RemainingCardBalance/>
            <CardNumber>************0026</CardNumber>
            <Cardholder>John Doe</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>1</ReaderEntryMode>
            <AvsResponse>Y</AvsResponse>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </SaleResult>
      </SaleResponse>
   </soap:Body>
</soap:Envelope>

Example Encrypted Keyed SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <Credentials>
            <MerchantName>Zero Inc</MerchantName>
            <MerchantSiteId>00000000</MerchantSiteId>
            <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
         </Credentials>
         <PaymentData>
            <Source>Keyed</Source>
            
            <!--Keyed Fields-->
            <CardNumber>4012000033330026</CardNumber>
            <ExpirationDate>1218</ExpirationDate>
            <CardHolder>John Doe</CardHolder>
            <AvsStreetAddress>1 Federal Street</AvsStreetAddress>
            <AvsZipCode>02110</AvsZipCode>
            <CardVerificationValue>123</CardVerificationValue>
            <EncryptedKeyedData>02B600C037001C101692;4012********0026=1812:***?*126=09876543210=FDB4CAC2FAF2483D4A68A4195273CFEAB03EDFC6819AD552631AAC0E9A47C4A63B14D241942C38F2A07CAFF696AE6387211133EC62994900580004600216713B03</EncryptedKeyedData>
         </PaymentData>
         <Request>
            <Amount>1.05</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>False</ForceDuplicate>
         </Request>
      </Sale>
   </soap:Body>
</soap:Envelope>

Sample Return Packet
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <SaleResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608957</Token>
            <AuthorizationCode>OK775C</AuthorizationCode>
            <TransactionDate>3/14/2016 7:57:22 PM</TransactionDate>
            <Amount>1.05</Amount>
            <RemainingCardBalance/>
            <CardNumber>************0026</CardNumber>
            <Cardholder>John Doe</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>1</ReaderEntryMode>
            <AvsResponse>Y</AvsResponse>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </SaleResult>
      </SaleResponse>
   </soap:Body>
</soap:Envelope>

Example Swiped Reader SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <Credentials>
            <MerchantName>Zero Inc</MerchantName>
            <MerchantSiteId>00000000</MerchantSiteId>
            <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
         </Credentials>
         <PaymentData>
            <Source>READER</Source>
            
            <!--Reader Fields-->
            <TrackData>%B4012000033330026^TEST CARD/GENIUS^181210054321000000000000000 150 A?;4012000033330026=18121011000012345678?</TrackData>
         </PaymentData>
         <Request>
            <Amount>1.29</Amount>
            <CashbackAmount>0.00</CashbackAmount>
            <SurchargeAmount>0.00</SurchargeAmount>
            <TaxAmount>0.00</TaxAmount>
            <InvoiceNumber>1906</InvoiceNumber>
            <PurchaseOrderNumber>12401</PurchaseOrderNumber>
            <CustomerCode>20</CustomerCode>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>138401</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
            <EnablePartialAuthorization>False</EnablePartialAuthorization>
            <ForceDuplicate>False</ForceDuplicate>
         </Request>
      </Sale>
   </soap:Body>
</soap:Envelope>

Sample Return Packet
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <SaleResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608970</Token>
            <AuthorizationCode>OK820C</AuthorizationCode>
            <TransactionDate>3/14/2016 8:22:23 PM</TransactionDate>
            <Amount>1.29</Amount>
            <RemainingCardBalance/>
            <CardNumber>************0026</CardNumber>
            <Cardholder>TEST CARD/GENIUS</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>2</ReaderEntryMode>
            <AvsResponse/>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </SaleResult>
      </SaleResponse>
   </soap:Body>
</soap:Envelope>

Example Vault SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <Credentials>
            <MerchantName>Zero Inc</MerchantName>
            <MerchantSiteId>00000000</MerchantSiteId>
            <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
         </Credentials>
         <PaymentData>
            <Source>Vault</Source>
            
            <!--Vault Fields-->
            <VaultToken>1000000000002AVGMM7Z</VaultToken>
         </PaymentData>
         <Request>
            <Amount>1.83</Amount>
            <CashbackAmount>0.00</CashbackAmount>
            <SurchargeAmount>0.00</SurchargeAmount>
            <TaxAmount>0.00</TaxAmount>
            <InvoiceNumber>1559</InvoiceNumber>
            <PurchaseOrderNumber>17809</PurchaseOrderNumber>
            <CustomerCode>23</CustomerCode>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>166909</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
            <EnablePartialAuthorization>False</EnablePartialAuthorization>
            <ForceDuplicate>False</ForceDuplicate>
         </Request>
      </Sale>
   </soap:Body>
</soap:Envelope>
Sample Return Packet
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <SaleResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608969</Token>
            <AuthorizationCode>OK818C</AuthorizationCode>
            <TransactionDate>3/14/2016 8:22:13 PM</TransactionDate>
            <Amount>1.83</Amount>
            <CardNumber>************0026</CardNumber>
            <Cardholder>John Doe</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>1</ReaderEntryMode>
            <AvsResponse>Y</AvsResponse>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </SaleResult>
      </SaleResponse>
   </soap:Body>
</soap:Envelope>


Example Healthcare SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <Sale xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <Credentials>
            <MerchantName>Zero Inc</MerchantName>
            <MerchantSiteId>00000000</MerchantSiteId>
            <MerchantKey>00000-00000-00000-00000-00000</MerchantKey>
         </Credentials>
         <PaymentData>
            <Source>Keyed</Source>
            
            <!--Keyed Fields-->
            <CardNumber>4012000033330026</CardNumber>
            <ExpirationDate>0416</ExpirationDate>
            <CardHolder>John Doe</CardHolder>
         </PaymentData>
         <Request>
            <Amount>202.00</Amount>
            <HealthCareAmountDetails>
               <CopayAmount>60.00</CopayAmount>
               <ClinicalAmount>0.00</ClinicalAmount>
               <DentalAmount>0.00</DentalAmount>
               <HealthCareTotalAmount>80.00</HealthCareTotalAmount>
               <PrescriptionAmount>0.00</PrescriptionAmount>
               <VisionAmount>0.00</VisionAmount>
            </HealthCareAmountDetails>
            <InvoiceNumber>1556</InvoiceNumber>
            <PurchaseOrderNumber>17801</PurchaseOrderNumber>
            <CustomerCode>20</CustomerCode>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>166901</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
            <EnablePartialAuthorization>True</EnablePartialAuthorization>
            <ForceDuplicate>False</ForceDuplicate>
         </Request>
      </Sale>
   </soap:Body>
</soap:Envelope>
Sample Return Packet
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Body>
      <SaleResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <SaleResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>609015</Token>
            <AuthorizationCode>OK775C</AuthorizationCode>
            <TransactionDate>3/14/2016 7:57:22 PM</TransactionDate>
            <Amount>1.05</Amount>
            <RemainingCardBalance/>
            <CardNumber>************0026</CardNumber>
            <Cardholder>John Doe</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>1</ReaderEntryMode>
            <AvsResponse>Y</AvsResponse>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </SaleResult>
      </SaleResponse>
   </soap:Body>
</soap:Envelope>