ProcessGiftCard

ArgoFire Gateway

ProcessGiftCard

This Web service operation processes gift card transactions for a merchant. The URL to access this Web service is:

https://secure.ftipgw.com/ArgoFire/transact.asmx?op=ProcessGiftCard

Descriptions of the parameters are listed below.

Parameter	Value
UserName	Required. User name assigned in the payment server
Password	Required. Password for the user name assigned in the payment server
TransType	Required. Type of the gift card transaction. Valid values are: Redeem to make a purchase on a gift card Reload to increase the balance on a gift card Refund to refund money back to a gift card Activate to activate a gift card Deactivate to deactivate a gift card Inquire to check the balance on a gift card Void to undo an unsettled transaction Force to place a transaction not processed through the payment server into the current batch (ForceAuth). Currently only available through Paymentech Capture to settle a single transaction in the current batch; only for terminal-based processors CaptureAll to settle all transactions in the current batch or host-based processors that support a batch release feature
CardNum	Required. Gift card number used to process the transaction
ExpDate	Required. Gift card's expiration date in MMYY format
MagData	Optional except when processing swiped card transactions. Data located on the track 2 of the magnetic strip of the card. Once this field is populated, the transaction will be indicated as Card-Present transaction and usually result in a more favorable retail discount rate. This parameter will remove invalid characters. See list of Removed Characters for more details The format of the MagData (or Track 2 data) is CardNum=ExpDate followed by the service code and checksum. For example, 36438999960016=05121015432112345678
Amount	Required except for TransType with Inquire. The total transaction amount in DDDD.CC format
InvNum	Optional. Invoice tracking number. This parameter will remove invalid characters. See list of Removed Characters for more details
PNRef	Optional except for TransType with Void. Reference number assigned by the payment server of a previous gift card transaction
ExtData	Optional. Extended data in XML format. Valid values are: TrainingMode for Training Mode in either T or F <Force>Force</Force> for forcing duplicate transactions to be processed; either T or F. Note that some processors, including Concord EFS, will not utilize this tag and may still reject a duplicate transaction <TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 40) <RegisterNum>RegisterNum</RegisterNum> for register number. The data within this XML tag parameter will remove invalid characters. See list of Removed Characters for more details <ForceAuth>Force</ForceAuth> For previously authorized Paymentech transactions of type Redeem, Reload, and Activate to place these transactions into the current batch. (See hierarchy below) Currently only available through Paymentech. See Examples 2 and 3 below <AuthCode>AuthCode</AuthCode> Required for Paymentech transactions of type Force (Redeem ForceAuth) See hierarchy below. The authorization code previously obtained for the transaction. Currently only available through Paymentech <ForceAuth> <AuthCode>AuthCode</AuthCode> Required for Paymentech transactions being processed using <ForceAuth> (placed within <ForceAuth> tag). The authorization code previously obtained for the transaction. Currently only available through Paymentech </ForceAuth>

Gift Card ForceAuth Transactions

When processing gift cards through Paymentech, it is possible to do a transaction of type Force (a Redeem ForceAuth, for example after a phone authorization is obtained for a purchase) in order to place a gift card Redeem transaction in the current batch. Such a transaction requires <AuthCode> to be passed in ExtData (See above table and see Example 2 below).

It is also possible to place previously authorized transactions of type Redeem, Reload, and Activate in the current batch using the <ForceAuth> tag with <AuthCode> nested inside (See above table and see Examples 3 and 4 below). Essentially, that means that a Redeem can be forced into the batch in two different ways, whereas the Reload and Activate types must be placed in the batch through the second method. Please note that Gift Card ForceAuth transactions are only required to place a previously authorized Redeem, Reload, or Activate in the current batch.

Examples

ArgoFire Gateway SDK - Main	Glossary of Terms	Response Codes