GetCardTrx

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

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

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
PNRef	Optional. The unique payment reference number assigned to the transaction. If this field is provided, all other query fields will be ignored when using PNRef parameter to query the system.
BeginDt	Required, except when PNRef is provided. The begin date of the date range in MM/DD/YYYY (or YYYY-MM-DD or YYYY-MM-DDThh:mm:ss) format. This date will be converted to YYYY-MM-DDThh:mm:ss (time is in 24-hour format). If the passed-in BeginDt does not contain time information, BeginDt will default to midnight on the given date. For example: 2005-08-19T12:00:12 is kept as is 2005-08-19 becomes 2005-08-19T00:00:00 2005/08/19 becomes 2005-08-19T00:00:00 08/19/2005 becomes 2005-08-19T00:00:00 The query to obtain transactions in the date range is constructed as follows: (Date DT >=BeginDt) AND (Date DT
EndDt	Required, except when PNRef is provided. The end date of the date range in MM/DD/YYYY (or YYYY-MM-DD or YYYY-MM-DDThh:mm:ss) format. This date will be converted to YYYY-MM-DDThh:mm:ss (time is in 24-hour format). If the passed-in EndDt does not contain time information, EndDt will be incremented to the next day at midnight such that no transaction on the desired end date will be excluded based on its time. For example: 2005-08-19T12:00:12 is kept as is 2005-08-19 becomes 2005-08-20T00:00:00 08/19/2005 becomes 2005-08-20T00:00:00
PaymentType	Optional. If provided, only those transactions matching the PaymentType 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 ‘PAYRECEIPT’ to retrieve receipt images that were uploaded to the payment server ‘SETTLE’ to retrieve requests to settle transactions Or any permutation of the above values, e.g. “‘PAYRECEIPT’,’SETTLE'” will pull all transactions with either PayReceipt or Settle payment types.
ExcludePaymentType	Optional. If provided, any transaction matching the ExcludePaymentType will be excluded
TransType	Optional. If provided, only those transactions matching the TransType will be included. Valid values are ‘Authorization’ to retrieve previously-authorized (pre-auth) transactions ‘Capture’ to retrieve captured transactions ‘Credit’ to retrieve return transactions ‘ForceCapture’ to retrieve force-auth transactions ‘GetStatus’ to make an inquiry to the EBT or gift card’s balance ‘PostAuth’ to retrieve post-auth transactions ‘Purged’ to remove a transaction from the current batch due to an error ‘Receipt’ to retrieve receipt images that were uploaded to the payment server ‘RepeatSale’ to retrieve repeat-sale transactions ‘Sale’ to retrieve sale transactions ‘Void’ to retrieve void transactions Or any permutation of the above values, e.g. “‘Credit’,’Sale'” will pull all transactions with either Credit or Sale transaction types.
ExcludeTransType	Optional. If provided, any transaction matching the ExcludeTransType will be excluded
ApprovalCode	Optional. If provided, only those transactions matching the ApprovalCode parameter will be included
Result	Optional. If provided, only those transactions matching the Result will be included. Valid values are: 0 is Approved Anything else is declined; if you want all the declined transactions, you should leave this field empty and use the ExcludeResult=0 instead.
ExcludeResult	Optional. If provided, any transactions matching the ExcludeResult will be excluded.
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	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 Or any permutation of the above values, “‘VISA’,’MASTER’,’DISCOVER'” will pull all transactions with either VISA, MASTER and DISCOVER card type There are cases when Cardtype needs to be set to ALL, for example CardType=ALL
ExcludeCardType	Optional. If provided, any transaction matching the ExcludeCardType will be excluded
ExcludeVoid	Required, except when PNRef is provided. An option to exclude voided transactions or not; must either be TRUE or FALSE
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
InvoiceId	Optional. The invoice ID that was included in the original transaction. If provided, only those transactions with matching invoiceId will be included. Matching is done using wild cards
SettleFlag	Optional. An option to retrieve the settled transactions or unsettled transactions; must either be 1 for true or 0 for false
SettleMsg	Optional. The settlement ID or message returned from the host
SettleDt	Optional. The date of the settlement
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 an 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	`<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE>` for no image <image_type>ONLY_IMAGE for only the image <image_type>ALL for all images CustomerID for customer ID Amount Total amount to search transactions for in DDDD.CC format. RegisterNum Register number, originally passed with the transaction, to search transactions for.

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 list of sale card transactions that were processed between 1/1/2000 and 1/1/3000. The format of the output will show descriptive headers and will be similar to a Comma Separate Values (CSV) format because of the use of the “,” character as the column delimiter.

Parameter	Value
UserName	test
Password	test
RPNum	1
BeginDt	1/1/2000
EndDt	1/1/3000
TransType	‘Sale’
ExcludeVoid	TRUE
TransformType	DELIM
ColDelim	,
RowDelim	\|
IncludeHeader	TRUE

Response

<?xml version=”1.0″ encoding=”utf-8″ ?><string xmlns=”http://localhost/admin/ws “>
TRX_HD_Key,Invoice_ID,Seq_Num_CH,Date_DT,Merchant_Key,User_Name_
VC,Register_Number_CH,Reseller_Key,Payment_Type_ID,Trans_Type_ID,Pr
ocessor_ID,TRX_Settle_Key,TRX_Settle_Msg_VC,Void_Flag_CH,Settle_Flag_
CH,Ref_Number_CH,Settle_Date_DT,Last_Update_DT,TRX_Card_Key,Card_I
nfo_Key,Auth_Amt_MN,Tip_Amt_MN,Total_Amt_MN,Cash_Back_Amt_MN,Su
reCharge_Amt_MN,Account_Type_CH,Result_CH,Result_Txt_VC,Approval_C
ode_CH,Host_Ref_Num_CH,AVS_Resp_CH,AVS_Resp_Txt_VC,CV_Resp_CH,C
V_Resp_Txt_VC,Host_Date_CH,Host_Time_CH,Acct_Num_CH,Exp_CH,Type_
CH,Name_on_Card_VC,Street_CH,Zip_CH,Track_VC,Pin_Block_CH,TRX_Recei
pt_key,Create_Date_DT,Receipt_Type_ID,IP_VC|14,,,12/3/2003 10:47:48
AM,1,test , ,100,VISA ,Sale ,VITAL ,14,GB00004 ACCEPTED,,1,,12/3/2003
10:46:34 AM,12/3/2003 10:48:13 AM,14,14,2.5000,0,2.5000,0,0,VISA ,0
,APPROVAL VITAL1 ,VITAL1 , ,0,, ,,,,4266503700000247,1009 ,VISA ,VINCE
VISA , , ,1, ,,,,127.0.0.1|13,,,12/3/2003 10:04:29 AM,1,test ,
,100,MASTERCARD,Sale ,VITAL ,13,GB00004 ACCEPTED,,1,,12/3/2003
10:46:34 AM,12/3/2003 10:48:13
AM,13,13,2.8500,0,2.8500,0,0,MASTERCARD,0 ,APPROVAL VITAL9 ,VITAL9 ,
,0,, ,,,,5424000000000015,0905 ,MASTERCARD, , , ,,
,,,,127.0.0.1|12,,,12/3/2003 9:45:59 AM,1,test , ,100,VISA ,Sale ,VITAL
,12,GB00003 ACCEPTED,,1,,12/3/2003 9:46:16 AM,12/3/2003 9:46:16
AM,12,12,1.6800,0,1.6800,0,0,VISA ,0 ,APPROVAL VITAL3 ,VITAL3 , ,0,,
,,,,4126196901499,0905 ,VISA , , , ,, ,,,,127.0.0.1|10,,,12/3/2003 9:35:19
AM,1,test , ,100,VISA ,Sale ,VITAL ,10,GB00003 ACCEPTED,,1,,12/3/2003
9:46:16 AM,12/3/2003 9:46:16 AM,10,10,2.3500,0,2.3500,0,0,VISA ,0
,APPROVAL VITAL8 ,VITAL8 , ,0,, ,,,,4055016727870315,0905 ,VISA , , , ,,
,,,,127.0.0.1|7,,,12/3/2003 9:27:57 AM,1,test , ,100,VISA ,Sale ,VITAL
,7,GB00002 ACCEPTED,,1,,12/3/2003 9:26:35 AM,12/3/2003 9:28:16
AM,7,7,1.2500,0,1.2500,0,0,VISA ,0 ,APPROVAL VITAL4 ,VITAL4 , ,0,,
,,,,4007000000027,0905 ,VISA , , , ,, ,,,,127.0.0.1|6,,,12/3/2003 9:27:44
AM,1,test , ,100,VISA ,Sale ,VITAL ,6,GB00002 ACCEPTED,,1,,12/3/2003
9:26:35 AM,12/3/2003 9:28:16 AM,6,6,2.0000,0,2.0000,0,0,VISA ,0
,APPROVAL VITAL9 ,VITAL9 , ,0,, ,,,,4007000000027,0905 ,VISA , , , ,,
,,,,127.0.0.1|5,,,12/3/2003 9:27:15 AM,1,test , ,100,MASTERCARD,Sale
,VITAL ,5,,,,,,12/3/2003 9:27:17
AM,5,5,1.2500,0,1.2500,0,0,MASTERCARD,12 , ACCT LENGTH ERR,EA , ,0,,
,,,,5405001478615777532,0905 ,MASTERCARD, , , ,,
,,,,127.0.0.1|2,,,12/3/2003 9:03:16 AM,1,test , ,100,MASTERCARD,Sale
,VITAL ,2,GB00001 ACCEPTED,,1,,12/3/2003 9:03:40 AM,12/3/2003
9:03:40 AM,2,2,2.4500,0,2.4500,0,0,MASTERCARD,0 ,APPROVAL VITAL7
,VITAL7 , ,0,, ,,,,5424000000000015,0905 ,MASTERCARD, , , ,,
,,,,127.0.0.1|1,,,12/3/2003 8:58:02 AM,1,test , ,100,VISA ,Sale ,VITAL
,1,GB00001 ACCEPTED,,1,,12/3/2003 9:03:40 AM,12/3/2003 9:03:40
AM,1,1,1.0000,0,1.0000,0,0,VISA ,0 ,APPROVAL VITAL3 ,VITAL3 , ,0,,
,,,,4111111111111111,0905 ,VISA , , , ,, ,,,,127.0.0.1<br /></string>

Secure Electronic Payments API

GetCardTrx