TrxDetail


Click here for a complete list of operations.

GetCheckTrx

Retrieves check transaction details for a merchant.
Required parameters are in bold.
ParameterValue
UserNameRequired: User Name
PasswordRequired: Password
RPNumRequired query field: The merchant's RP Number, the query will be run against this merchant's account.
PNRefOptional query field: The unique identifier (assigned by the payment server) for a transaction. If this field is provided, at most only one transaction matching this PNRef will be returned. All other query fields will be ignored when using PNRef to query the system.
BeginDtOptional query field: The begin date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT00:00:00:0000AM
EndDtOptional query field: The end date of the date range in MM/DD/YYYY format. This date will be converted to MM/DD/YYYYT12:59:59:9999PM
PaymentTypeOptional query field: If provided, only those transactions matching the PaymentType will be included.
Valid values are
  • 'ACH'
  • 'DEBIT'
  • 'EBT'
  • 'ECHECK'
  • 'GUARANTEE'
  • 'PAYRECEIPT'
  • 'SETTLE'
  • 'VERIFY'

  • Or any permutation of the above values, e.g. "'DEBIT','EBT'" will pull all transactions with either DEBIT and EBT payment type.
ExcludePaymentTypeOptional query field: If provided, any transaction matching the ExcludedPaymentType will be exlucded.
TransTypeOptional query field: If provided, only those transactions matching the TransType will be included.
Valid values are
  • 'Authorization'
  • 'Capture'
  • 'Credit'
  • 'ForceCapture'
  • 'GetStatus'
  • 'PostAuth'
  • 'Purged'
  • 'Receipt'
  • 'RepeatSale'
  • 'Sale'
  • 'Void'

Or any permutation of the above values.
ExcludeTransTypeOptional query field: If provided, any transaction matching the ExcludedTransType will be exlucded.
ApprovalCodeOptional query field: If provided, only those transactions matching the Approval Code will be included.
ResultOptional query field: If provided, only those transactions matching the Result will be included. Valid values are:
  • 0 - Approved
  • Anything else is declined, if you want all the declined transactions, you should leave this field empty and use the ExcludeResult=0 instead.
ExcludeResultOptional query field: If provided, any transactions matching the ExcludedResult will be excluded.
NameOnCheckOptional query field: 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 card. e.g. "test" will match "test", "1test" and "1test234".
CheckNumOptional query field: Check number, if provided, only those transactions with matching CheckNum will be included.
AcctNumOptional query field: Check Account number, if provided, only those transactions matching the AcctNum will be included. Matching is done using wild card.
RouteNumOptional query field: If provided, any transactions matching the RouteNum (Transit Number) will be excluded. Matching is done using wild card.
ExcludeVoidOptional query field: Whether to exclude voided transaction, must either be TRUE or FALSE. Default is TRUE
UserOptional query field: The user who originated the transactions, if provided, only those transactions with card holder's name matching User will be included. Matching is done using wild card.
InvoiceIdOptional query field: The invoice id that was included in the original transaction. If provided, only those transactions with matching invoice Id will be included. Matching is done using wild card.
SettleFlagOptional query field: Whether the transaction was settled.
SettleMsgOptional query field: The settlement ID or Message returned from the host.
SettleDtOptional query field: The settlement timestamp.
TransformTypeOptional: Default is XML.
  • XML - output the plain XML string
  • XSL - use XSL to transform the XML output
  • DELIM - use ColDelim and RowDelim to format the output
XslOptional: 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 Service 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 pass, then that XSL will be used for transformation.
A sample predefined XSL is included with this Web Service:
  • TabDelim.xsl
ColDelimOptional: This field is used only if the TransformType is "DELIM". This defines the string taht sepearte each column.
RowDelimOptional: This field is used only if the TransformType is "DELIM". This defines the string that separate each row.
IncludeHeaderOptional: 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.
ExtDataOptional: Extended Data in XML, Valid Values are: IMAGE_TYPE - can be NO_IMAGE, ONLY_IMAGE, ONLY_IMAGE_INCLUDE_DATA, ALL or ALL_INCLUDE_DATA. CustomerID, Amount, RegisterNum

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
UserName:
Password:
RPNum:
PNRef:
BeginDt:
EndDt:
PaymentType:
ExcludePaymentType:
TransType:
ExcludeTransType:
ApprovalCode:
Result:
ExcludeResult:
NameOnCheck:
CheckNum:
AcctNum:
RouteNum:
ExcludeVoid:
User:
invoiceId:
SettleFlag:
SettleMsg:
SettleDt:
TransformType:
Xsl:
ColDelim:
RowDelim:
IncludeHeader:
ExtData:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /admin/ws/trxdetail.asmx HTTP/1.1
Host: secure.ftipgw.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://demo.tpisoft.com/Admin/ws/GetCheckTrx"

<?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>
    <GetCheckTrx xmlns="http://demo.tpisoft.com/Admin/ws">
      <UserName>string</UserName>
      <Password>string</Password>
      <RPNum>string</RPNum>
      <PNRef>string</PNRef>
      <BeginDt>string</BeginDt>
      <EndDt>string</EndDt>
      <PaymentType>string</PaymentType>
      <ExcludePaymentType>string</ExcludePaymentType>
      <TransType>string</TransType>
      <ExcludeTransType>string</ExcludeTransType>
      <ApprovalCode>string</ApprovalCode>
      <Result>string</Result>
      <ExcludeResult>string</ExcludeResult>
      <NameOnCheck>string</NameOnCheck>
      <CheckNum>string</CheckNum>
      <AcctNum>string</AcctNum>
      <RouteNum>string</RouteNum>
      <ExcludeVoid>string</ExcludeVoid>
      <User>string</User>
      <invoiceId>string</invoiceId>
      <SettleFlag>string</SettleFlag>
      <SettleMsg>string</SettleMsg>
      <SettleDt>string</SettleDt>
      <TransformType>string</TransformType>
      <Xsl>string</Xsl>
      <ColDelim>string</ColDelim>
      <RowDelim>string</RowDelim>
      <IncludeHeader>string</IncludeHeader>
      <ExtData>string</ExtData>
    </GetCheckTrx>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetCheckTrxResponse xmlns="http://demo.tpisoft.com/Admin/ws">
      <GetCheckTrxResult>string</GetCheckTrxResult>
    </GetCheckTrxResponse>
  </soap:Body>
</soap:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /admin/ws/trxdetail.asmx/GetCheckTrx?UserName=string&Password=string&RPNum=string&PNRef=string&BeginDt=string&EndDt=string&PaymentType=string&ExcludePaymentType=string&TransType=string&ExcludeTransType=string&ApprovalCode=string&Result=string&ExcludeResult=string&NameOnCheck=string&CheckNum=string&AcctNum=string&RouteNum=string&ExcludeVoid=string&User=string&invoiceId=string&SettleFlag=string&SettleMsg=string&SettleDt=string&TransformType=string&Xsl=string&ColDelim=string&RowDelim=string&IncludeHeader=string&ExtData=string HTTP/1.1
Host: secure.ftipgw.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://demo.tpisoft.com/Admin/ws">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /admin/ws/trxdetail.asmx/GetCheckTrx HTTP/1.1
Host: secure.ftipgw.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

UserName=string&Password=string&RPNum=string&PNRef=string&BeginDt=string&EndDt=string&PaymentType=string&ExcludePaymentType=string&TransType=string&ExcludeTransType=string&ApprovalCode=string&Result=string&ExcludeResult=string&NameOnCheck=string&CheckNum=string&AcctNum=string&RouteNum=string&ExcludeVoid=string&User=string&invoiceId=string&SettleFlag=string&SettleMsg=string&SettleDt=string&TransformType=string&Xsl=string&ColDelim=string&RowDelim=string&IncludeHeader=string&ExtData=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://demo.tpisoft.com/Admin/ws">string</string>