Vault Transactions

Vault Transactions

The vault web service provides payment and processing methods for both credit and debit cards.
 

Service Information

Service Endpoint - https://ps1.merchantware.net/Merchantware/ws/RetailTransaction/v4/Credit.asmx

Methods

Level2SaleVault

The Level2SaleVault web method performs a Purchase Card Level-2 charge on a credit card using payment information stored within the Merchantware Vault.

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.
invoiceNumber string 0-8 The invoice or order number associated with the transaction.
amount string (double) 1-100 The amount of the sale.
vaultToken string 1-40 The token used to identify the payment method within the Merchantware Vault.
customerCode string 0-100 The merchant-defined identifier for the customer involved in the transaction.
poNumber string 0-100 The customer-defined identifier declaring a purchase order for the transaction.
taxAmount string (double) 0-100 The declared tax amount of the transaction.
forceDuplicate string (bool) 0-5 Override duplicate protection and allow the transaction to process normally.
registerNumber string 0-100 The identifier for the register or point of sale device submitting the transaction.
merchantTransactionId string 0-100 The merchant-defined identifier for the transaction.

Return Values

A CreditLevel2Response4 is returned.

Notes

To meet the best qualification level possible when processing commercial cards, you should set the customer code, purchase order number, and tax amount. Omitting any of these values may cause your transactions to downgrade, which increases your Merchant's transaction costs.

The purchase order number is optional, and if left blank, is automatically filled in with the invoice number. However, the customer code is not automatically filled in. The intended usage of a customer code is to cross-reference a customer that the merchant can identify when presented with this code. If the invoice number is sufficient for this, the developer may copy the invoice number into this field. Otherwise, use a better identifier such as your integrating system's identifier for the customer or the customer's name for this field.

The tax amount specifies the amount of tax applied in the transaction, but it is not a charge amount. It is assumed by all processing parties that the tax amount has already been included in the transaction amount.

It is a bad idea to use cardholder data for any portion of the customer code or purchase order number. Card data specified in these fields is not masked or truncated and thus may put your customer at risk.

The forceDuplicate flag may be left blank if desired. Duplicate transaction behavior defaults to what was specified when the merchant's account was boarded.

Any value passed into the vaultToken field is case-insensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/Level2SaleVault
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>
    <Level2SaleVault
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>ZZS8</invoiceNumber>
      <amount>1.08</amount>
      <vaultToken>MWV000000000000000001</vaultToken>
      <customerCode>ref-ABC-Inc</customerCode>
      <poNumber>Invoice2008Sep21</poNumber>
      <taxAmount>.06</taxAmount>
      <forceDuplicate></forceDuplicate>
      <registerNumber></registerNumber>
      <merchantTransactionId></merchantTransactionId>
    </Level2SaleVault>
  </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>
    <Level2SaleVaultResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <Level2SaleVaultResult>
        <Amount>1.18</Amount>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <AuthorizationCode>06911B</AuthorizationCode>
        <AvsResponse></AvsResponse>
        <Cardholder>Discover Test Card</Cardholder>
        <CardNumber>************1117</CardNumber>
        <CardType>1</CardType>
        <CustomerCode>ref-ABC-Inc</CustomerCode>
        <CvResponse></CvResponse>
        <EntryMode>1</EntryMode>
        <ErrorMessage></ErrorMessage>
        <ExtraData></ExtraData>
        <InvoiceNumber>ZZS22</InvoiceNumber>
        <PurchaseOrderNumber>Invoice2008Sep11</PurchaseOrderNumber>
        <TaxAmount>0.07</TaxAmount>
        <Token>981167</Token>
        <TransactionDate>2008-09-19 17:37:13.500</TransactionDate>
        <TransactionType>1</TransactionType>
      </Level2SaleVaultResult>
    </Level2SaleVaultResponse>
  </soap:Body>
</soap:Envelope>

PreAuthorizationVault

