BoardCard

BoardCard

The BoardCard method stored payment information for a credit card into the Merchantware Vault.

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 BoardingRequest A BoardingRequest object containing the transactional data used to board a card.

Response

A VaultBoardingResponse45 object is returned.

Allowed Payment Data Sources

Reader, Keyed, PreviousTransaction

Notes

Merchant Defined Tokens are no longer supported. If you require use of this feature please contact the Integraion team.

Example Keyed SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <BoardCard 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>
         </PaymentData>
      </BoardCard>
   </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>
      <BoardCardResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <BoardCardResult>
            <VaultToken>1000000000002WSZECPL</VaultToken>
            <ErrorCode/>
            <ErrorMessage/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </BoardCardResult>
      </BoardCardResponse>
   </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>
      <BoardCard 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>
            <EncryptedKeyedData>02B600C037001C101692;4012********0026=1812:***?*126=09876543210=FDB4CAC2FAF2483D4A68A4195273CFEAB03EDFC6819AD552631AAC0E9A47C4A63B14D241942C38F2A07CAFF696AE6387211133EC62994900580004600216713B03</EncrptedKeyedData>
         </PaymentData>
      </BoardCard>
   </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>
      <BoardCardResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <BoardCardResult>
            <VaultToken>1000000000002WSZECPL</VaultToken>
            <ErrorCode/>
            <ErrorMessage/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </BoardCardResult>
      </BoardCardResponse>
   </soap:Body>
</soap:Envelope>

Example Previous Transaction SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <BoardCard 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>PreviousTransaction</Source>

            <!--Previous Transaction Field-->
            <Token>608937</Token>
         </PaymentData>
      </BoardCard>
   </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>
      <BoardCardResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <BoardCardResult>
            <VaultToken>138JK7U40X02WSZECPL</VaultToken>
            <ErrorCode/>
            <ErrorMessage/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </BoardCardResult>
      </BoardCardResponse>
   </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>
      <BoardCard 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>
      </BoardCard>
   </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>
      <BoardCardResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <BoardCardResult>
            <VaultToken>127MMEIIQVEW2WSZECPL</VaultToken>
            <ErrorCode/>
            <ErrorMessage/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </BoardCardResult>
      </BoardCardResponse>
   </soap:Body>
</soap:Envelope>

Example Custom Token SOAP Request

Sample Request Packet (raw)
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
   <soap:Body>
      <BoardCard 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>
         </PaymentData>
         <Request>
            <MerchantDefinedToken>MYTOKENVALUEX</MerchantDefinedToken>
         </Request>         
      </BoardCard>
   </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>
      <BoardCardResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/v45/">
         <BoardCardResult>
            <VaultToken>MYTOKENVALUEX</VaultToken>
            <ErrorCode/>
            <ErrorMessage/>
            <Rfmiq>10000ABCDE</Rfmiq>
         </BoardCardResult>
      </BoardCardResponse>
   </soap:Body>
</soap:Envelope>