Bar Tab Technical Details

Authorization Request

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

Authorization Request
Method Name	Authorize Web Method
Arguments	MerchantCredentials - A MerchantCredentials object used to authenticate against Merchantware PaymentData - A PaymentData object containing the payment details of the card used to process the transaction AuthorizationRequest - An AuthorizationRequest object containing the transactional data used to create the authorization
Allowed Payment Data Sources	Reader, Keyed, Vault, Wallet
Notes	To finish committing a transaction, the token obtained from this method should be used with the Capture web method. Contact the brand and follow their rules for incrementing the amount of an authorization. For example, the amount of an authorization for American Express cannot be incremented. The Genius gateway does not validate the merchant's category code (MCC) or enforce the threshold limits of incrementing the amount of an authorization
Response	A `TransactionResponse46` object is returned

Example Keyed Authorization

Sample SOAP Request Packet - Keyed Authorization

<?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> <Authorize 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>5.00</Amount> <InvoiceNumber>CREDIT12</InvoiceNumber> <RegisterNumber>1</RegisterNumber> <MerchantTransactionId>TRX123</MerchantTransactionId> <CardAcceptorTerminalId>32</CardAcceptorTerminalId> <StoreCardInVault>False</StoreCardInVault> </Request> </Authorize> </soap12:Body> </soap12:Envelope>

Sample Return Packet - Keyed Authorization

<?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> <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <AuthorizeResult> <ApprovalStatus>APPROVED</ApprovalStatus> <Token>1971223817</Token> <AuthorizationCode>OK9999</AuthorizationCode> <TransactionDate>1/23/2020 1:15:24 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 /> <CardBin /> <Rfmiq>10000003WM</Rfmiq> <DebitTraceNumber /> <CardBin /> </AuthorizeResult> </AuthorizeResponse> </soap12:Body> </soap12:Envelope>]

Example Card on File Authorization

Sample Vault SOAP Request Packet - Card on File

<?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> <Authorize 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>100000101RT2T38BUABU</VaultToken> </PaymentData> <Request> <Amount>15.00</Amount> <InvoiceNumber>CREDIT12</InvoiceNumber> <RegisterNumber>1</RegisterNumber> <MerchantTransactionId>TRX123</MerchantTransactionId> <CardAcceptorTerminalId>32</CardAcceptorTerminalId> <StoredCardReason>Unscheduledmit</StoredCardReason> </Request> </Authorize> </soap12:Body> </soap12:Envelope>

Sample Return Packet - Card on File

<?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> <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <AuthorizeResult> <ApprovalStatus>APPROVED</ApprovalStatus> <Token>1971226912</Token> <AuthorizationCode>OK9999</AuthorizationCode> <TransactionDate>1/23/2020 1:28:10 PM</TransactionDate> <Amount>15.00</Amount> <RemainingCardBalance /> <CardNumber>**0026</CardNumber> <Cardholder>John Doe</Cardholder> <CardType>4</CardType> <FsaCard /> <ReaderEntryMode>8</ReaderEntryMode> <AvsResponse /> <CvResponse /> <ErrorMessage /> <ExtraData /> <Rfmiq>10000003WM</Rfmiq> <DebitTraceNumber /> <CardBin /> </AuthorizeResult> </AuthorizeResponse> </soap12:Body> </soap12:Envelope>

Example Wallets Authorization

Sample Encrypted Request Packet - Wallets

Nota

Amount is not included in the AuthorizeRequest object for Apple Pay. It is part of the EncryptedPaymentData.

<?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> <Authorize 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>100000101RT2T38BUABU</WalletId> <EncryptedPaymentData>ew0KCSJ2ZXJzaW9uIjogIkVDX3YxIiwNCgkiZ</EncryptedPaymentData> </PaymentData> <Request> <InvoiceNumber>CREDIT12</InvoiceNumber> <RegisterNumber>1</RegisterNumber> <MerchantTransactionId>TRX123</MerchantTransactionId> <CardAcceptorTerminalId>32</CardAcceptorTerminalId> </Request> </Authorize> </soap12:Body> </soap12:Envelope>

Sample Return Packet - Wallets

