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 gift card transaction being made. Valid values are:

•      Redeem  – make a purchase on a gift card

•      Reload  – increase the balance on a gift card

•      Refund  – refund money back to a gift card

•      Activate  – activate a gift card

•      Deactivate  – deactivate a gift card

•      Inquire  – check the balance on a gift card

•      Void  – undo an unsettled transaction

Paymentech/Tampa only:

•      Force – place a transaction not processed through the payment server into the current batch (ForceAuth).

Terminal-based processors only:

•      Capture – settle a single transaction in the current batch; only for terminal-based processors

Processors supporting the batch release feature only:

•      CaptureAll – settle all transactions in the current batch.

CardNum

R

Gift card number used to uniquely identify the owner’s account.

ExpDate

R

Gift card date of expiration in MMYY format.

MagData

R^$

Data located the magnetic strip on the back of the card. The format of the MagData is CardNum=ExpDate followed by the service code and checksum. For example:

36438999960016=05121015432112345678

Amount

R^#

Total transaction amount in DDDD.CC format.

Note: This amount includes the CashBackAmt and SureChargeAmt.

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

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.

The following information may be added via the ExtData parameter:

Training Mode: (optional) This is an indicator that specifies whether transactions will be processed for local loop back testing or treated normally. Valid formats are:

•      <TrainingMode>T</TrainingMode> where T (true) indicates that training mode is active and transactions are processed for local loop back testing.

•      <TrainingMode>F</TrainingMode> where F (false) indicates that training mode is inactive and transactions should be treated normally.

Force: (optional) This is an indicator that specifies whether or not duplicate transactions will be processed. Valid formats are:

•      <Force>T</Force> where T (true) indicates that duplicate transactions are accepted.

•      <Force>F</Force> where F (false) indicates that duplicate transactions are not accepted.

Note: Some processors, including BuyPass, will not recognize this tag and reject duplicate transactions.

Time out: (optional) Processor time out value in seconds. The default value for the parameter is 30 seconds for a transaction and 300 seconds for a settlement transaction. Valid format is:

•      <TimeOut>TimeOut</TimeOut> where TimeOut is the processor time out value in seconds.

Register Number: (optional) This is unique identifier for the register, terminal or computer used to process the gift card transaction. Valid format is:

•      <RegisterNum>RegisterNum</RegisterNum> where RegisterNum is equal to the register identification number stored on the merchant’s account record.

Paymentech/Tampa Only

Force Authorization: (optional) Places a previously authorized transaction (TransType = Redeem, Reload, or Activate) into the current batch. 

External IP: (optional) When using the Transact web service, the IP address defaults to the calling computer's IP. If the request is coming from an external source, the external IP address can be substituted for the purpose of logging and fraud control.

To implement this IP pass through functionality, the following XML node should be included in the external data field of the web service call...

•      <ExternalIP>IP Address Here</ExternalIP>

If the ExternalIP node is not included in the external data field, then the default behavior of using the callers IP address is used.