VaultBoardCreditByReference

VaultBoardCreditByReference

The VaultBoardCreditByReference web method stores the payment information for a credit card into the Merchantware Vault associated with a prior transaction.

Arguments

Name Type Size Description
merchantName string 1-160 The name of the business or organization owning the Merchantware account.
merchantSiteId string 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
merchantKey string 1-160 The software key or password for the site accessing a Merchantware account.
merchantDefinedToken string 0-40 This value is no longer supported.
referenceNumber string 1-100 The token identifier returned from a previous transaction.

Return Values

A VaultBoardingResponse is returned.

Notes

Merchant defined tokens are no longer supported. If you wish to use this feature please contact the Integrations team. 

Valid transaction references are currently limited to credit sales and pre-authorizations. Also, these transactions must have been conducted with an entry mode of keyed or swiped.

Transaction references for debit transacitons are not currently supported by this function.

Transaction references for proximity transactions are not currently supported by this funciton. Due to how some forms of proximity payments such as Apple Pay are processed, the reference is not valid for vault boarding. 

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/VaultBoardCreditByReference
Sample Request Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <VaultBoardCreditByReference
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <referenceNumber>164682</referenceNumber>
    </VaultBoardCreditByReference>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <VaultBoardCreditByReferenceResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <VaultBoardCreditByReferenceResult>
        <ErrorCode></ErrorCode>
        <ErrorMessage></ErrorMessage>
        <VaultToken>CUSTOMER15</VaultToken>
      <VaultBoardCreditByReferenceResult>
    <VaultBoardCreditByReferenceResponse>
  </soap:Body>
</soap:Envelope>