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:
|
| 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
|
| 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:
|
| 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:
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
|
| 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:
|
| 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 |
|
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
Copyright 2024 FrontStream Holdings, LLC.
FrontStream Payments is a registered ISO/MSP of Elavon, Inc, Georgia, First National Bank of Omaha, Omaha, NE, Citizen Bank N.A.,
Providence, RI, and Wells Fargo Bank, N.A., Concord, CA., Peoples Trust Company, Vancouver, Canada
