Authorize

Authorize

The Authorize web method applies an authorization to a credit card which can be captured at a later time.

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 AuthorizationRequest An AuthorizationRequest object containing the transactional data used to create the authorization.

Response

A TransactionResponse45 object is returned.

Allowed Payment Data Sources

Reader, Keyed, Vault

Notes

To finish committing a transaction, the token obtained from this method should be used with the Capture web method.

Example Keyed SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <Authorize 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>
            <InvoiceNumber>1556</InvoiceNumber>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>167901</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
         </Request>
      </Authorize>
   </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>
      <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <AuthorizeResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608958</Token>
            <AuthorizationCode>OK785C</AuthorizationCode>
            <TransactionDate>3/14/2016 7:58:33 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>
         </AuthorizeResult>
      </AuthorizeResponse>
   </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>
      <Authorize 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</EncrptedKeyedData>
         </PaymentData>
         <Request>
            <Amount>1.05</Amount>
            <InvoiceNumber>1556</InvoiceNumber>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>167901</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
         </Request>
      </Authorize>
   </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>
      <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <AuthorizeResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608958</Token>
            <AuthorizationCode>OK785C</AuthorizationCode>
            <TransactionDate>3/14/2016 7:58:33 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>
         </AuthorizeResult>
      </AuthorizeResponse>
   </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>
      <Authorize 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>2.74</Amount>
            <InvoiceNumber>1264</InvoiceNumber>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>137149</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
         </Request>
      </Authorize>
   </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>
      <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <AuthorizeResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608959</Token>
            <AuthorizationCode>OK788C</AuthorizationCode>
            <TransactionDate>3/14/2016 7:59:58 PM</TransactionDate>
            <Amount>2.74</Amount>
            <RemainingCardBalance/>
            <CardNumber>************0026</CardNumber>
            <Cardholder>TEST CARD/GENIUS</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>2</ReaderEntryMode>
            <AvsResponse/>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </AuthorizeResult>
      </AuthorizeResponse>
   </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>
      <Authorize 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>2.05</Amount>
            <InvoiceNumber>1558</InvoiceNumber>
            <RegisterNumber>35</RegisterNumber>
            <MerchantTransactionId>167903</MerchantTransactionId>
            <CardAcceptorTerminalId>3</CardAcceptorTerminalId>
         </Request>
      </Authorize>
   </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>
      <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <AuthorizeResult>
            <ApprovalStatus>APPROVED</ApprovalStatus>
            <Token>608960</Token>
            <AuthorizationCode>OK790C</AuthorizationCode>
            <TransactionDate>3/14/2016 8:02:00 PM</TransactionDate>
            <Amount>2.05</Amount>
            <CardNumber>************0026</CardNumber>
            <Cardholder>John Doe</Cardholder>
            <CardType>4</CardType>
            <FsaCard/>
            <ReaderEntryMode>1</ReaderEntryMode>
            <AvsResponse>Y</AvsResponse>
            <CvResponse/>
            <ErrorMessage/>
            <ExtraData/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </AuthorizeResult>
      </AuthorizeResponse>
   </soap:Body>
</soap:Envelope>