The PreAuthorizationVault web method applies an authorization to a credit card using payment information stored within the Merchantware Vault.

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.
invoiceNumber string 0-8 The invoice or order number associated with the transaction.
amount string (double) 1-100 The amount of the sale.
vaultToken string 1-40 The token used to identify the payment method within the Merchantware Vault.
registerNumber string 0-100 The identifier for the register or point of sale device submitting the transaction.
merchantTransactionId string 0-100 The merchant-defined identifier for the transaction.

Return Values

A CreditResponse4 is returned.

Notes

To finish committing a transaction, the token obtained from this method should be used with the PostAuthorization web method. Do not use the ForceSale method to complete transactions, as this will cause downgrades and increased fees.

Any value passed into the vaultToken field is case-in-sensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/PreAuthorizationVault
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>
    <PreAuthorizationVault
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>ZZS20</invoiceNumber>
      <amount>1.20</amount>
      <vaultToken>MWV000000000000000001</vaultToken>
      <registerNumber></registerNumber>
      <merchantTransactionId></merchantTransactionId>
    </PreAuthorizationVault>
  </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>
    <PreAuthorizationVaultResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <PreAuthorizationVaultResult>
        <Amount>5.00</Amount>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <AuthorizationCode>MC0110</AuthorizationCode>
        <AvsResponse></AvsResponse>
        <Cardholder></Cardholder>
        <CardNumber></CardNumber>
        <CardType>0</CardType>
        <CvResponse></CvResponse>
        <EntryMode>0</EntryMode>
        <ErrorMessage></ErrorMessage>
        <ExtraData></ExtraData>
        <InvoiceNumber></InvoiceNumber>
        <Token>1236564</Token>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <TransactionType>7</TransactionType>
      </PreAuthorizationVaultResult>
    </PreAuthorizationVaultResponse>
  </soap:Body>
</soap:Envelope>

SaleVault

The SaleVault web method charges a credit card using payment information stored within the Merchantware Vault.

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.
invoiceNumber string 0-8 The invoice or order number associated with the transaction.
amount string (double) 1-100 The amount of the sale.
vaultToken string 1-40 The token used to identify the payment method within the Merchantware Vault.
forceDuplicate string (bool) 0-5 Override duplicate protection and allow the transaction to process normally.
registerNumber string 0-100 The identifier for the register or point of sale device submitting the transaction.
merchantTransactionId string 0-100 The merchant-defined identifier for the transaction.

Return Values

A CreditResponse4 is returned.

Notes

Any value passed into the vaultToken field is case-insensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/SaleVault
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>
    <SaleVault
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>ZZS20</invoiceNumber>
      <amount>1.20</amount>
      <vaultToken>MWV000000000000000001</vaultToken>
      <forceDuplicate></forceDuplicate>
      <registerNumber></registerNumber>
      <merchantTransactionId></merchantTransactionId>
    </SaleVault>
  </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>
    <SaleVaultResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <SaleVaultResult>
        <Amount>5.00</Amount>
        <ApprovalStatus>APPROVED</ApprovalStatus>
        <AuthorizationCode>MC0110</AuthorizationCode>
        <AvsResponse></AvsResponse>
        <Cardholder></Cardholder>
        <CardNumber></CardNumber>
        <CardType>0</CardType>
        <CvResponse></CvResponse>
        <EntryMode>0</EntryMode>
        <ErrorMessage></ErrorMessage>
        <ExtraData></ExtraData>
        <InvoiceNumber></InvoiceNumber>
        <Token>1236564</Token>
        <TransactionDate>10/10/2008 1:13:55 PM</TransactionDate>
        <TransactionType>7</TransactionType>
      </SaleVaultResult>
    </SaleVaultResponse>
  </soap:Body>
</soap:Envelope>

VaultBoardCredit

The VaultBoardCredit web method stores the payment information for a credit card into the Merchantware Vault using swiped card data.

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 The merchant defined vault token value for the payment method.
trackData string 1-500 The complete track data (all tracks) for the payment card returned from a card reader.
avsStreetAddress string 0-100 The street address associated with the payment card for use in address verification system (AVS) checks.
avsStreetZipCode string 0, 5, or 9 The ZIP Code associated with the payment card for use in address verification system (AVS) checks.

