Reports

Reporting Transactions

The Reporting web service provides methods for retrieving a merchant's transaction history.

 

Service Information

Service Endpoint - https://ps1.merchantware.net/Merchantware/ws/TransactionHistory/v4/Reporting.asmx

 

Methods

CurrentBatchSummary

The CurrentBatchSummary web method loads a summary of transaction data for the current batch.

This data will reflect all Sale and Refund data. In addition, it will tally the net value of those transactions. Finally, this method only works for transactions that have not been batched and for transactions in the last 24 hours.

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.
cardholderFilter string 0-100 (optional) A substring of a card holder to be used when filtering results.
cardType int (CardType) 0-100 (optional) A card type to be used when filtering results.

Return Values

An array of TransactionSummary4 items is returned. There will be one for each card type in a given period, unless a specific value is given in cardType. If a given card type was not accepted for payment in the given time period, data for that card type will not be returned among the results.

Notes

Unlike other optional parameters in Merchantware, cardType cannot be blank. If you are not going to filter by a given card type, you must pass in a 0 for cardType.

The cardholderFilter parameter will match any portion of a past card holder value, and is case-insensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/CurrentBatchSummary
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>
    <CurrentBatchSummary xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <cardholderFilter>JANE DOE</cardholderFilter>
      <cardType>0</cardType>
    </CurrentBatchSummary>
  </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>
    <CurrentBatchSummaryResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <CurrentBatchSummaryResult>
        <TransactionSummary4>
          <Cardholder>JANE DOE/CHASE AIRMILES PLUS</Cardholder>
          <SaleAmount>5.60</SaleAmount>
          <SaleCount>2</SaleCount>
          <RefundAmount>0.00</RefundAmount>
          <RefundCount>0</RefundCount>
          <NetAmount>5.60</NetAmount>
          <TotalTransactions>2</TotalTransactions>
          <CardType>3</CardType>
        </TransactionSummary4>
        <TransactionSummary4>
          <Cardholder>JANE DOE/AMERICAN EXPRESS</Cardholder>
          <SaleAmount>8.00</SaleAmount>
          <SaleCount>1</SaleCount>
          <RefundAmount>8.00</RefundAmount>
          <RefundCount>1</RefundCount>
          <NetAmount>0.00</NetAmount>
          <TotalTransactions>2</TotalTransactions>
          <CardType>1</CardType>
        </TransactionSummary4>
      </CurrentBatchSummaryResult>
    </CurrentBatchSummaryResponse>
  </soap:Body>
</soap:Envelope>

CurrentBatchTransactions

The CurrentBatchTransactions web method loads all transactions in the last 24 hours that have not been batched.

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.

Return Values

An array of TransactionReference4 items is returned.

Notes

When looking up information on a test account, you may find that this method behaves in a strange manner and may still show transactions that have been batched. When used on live accounts, this method behaves as intended and batched transactions will not show up in your results.

All dates and times in the return data will be set to UTC standard time (GMT).

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/CurrentBatchTransactions
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>
    <CurrentBatchTransactions xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
    </CurrentBatchTransactions>
  </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>
    <CurrentBatchTransactionsResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <CurrentBatchTransactionsResult>
        <TransactionReference4>
          <Token>2980983</Token>
          <InvoiceNumber>s90103</InvoiceNumber>
          <TransactionDate>2008-01-03 15:03:01.158</TransactionDate>
          <ApprovalStatus>APPROVED</ApprovalStatus>
          <Cardholder>JOHN DOE/CAPITALONE</Cardholder>
          <Amount>13.56</Amount>
          <Type>1</Type>
          <CardNumber>************1160</CardNumber>
          <CardType>4</CardType>
          <AuthorizationCode>14087</AuthorizationCode>
          <MerchantTransactionId>DEV101</MerchantTransactionId>
          <BatchNumber>159</BatchNumber>
        </TransactionReference4>
        <TransactionReference4>
          <Token>2980989</Token>
          <InvoiceNumber>r90103</InvoiceNumber>
          <TransactionDate>2008-01-03 15:06:35.981</TransactionDate>
          <ApprovalStatus>APPROVED</ApprovalStatus>
          <Cardholder>JANE DOE/CAPITALONE</Cardholder>
          <Amount>13.56</Amount>
          <Type>2</Type>
          <CardNumber>************9896</CardNumber>
          <CardType>4</CardType>
          <AuthorizationCode>14088</AuthorizationCode>
          <MerchantTransactionId>DEV102</MerchantTransactionId>
          <BatchNumber>159</BatchNumber>
        </TransactionReference4>
      </CurrentBatchTransactionsResult>
    </CurrentBatchTransactionsResponse>
  </soap:Body>
