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.

BeginDt

R

Identifies the beginning date range for a group of transactions.

EndDt

R

Identifies the ending date range for a group of transactions.

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. This field may also be used by payment processors  to return error messages.

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.

Register

O

The register is a unique string used to identify the register where the transaction took place. If used, only transactions made with the matching register number will be returned.

NameOnCard

O

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

CardNum

O

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

CardType

O

The card type identifies the type of card used to make the transaction. If one or more card types are provided, only transactions with matching CardType will be included in the results. Valid entries are:

•      Unused/blank returns summary information for all card types

•      ‘AMEX’ - American Express card

•      ‘CARTBLANCH’ - Carte Blanch card

•      ‘DEBIT’ - Debit card

•      ‘DINERS’ - Diners club card

•      ‘DISCOVER’ - Discover card

•      ‘EBT’ - Electronic benefit transfer

•      ‘JAL’ - Japanese Airlines card

•      ‘JCB’ - Japanese Commercial Bank card

•      ‘MASTERCARD’ - Master card

•      ‘VISA’ - Visa card

•      ‘EGC’ - Gift card

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

ExcludeVoid

R

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

•      ‘TRUE’ - voided transactions are excluded from summary information

•      ‘FALSE’ - voided transactions are included from summary information

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"

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 summary information for settled and unsettled transactions

•      ‘1’ - returns only summary information for settled transactions

•      ‘0’ - return only summary information for 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.

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