Parameter

Opt/Req

Description

UserName

R

User name assigned in the payment server. The user must have the apporpriate security permissions in order for the system to return transaction records.

Password

R

Password for the user name assigned in the payment server.

RPNum

R

Unique value assigned to each gateway account used as a third credential to ensure security and

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

PNRef

O

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

R*

Beginning date of the transaction record query.

EndDt

R*

End date of the transaction record query.

PaymentType

O

If provided, only those transactions matching the PaymentType will be included. Valid values are:

•      'AMEX' American Express card

•      'CARTBLANCH' Carte Blanch card

•      'DEBIT' Debit card

•      'DINERS' Diners Club card

•      'DISCOVER' Novus Discover card

•      'EBT' Electronic Benefit Transfer

•      'JAL' JAL card

•      'JCB' Japanese Commercial Bank card

•      'MASTERCARD' Master card

•      'VISA' Visa card

•      ‘EGC’ Gift card

•      'PAYRECEIPT' to retrieve receipt images that were uploaded to the payment server

•      'SETTLE' to retrieve requests to settle transactions

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. "'PAYRECEIPT','SETTLE'" will pull all transactions with either PayReceipt or Settle 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.

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. 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.

Result

O

If provided, only those transactions matching the Result will be included. Valid values are:

•      ‘NULL’ returns both approved and declined transactions

•      ‘0’ returns only approved transactions

•      Any other value for Result will return transactions matching that Result code.

Note: to return only declined transactions do not pass a value for this parameter and instead set ExcludeResult = 0

ExcludeResult

O

If provided, any transactions matching the ExcludeResult will be excluded.

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

NameOnCard

O

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

O

A card number. If provided, only those transactions with the card number matching CardNum will be included. Matching is done using wild cards.

CardType

O

This field has been deprecated. Please use the PaymentType field to specify the type of card used in a transaction.

ExcludeCardType

O

This field has been deprecated. Please use the ExcludePaymentType field to specify the type of cards you wish to be excluded from the result set.

ExcludeVoid

R*

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

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

User

O

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: e.g. "test" will match "test", "1test" and "1test234"

InvoiceId

O

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: 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’ - returns only transactions that are not yet settled

SettleMsg

O

The settlement ID or message returned from the host.

SettleDt

O

The date of settlement.

TransformType

O

The type of format to transform the data into. Leave the field blank to default to XML

•      ‘XML’ will output the plain XML string

•      ‘XSL’ will use XSL to transform the XML output

•      ‘DELIM’ uses ColDelim and RowDelim to format the output

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