Parameter Name

Opt/Req

Description

UserName

R

User name assigned in the payment server. The user must have an appropriate level of access within the system in order to return records.

Password

R

Password associated with the user name provided.

RPNum

R

Unique numeric value used to identify the merchant for the query. The RPNum is assigned by the gateway and acts as the primary key for the merchant table.

Note: RPNum may also be called Merchant ID, Merchant Number, or Vendor Key.

PNRef

O

Unique payment reference number used to identify a single transaction within the system. The payment reference number (PNRef) is assigned by the payment server at the time the transaction is created.

Note: If a PNRef is provided, all other query fields will be ignored.

BeginDt

R*

Identifies the beginning date range for a group of transactions.

EndDt

R*

Identifies the ending date range for a group of transactions.

PaymentType

O

The payment type identifies the payment venue. If one or more payment types are provided, only transactions with matching PaymentType will be included in the results; all other PaymentType values will be excluded. Valid entries are:

•      ‘ACH’ - Automated Clearing House

•      ‘ECHECK’ - Electronic check

•      ‘GUARANTEE’ - Guarantee check

•      ‘PAYRECEIPT’ - receipt images uploaded to the server

•      ‘SETTLE’ - transactions that have been finalized with the payment host

•      ‘VERIFY’ - Pre-authorized checks

Note: The default value for this field is “All”. If no value is set, all payment types will be returned in the result set.

Or any permutation of the above values, e.g. "’ACH’,’ECHECK’" will pull all transactions with either ACH or ECHECK payment types.

ExcludePaymentType

O

The ExcludePaymentType parameter allows you to exclude certain payment types from the result set. Any valid entry (or combination) listed under the PaymentType parameter may be used.

Note: If you pass the same value in the PaymentType and ExcludePaymentType parameters, the entry in the ExcludePaymentType parameter will override the PaymentType and results of that type will be excluded.

This parameter accepts multiple values.

TransType

O

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

O

The ExcludeTransType parameter allows you to exclude certain transaction types from the result set. Any valid entry (or combination) listed under the TransType parameter may be used.

Note: If you pass the same value in the TransType and ExcludeTransType parameters, the entry in the ExcludeTransType parameter will override the TransType and results of that type will be excluded.

Note: A value of ‘Void’ in the ExcludeTransType parameter will be overridden by the ExcludeVoid if both parameters are used.

This parameter accepts multiple values.

ApprovalCode

O

The approval code is a 6-character string (alphanumeric) generated by the issuing bank. The code is used the card issuer to verify the specific authorization when transactions are being settled.

Note: You may only query one approval code at a time; however, approval codes are not necessarily unique and there is potential (rare) for more than one record to be returned.

Result

O

The result indicates whether a transaction was approved (Result = 0) or declined (Result ≠ 0). Valid entries are:

•      Unused/blank returns both approved and declined transactions

•      0 - returns only approved transactions

Note: To return only declined transactions, leave this parameter blank and use the ExcludeResult parameter.

ExcludeResult

O

The result indicates whether a transaction was approved (Result = 0) or declined (Result ≠ 0). If provided, any transactions matching the ExcludeResult input will be excluded.

Note: To return a only declined transactions, set ExcludeResult = 0

NameOnCheck

O

If an owner’s name is provided for this parameter, only those transactions with matching names will be returned. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

CheckNum

O

If a check number is provided for this parameter, only those transactions with a matching check number will be returned.

AcctNum

O

If a checking account number is provided, only those transactions with matching account numbers will be returned.  Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

RouteNum

O

If a route number (transit number) is provided, only those transactions with matching route numbers will be returned. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

ExcludeVoid

O

The ExcludeVoid parameter allows you to exclude voided transactions from the result set. Valid entries are:

•      ‘TRUE’ - voided transactions are excluded

•      ‘FALSE’ - voided transactions are included

User

O

If provided, only transactions generated by users with a matching user ID will be included in the results. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

InvoiceID

O

The invoice ID is assigned by the merchant. This identifier can be used to locate a specific transaction or multiple transactions grouped under a single invoice. If provided, only transactions with a matching invoice ID will be included in the results. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

SettleFlag

O

The SettleFlag parameter allows you to choose whether settled or unsettled transactions are included in the results. Valid entries are:

•      Unused/blank returns all transactions

•      ‘1’ - returns only settled transactions

•      ‘0‘- return only transactions that are not yet settled

SettleMsg

O

The settlement message is an ID or message returned from the host upon settlement of a transaction. If provided, only the transaction that exactly matches the SettleMsg provided will be returned. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

SettleDt

O

If provided, only transactions that were settled on the same date will be included in the results.

TransformType

O

Indicates how the result set should be formatted. Valid entries are:

•      ‘XML’ - outputs a plain XML string

•      ‘XSL’ - uses XSL to format the XML output. If ‘XSL’ is selected, use the Xsl parameter to identify the XSL string that will be used to format the output.

•      ‘DELIM’ - outputs records in a delimited format. If ‘DELIM’ is selected, you may also pass values for the ColDelim, RowDelim, and IncludeHeader parameters.

Xsl

O

This field is used only if the TransformType is XSL.

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:

•      https://<PMN assigned host name>/admin/ws/TabDelim.xsl’ for a tab delimited transformation

ColDelim

O

This field is used only if the TransformType is DELIM. This defines the string that separates each column:

e.g. a value of ‘@’, would separate each column value with ‘@’

RowDelim

O

This field is used only if the TransformType is DELIM. This defines the string that separates each row

e.g. a value of ‘!’ would start each row with ‘!’

IncludeHeader

O

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

O

The ExtData parameter allows you to pass additional information to the web service that is not covered under the input parameters. ExtData values need not be placed in any particular order; however, they must be properly formatted using XML tags.

Extended data in XML format. Valid values are:

•      ‘<IMAGE_TYPE>NO_IMAGE</IMAGE_TYPE>’ – Will only return transaction data that does not include image data (to include signature data and check images)

•      ‘<IMAGE_TYPE>ONLY_IMAGE</IMAGE_TYPE>’ – Will only return transaction data that includes image data (to include signature data and check images)

•      ‘<IMAGE_TYPE>ALL</IMAGE_TYPE>’- will return transaction with or without image data

•      ‘<CustomerID>CustomerID</CustomerID>’ – specifies the customer ID value to search by. Matching is done using wild cards: e.g. "test" will match "test", "1test" and "1test234"

•      ‘<Amount>Amount</Amount>’ – specifies the amount value of the transactions being searched for. In DDDDDD.CC format

•      ‘<RegisterNum>RegisterNum</RegisterNum>’ -  apecifies the register number, originally passed with the transaction, to search by

•      <Timezone>Timezone</Timezone> - Used to convert the input and output (where applicable) date/time values to the desired timezone. When specified, the same timezone is used to convert the begin/end date parameters as well as the Date and Last Update output values. This field is optional, and if omitted all date/time values are treated as UTC.  Daylight savings time adjustments, where applicable, are handled automatically.  Accepted values are:

§ AKST – Alaskan Standard Time

§ CST – Central Standard Time

§ EST – Eastern Standard Time

§ HST – Hawaiian Standard Time

§ MST – Mountain Standard Time

§ AZMST – Arizona

§ PST – Pacific Standard Time