Transaction Processing

Home/ Genius / Transaction Processing / Retrieve Transaction Details

Retrieve Transaction Details

The DetailsByTransportKey web service method allows the Point of Sale developers to send in the original TransportKey and request additional payment information at a later time.

Content-Type: text/xml; charset=utf-8
SOAPAction: http://schemas.merchantwarehouse.com/genius/10/Reporting/DetailsByTransportKey
Reporting Endpoint https://genius.merchantware.net/v1/Reporting.asmx

Request Parameters

Name Type Size Description
Name String 1-160 The name of the business or organization owning the Merchantware account.
SiteID String 8-160 The site identifier of a location or storefront owned by the Merchantware account owner.
Key String 1-160 The software key or password for the site accessing a Merchantware account.
TransportKey String 1-160 The unique key generated using the createTransaction method.

Response Parameters

Name Type Description
Status String The Status of the transaction, whether approved or declined. This value may also have other definitions depending on CardType and context.
ErrorMessage String A message indicating why the transaction could not be processed.
TotalAmountApproved String The amount of the transaction that was approved. If partial authorizations are enabled, this will be the authorized amount and may be different than the requested amount.
RequestedAmount String The requested amount of the transaction.
ResponseType String SINGLE, MULTI or COMPOUND. Typical credit, debit and EBT payment types will return SINGLE as the ResponseType. MULTI or COMPOUND response types are returned for additional payment types such as gift and loyalty.
Payment Details PaymentDetail Collection of detail objects for the transaction processed. If more than one payment type was processed to complete the transaction, each sub-transaction will be in the collection. For example, if a $100 transaction is processed using a $30 gift card and $70 credit card transaction, there will be a payment detail for each one within the payment details object.
ReportingInvoice Object An optional field that specifies various data for level three processing-rates.
AdditionalResponseParameters Object    
  • FsaCard – Can be True if customer uses FSA Card or False if the customer does not use an FSA Card.
  • <EbtDetails><EbtType>SNAP</EbtType><FnsId>222222222</FnsId><Balances><CashAvailableBalance>12.00</CashAvailableBalance><SnapAvailableBalance>30.00</SnapAvailableBalance></Balances></EbtDetails>. <EbtType> can be CASH or SNAP. <FnsId> is shown only when <EbtType> is SNAP.

Examples

Soap Request Example

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <DetailsByTransportKey xmlns="http://schemas.merchantwarehouse.com/genius/10/Reporting">
      <Name>ZERO INC</Name>
      <SiteID>00000000</SiteID>
      <Key>00000-00000-00000-00000-00000</Key>
      <TransportKey>xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx</TransportKey>
    </DetailsByTransportKey>
  </soap12:Body>
</soap12:Envelope>

Soap Response Example