</soap:Envelope>

SummaryByDate

The SummaryByDate web method loads a summary of transaction data based on a specified date and time range.

This data will reflect all Sale and Refund data. In addition, it will tally the net value of those transactions.

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.
startDate DateTime (string, UTC) 10-40 The starting date and time to start searching for transactions.
endDate DateTime (string, UTC) 10-40 The ending date and time to stop searching for transactions.
cardholderFilter string 0-100 (optional) A substring of a card holder to be used when filtering results.
cardType int (CardType) 0-100 (optional) A card type to be used when filtering results.

Return Values

An array of TransactionSummary4 items is returned. There will be one for each card type in a given period, unless a specific value is given in cardType. If a given card type was not accepted for payment in the given time period, data for that card type will not be returned among the results.

Notes

The web service rejects calls where the time span is greater than 1 year (365/366 days).

Unlike other optional parameters in Merchantware, cardType cannot be blank. If you are not going to filter by a given card type, you must pass in a 0 for cardType.

The cardholderFilter parameter will match any portion of a past card holder value, and is case-insensitive.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/SummaryByDate
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>
    <SummaryByDate xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <strStartDate>2008-12-01</strStartDate>
      <strEndDate>2008-12-31</strEndDate>
      <cardholderFilter>REWARDS</cardholderFilter>
      <cardType>0</cardType>
    </SummaryByDate>
  </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>
    <SummaryByDateResponse xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <SummaryByDateResult>
        <TransactionSummary4>
          <Cardholder>CITI REWARDS CARD</Cardholder>
          <SaleAmount>35.00</SaleAmount>
          <SaleCount>3</SaleCount>
          <RefundAmount>15.00</RefundAmount>
          <RefundCount>1</RefundCount>
          <NetAmount>20.00</NetAmount>
          <TotalTransactions>4</TotalTransactions>
          <CardType>4</CardType>
        </TransactionSummary4>
        <TransactionSummary4>
          <Cardholder>RBS REWARDS CARD</Cardholder>
          <SaleAmount>5.00</SaleAmount>
          <SaleCount>1</SaleCount>
          <RefundAmount>0.00</RefundAmount>
          <RefundCount>0</RefundCount>
          <NetAmount>5.00</NetAmount>
          <TotalTransactions>1</TotalTransactions>
          <CardType>3</CardType>
        </TransactionSummary4>
      </SummaryByDateResult>
    </SummaryByDateResponse>
  </soap:Body>
</soap:Envelope>

TransactionsByDate

The TransactionsByDate web method can lookup a set of transactions based on a specified date and time range.

Optionally, you may also lookup transactions in the specified date range sharing a common keyword within the invoice number for each 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.
startDate DateTime (string, UTC) 10-40 The starting date and time to start searching for transactions.
endDate DateTime (string, UTC) 10-40 The ending date and time to stop searching for transactions.
invoiceNumber string 0-100 (optional) A substring of an invoice or order number to be used when searching for results.
registerNumber string 0-100 (optional) A substring of an register number to be used when searching for results.
authorizationCode string 0-100 (optional) An authorization code of transaction used when searching for results.

Return Values

An array of TransactionReference4 is returned.

Notes

The web service rejects calls where the time span is greater than 1 year (365/366 days).

Card numbers are always truncated. It is not possible to retrieve the original Card Number from this method.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/TransactionsByDate
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>
    <TransactionsByDate
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <startDate>2008-05-01T01:00:00</startDate>
      <endDate>2008-06-01T13:00:00</endDate>
      <invoiceNumber>1000</invoiceNumber>
      <registerNumber></registerNumber>
      <authorizationCode></authorizationCode>
    </TransactionsByDate>
  </soap:Body>