<?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> <AuthorizeResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <AuthorizeResult> <ApprovalStatus>APPROVED</ApprovalStatus> <Token>1971321455</Token> <AuthorizationCode>OK9999</AuthorizationCode> <TransactionDate>1/23/2020 4:12:02 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 /> </AuthorizeResult> </AuthorizeResponse> </soap12:Body> </soap12:Envelope>

CaptureWeb Method

The CaptureWeb Method completes a transaction for a prior authorization.

Authorization Request
Method Name	CaptureWeb Method
Arguments	MerchantCredentials - A MerchantCredentials object used to authenticate against Merchantware CaptureRequest - A CaptureRequest object containing the transactional data used capture a previous authorization and place it into the batch
Notes	This method captures a previous authorization and adds it to the current batch for settlement. The Void Method cancels a transaction created with the Capture Method up until it has been batched.
Response	A `TransactionResponse46` object is returned

Sample SOAP Request Packet - Final Payment

<?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> <Capture xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <Credentials> <MerchantName>Zero Inc</MerchantName> <MerchantSiteId>00000000</MerchantSiteId> <MerchantKey>00000-00000-00000-00000-00000</MerchantKey> </Credentials> <Request> <Token>1971238639</Token> <Amount>15.00</Amount> <InvoiceNumber>CREDIT12</InvoiceNumber> <RegisterNumber>1</RegisterNumber> <MerchantTransactionId>TRX123</MerchantTransactionId> <CardAcceptorTerminalId>32</CardAcceptorTerminalId> </Request> </Capture> </soap12:Body> </soap12:Envelope>

Sample Return Packet - Final Payment

<?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> <CaptureResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <CaptureResult> <ApprovalStatus>APPROVED</ApprovalStatus> <Token>1971245925</Token> <AuthorizationCode>OK9999</AuthorizationCode> <TransactionDate>1/23/2020 2:25:30 PM</TransactionDate> <Amount>15.00</Amount> <RemainingCardBalance /> <CardNumber /> <Cardholder /> <CardType>0</CardType> <FsaCard /> <ReaderEntryMode>3</ReaderEntryMode> <AvsResponse /> <CvResponse /> <ErrorMessage /> <ExtraData /> <Rfmiq>10000003WM</Rfmiq> <DebitTraceNumber /> </CaptureResult> </CaptureResponse> </soap12:Body> </soap12:Envelope>

AdjustTip Method

The AdjustTip Method adds or alters the tip amount to a prior transaction.

Authorization Request
Method Name	AdjustTip Method
Arguments	MerchantCredentials - A MerchantCredentials object used to authenticate against Merchantware TipRequest - A TipRequest object containing the transactional data used to perform a tip adjustment.
Notes	The AdjustTip method changes the tip amount to a prior sale in the current batch. It can be be used after the capture method using the token returned from the capture response. It is not possible to adjust the tip of a transaction settled in a previous batch.
Response	A `TransactionResponse46` object is returned

Sample SOAP Request Packet - AdjustTip

<?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> <AdjustTip xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <Credentials> <MerchantName>Zero Inc</MerchantName> <MerchantSiteId>00000000</MerchantSiteId> <MerchantKey>00000-00000-00000-00000-00000</MerchantKey> </Credentials> <Request> <Token>1971219347</Token> <Amount>4.50</Amount> </Request> </AdjustTip> </soap12:Body> </soap12:Envelope>

Sample Return Packet - AdjustTip

<?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> <AdjustTipResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v46/"> <AdjustTipResult> <ApprovalStatus>APPROVED</ApprovalStatus> <Token>1971219433</Token> <AuthorizationCode>OK9999</AuthorizationCode> <TransactionDate>1/23/2020 12:56:46 PM</TransactionDate> <Amount /> <RemainingCardBalance /> <CardNumber /> <Cardholder /> <CardType>0</CardType> <FsaCard /> <ReaderEntryMode>0</ReaderEntryMode> <AvsResponse /> <CvResponse /> <ErrorMessage /> <ExtraData /> <DebitTraceNumber /> </AdjustTipResult> </AdjustTipResponse> </soap12:Body> </soap12:Envelope>

抖阴