Return Values

A VaultBoardingResponse is returned.

Notes

Data from Track 2 is required for the trackData parameter. However, you may send in the raw swipe, as long as it has not been altered since it was read from the payment card. This method will separate Track 2 data by itself.

The trackData should be unaltered raw swipe data from unencrypted readers or from IDTech, IDTech Enhanced, Magtek encrypted readers.

Merchants can supply their own vault token value if they choose. It a merchant defined vault token isn't supplied, the system will automatically generate one.

Merchant defined tokens are case-insensitive. They can contain any character from A-Z, 0-9, or any of the following special characters: - = _ . , + : { }

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/VaultBoardCredit
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>
    <VaultBoardCredit
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <merchantDefinedToken>CUSTOMER15</merchantDefinedToken>
      <trackData> [magnetic stripe data] </trackData>
      <avsStreetAddress>123 Main Street</avsStreetAddress>
      <avsStreetZipCode>02110</avsStreetZipCode>
    </VaultBoardCredit>
  </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>
    <VaultBoardCreditResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <VaultBoardCreditResult>
        <ErrorCode></ErrorCode>
        <ErrorMessage></ErrorMessage>
        <VaultToken>CUSTOMER15</VaultToken>
      </SaleResult>
    </SaleResponse>
  </soap:Body>
</soap:Envelope>

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 The merchant defined vault token value for the payment method.
referenceNumber string 1-100 The token identifier returned from a previous transaction.

Return Values

A VaultBoardingResponse is returned.

Notes

Merchants can supply their own vault token value if they choose. If a merchant defined vault token isn't supplied, the system will automatically generate one.

Merchant defined tokens are case-insensitive. They can contain any character from A-Z, 0-9, or any of the following special characters: - = _ . , + : { }

Valid transaction references are currently limited to approved 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>
      <merchantDefinedToken>CUSTOMER15</merchantDefinedToken>
      <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>

VaultBoardCreditKeyed

The VaultBoardCreditKeyed web method stores the payment information for a credit card into the Merchantware Vault using keyed card information.

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 The merchant defined vault token value for the payment method.
cardNumber string 13-19 The PAN or card number of the payment card.
expirationDate string 4 The expiration date of the payment card in MMYY format.
cardholder string 0-100 The cardholder name as it appears on the payment card.
avsStreetAddress string 0-100 The street address associated with the payment card for use in address verification system (AVS) checks.
avsStreetZipCode string 0, 5, or 9 The ZIP Code associated with the payment card for use in address verification system (AVS) checks.

Return Values

A VaultBoardingResponse is returned.

Notes

The expiration date should be specified in the form "MMYY", the same ordering as a card holder would physically see on their card. For example, a card expiring in November 2008 would be specified as 1108.

Merchants can supply their own vault token value if they choose. It a merchant defined vault token isn't supplied, the system will automatically generate one.

Merchant defined tokens are case-insensitive. They can contain any character from A-Z, 0-9, or any of the following special characters: - = _ . , + : { }

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/VaultBoardCreditKeyed
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>
    <VaultBoardCreditKeyed
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <merchantDefinedToken>CUSTOMER15</merchantDefinedToken>
      <cardNumber>4005550000000019</cardNumber>
      <expirationDate>1208</expirationDate>
      <cardholder>Visa Test Card</cardholder>
      <avsStreetAddress>123 Main Street</avsStreetAddress>
      <avsStreetZipCode>02110</avsStreetZipCode>
    </VaultBoardCreditKeyed>
  </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>
    <VaultBoardCreditKeyedResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <VaultBoardCreditKeyedResult>
        <ErrorCode></ErrorCode>
        <ErrorMessage></ErrorMessage>
        <VaultToken>CUSTOMER15</VaultToken>
      </VaultBoardCreditKeyedResult>
    </VaultBoardCreditKeyedResponse>
  </soap:Body>
</soap:Envelope>

VaultDeleteToken