</soap:Envelope>
Sample Return Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <TransactionsByDateResponse
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <TransactionsByDateResult>
        <TransactionReference4>
          <Token>302856</Token>
          <InvoiceNumber>10002</InvoiceNumber>
          <TransactionDate>2008-05-09 20:29:52.747</TransactionDate>
          <ApprovalStatus>APPROVED</ApprovalStatus>
          <Cardholder>VISA TEST CARD</Cardholder>
          <Amount>1.02</Amount>
          <Type>3</Type>
          <CardNumber>************0019</CardNumber>
          <CardType>4</CardType>
          <AuthorizationCode>14087</AuthorizationCode>
          <MerchantTransactionId>DEV101</MerchantTransactionId>
          <BatchNumber>159</BatchNumber>
        </TransactionReference4>
        <TransactionReference4>
          <Token>302855</Token>
          <InvoiceNumber>10001</InvoiceNumber>
          <TransactionDate>2008-05-09 20:29:49.123</TransactionDate>
          <ApprovalStatus>APPROVED</ApprovalStatus>
          <Cardholder>MASTERCARD TEST CARD</Cardholder>
          <Amount>1.01</Amount>
          <Type>1</Type>
          <CardNumber>************3003</CardNumber>
          <CardType>3</CardType>
          <AuthorizationCode>14088</AuthorizationCode>
          <MerchantTransactionId>DEV102</MerchantTransactionId>
          <BatchNumber>159</BatchNumber>
        </TransactionReference4>
      </TransactionsByDateResult>
    </TransactionsByDateResponse>
  </soap:Body>
</soap:Envelope>

TransactionsByReference

The TransactionsByReference web method can lookup specific transactions based on the token assigned by Merchantware.

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.
token string 1-100 The token identifier returned from a previous transaction.

Return Values

An array of TransactionReference4 is returned.

Notes

The reference ID is usually a number, but may have other forms depending on the card and transaction type. Avoid making the assumption that it is always a number.

Card numbers are always truncated. It is not possible to retrieve the original card number from this method.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/TransactionsByReference
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>
    <TransactionsByReference
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <token>375814</token>
    </TransactionsByReference>
  </soap:Body>
</soap:Envelope>
Sample Response Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <TransactionsByReferenceResponse
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <TransactionsByReferenceResult>
        <TransactionReference4>
          <Token>375814</Token>
          <InvoiceNumber>9980</InvoiceNumber>
          <TransactionDate>2008-04-22 20:11:28.217</TransactionDate>
          <ApprovalStatus>DECLINED</ApprovalStatus>
          <Cardholder>John Doe</Cardholder>
          <Amount>1.06</Amount>
          <Type>1</Type>
          <CardNumber>************1117</CardNumber>
          <CardType>2</CardType>
          <AuthorizationCode>14087</AuthorizationCode>
          <MerchantTransactionId>DEV101</MerchantTransactionId>
          <BatchNumber>159</BatchNumber>
        </TransactionReference4>
      </TransactionsByReferenceResult>
    </TransactionsByReferenceResponse>
  </soap:Body>
</soap:Envelope>

TransactionsByTransactionId

The TransactionsByTransactionID web method can lookup specific transactions based on the Merchant provided Transaction ID.

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.
merchantTransactionId string 1-50 The Transaction ID provided by the Merchant in a previous transaction.

Return Values

An array of TransactionReference4 is returned.

Notes

The Transaction ID must in the same form as provided by Merchant in a previous transaction. The value cannot be empty and should be between 1 and 50 in length

Card numbers are always truncated. It is not possible to retrieve the original card number from this method.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/TransactionsByTransactionId
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>
    <TransactionsByTransactionID
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <merchantTransactionId>448254125</merchantTransactionId>
    </TransactionsByTransactionId>
  </soap:Body>
</soap:Envelope>
Sample Response Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <TransactionsByTransactionIdResponse
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <TransactionsByTransactionIdResult>
        <TransactionReference4>
          <Amount>1.06</Amount>
          <ApprovalStatus>DECLINED</ApprovalStatus>
          <AuthorizationCode>14087</AuthorizationCode>
          <Cardholder>John Doe</Cardholder>
          <CardNumber>************1117</CardNumber>
          <CardType>2</CardType>
          <ErrorMessage></ErrorMessage>
          <InvoiceNumber>9980</InvoiceNumber>
          <MerchantTransactionId>448254125</MerchantTransactionId>
          <Token>375814</Token>
          <TransactionDate>2008-04-22 20:11:28.217</TransactionDate>
          <TransactionType>1</TransactionType>
        </TransactionReference4>
      </TransactionsByReferenceResult>
    </TransactionsByTransactionIdResponse>
  </soap:Body>
</soap:Envelope>

DetailedTransactionByReference

DetailedTransactionByReference

The DetailedTransactionByReference web method can lookup detailed information about a specific transaction based on the token assigned by Merchantware.

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.
token string 1-100 The token identifier returned from a previous transaction.

Return Values

A DetailedTransactionReference4 along with a SupportedActions is returned.

For an EMV transaction an Emv is returned.

If there are Health Care Amounts in the transaction data a HealthCareAmountDetails is returned.

Notes

The token is usually a number, but may have other forms depending on the card and transaction type. Avoid making the assumption that it is always a number.

