GetCheckTrx

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

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

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:

  • ‘ACH’ Automated Clearing House
  • ‘ECHECK’ Electronic Check
  • ‘GUARANTEE’ Guarantee check
  • ‘PAYRECEIPT’ to retrieve receipt images that were uploaded to the payment server
  • ‘SETTLE’ to retrieve requests to settle transactions
  • ‘VERIFY’ to retrieve pre-authorized checks

Or any permutation of the above values, e.g. “‘ACH’,’ECHECK'” will pull all transactions with either ACH or ECHECK 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
ExcludeVoid Required. Whether to exclude voided transactions; must either be TRUE or FALSE. Default is TRUE
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 ExcludedResult will be excluded
NameOnCheck Optional. Check owner’s name as it is appear on the check, if provided. Only those transactions with check owner’s name matching NameOnCheck will be included. Matching is done using wild cards: e.g. “test” will match “test”, “1test” and “1test234”
CheckNum Optional. Check number. If provided, only those transactions with matching CheckNum will be included
AcctNum Optional. Check account number. If provided, only those transactions matching the AcctNum will be included. Matching is done using wild cards
RouteNum Optional. If provided, any transactions matching the RouteNum (Transit Number) will be excluded. Matching is done using wild cards
ExcludeVoid Optional. Whether to exclude voided transactions; must either be TRUE or FALSE. The default value 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
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. Whether the transaction was settled; must either be 1 for true or 0 for 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
  • <CustomerID>CustomerID</CustomerID> for customer ID
  • <Amount>Amount</Amount> Total amount to search transactions for in DDDD.CC format.
  • <RegisterNum>RegisterNum</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 approved Verify check transactions that were processed between 1/1/2003 and 12/31/2003. 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/2010
EndDt 12/31/2010
PaymentType VERIFY’
Result 0


Response

<?xml version=”1.0″ encoding=”utf-8″ ?>

<string xmlns=” http://localhost/admin/ws”>

<RichDBDS> <TrxDetailCheck> <RichDBDS> <TrxDetailCheck>
<TRX_HD_Key>25</TRX_HD_Key> <Invoice_ID /> <Date_DT>2003-12-
05T13:47:15.1230000-08:00</Date_DT>
<Merchant_Key>1</Merchant_Key> <User_Name_VC>test
</User_Name_VC> <Register_Number_CH> </Register_Number_CH>
<Reseller_Key>100</Reseller_Key> <Payment_Type_ID>VERIFY
</Payment_Type_ID> <Trans_Type_ID>Authorization </Trans_Type_ID>
<Processor_ID>RMRS </Processor_ID> <Last_Update_DT>2003-12-
05T13:47:15.1230000-08:00</Last_Update_DT>
<TRX_Check_Key>5</TRX_Check_Key> <CheckNum_CH>1001
</CheckNum_CH> <MICR_VC />
<AccountNum_VC>******7890</AccountNum_VC>
<TransitNum_VC>123456780</TransitNum_VC> <RawMICR_VC />
<DL_VC /> <SS_CH /> <DOB_CH> </DOB_CH> <StateCode_CH>DE
</StateCode_CH> <NameOnCheck_VC>Jane Doe</NameOnCheck_VC>
<EMail_VC /> <Phone_VC /> <Amount_MN>1.0000</Amount_MN>
<Result_CH>0 </Result_CH> <Result_Txt_VC><INPUT TYPE=HIDDEN
NAME=PARAM_RESPONSE_CODE VALUE=”AA”><INPUT TYPE=HIDDEN
NAME=PARAM_AUTH_SOURCE VALUE=”0″><INPUT TYPE=HIDDEN
NAME=PARAM_CAP_CODE VALU</Result_Txt_VC>
<Host_Approval_CH>963852 </Host_Approval_CH> <Host_Ref_Num_CH>
</Host_Ref_Num_CH> <Result_Msg_VC>APPROVAL
963852</Result_Msg_VC> <Result_Msg1_VC /> <Result_Msg2_VC />
<Host_Date_CH>120503 </Host_Date_CH> <Host_Time_CH>164502
</Host_Time_CH> <IP_VC>192.168.2.22</IP_VC> </TrxDetailCheck>
<TrxDetailCheck> <TRX_HD_Key>24</TRX_HD_Key> <Invoice_ID />
<Date_DT>2003-12-05T13:46:50.0770000-08:00</Date_DT>
<Merchant_Key>1</Merchant_Key> <User_Name_VC>test
</User_Name_VC> <Register_Number_CH> </Register_Number_CH>
<Reseller_Key>100</Reseller_Key> <Payment_Type_ID>VERIFY
</Payment_Type_ID> <Trans_Type_ID>Authorization </Trans_Type_ID>
<Processor_ID>RMRS </Processor_ID> <Last_Update_DT>2003-12-
05T13:46:50.0770000-08:00</Last_Update_DT>
<TRX_Check_Key>4</TRX_Check_Key> <CheckNum_CH>4877
</CheckNum_CH> <MICR_VC />
<AccountNum_VC>******7890</AccountNum_VC>
<TransitNum_VC>123456780</TransitNum_VC> <RawMICR_VC />
<DL_VC /> <SS_CH /> <DOB_CH> </DOB_CH> <StateCode_CH>WA
</StateCode_CH> <NameOnCheck_VC>John Doe</NameOnCheck_VC>
<EMail_VC /> <Phone_VC /> <Amount_MN>2.0000</Amount_MN>
<Result_CH>0 </Result_CH> <Result_Txt_VC><INPUT TYPE=HIDDEN
NAME=PARAM_RESPONSE_CODE VALUE=”AA”><INPUT TYPE=HIDDEN
NAME=PARAM_AUTH_SOURCE VALUE=”0″><INPUT TYPE=HIDDEN
NAME=PARAM_CAP_CODE VALU</Result_Txt_VC>
<Host_Approval_CH>963852 </Host_Approval_CH> <Host_Ref_Num_CH>
</Host_Ref_Num_CH> <Result_Msg_VC>APPROVAL
963852</Result_Msg_VC> <Result_Msg1_VC /> <Result_Msg2_VC />
<Host_Date_CH>120503 </Host_Date_CH> <Host_Time_CH>164437
</Host_Time_CH> <IP_VC>192.168.2.22</IP_VC> </TrxDetailCheck>
</RichDBDS>
</string>