Parameter Name

Opt/Req

Description

UserName

R

User name assigned in the payment server. The user must have an appropriate level of access in order to utilize the web service.

Password

R

Password associated with the user name provided.

TransType

R

Identifies the type of credit card transaction being made. Valid values are:

•      Sale - make a purchase using a credit card

•      Auth – authorize the amount on a credit card

•      Return – credits the card holder’s account

•      Void – undo an unsettled transaction

•      Force – force an Auth transaction in to the current batch (PostAuth) or place a transaction not processed through the payment server into the current batch (ForceAuth).

Note: When using this transaction type for a ForceAuth, you must include an AuthCode under the ExtData parameter.

•      RepeatSale – perform a recurring billing or installment payment transaction

Processors supporting the restaurant adjustment function only:

•      Adjustment – used to modify an existing tip amount for an original sale To call the service

CardToken

R

Numerical key value assigned to the payment method when it was added to the system.

TokenMode

R

The type of token that is being used for the transaction.

•      DEFAULT -  Returns a numeric CcInfoKey

•      CARDFORMAT – Returns a randomly generated number in the format of a credit card matching the card type of the actual card

Amount

R

Total transaction amount in DDDD.CC format.

InvNum

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

PNRef

R*

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.

ExtData

O

Reserved for future use.