Card numbers are always truncated. It is not possible to retrieve the original card number from this method.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/DetailedTransactionByReference
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>
    <DetailedTransactionByReference
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <token>375814</token>
    </DetailedTransactionByReference>
  </soap:Body>
</soap:Envelope>
Sample Response Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <DetailedTransactionByReferenceResponse
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <DetailedTransactionByReferenceResult>
        <ApprovalCode></ApprovalCode>
        <ApprovalStatus>DECLINED</ApprovalStatus>
        <AuthorizationAmount>5.00</AuthorizationAmount>
        <AvsResponse></AvsResponse>
        <BatchNumber></BatchNumber>
        <Cardholder>John Doe</Cardholder>
        <CashBackAmount>1.00</CashBackAmount>
        <CardNumber>************1117</CardNumber>
        <CardType>2</CardType>
        <ConvenienceAmount>1.00</ConvenienceAmount>
        <CustomerId></CustomerId>
        <CvvResponse></CvvResponse>
        <DiscountAmount></DiscountAmount>
        <ErrorMessage></ErrorMessage>
        <ExpirationDate>1222</ExpirationDate>
        <HostReference>14087</HostReference>
        <InvoiceNumber>9980</InvoiceNumber>
        <IsCardNumberKeyed>true</IsCardNumberKeyed>
        <IsTransactionAdjusted>false</IsTransactionAdjusted>
        <IsTransactionCaptured>false</IsTransactionCaptured>
        <IsTransactionVoided>false</IsTransactionVoided>
        <IsTransactionSettled>false</IsTransactionSettled>
        <MerchantTransactionId>DEV101</MerchantTransactionId>
        <OriginalToken></OriginalToken>
        <PostalCode>02110</PostalCode>
        <PurchaseOrderNumber>101750</PurchaseOrderNumber>
        <RegisterNumber>15</RegisterNumber>
        <StreetAddress>123 Main Street</StreetAddress>
        <SupportedActions>
          <AdjustmentToken></AdjustmentToken>
          <CaptureToken></CaptureToken>
          <EmailReceiptToken>375814</EmailReceiptToken>
          <RefundMaxAmount>5.00</RefundMaxAmount>
          <RefundToken></RefundToken>
          <RepeatSaleToken>375814</RepeatSaleToken>
          <VoidToken></VoidToken>
        </SupportedActions>
        <SurchargeAmount></SurchargeAmount>
        <TaxAmount>0.25</TaxAmount>
        <TipAmount>1.00</TipAmount>
        <Token>375814</Token>
        <TotalAmount>6.00</TotalAmount>
        <TransactionDate>2008-04-22 20:11:28.217</TransactionDate>
        <TransactionType>1</TransactionType>
        <UserName>GWAPITEST</UserName>
        <FsaCard>false</FsaCard>
        <HealthCareAmountDetails>
            <CopayAmount>2.00</CopayAmount>
            <ClinicalAmount>3.00</ClinicalAmount>
            <DentalAmount>1.00</DentalAmount>
            <HealthCareTotalAmount>15.00</HealthCareTotalAmount>
            <PrescriptionAmount>4.00</PrescriptionAmount>
            <VisionAmount>5.00</VisionAmount>
        </HealthCareAmountDetails>
        <Emv>
            <ApplicationInformation>
                <Aid>A0000000031010</Aid>
                <ApplicationLabel>VISA CREDIT</ApplicationLabel>
                <ApplicationExpiryDate>12/31/2022</ApplicationExpiryDate>
                <ApplicationEffectiveDate>01/01/2014</ApplicationEffectiveDate>
                <ApplicationInterchangeProfile>5C00</ApplicationInterchangeProfile>
                <ApplicationVersionNumber>008C</ApplicationVersionNumber>
                <ApplicationTransactionCounter>1680</ApplicationTransactionCounter>
                <ApplicationUsageControl>FF80</ApplicationUsageControl>
                <ApplicationPreferredName>VISA CREDIT 3</ApplicationPreferredName>
                <ApplicationDisplayName>VISA CREDIT 3</ApplicationDisplayName>
            </ApplicationInformation>
            <CardInformation>
                <MaskedPan>XXXXXXXXXXXXXXXX</MaskedPan>
                <PanSequenceNumber>XX</PanSequenceNumber>
                <CardExpiryDate>1222</CardExpiryDate>
            </CardInformation>
            <ApplicationCryptogram>
                <CryptogramType>TC</CryptogramType>               
                <Cryptogram>D4EF490CC3CA74D5</Cryptogram>
            </ApplicationCryptogram>
            <CVMResults>410302</CVMResults>
            <IssuerApplicationData>06020103A40000</IssuerApplicationData>
            <TerminalVerificationResults>0200008000</TerminalVerificationResults>
            <UnpredictableNumber>4B119B92</UnpredictableNumber>
            <Amount>
                <AmountAuthorized>6.00</AmountAuthorized>               
                <AmountOther>0.00</AmountOther>
            </Amount>
            <PosEntryMode>05</PosEntryMode>
            <TerminalInformation>
                <TerminalType>22</TerminalType>
                <IfdSerialNumber>87654321</IfdSerialNumber>
                <TerminalCountryCode>0840</TerminalCountryCode>
                <TerminalID>12345678</TerminalID>
                <TerminalActionCodeDefault>DC4000A800</TerminalActionCodeDefault>
                <TerminalActionCodeDenial>0010000000</TerminalActionCodeDenial>
                <TerminalActionCodeOnline>DC4004F800</TerminalActionCodeOnline>
            </TerminalInformation>
            <TransactionInformation>
                <TransactionType>00</TransactionType>
                <TransactionCurrencyCode>0840</TransactionCurrencyCode>
                <TransactionStatusInformation>E800</TransactionStatusInformation>
            </TransactionInformation>
            <CryptogramInformationData>40</CryptogramInformationData>
            <PINStatement>PIN VERIFIED</PINStatement>
            <CvmMethod>000000000000000045035E03</CvmMethod>
            <IssuerActionCodeDefault>FC50ECA800</IssuerActionCodeDefault>
            <IssuerActionCodeDenial>0000000000</IssuerActionCodeDenial>
            <IssuerActionCodeOnline>FC50ECA800</IssuerActionCodeOnline>
            <AuthorizationResponseCode>3030</AuthorizationResponseCode>
            <EntryMode>Contact</EntryMode>
        </Emv>
      </DetailedTransactionByReferenceResult>
    </DetailedTransactionByReferenceResponse>
  </soap:Body>
