GetCardTrxSummary

This Web service operation retrieves a card transaction summary for a merchant. The URL to access this Web service is:

https://secure.ftipgw.com/admin/ws/trxdetail.asmx?op=GetCardTrxSummary

Descriptions of the parameters are listed below.

Parameter Description
UserName Required. User name assigned in the payment server
Password Required. Password for the user name assigned in the payment server
RPNum Required. The merchant’s RP Number in order to uniquely identify merchant’s account for the query
BeginDt Required. The begin date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT00:00:00:0000AM
EndDt Required. The end date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT12:59:59:9999PM
ApprovalCode Optional. If provided, only those transactions matching the ApprovalCode parameter will be included
Register Optional. The register that originated the transaction. If provided, only those transactions with the matching register will be included
NameOnCard Optional. Cardholder’s name as it is appears on the card. If provided, only those transactions with cardholder’s name matching NameOnCard will be included. Matching is done using wild cards: e.g. “test” will match “test”, “1test” and “1test234”
CardNum Optional. A card number. If provided, only those transactions with the cardholder’s name matching CardNum will be included. Matching is done using wild cards
CardType

Optional. If provided, only those transactions matching the CardType will be included. Valid values are:

  • ‘AMEX’ American Express card
  • ‘CARTBLANCH’ Carte Blanch card
  • ‘DEBIT’ Debit card
  • ‘DINERS’ Diners Club card
  • ‘DISCOVER’ Novus Discover card
  • ‘EBT’ Electronic Benefit Transfer
  • ‘JAL’ JAL card
  • ‘JCB’ Japanese Commercial Bank card
  • ‘MASTERCARD’ Master card
  • ‘VISA’ Visa card
  • ‘EGC’ Gift card
ExcludeVoid Required. Whether to exclude voided transactions; must either be TRUE or FALSE. Default is TRUE
User Optional. The user who originated the transactions. If provided, only those transactions created by the matching User will be included. Matching is done using wild cards
SettleFlag Optional. An option to retrieve the settled transactions or unsettled transactions; must either be TRUE or FALSE
SettleMsg Optional. The settlement ID or message returned from the host
SettleDt Optional. The settlement timestamp
TransformType

Optional. The type of format to transform the data into. Leave the field blank to default to XML

  • XML will output the plain XML string
  • XSL will use XSL to transform the XML output
  • DELIM uses ColDelim and RowDelim to format the output
Xsl

Optional. This field is used only if the TransformType is XSL. The XSL to transform the resulting dataset; if provided, the resulting dataset will be transformed using this XSL. You may pass in a URL to the XSL file, or the XSL string itself. If this field is not empty, the Web Services will try to locate the file from the URL. If that also fails, it will treat it as a XSL string. In any case, the final XSL string will be loaded and validated against the XSL schema; if it passes, then that XSL will be used for transformation. A sample predefined XSL is included with this Web Services:

  • http://localhost/admin/ws/TabDelim.xsl for a tab delimited transformation
ColDelim Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each column
RowDelim Optional. This field is used only if the TransformType is DELIM. This defines the string that separates each row
IncludeHeader Optional. This field is used only if the TransformType is DELIM. If TRUE, then field headers will be included in the first row using the same delimiter strings; must either be TRUE or FALSE
ExtData

Optional. Extended data in XML format. Valid values are:

  • <IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE> for no image
  • <IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE> for only the image
  • <IMAGE_TYPE>ALL</IMAGE_TYPE>for all images

Example
The following table contains sample data you can use to test this Web service. The UserName, Password, and RPNum parameters should be changed when testing this example yourself. The example data shown will create a summarized list of Visa card transactions that were processed between 1/1/2000 and 1/1/3000. The output data is in XML format because the TransformType parameter was not specified.

Parameter Value
UserName Test
Password 123
RPNum 1
BeginDt 1/1/2000
EndDt 1/1/3000
CardType VISA
ExcludeVoid FALSE


Response: 

<?xml version="1.0" encoding="utf-8" ?>
<string xmlns="http://localhost/Admin/ws">

<CardTrxSummary> <PaymentMethod> <Payment_Type_ID>VISA </Payment_Type_ID> <Authorization>1.0000</Authorization> <Capture>0</Capture> <ForceCapture>0</ForceCapture> <PostAuth>0</PostAuth> <Return>0</Return> <Sale>2.0000</Sale> <Receipt>0</Receipt> <RepeatSale>0</RepeatSale> <Activate>0</Activate> <Deactivate>0<</Deactivate> <Reload>0</Reload> <Authorization_Cnt>1</Authorization_Cnt> <Capture_Cnt>0</Capture_Cnt> <ForceCapture_Cnt>0</ForceCapture_Cnt>> <PostAuth_Cnt>0</PostAuth_Cnt> <Return_Cnt>>0</Return_Cnt>> <Sale_Cnt>2</Sale_Cnt> <Receipt_Cnt>0</Receipt_Cnt> <RepeatSale_Cnt>0</RepeatSale_Cnt> <Activate_Cnt>0</Activate_Cnt> <Deactivate_Cnt>0</Deactivate_Cnt> <Reload_Cnt>0</Reload_Cnt> <<Cnt>3</Cnt> </PaymentMethod> </CardTrxSummary>

</string>