The VaultDeleteToken web method removes existing payment information from the Merchantware Vault.

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.
vaultToken string 1-40 The token used to identify the payment method within the Merchantware Vault.

Return Values

A VaultBoardingResponse is returned.

Notes

Any value passed into the vaultToken field is case-insensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/VaultDeleteToken
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>
    <VaultDeleteToken
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <invoiceNumber>ZZS20</invoiceNumber>
      <vaultToken>MWV000000000000000001</vaultToken>
    </VaultDeleteToken>
  </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>
    <VaultDeleteTokenResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <VaultDeleteTokenResult>
        <ErrorCode></ErrorCode>
        <ErrorMessage></ErrorMessage>
        <VaultToken>MWV000000000000000001</VaultToken>
      </VaultDeleteTokenResult>
    </VaultDeleteTokenResponse>
  </soap:Body>
</soap:Envelope>

VaultFindPaymentInfo

VaultFindPaymentInfo

The VaultFindPaymentInfo web method retrieves payment information stored in the Merchantware Vault.

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.
vaultToken string 1-40 The token used to identify the payment method within the Merchantware Vault.

Return Values

A VaultPaymentInfoResponse is returned.

Notes

Any returned sensitive information (such as credit card numbers) will be masked and/or truncated.

Any value passed into the vaultToken field is case-insensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Credit/VaultFindPaymentInfo
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>
    <VaultFindPaymentInfo xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <vaultToken>MWV000000000000000000</vaultToken>
    </VaultFindPaymentInfo>
  </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>
    <VaultFindPaymentInfoResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Credit/">
      <VaultFindPaymentInfoResult>
        <AvsStreetAddress>123 Main Street</AvsStreetAddress>
        <AvsZipCode>02110</AvsZipCode>
        <Cardholder>Visa Test Card</Cardholder>
        <CardNumber>4005550000000019</CardNumber>
        <CardType>1</CardType>
        <ErrorMessage></ErrorMessage>
        <ExpirationDate>1208</ExpirationDate>
      </VaultFindPaymentInfoResult>
    </VaultFindPaymentInfoResponse>
  </soap:Body>
</soap:Envelope>

Data Structures

Credit Responses

CreditLevel2Response4

The CreditLevel2Response4 structure encapsulates the results of a retail Merchantware Purchase-Card Level 2 transaction.

Fields

Name Type Description
Amount string (double) The amount of the transaction. If partial authorizations are enabled, this will be the authorized amount and may be different than the requested amount.
ApprovalStatus string The status of the transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
AuthorizationCode string Authorization Code issued by the processor upon receipt of a transaction.
AvsResponse string This is a string describing the result of an AVS lookup.
Cardholder string The Cardholder associated with the payment card used in a transaction.
CardNumber string A string representing the truncated card number of the payment card used in a transaction.
CardType int (CardType) A value from the CardType enumeration indicating the type of payment card used in a transaction.
CustomerCode string This is client-defined string of the reference code declaring the customer involved in the transaction.
CvResponse string A string describing the result of a Card Verification or CVD check.
EntryMode int (POSEntryType) A value from the POSEntryType enumeration indicating the method used to submit a transaction.
ErrorMessage string A message indicating why the transaction could not be processed.
ExtraData string Contains extra information, when applicable.
InvoiceNumber string The invoice or order number associated with the transaction.
PurchaseOrderNumber string This is a client-string declaring the purchase order number for this customer and transaction.
TaxAmount string The declared tax amount of the transaction.
Token string The identifier received by the Merchantware client when a transaction has been issued. This value may be used to lookup a specific transaction in the history log.
TransactionDate string (DateTime, UTC) The date and time when a transaction is issued, in UTC time.
TransactionType int A value from the TransactionType enumeration indicating the type of transaction.

Notes

When an instance of this structure is received from a credit sale, the purchase order number is automatically filled in with a copy of the invoice number if it was not specified.

Card numbers are always truncated when methods return data in this structure. Some items may not be applicable to all applications, such as the AVS and CV response.