</soap:Envelope>

DetailedTransactionByTransactionId

DetailedTransactionByTransactionId

The DetailedTransactionByReference web method can lookup detailed information about a specific transaction based on the token assigned by Merchantware.

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.
merchantTransactionId string 1-50 The Transaction ID provided by the Merchant in a previous transaction.

Return Values

A DetailedTransactionReference4 along with a SupportedActions is returned.

For an EMV transaction an Emv is returned.

If there are Health Care Amounts in the transaction data a HealthCareAmountDetails is returned.

Notes

The token is usually a number, but may have other forms depending on the card and transaction type. Avoid making the assumption that it is always a number.

Card numbers are always truncated. It is not possible to retrieve the original card number from this method.

SOAP Information

SOAPAction
http://schemas.merchantwarehouse.com/merchantware/40/Reports/TransactionsByTransactionId
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>
    <DetailedTransactionByTransactionId
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <merchantName>Zero Inc.</merchantName>
      <merchantSiteId>00000000</merchantSiteId>
      <merchantKey>00000-00000-00000-00000-00000</merchantKey>
      <merchantTransactionId>448254125</token>
    </DetailedTransactionByTransactionId>
  </soap:Body>
</soap:Envelope>
Sample Response Packet (raw)
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <DetailedTransactionByTransactionIdResponse
     xmlns="http://schemas.merchantwarehouse.com/merchantware/40/Reports/">
      <DetailedTransactionByReferenceResult>
        <ApprovalCode></ApprovalCode>
        <ApprovalStatus>DECLINED</ApprovalStatus>
        <AuthorizationAmount>5.00</AuthorizationAmount>
        <AvsResponse></AvsResponse>
        <BatchNumber></BatchNumber>
        <Cardholder>John Doe</Cardholder>
        <CashBackAmount>1.00</CashBackAmount>
        <CardNumber>************1117</CardNumber>
        <CardType>2</CardType>
        <ConvenienceAmount>1.00</ConvenienceAmount>
        <CustomerId></CustomerId>
        <CvvResponse></CvvResponse>
        <DiscountAmount></DiscountAmount>
        <ErrorMessage></ErrorMessage>
        <ExpirationDate>1215</ExpirationDate>
        <HostReference>14087</HostReference>
        <InvoiceNumber>9980</InvoiceNumber>
        <IsCardNumberKeyed>true</IsCardNumberKeyed>
        <IsTransactionAdjusted>false</IsTransactionAdjusted>
        <IsTransactionCaptured>false</IsTransactionCaptured>
        <IsTransactionVoided>false</IsTransactionVoided>
        <IsTransactionSettled>false</IsTransactionSettled>
        <MerchantTransactionId>DEV101</MerchantTransactionId>
        <OriginalToken></OriginalToken>
        <PostalCode>02110</PostalCode>
        <PurchaseOrderNumber>101750</PurchaseOrderNumber>
        <RegisterNumber>15</RegisterNumber>
        <StreetAddress>123 Main Street</StreetAddress>
        <SupportedActions>
          <AdjustmentToken></AdjustmentToken>
          <CaptureToken></CaptureToken>
          <EmailReceiptToken>375814</EmailReceiptToken>
          <RefundMaxAmount>5.00</RefundMaxAmount>
          <RefundToken></RefundToken>
          <RepeatSaleToken>375814</RepeatSaleToken>
          <VoidToken></VoidToken>
        </SupportedActions>
        <SurchargeAmount></SurchargeAmount>
        <TaxAmount>0.25</TaxAmount>
        <TipAmount>1.00</TipAmount>
        <Token>375814</Token>
        <TotalAmount>6.00</TotalAmount>
        <TransactionDate>2008-04-22 20:11:28.217</TransactionDate>
        <TransactionType>1</TransactionType>
        <UserName>GWAPITEST</UserName>
        <FsaCard>false</FsaCard>
        <HealthCareAmountDetails>
            <CopayAmount>2.00</CopayAmount>
            <ClinicalAmount>3.00</ClinicalAmount>
            <DentalAmount>1.00</DentalAmount>
            <HealthCareTotalAmount>15.00</HealthCareTotalAmount>
            <PrescriptionAmount>4.00</PrescriptionAmount>
            <VisionAmount>5.00</VisionAmount>
        </HealthCareAmountDetails>
        <Emv>
            <ApplicationInformation>
                <Aid>A0000000031010</Aid>
                <ApplicationLabel>VISA CREDIT</ApplicationLabel>
                <ApplicationExpiryDate>12/31/2022</ApplicationExpiryDate>
                <ApplicationEffectiveDate>01/01/2014</ApplicationEffectiveDate>
                <ApplicationInterchangeProfile>5C00</ApplicationInterchangeProfile>
                <ApplicationVersionNumber>008C</ApplicationVersionNumber>
                <ApplicationTransactionCounter>1680</ApplicationTransactionCounter>
                <ApplicationUsageControl>FF80</ApplicationUsageControl>
                <ApplicationPreferredName>VISA CREDIT 3</ApplicationPreferredName>
                <ApplicationDisplayName>VISA CREDIT 3</ApplicationDisplayName>
            </ApplicationInformation>
            <CardInformation>
                <MaskedPan>XXXXXXXXXXXXXXXX</MaskedPan>
                <PanSequenceNumber>XX</PanSequenceNumber>
                <CardExpiryDate>1222</CardExpiryDate>
            </CardInformation>
            <ApplicationCryptogram>
                <CryptogramType>TC</CryptogramType>               
                <Cryptogram>D4EF490CC3CA74D5</Cryptogram>
            </ApplicationCryptogram>
            <CVMResults>410302</CVMResults>
            <IssuerApplicationData>06020103A40000</IssuerApplicationData>
            <TerminalVerificationResults>0200008000</TerminalVerificationResults>
            <UnpredictableNumber>4B119B92</UnpredictableNumber>
            <Amount>
                <AmountAuthorized>6.00</AmountAuthorized>               
                <AmountOther>0.00</AmountOther>
            </Amount>
            <PosEntryMode>05</PosEntryMode>
            <TerminalInformation>
                <TerminalType>22</TerminalType>
                <IfdSerialNumber>87654321</IfdSerialNumber>
                <TerminalCountryCode>0840</TerminalCountryCode>
                <TerminalID>12345678</TerminalID>
                <TerminalActionCodeDefault>DC4000A800</TerminalActionCodeDefault>
                <TerminalActionCodeDenial>0010000000</TerminalActionCodeDenial>
                <TerminalActionCodeOnline>DC4004F800</TerminalActionCodeOnline>
            </TerminalInformation>
            <TerminalInformation>
                <TransactionType>00</TransactionType>
                <TransactionCurrencyCode>0840</TransactionCurrencyCode>
                <TransactionStatusInformation>E800</TransactionStatusInformation>
            </TerminalInformation>
            <CryptogramInformationData>40</CryptogramInformationData>
            <PINStatement>PIN VERIFIED</PINStatement>
            <CvmMethod>000000000000000045035E03</CvmMethod>
            <IssuerActionCodeDefault>FC50ECA800</IssuerActionCodeDefault>
            <IssuerActionCodeDenial>0000000000</IssuerActionCodeDenial>
            <IssuerActionCodeOnline>FC50ECA800</IssuerActionCodeOnline>
            <AuthorizationResponseCode>3030</AuthorizationResponseCode>
            <EntryMode>Contact</EntryMode>
        </Emv>
      </DetailedTransactionByReferenceResult>
    </DetailedTransactionByReferenceResponse>
  </soap:Body>
</soap:Envelope>

Data Structures

DetailedTransactionReference4

The DetailedTransactionReference4 structure encapsulates detailed information about a Merchantware transaction record.

Fields

Name Type Description
ApprovalCode string The approval code returned by the server.
ApprovalStatus string The status of a prior transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
AuthorizationAmount string (double) The original amount authorized for the transaction.
AvsResponse string The string describing the result of an SVS lookup.
BatchNumber string The batch number the transaction belongs to.
Cardholder string The Cardholder associated with the payment card used in a transaction.
CashBackAmount string (double) The amount the customer requested as cash back from the transaction.
CardNumber string This is 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.
ConvenienceAmount string (double) The amount charged to the customer for performing the transaction.
CustomerId string The merchant-defined identification number for the customer.
CvResponse string A string describing the result of a Card Verification or CVD check.
DiscountAmount string (double) The amount discounted on the original transaction by the merchant.
ErrorMessage string A message indicating why the transaction could not be processed.
ExpirationDate string The expiration date of the payment card in MMYY format.
HostReference string Authorization Code issued by the processor upon receipt of a transaction.
InvoiceNumber string The InvoiceNumber is the invoice or order number associated with the transaction.
IsCardNumberKeyed boolean A true or false value indicating wheither the card number was keyed manually.
IsTransactionAdjusted boolean A true or false value indicating wheither the transaction was adjusted from its original amount.
IsTransactionCaptured boolean A true or false value indicating wheither the transaction was was captured or not in the case of a pre-authorization.
IsTransactionVoided boolean A true or false value indicating wheither the transaction was voided.
IsTransactionSettled boolean A true or false value indicating wheither the transaction is settled.
MerchantTransactionId string The merchant-defined identification number for the transaction..
OriginalToken string The token identifier for the originiating transaction referenced by the current transaction. This value may be used to lookup a specific transaction in the history log.
PostalCode string The ZIP Code associated with the payment card for use in address verification system (AVS) checks.
PurchaseOrderNumber string The PurchaseOrderNumber is the invoice or order number associated with the transaction.
RegisterNumber string The identifier for the register or point of sale device submitting the transaction.
SupportedActions SupportedActions The supported actions allowed for the current or originating transaction.
SurchargeAmount string (double) Any additional amount charged to the customer.
TaxAmount string (double) The declared tax amount of the transaction.
TipAmount string (double) The declared tip amount of the transaction.
Token string The Token is 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.
TotalAmount string (double) The total amount of the transaction. If partial authorizations are enabled, this will be the authorized amount and may be different than the requested amount.
TransactionDate string (DateTime, UTC) The date and time when a transaction was received, in UTC time.
TransactionType int (TransactionType) The type of transaction, and this value matches up with the TransactionType enumeration.
UserName string The user name for the account that executed the transaction.
FsaCard boolean true or false value indicating wheither the card processed was an FSA card.
HealthCareAmountDetails HealthCareAmountDetails The HealthCareAmountDetails structure provides fields to specify healthcare amounts for health-based cards, such as Flex Spending Accounts.
Emv Emv The Emv Details structure provides fields specific to EMV transactions
EntryMode string Indicates entry mode of the transaction

Notes

Card numbers are always truncated when data is returned in this structure.

It is possible for transactions to be missing from the history, but only those transactions where a failure occurred before the processor could be contacted will be missing.

References

A DetailedTransactionReference4 is returned by these web methods.

Emv

The Emv structure provides fields specific to EMV transactions.

Fields

Name Type Description
ApplicationInformation ApplicationInformation The Emv Application Information Details structure provides fields specific to Application Information in EMV transactions
CardInformation CardInformation The Emv Card Information Details structure provides fields specific to Card Information in EMV transactions
ApplicationCryptogram ApplicationCryptogram The Emv Application Cryptogram Details structure provides fields specific to Cryptogram Information in EMV transactions
CVMResults string Indicates the results of the last CVM performed.
IssuerApplicationData string Contains proprietary application data for transmission to the issuer in an online transaction.
TerminalVerificationResults string Status of the various functions as seen from the terminal.
UnpredictableNumber string Value to provide variability and uniqueness to the generation of a cryptogram.
Amount Amount The Emv Amount Information Details structure provides fields specific to Amounts in EMV transactions
PosEntryMode string Indicates the method by which the PAN was entered.
TerminalInformation TerminalInformation The Emv Terminal Information Details structure provides fields specific to Terminal Information in EMV transactions
TransactionInformation TransactionInformation The Emv Transaction Information Details structure provides fields specific to Transaction Information in EMV transactions
CryptogramInformationData string Indicates the type of cryptogram and the actions to be performed by the terminal.
PINStatement string Statement to signify is PIN is verified or PIN is locked.
CvmMethod string Identifies a method of verification of the cardholder supported by the application.
IssuerActionCodeDefault string Specifies the issuer's conditions that cause a transaction to be rejected if it might have been approved online, but the terminal is unable to process the transaction online.
IssuerActionCodeDenial string Specifies the issuer's conditions that cause the denial of a transaction without attempt to go online.
IssuerActionCodeOnline string Specifies the issuer's conditions that cause a transaction to be transmitted online.
AuthorizationResponseCode string Code that defines the disposition of a message.