<?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>
    <DetailsByTransportKeyResponse xmlns="http://tempuri.org/">
      <DetailsByTransportKeyResult>
        <Status>UNKNOWN or APPROVED or FAILED or DECLINED or DECLINED_DUPLICATE or REFERRAL</Status>
        <ErrorMessage>string</ErrorMessage>
        <TotalAmountApproved>decimal</TotalAmountApproved>
        <RequestedAmount>decimal</RequestedAmount>
        <ResponseType>UNKNOWN or SINGLE or MULTI or COMPOUND</ResponseType>
        <PaymentDetails>
          <PaymentDetail>
            <PaymentType>UNKNOWN or AMEX or DISCOVER or MASTERCARD or VISA or DEBIT or EBT or EGC or WEX or VOYAGER or JCB or CUP or LU</PaymentType>
            <Status>UNKNOWN or APPROVED or FAILED or DECLINED or DECLINED_DUPLICATE or REFERRAL</Status>
            <ErrorMessage>string</ErrorMessage>
            <TransactionType>UNKNOWN or SALE or REFUND or AUTHORIZATION</TransactionType>
            <Token>string</Token>
            <AuthorizationCode>string</AuthorizationCode>
            <Customer>string</Customer>
            <Email>string</Email>
            <PhoneNumber>string</PhoneNumber>
            <AccountNumber>string</AccountNumber>
            <ExpirationDate>string</ExpirationDate>
            <EntryMode>UNKNOWN or MANUAL or SWIPE or AUTHORIZATION or PROXIMITY or BARCODE</EntryMode>
            <TransactionDate>dateTime</TransactionDate>
            <AmountDetail>
                <AmountApproved>30.00</AmountApproved>
                <AmountCharged>0</AmountCharged>
                <TaxAmount>1.88</TaxAmount>
                <TipAmount>2.50</TipAmount>
                <UserTipAmount>2.50</UserTipAmount>
                <DiscountAmount>4.00</DiscountAmount>
                <VoucherAmount>1.00</VoucherAmount>
                <RemainingCardBalance>100.00</RemainingCardBalance>
            </AmountDetail>
            <SignatureDetail>
                <SignatureType>VECTOR</SignatureType>
                <Signature>10,10^110,110^0,65535^10,110^110,10^0,65535^~</Signature>
            </SignatureDetail>
            <GiftDetail>
                <Balance>25.35</Balance>
            </GiftDetail>
            <LoyaltyDetail>
                <Visits>25</Visits>
                <LastVisit>2011-07-02T00:00:00</LastVisit>
                <LifetimeSpend>560.33</LifetimeSpend>
                <Balance>144</Balance>
            </LoyaltyDetail>
            <AdditionalResponseParameters>
                <FsaCard>false</FsaCard>
                <EbtDetails>
                    <EbtType>SNAP</EbtType>
                    <FnsId>222222222</FnsId>
                    <Balances>
                        <CashAvailableBalance>12.00</CashAvailableBalance>
                        <SnapAvailableBalance>30.00</SnapAvailableBalance>
                    </Balances>
                </EbtDetails>
            </AdditionalResponseParameters>
          </PaymentDetail>
        </PaymentDetails>
      <Invoice>
        <TaxIndicator>Provided</TaxIndicator>
            <ProductDescription>Misc Goods</ProductDescription>
            <DiscountAmount>1.01</DiscountAmount>
            <ShippingAmount>1.02</ShippingAmount>
            <DutyAmount>1.03</DutyAmount>
            <DestinationPostalCode>06033</DestinationPostalCode>
            <DestinationCountryCode>840</DestinationCountryCode>
            <ShipFromPostalCode>01887</ShipFromPostalCode>
            <LineItems>
               <LineItem>
                  <CommodityCode>030</CommodityCode>
                  <Description>Misc Good</Description>
                  <Upc>012345678901</Upc>
                  <Quantity>5.1</Quantity>
                  <UnitOfMeasure>lbs</UnitOfMeasure>
                  <UnitCost>0.60</UnitCost>
                  <DiscountAmount>0.61</DiscountAmount>
                  <TotalAmount>0.62</TotalAmount>
                  <TaxAmount>0.63</TaxAmount>
                  <ExtendedAmount>0.64</ExtendedAmount>
                  <DebitOrCreditIndicator>Credit</DebitOrCreditIndicator>
                  <NetOrGrossIndicator>Gross</NetOrGrossIndicator>
               </LineItem>
               <LineItem>
                  <CommodityCode>031</CommodityCode>
                  <Description>Misc Good 2</Description>
                  <Upc>012345678901</Upc>
                  <Quantity>5.1</Quantity>
                  <UnitOfMeasure>lbs</UnitOfMeasure>
                  <UnitCost>0.60</UnitCost>
                  <DiscountAmount>0.61</DiscountAmount>
                  <TotalAmount>0.62</TotalAmount>
                  <TaxAmount>0.63</TaxAmount>
                  <ExtendedAmount>0.64</ExtendedAmount>
                  <DebitOrCreditIndicator>Credit</DebitOrCreditIndicator>
                  <NetOrGrossIndicator>Gross</NetOrGrossIndicator>
               </LineItem>
            </LineItems>
         </Invoice>
        <AdditionalResponseParameters />
      </DetailsByTransportKeyResult>
    </DetailsByTransportKeyResponse>
  </soap:Body>
</soap:Envelope>