TrxDetail
This Web Service provides methods that can retrieve transaction details.
The following operations are supported. For a formal definition, please review the Service Description.
-
GetCardTrx
Retrieves card transaction details for a merchant.
Required parameters are in bold.Parameter Value UserName Required: User Name Password Required: Password RPNum Required query field: The merchant's RP Number, the query will be run against this merchant's account. PNRef Optional 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. BeginDt Optional 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 EndDt Optional 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 PaymentType Optional 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.ExcludePaymentType Optional query field: If provided, any transaction matching the ExcludedPaymentType will be exlucded. TransType Optional 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'
- 'Reversal'
Or any permutation of the above values.ExcludeTransType Optional query field: If provided, any transaction matching the ExcludedTransType will be exlucded. ApprovalCode Optional query field: If provided, only those transactions matching the Approval Code will be included. Result Optional 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.
ExcludeResult Optional query field: If provided, any transactions matching the ExcludedResult will be excluded. NameOnCard Optional query field: Card holder's name, if provided, only those transactions with card holder's name matching NameOnCard will be included. Matching is done using wild card. e.g. "test" will match "test", "1test" and "1test234". CardNum Optional query field: Card number, if provided, only those transactions with card holder's name matching CardNum will be included. Matching is done using wild card. CardType Optional query field: Card Type, if provided, only those transactions matching the CardType will be included.
Valid values are- 'ACH'
- 'AMEX'
- 'CARTBLANCH'
- 'DEBIT'
- 'DINERS'
- 'DISCOVER'
- 'EBT'
- 'JAL'
- 'JCB'
- 'MASTERCARD'
- 'VISA'
Or any permutation of the above values, e.g. "'VISA','MASTER','DISCOVER'" will pull all transactions with either VISA, MASTER and DISCOVER payment type.ExcludeCardType Optional query field: If provided, any transactions matching the ExcludeCardType will be excluded. ExcludeVoid Optional query field: Whether to exclude voided transaction, must either be TRUE or FALSE. Default is TRUE User Optional 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. InvoiceId Optional 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. SettleFlag Optional query field: Whether the transaction was settled. SettleMsg Optional query field: The settlement ID or Message returned from the host. SettleDt Optional query field: The settlement timestamp. TransformType Optional: 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
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 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
ColDelim Optional: This field is used only if the TransformType is "DELIM". This defines the string taht sepearte each column. RowDelim Optional: This field is used only if the TransformType is "DELIM". This defines the string that separate 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. ExtData Optional: 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 -
GetCardTrxSummary
Retrieves card transaction summary for a merchant.
Required parameters are in bold.Parameter Value UserName Required: User Name Password Required: Password RPNum Required query field: The merchant's RP Number, the query will be run against this merchant's account. BeginDt Optional 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 EndDt Optional 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 ApprovalCode Optional query field: If provided, only those transactions matching the Approval Code will be included. NameOnCard Optional query field: Card holder's name, if provided, only those transactions with card holder's name matching NameOnCard will be included. Matching is done using wild card. e.g. "test" will match "test", "1test" and "1test234". CardNum Optional query field: Card number, if provided, only those transactions with card holder's name matching CardNum will be included. Matching is done using wild card. CardType Optional query field: Card Type, if provided, only those transactions matching the CardType will be included.
Valid values are- 'ACH'
- 'AMEX'
- 'CARTBLANCH'
- 'DEBIT'
- 'DINERS'
- 'DISCOVER'
- 'EBT'
- 'JAL'
- 'JCB'
- 'MASTERCARD'
- 'VISA'
Or any permutation of the above values, e.g. "'VISA','MASTER','DISCOVER'" will pull all transactions with either VISA, MASTER and DISCOVER payment type.ExcludeCardType Optional query field: If provided, any transactions matching the ExcludeCardType will be excluded. ExcludeVoid Optional query field: Whether to exclude voided transaction, must either be TRUE or FALSE. Default is TRUE User Optional 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. Register Optional query field: The register that originated the transactions. If provided, only those transactions with matching register will be included. SettleFlag Optional query field: Whether the transaction was settled. SettleMsg Optional query field: The settlement ID or Message returned from the host. SettleDt Optional query field: The settlement timestamp. TransformType Optional: 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
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 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
ColDelim Optional: This field is used only if the TransformType is "DELIM". This defines the string taht sepearte each column. RowDelim Optional: This field is used only if the TransformType is "DELIM". This defines the string that separate 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. ExtData Optional: 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 -
GetCardUpdates
Retrieves information for individual card updates by merchant from Card Updater service.
Required parameters are in bold.Parameter Value UserName Required: User Name assigned by the payment gateway Password Required: Password assigned by the payment gateway MerchantKey Required: The merchant's merchantkey, the query will be run against this merchant's account. 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 ExtData Optional: Extended Data in XML -
GetCheckTrx
Retrieves check transaction details for a merchant.
Required parameters are in bold.Parameter Value UserName Required: User Name Password Required: Password RPNum Required query field: The merchant's RP Number, the query will be run against this merchant's account. PNRef Optional 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. BeginDt Optional 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 EndDt Optional 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 PaymentType Optional 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.ExcludePaymentType Optional query field: If provided, any transaction matching the ExcludedPaymentType will be exlucded. TransType Optional 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.ExcludeTransType Optional query field: If provided, any transaction matching the ExcludedTransType will be exlucded. ApprovalCode Optional query field: If provided, only those transactions matching the Approval Code will be included. Result Optional 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.
ExcludeResult Optional query field: If provided, any transactions matching the ExcludedResult will be excluded. NameOnCheck Optional 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". CheckNum Optional query field: Check number, if provided, only those transactions with matching CheckNum will be included. AcctNum Optional query field: Check Account number, if provided, only those transactions matching the AcctNum will be included. Matching is done using wild card. RouteNum Optional query field: If provided, any transactions matching the RouteNum (Transit Number) will be excluded. Matching is done using wild card. ExcludeVoid Optional query field: Whether to exclude voided transaction, must either be TRUE or FALSE. Default is TRUE User Optional 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. InvoiceId Optional 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. SettleFlag Optional query field: Whether the transaction was settled. SettleMsg Optional query field: The settlement ID or Message returned from the host. SettleDt Optional query field: The settlement timestamp. TransformType Optional: 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
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 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
ColDelim Optional: This field is used only if the TransformType is "DELIM". This defines the string taht sepearte each column. RowDelim Optional: This field is used only if the TransformType is "DELIM". This defines the string that separate 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. ExtData Optional: 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 -
GetOpenBatchSummary
Retrieves Payment Type transaction summary of the current open batch for a specific merchant.
Required parameters are in bold.Parameter Value UserName Required: User Name Password Required: Password RPNum Required: The merchant's RP Number, the query will be run against this merchant's account. BeginDt Optional 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 EndDt Optional 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 ExtData Optional: Extended Data in XML -
GetReturnedCheckReport
Retrieves returned checks report for a merchant.
Required parameters are in bold.Parameter Value UserName Required: User Name Password Required: Password MerchantKey Required: Merchant key for which to pull the report BeginDt Required 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 EndDt Optional 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. If not provided, end date will be midnight of beginning date. ExtData Optional: Extended Data in XML, Valid Values are: Future Use