ApprovalStatus currently may contain 'APPROVED', 'DECLINED', 'REFERRAL'. In addition, it may have 'DUPLICATE' appended with a comma when it is known that duplicate transactions were the reason for the decline.

Only the value 'APPROVED' will be returned on any approval. It is safe to assume that no charge, refund, or any other action or transfer of value has occurred if you do not receive this return value.

APPROVED

Any of these values and possibly other values may be returned on a decline or other failure.

DECLINED DECLINED,DUPLICATE REFERRAL

A detailed explanation of error status values is available here.

CreditResponse4

The CreditResponse4 structure encapsulates the results of a retail Merchantware transaction.

Fields

Name Type Description
Amount string (double) The amount of the transaction. If partial authorizations are enabled, this will be the authorized amount and may be different than the requested amount.
ApprovalStatus string The status of the transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
AuthorizationCode string Authorization Code issued by the processor upon receipt of a transaction.
AvsResponse string A string describing the result of an AVS lookup.
Cardholder string The Cardholder associated with the payment card used in a transaction.
CardNumber string A string representing the truncated card number of the payment card used in a transaction.
CardType int (CardType) The issuer type of payment card used in a transaction. This value matches up with the CardType enumeration.
CvResponse string A string describing the result of a Card Verification or CVD check.
EntryMode int (POSEntryType) A value from the POSEntryType enumeration indicating the method used to submit a transaction.
ErrorMessage string A message indicating why the transaction could not be processed.
ExtraData string Contains extra information, when applicable.
InvoiceNumber string The invoice or order number associated with the transaction.
Token string The identifier received by the Merchantware client when a transaction has been issued. This value may be used to lookup a specific transaction in the history log.
TransactionDate string (DateTime, UTC) The date and time when a transaction is issued, in UTC time.
TransactionType int The type of transaction, and this value matches up with the TransactionType enumeration.

Notes

Card numbers are always truncated when methods return data in this structure. Some items may not be applicable to all applications, such as the AVS and CV response.

ApprovalStatus currently may contain the values 'APPROVED', 'DECLINED', and 'REFERRAL'. In addition, it may have 'DUPLICATE' appended with a comma; when it is known that duplicate transactions were the reason for the decline. A 'REFERRAL' response indicates that the processor should be contacted for an authorization code or for further instructions regarding balance limits or fraud.

Only the value 'APPROVED' will be returned on any approval. It is safe to assume that no charge, refund, or any other action or transfer of value has occurred if you do not receive this return value.

APPROVED

Any of these values and possibly other values may be returned on a decline or other failure.

DECLINED DECLINED,DUPLICATE REFERRAL

A detailed explanation of error status values is available here.

VaultBoardingResponse

The VaultBoardingResponse structure encapsulates the results of a Merchantware Vault boarding operation.

Fields

Name Type Description
VaultToken string The token used to identify the payment information within the Merchantware Vault.
ErrorCode string An error code associated with any problems that may have occurred when managing the boarding of payment information.
ErrorMessage string A message indicating why the boarding changes for a token failed.

Notes

The error codes returned within the VaultBoardingResponse may either be specific vault errors or may come in the form of transaction errors for validation or any of the miscellaneous errors.

The ErrorCode and ErrorMessage fields do not contain any values if the operation is successful.

References

A VaultBoardingResponse is returned by these web methods:

VaultPaymentInfoResponse

The VaultPaymentInfoResponse structure encapsulates the results of a Merchantware Vault payment information find operation.

Fields

Name Type Description
Cardholder string The owner or cardholder associated with the payment information.
CardNumber string A string representing the truncated card number of the payment card.
CardType int (CardType) A value from the CardType enumeration indicating the type of payment card.
ExpirationDate string The expiration date of the payment card in MMYY format.
ErrorCode string An error code associated with any problems that may have occurred during the retrieval of payment information.
ErrorMessage string A message indicating why the retrieval of payment information failed.

Notes

A detailed explanation of error status values is available here.

References

A VaultPaymentInfoResponse is returned by these web methods: