Radial Integration | 2016

Payments, Tax & Fraud > Payments Processing > Transaction History

Transaction History

Overview

A transaction history call retrieves all transactions that match the search terms sent in the request. Searches can be based on any the following elements:

URI Summary

Action URI Template URI Example Non-URI Request Response
POST /vM.m/stores/[StoreId]/payments/transaction/history.xml /vM.m/stores/TMSUS/payments/
transaction/history.xml		 XML 200 + XML Response containing the list of transactions matching the input criteria

Request Format

The request is a TransactionHistoryRequest message. The message layout depends on the type of search.

By OrderId

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <OrderId>{OrderID}</OrderId>
  </TransactionHistoryRequest>

By TenderType and PaymentAccountUniqueId

<TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="1234">
    <TenderType>{Tender Type}</TenderType>
    <PaymentAccountUniqueId isToken="{true/false}">{PaymentAccountUniqueId}</PaymentAccountUniqueId>
    <FromDateTime>{Date : YYYY-MM-DDTHH:MM:SS}</FromDateTime>
    <ToDateTime>{Date : YYYY-MM-DDTHH:MM:SS}</ToDateTime>
  </TransactionHistoryRequest>

By Gateway Key

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="1234">
    <GatewayKey>{gateway key}</GatewayKey>
  </TransactionHistoryRequest>

By Secondary Gateway Key

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="1234">
    <SecondaryGatewayKey>{SecondaryGatewayKey}</SecondaryGatewayKey>
  </TransactionHistoryRequest>

Request Elements

The elements and attributes for the Transaction History Request vary according to the type of search.

By OrderId

Element Required Description Type Restriction
OrderId Required The order ID of the transactions, as a search term to retrieve a list of transactions. String 20 Characters

By TenderType and PaymentAccountUniqueId

Element Required Description Type Restriction
TenderType Required The tender type of the payment method used for the transactions, as a search term to retrieve a list of transactions. String PrivateLabelCreditCard, CreditCard, StoredValue
PaymentAccountUniqueId Required The PAN of the payment method used for the transaction, as a search term to retrieve a list of transactions. String 22 Characters
isToken Required if PaymentAccountUniqueId is present Is the PaymentAccountUniqueId a token? Boolean true/false
FromDateTime No The beginning of the time frame in which to look up transaction history. DateTime YYYY-MM-DDTHH:MM:SS
ToDateTime No The ending of the time frame in which to look up transaction history. DateTime YYYY-MM-DDTHH:MM:SS

By Gateway Key

Element Required Description Type Restriction
GatewayKey Required The gateway key of the transactions, as a search term to retrieve a list of transactions. String 30 Characters

By Secondary Gateway Key

Element Required Description Type Restriction
SecondaryGatewayKey Required The secondary gateway key of the transactions, as a search term to retrieve a list of transactions. String 16 Characters

Request Examples

The following examples show request messages for different types of searches.

By OrderId

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <OrderId>11111123</OrderId>
  </TransactionHistoryRequest>

By TenderType and PaymentAccountUniqueId

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="1234">
    <TenderType>VC</TenderType>
    <PaymentAccountUniqueId isToken="false">4111111111111111</PaymentAccountUniqueId>
    <FromDateTime>2015-06-01T00:00:00</FromDateTime>
    <ToDateTime>2015-07-01T00:00:00</ToDateTime>
  </TransactionHistoryRequest>

By Gateway Key

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="1234">
    <GatewayKey>12345</GatewayKey>
  </TransactionHistoryRequest>

By Secondary Gateway Key

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <TransactionHistoryRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="1234">
    <SecondaryGatewayKey>4443333</SecondaryGatewayKey>
  </TransactionHistoryRequest>

Response Format

The response is a TransactionHistoryReply message.

<?xml version="1.0" encoding="UTF-8"?>
  <TransactionHistoryReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0" sessionId="{Session Id}">
    <Transactions>
      <PaymentTransaction>
         <PaymentContext>
            <OrderId>{OrderId}</OrderId>
            <PaymentAccountUniqueId isToken="{true/false}">{PaymentAccountUniqueId}</PaymentAccountUniqueId>
         </PaymentContext>
         <TenderType>{TenderType}</TenderType>
         <TransactionType>{Transaction Type}</TransactionType>
         <TransactionStatus>{Transaction Status}</TransactionStatus>
         <TransactionAmount currencyCode="{Currency Code}">{Transaction Amount}</TransactionAmount>
         <ResponseCode>{Response Code}</ResponseCode>
         <GatewayKey>{Gateway Key}</GatewayKey>
         <GatewayResponseCode>{GatewayResponseCode}</GatewayResponseCode>
         <RequestTimestamp>{Timestamp}</RequestTimestamp>
         <ReplyTimestamp>2{Timestamp}</ReplyTimestamp>
         <SecondaryGatewayKey>{SecondaryGatewayKey}</SecondaryGatewayKey>
         <GatewayId>{Gateway Id}</GatewayId>
         <CreditCardTransaction>{CreditCardTransaction}</CreditCardTransaction>
         <SettlementTransaction>{SettlementTransaction}</SettlementTransaction>
         <TransactionHistoryDetail>{TransactionHistoryDetail}</TransactionHistoryDetail>
      </PaymentTransaction>
    </Transactions>
    <extension>{extension}</extension>
  </TransactionHistoryReply>

Response Elements

Element Required Description Type Restriction
Transactions Required The transactions matching the criteria of the request See sub elements  
PaymentTransaction No An individual transaction matching the request criteria See sub elements  
PaymentContext Required The payment context of the transaction See sub elements  
OrderId Required The order ID for the payment context of the transaction String 22 Characters
PaymentAccountUniqueId Required Either a raw PAN or a token representing a PAN String 22 Characters
isToken Required Is the PaymentAccountUniqueId a tokenized value? Boolean true/false
TenderType Required The Tender Type used in the transaction String PrivateLabelCreditCard, CreditCard, StoredValue
TransactionType Required The type of transaction that was performed String  
TransactionStatus No The failure or success status of the transaction String  
TransactionAmount No The amount of the transaction String  
currencyCode Required if Transaction Amount is Present Code identifies the currency for the TransactionAmount String IS-4217 three-letter code
ResponseCode No The Response Code for the transaction String  
GatewayKey No A key value returned by the gateway that processed the transaction String 30 Characters
GatewayResponseCode No A response code returned from the gateway for the transaction String  
RequestTimestamp No The timestamp of when the transactions request was made DateTime YYYY-MM-DDTHH:MM:SS.SSSZ
ReplyTimestamp No The timestamp of when the transactions reply was made DateTime YYYY-MM-DDTHH:MM:SS.SSSZ
SecondaryGatewayKey No A key value returned by the gateway that processed the transaction String 16 Characters
GatewayId No The ID of the gateway that processed the transaction String  
CreditCardTransaction No Information relevant to a Credit Card transaction   See chart below
SettlementTransaction No Information relevant to a settlement transaction   See chart below

CreditCardTransaction Elements

The following elements are subordinate to the CreditCardTransaction element.

Element Required Description Type Restriction
AuthorizedAmount No The amount authorized by the credit card String  
AuthorizationCode No An authorization code returned by the gateway that processed the transaction String  
AuthorizationDate No The date when the authorization was performed, in YYYY-MM-DD format date YYYY-MM-DD
VerbalAuth No Was the authorization performed as a verbal authorization? boolean true/false
AvsResponse No The response code returned by the address verification check String  
Cvv2Response No The response code returned by the CVV verification check String  
CardExpirationDate No The expiration date of the credit card used in the transaction, in YYYY-MM format gYearMonth YYYY-MM

SettlementTransaction Elements

The following elements are subordinate to the SettlementTransaction element.

Element Required Description Type Restriction
TaxAmount No The amount of taxes for the settlement transaction String  
SettlementType No The type of settlement for the transaction String  
SettlementStatus No The settlement status of the transaction String  
SettlementSentDate No The date when the settlement was sent, in YYYY-MM-DD format date YYYY-MM-DD
SettlementConfirmDate No The date when the settlement confirmation was sent, in YYYY-MM-DD format date YYYY-MM-DD
TransactionDate No The date the transaction being settled took place, in YYYY-MM-DD format date YYYY-MM-DD
BusinessDate No The date {fill in} date YYYY-MM-DD
BatchId No The batch ID of the batch the settlement was sent in String  
SettlementConfirmationAmount No The amount actually confirmed and settled on String  
currencyCode Required if Settlement Confirmation Amount is present Code identifies the currency for SettlementConfirmationAmount String IS-4217 three-letter code
ProcessorSettleStatusCode No The status code of the settlement returned by the process provider String  
ProcessorSettleReasonCode No The reason code of the settlement returned by the process provider String  

Response Example

<?xml version="1.0" encoding="UTF-8"?>
<TransactionHistoryReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
   <Transactions>
      <PaymentTransaction>
         <PaymentContext>
            <OrderId>0002610423_s1_3</OrderId>
            <PaymentAccountUniqueId isToken="true">4111110PASeK1111</PaymentAccountUniqueId>
         </PaymentContext>
         <TenderType>VC</TenderType>
         <TransactionType>Credit Card Authorization</TransactionType>
         <TransactionStatus>S</TransactionStatus>
         <TransactionAmount currencyCode="USD">116.87</TransactionAmount>
         <ResponseCode>APPROVED</ResponseCode>
         <GatewayKey>20694</GatewayKey>
         <GatewayResponseCode>100</GatewayResponseCode>
         <RequestTimestamp>2015-06-03T20:40:17.936Z</RequestTimestamp>
         <ReplyTimestamp>2015-06-03T20:40:18.019Z</ReplyTimestamp>
         <SecondaryGatewayKey>-1</SecondaryGatewayKey>
         <GatewayId>COMPASS</GatewayId>
         <CreditCardTransaction>
            <AuthorizationCode>000075</AuthorizationCode>
            <AuthorizationDate>2015-06-03</AuthorizationDate>
            <VerbalAuth>false</VerbalAuth>
            <AvsResponse>M</AvsResponse>
            <Cvv2Response>M</Cvv2Response>
            <CardExpirationDate>2018-12</CardExpirationDate>
         </CreditCardTransaction>
      </PaymentTransaction>
      <PaymentTransaction>
         <PaymentContext>
            <OrderId>00026109284_s1_2</OrderId>
            <PaymentAccountUniqueId isToken="true">4111110PASeK1111</PaymentAccountUniqueId>
         </PaymentContext>
         <TenderType>VC</TenderType>
         <TransactionType>Credit Card Authorization</TransactionType>
         <TransactionStatus>S</TransactionStatus>
         <TransactionAmount currencyCode="USD">116.87</TransactionAmount>
         <ResponseCode>APPROVED</ResponseCode>
         <GatewayResponseCode>100</GatewayResponseCode>
         <RequestTimestamp>2015-06-10T00:01:58.579Z</RequestTimestamp>
         <ReplyTimestamp>2015-06-10T00:01:58.655Z</ReplyTimestamp>
         <SecondaryGatewayKey>-1</SecondaryGatewayKey>
         <GatewayId>COMPASS</GatewayId>
         <CreditCardTransaction>
            <AuthorizationCode>000024</AuthorizationCode>
            <AuthorizationDate>2015-06-10</AuthorizationDate>
            <VerbalAuth>false</VerbalAuth>
            <AvsResponse>M</AvsResponse>
            <Cvv2Response>M</Cvv2Response>
            <CardExpirationDate>2018-12</CardExpirationDate>
         </CreditCardTransaction>
      </PaymentTransaction>
   </Transactions>
</TransactionHistoryReply>

 

Copyright © 2017 Radial. All rights reserved.