References

An Emv data structure is returned by these web methods.

HealthCareAmountDetails

The HealthCareAmountDetails structure provides fields to specify healthcare amounts for health-based cards, such as flex spending accounts.

Fields

Name Type Description
HealthCareTotalAmount string (double) The total amount of the transaction that represents eligible healthcare charges.
ClinicalAmount string (double) The portion of the healthcare total that represents clinical charges.
CopayAmount string (double) The portion of the healthcare total that represents a copayment.
DentalAmount string (double) The portion of the healthcare total that represents dental charges.
PrescriptionAmount string (double) The portion of the healthcare total that represents prescription charges.
VisionAmount string (double) The portion of the healthcare total that represents vision charges.

References

A HealthCareAmountDetails data structure is returned by these web methods.

SupportedActions

The SupportedActions structure encapsulates detailed information supported actions allowed for a transaction and its originating transaction.

Fields

NameTypeDescription
AdjustmentTokenstringThe token identifier recommended to use for performing a tip adjustment.
CaptureTokenstringThe token identifier recommended to use for a post-authorization on an existing pre-authorization.
EmailReceiptTokenstringThe token identifier recommended to use when emailing the customer a receipt for the transaction.
RefundMaxAmountstring (double)The maximum amount allowed and remaining that can be refunded for a sale transaction.
RepeatSaleTokenstringThe token identifier recommended to use for performing a repeat sale.
VoidTokenstringThe token identifier recommended to use for voiding the transaction.

Notes

When it is not possible to perform an action, a blank value or a 0 value indicates that it is not possible to perform the action on the transaction.

References

A SupportedActions data structure is returned by these web methods.

TransactionReference4

The TransactionReference4 structure encapsulates a Merchantware transaction record.

Fields

Name Type Description
Token string The Token is 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.
InvoiceNumber string The InvoiceNumber is the invoice or order number associated with the transaction.
TransactionDate string (DateTime, UTC) The date and time when a transaction was received, in UTC time.
ApprovalStatus string The status of a prior transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
Cardholder string The Cardholder associated with the payment card used in a transaction.
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.
TransactionType int (TransactionType) The type of transaction, and this value matches up with the TransactionType enumeration.
CardNumber string This is 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.
AuthorizationCode string The authorization code of the transaction.
MerchantTransactionId string The merchant-defined identification number for the transaction..
BatchNumber string The batch number the transaction belongs to.

Notes

Card numbers are always truncated when data is returned in this structure.

It is possible for transactions to be missing from the history, but only those transactions, where a failure occurred before the processor could be contacted, will be missing.

References

A TransactionReference4 is returned by these web methods.

TransactionSummary4

The TransactionSummary4 structure encapsulates a summary of a set of Merchantware transaction records.

Fields

Name Type Description
Cardholder string The Cardholder associated with the payment card used in a transaction.
SaleAmount string (decimal) This is total amount of sale transactions.
SaleCount int The total number of sale transactions.
RefundAmount string (decimal) This is total amount of refund transactions.
RefundCount int The total number of refund transactions.
NetAmount string (decimal) This is net amount of all transactions.
TotalTransactions int The total number of all transactions.
CardType int (CardType) The issuer type of payment card used in a transaction. This value matches up with the CardType enumeration.

Notes

It is possible for transactions to be missing from the history, but only those transactions, where a failure occurred before the processor could be contacted, will be missing.

Voided transactions will not show up in this structure.

References

A TransactionSummary4 is returned by these web methods.