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 | Description |
|---|---|
| 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:
|
| 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 detailsThe 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:
|
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.
Example: Redeem
The example data below will process a Redeem transaction on a gift card through the payment server.
| Parameter | Value |
|---|---|
| UserName | test |
| Password | 123 |
| TransType | Redeem |
| CardNum | 6032250001350000156 |
| ExpDate | 0509 |
| MagData | 6032250001350000156=09051015432112345678 |
| Amount | 10.00 |
| InvNum | 1001 |
| InvNum | <Force>T</Force> |
Response
<?xml version=”1.0″ encoding=”utf-8″ ?>
<Response xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”https://secure.ftipgw.com/ArgoFire/”>
<Result>0</Result><Message>GiftCardBalanceAmount: 10.00</Message><PNRef>2355</PNRef><HostCode>100004389913</HostCode ><ExtData>InvNum=1001,CardType=EGC</ExtData>
</Response>
Example: Force
The example data below will process a swiped gift card Force transaction through the payment server. The AuthCode value should be changed when testing this example yourself.
| Parameter | Value |
|---|---|
| UserName | test |
| Password | 123 |
| Password | Force |
| CardNum | 6035718888880552378 |
| ExpDate | 1210 |
| MagData | 6035718888880552378=1012000876414 |
| NameOnCard | John Doe |
| Amount | 3.00 |
| ExtData | <AuthCode>104013</AuthCode> |
Response
<?xml version=”1.0″ encoding=”utf-8″ ?>
– <Response xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”https://secure.ftipgw.com/ArgoFire/”>
<Result>0</Result><Message>APPROVED</Message><AuthCode>104013</Aut hCode><PNRef>39782</PNRef><HostCode>00000014</HostCode><ExtData>Ca rdType=EGC</ExtData>
</Response>
Example: Redeem
The example data below will place a gift card Redeem transaction into the current batch. The AuthCode value should be changed when testing this example yourself.
| Parameter | Value |
|---|---|
| UserName | test |
| Password | test |
| TransType | Redeem |
| CardNum | 6035718888880552378 |
| ExpDate | 1210 |
| NameOnCard | John Doe |
| Amount | 3.00 |
| ExtData | <ForceAuth><AuthCode>105258</AuthCode></ForceAuth> |
Response
<?xml version=”1.0″ encoding=”utf-8″ ?>
– <Response xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”https://secure.ftipgw.com/ArgoFire/”>
<Result>0</Result><Message>APPROVED</Message><AuthCode>105259</Aut hCode><PNRef>39783</PNRef><HostCode>00000015</HostCode><ExtData>Ca rdType=EGC</ExtData>
</Response>
Example: Reload
The example data below will place a gift card Reload transaction into the current batch. The AuthCode value should be changed when testing this example yourself.
| Parameter | Value |
|---|---|
| UserName | test |
| Password | 123 |
| TransType | Reload |
| CardNum | 6035718888880552378 |
| ExpDate | 1210 |
| NameOnCard | John Doe |
| Amount | 20.00 |
| ExtData | <ForceAuth><AuthCode>105260</AuthCode></ForceAuth> |
Response
<?xml version=”1.0″ encoding=”utf-8″ ?>
– <Response xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns=”https://secure.ftipgw.com/ArgoFire/”>
<Result>0</Result><Message>APPROVED</Message><AuthCode>105261</Aut hCode><PNRef>39784</PNRef><HostCode>00000016</HostCode> <ExtData>CardType=EGC</ExtData>
</Response>
Copyright 2024 FrontStream Holdings, LLC.
FrontStream Payments is a registered ISO/MSP of Elavon, Inc, Georgia, First National Bank of Omaha, Omaha, NE, Citizen Bank N.A.,
Providence, RI, and Wells Fargo Bank, N.A., Concord, CA., Peoples Trust Company, Vancouver, Canada
