pathwaylink transaction processing developers api

PathWayLink Transaction Processing API Guide PathWayLink Transaction Processing API Guide Version 1.2.2 Released June 29, 2016 Copyright © 2011‐2016, BridgePay Network Solutions, Inc. All rights reserved. The information contained herein is the confidential and proprietary property of BridgePay Network Solutions, Inc. and may not be used, distributed, modified, disclosed, or reproduced without express written permission.

Table of Contents Table of Contents ............................................................................................................................. 2 Changes and Modifications ............................................................................................................... 9 Chapter 1. Introduction .................................................................................................................. 10

1.1. Overview ............................................................................................................................. 10 1.2. Testing ................................................................................................................................. 10

1.2.1. Testing for PIN‐based Transactions .................................................................................. 10 1.2.2. Duplicate Transaction Handling ....................................................................................... 10

Chapter 2. Web Service Functionality ............................................................................................. 12 2.1. GetInfo ................................................................................................................................ 12

2.1.1. Examples ....................................................................................................................... 13 2.1.1.1. BatchInquiry ............................................................................................................ 13 2.1.1.2. Setup ...................................................................................................................... 14 2.1.1.3. StatusCheck ............................................................................................................. 14 2.1.1.4. Initialize .................................................................................................................. 14

2.2. ProcessCheck ....................................................................................................................... 15 2.2.1. Examples ....................................................................................................................... 19

2.2.1.1. Manual Check Sale ................................................................................................... 19 2.2.1.2. Swiped Check Sale ................................................................................................... 20 2.2.1.3. Manual Check Return ............................................................................................... 20 2.2.1.4. Check Void .............................................................................................................. 21

2.3. ProcessCreditCard ................................................................................................................ 22 2.3.1. Purchase Card Level III Data ............................................................................................ 29 2.3.2. Fuel Purchases ............................................................................................................... 29 2.3.3. Examples ....................................................................................................................... 29

2.3.3.1. Manual Credit Sale ................................................................................................... 29 2.3.3.2. Manually Entered Credit Auth .................................................................................. 30 2.3.3.3. Swiped Credit Return ............................................................................................... 31 2.3.3.4. Credit Void with PNRef ............................................................................................. 31 2.3.3.5. Credit Void with Transaction ID ................................................................................ 32 2.3.3.6. Credit Force with Training Mode ............................................................................... 34 2.3.3.7. Manually Entered Credit Force ................................................................................. 34 2.3.3.8. Credit Capture ......................................................................................................... 35 2.3.3.9. Credit Capture All .................................................................................................... 35 2.3.3.10. Responses with Single/Multiple Batch Detail ........................................................... 36 2.3.3.11. Credit RepeatSale .................................................................................................. 38 2.3.3.12. Tip Adjustment ...................................................................................................... 39 2.3.3.13. Manual Credit Reversal .......................................................................................... 40 2.3.3.14. Credit Sale with CVPresence ................................................................................... 42 2.3.3.15. Credit Sale with Contactless ................................................................................... 42

2.4. ProcessDebitCard ................................................................................................................. 43 2.4.1. PIN‐less Debit Transactions ............................................................................................. 46 2.4.2. Debit Fuel Purchases ...................................................................................................... 46 2.4.3. Examples ....................................................................................................................... 46

2.4.3.1. Swiped Debit Sale .................................................................................................... 47 2.4.3.2. Swiped Debit Return ................................................................................................ 47 2.4.3.3. Manual Debit Reversal ............................................................................................. 48

2.5. ProcessEBTCard .................................................................................................................... 50 2.5.1. Examples ....................................................................................................................... 52

2.5.1.1. Swiped EBT Food Stamp Sale .................................................................................... 52 2.5.1.2. Manually Entered EBT Food Stamp Return ................................................................ 53 2.5.1.3. Manually Entered EBT Cash Benefit Sale ................................................................... 54 2.5.1.4. EBT Force (Voucher Clear) ........................................................................................ 55

2.6. ProcessGiftCard .................................................................................................................... 55 2.6.1. Gift Force Transactions ................................................................................................... 57 2.6.2. Examples ....................................................................................................................... 58

2.6.2.1. Swiped Gift Redeem ................................................................................................ 58 2.7. ProcessLoyaltyCard ............................................................................................................... 58

2.7.1. Examples ....................................................................................................................... 60 2.7.1.1. Loyalty Redeem ....................................................................................................... 60 2.7.1.2. Loyalty Reload ......................................................................................................... 61

2.8. ProcessSignature .................................................................................................................. 61 2.8.1. Creating a Receipt Image Transaction from a File ............................................................. 62 2.8.2. Examples ....................................................................................................................... 63

2.8.2.1. Drawing a Square..................................................................................................... 63 2.8.2.2. Saving a Receipt Image ............................................................................................. 64 2.8.2.3. Saving a Check Image ............................................................................................... 66

Chapter 3. Response Values............................................................................................................ 71 3.1. Transact.asmx Response Fields .............................................................................................. 71 3.2. Result Code Descriptions ....................................................................................................... 73

3.2.1. Result Code ................................................................................................................... 73 3.2.2. AVS Response Code ........................................................................................................ 76 3.2.3. CV Response Code .......................................................................................................... 77

Chapter 4. Processor Addendum ..................................................................................................... 78 4.1. American Express ................................................................................................................. 78

4.1.1. ProcessCheck ................................................................................................................. 78 4.1.2. ProcessCreditCard .......................................................................................................... 78 4.1.3. ProcessDebitCard ........................................................................................................... 79 4.1.4. ProcessEBTCard ............................................................................................................. 79 4.1.5. ProcessGiftCard ............................................................................................................. 80 4.1.6. Response Values ............................................................................................................ 80

4.2. Ceridian Stored Value Solutions (SVS) .................................................................................... 81 4.2.1. ProcessGiftCard ............................................................................................................. 81

4.2.1.1. Transaction Subtypes: CashOut & Issue ..................................................................... 81 4.2.2. Response Values ............................................................................................................ 81

4.3. Campus Card (CBORD) .......................................................................................................... 82 4.3.1. Response Values ............................................................................................................ 82

4.4. Card Group........................................................................................................................... 82 4.4.1. ProcessGiftCard ............................................................................................................. 82 4.4.2. Response Values ............................................................................................................ 83

4.5. Certegy ................................................................................................................................ 83 4.5.1. ProcessCheck ................................................................................................................. 83

4.6. Concord (EFSNet)‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐‐ 84

4.6.1. ProcessCreditCard .......................................................................................................... 84 4.6.1.1. Purchase Card Level III Data ..................................................................................... 85 4.6.1.2. Fuel Purchases ......................................................................................................... 85 4.6.1.3. Examples ................................................................................................................. 86

4.6.1.3.1. Swiped Credit Sale with Purchase Card Level III Data ........................................... 86 4.6.1.3.2. Swiped Credit Sale Fuel Transaction ................................................................... 87 4.6.1.3.3. Swiped Fleet Sale .............................................................................................. 88 4.6.1.3.4. Manually Entered Fleet Sale ............................................................................... 89

4.6.2. ProcessDebitCard ........................................................................................................... 90 4.6.2.1. PIN‐less Debit Transactions ...................................................................................... 90 4.6.2.2. Fuel Purchases ......................................................................................................... 90 4.6.2.3. Examples ................................................................................................................. 91

4.6.2.3.1. Swiped PIN‐less Debit Sale ................................................................................. 91 4.6.2.3.2. Swiped Debit Auth............................................................................................. 91 4.6.2.3.3. Swiped Debit Force ........................................................................................... 92 4.6.2.3.4. Swiped Debit Fuel Sale....................................................................................... 93

4.7. CredoRax ............................................................................................................................. 94 4.7.1. GetInfo .......................................................................................................................... 94 4.7.2. ProcessCheck ................................................................................................................. 94 4.7.3. ProcessCreditCard .......................................................................................................... 95 4.7.4. ProcessDebitCard ........................................................................................................... 95 4.7.5. ProcessEBTCard ............................................................................................................. 95 4.7.6. ProcessGiftCard ............................................................................................................. 96

4.8. Echo/Intuit ........................................................................................................................... 96 4.8.1. ProcessCheck ................................................................................................................. 96

4.9. Elavon/Nova ......................................................................................................................... 96 4.9.1. ProcessCheck ................................................................................................................. 97 4.9.2. ProcessCreditCard .......................................................................................................... 97 4.9.3. ProcessDebitCard ........................................................................................................... 97 4.9.4. ProcessEBTCard ............................................................................................................. 98 4.9.5. ProcessGiftCard ............................................................................................................. 98

4.10. FastCheck/Cyclone (GETI) .................................................................................................... 98 4.10.1. ProcessCheck ............................................................................................................... 98 4.10.2. Uploading Check Image at Transaction Time ................................................................. 100

4.10.2.1. Supported SEC Types ............................................................................................ 100 4.10.3. ProcessGiftCard ........................................................................................................... 100

4.10.3.1. eCertificates ......................................................................................................... 101 4.10.4. Response Values ......................................................................................................... 101

4.11. FirstData BuyPass .............................................................................................................. 101 4.11.1. ProcessCheck .............................................................................................................. 102 4.11.2. ProcessCreditCard ....................................................................................................... 102 4.11.3. ProcessDebitCard ........................................................................................................ 103

4.11.3.1. PIN‐less Debit Transactions ................................................................................... 104 4.11.4. ProcessEBTCard .......................................................................................................... 104 4.11.5. ProcessGiftCard ........................................................................................................... 104 4.11.6. Response Values ......................................................................................................... 105

4.12. FirstData Nashville ............................................................................................................. 105

4.12.1. ProcessCheck .............................................................................................................. 105 4.12.2. ProcessCreditCard ....................................................................................................... 105 4.12.3. ProcessDebitCard ........................................................................................................ 106 4.12.4. ProcessEBTCard .......................................................................................................... 106 4.12.5. ProcessGiftCard ........................................................................................................... 107 4.12.6. Response Values ......................................................................................................... 107

4.13. FirstData North .................................................................................................................. 107 4.13.1. ProcessCheck .............................................................................................................. 108 4.13.2. ProcessCreditCard ....................................................................................................... 108

4.13.2.1. Examples .............................................................................................................. 109 4.13.2.1.1. Swiped Credit Sale with IIAS ............................................................................ 109 4.13.2.1.2. Swiped Credit Reversal with IIAS ..................................................................... 110 4.13.2.1.3. Credit Partial Reversal with IIAS ....................................................................... 110

4.13.3. ProcessDebitCard ........................................................................................................ 111 4.13.4. ProcessEBTCard .......................................................................................................... 112 4.13.5. ProcessGiftCard ........................................................................................................... 112 4.13.6. Response Values ......................................................................................................... 113

4.14. FirstData Omaha ................................................................................................................ 113 4.14.1. ProcessCheck .............................................................................................................. 113 4.14.2. ProcessCreditCard ....................................................................................................... 114 4.14.3. ProcessDebitCard ........................................................................................................ 114 4.14.4. ProcessEBTCard .......................................................................................................... 114 4.14.5. ProcessGiftCard ........................................................................................................... 114 4.14.6. Response Values ......................................................................................................... 115

4.15. FirstData South .................................................................................................................. 115 4.15.1. ProcessCreditCard ....................................................................................................... 115

4.16. FirstData Telecheck ............................................................................................................ 115 4.16.1. ProcessCheck .............................................................................................................. 115 4.16.2. Response Values ......................................................................................................... 117

4.17. GiveX ................................................................................................................................ 117 4.17.1. Additional Extended Data ............................................................................................ 117

4.18. Global East ........................................................................................................................ 117 4.18.1. GetInfo ....................................................................................................................... 118 4.18.2. ProcessCheck .............................................................................................................. 118 4.18.3. ProcessCreditCard ....................................................................................................... 119 4.18.4. ProcessDebitCard ........................................................................................................ 120

4.18.4.1. PIN‐less Debit Transactions ................................................................................... 120 4.18.4.2. Examples .............................................................................................................. 121

4.18.4.2.1. Swiped PIN‐less Debit Sale .............................................................................. 121 4.18.5. ProcessEBTCard .......................................................................................................... 122 4.18.6. ProcessGiftCard ........................................................................................................... 123 4.18.7. Response Values ......................................................................................................... 123

4.19. Global Interac (Canada) ...................................................................................................... 124 4.19.1. GetInfo ....................................................................................................................... 124 4.19.2. ProcessDebitCard ........................................................................................................ 124

4.19.2.1. PIN‐less Debit Transactions ................................................................................... 125 4.19.2.2. Examples .............................................................................................................. 125

4.19.2.2.1. Swiped PIN‐less Debit Sale .............................................................................. 125

4.19.2.2.2. Swiped Debit Sale ........................................................................................... 126 4.19.3. Response Values ......................................................................................................... 127

4.20. Heartland Payments .......................................................................................................... 127 4.20.1. ProcessCheck .............................................................................................................. 127 4.20.2. ProcessCreditCard ....................................................................................................... 128 4.20.3. ProcessDebitCard ........................................................................................................ 128 4.20.4. ProcessEBTCard .......................................................................................................... 128 4.20.5. ProcessGiftCard ........................................................................................................... 129

4.21. IntegraPay ......................................................................................................................... 129 4.21.1. ProcessCreditCard ....................................................................................................... 129 4.21.2. ProcessDebitCard ........................................................................................................ 129

4.22. Litle .................................................................................................................................. 130 4.22.1. ProcessCheck .............................................................................................................. 130 4.22.2. ProcessCreditCard ....................................................................................................... 130 4.22.3. ProcessDebitCard ........................................................................................................ 131 4.22.4. ProcessEBTCard .......................................................................................................... 131 4.22.5. ProcessGiftCard ........................................................................................................... 131

4.23. Mercury Payment Systems ................................................................................................. 132 4.23.1. ProcessCheck .............................................................................................................. 132 4.23.2. ProcessCreditCard ....................................................................................................... 132 4.23.3. ProcessDebitCard ........................................................................................................ 132 4.23.4. ProcessEBTCard .......................................................................................................... 133 4.23.5. ProcessGiftCard ........................................................................................................... 133 4.23.6. Additional Extended Data ............................................................................................ 133 4.23.7. Response Values ......................................................................................................... 134

4.24. Paymentech (Tampa) ......................................................................................................... 134 4.24.1. ProcessCheck .............................................................................................................. 134 4.24.2. ProcessCreditCard ....................................................................................................... 134 4.24.3. ProcessDebitCard ........................................................................................................ 135 4.24.4. ProcessEBTCard .......................................................................................................... 136 4.24.5. ProcessGiftCard ........................................................................................................... 136

4.24.5.1. Gift ForceAuth Transactions .................................................................................. 137 4.24.5.2. Examples .............................................................................................................. 137

4.24.5.2.1. Swiped Gift Force ........................................................................................... 137 4.24.5.2.2. Manual Gift Force (ForceAuth Redeem) ........................................................... 138 4.24.5.2.3. Manual Gift Force (ForceAuth Reload) ............................................................. 138

4.24.6. Response Values ......................................................................................................... 139 4.25. Planet Payment ................................................................................................................. 139

4.25.1. ProcessDCCLookup ...................................................................................................... 140 4.25.1.1. Examples .............................................................................................................. 140

4.25.1.1.1. DCC Lookup ................................................................................................... 140 4.25.2. ProcessMCPLookup ..................................................................................................... 141

4.25.2.1. Supported Currency Codes .................................................................................... 141 4.25.2.2. Examples .............................................................................................................. 142

4.25.2.2.1. MCP Lookup ................................................................................................... 142 4.25.3. GetInfo ....................................................................................................................... 143 4.25.4. ProcessCreditCard ....................................................................................................... 143

4.25.4.1. Currency Conversion ............................................................................................. 144

4.25.4.2. Examples .............................................................................................................. 144 4.25.4.2.1. Credit Sale with DCC ....................................................................................... 144 4.25.4.2.2. Credit Sale with MCP ...................................................................................... 145

4.25.5. Response Values ......................................................................................................... 146 4.26. Profit Stars ........................................................................................................................ 147

4.26.1. ProcessCreditCard ....................................................................................................... 147 4.26.2. ProcessDebitCard ........................................................................................................ 147 4.26.3. ProcessEBTCard .......................................................................................................... 147

4.27. TSYS (Host) ........................................................................................................................ 148 4.27.1. GetInfo ....................................................................................................................... 148 4.27.2. ProcessCheck .............................................................................................................. 148 4.27.3. ProcessCreditCard ....................................................................................................... 149 4.27.4. ProcessDebitCard ........................................................................................................ 149

4.27.4.1. Examples .............................................................................................................. 150 4.27.4.1.1. Manual Debit Reversal .................................................................................... 150

4.27.5. ProcessEBTCard .......................................................................................................... 152 4.27.6. ProcessGiftCard ........................................................................................................... 152 4.27.7. Additional Extended Data ............................................................................................ 153 4.27.8. Response Values ......................................................................................................... 153

4.28. TSYS (Terminal) .................................................................................................................. 154 4.28.1. GetInfo ....................................................................................................................... 154 4.28.2. ProcessCheck .............................................................................................................. 154 4.28.3. ProcessCreditCard ....................................................................................................... 155 4.28.4. ProcessDebitCard ........................................................................................................ 156

4.28.4.1. Examples .............................................................................................................. 157 4.28.4.1.1. Manual Debit Reversal .................................................................................... 157

4.28.5. ProcessEBTCard .......................................................................................................... 158 4.28.6. ProcessGiftCard ........................................................................................................... 159 4.28.7. Response Values ......................................................................................................... 159

4.29. Valutec .............................................................................................................................. 160 4.29.1. GetInfo ....................................................................................................................... 160

4.30. Vantiv (Cincinnati) ............................................................................................................. 160 4.30.1. ProcessCreditCard ....................................................................................................... 160 4.30.2. ProcessDebitCard ........................................................................................................ 161 4.30.3. ProcessEBTCard .......................................................................................................... 161 4.30.4. ProcessGiftCard ........................................................................................................... 162 4.30.5. ProcessLoyaltyCard ..................................................................................................... 162 4.30.6. Response Values ......................................................................................................... 162

4.31. Vantiv (St. Petersburg) ....................................................................................................... 162 4.31.1. GetInfo ....................................................................................................................... 163 4.31.2. ProcessCreditCard ....................................................................................................... 163 4.31.3. ProcessDebitCard ........................................................................................................ 164 4.31.4. ProcessEBTCard .......................................................................................................... 165 4.31.5. ProcessGiftCard ........................................................................................................... 165 4.31.6. ProcessLoyaltyCard ..................................................................................................... 166 4.31.7. Response Values ......................................................................................................... 166

4.32. WorldPay .......................................................................................................................... 166 4.32.1. GetInfo ....................................................................................................................... 166

4.32.2. ProcessCheck .............................................................................................................. 167 4.32.3. ProcessCreditCard ....................................................................................................... 167 4.32.4. ProcessDebitCard ........................................................................................................ 168 4.32.5. ProcessEBTCard .......................................................................................................... 170 4.32.6. ProcessGiftCard ........................................................................................................... 170

A. Appendix .................................................................................................................................. 171 A.1. Valid Input Characters ......................................................................................................... 171 A.2. XML Character Removal ....................................................................................................... 172 A.3. Invoice Number ................................................................................................................... 173

Changes and Modifications The table below lists changes made to the PathwayLINK Transaction Processing API Guide:

Version Changes/Modifications Pages 1.0 Document launch. All

1.1 Added contactless documentation pg. 25, pg.42

1.2 Updated contactless documentation pg. 25, pg.42

1.2.2 Added Invoice Number appendix pg.173

Chapter 1. Introduction

1.1. Overview

This document assists Point‐of‐Sale (POS) developers in integrating directly with BridgePay’s PathwayLINK Payment Gateway using the following integration methods:

.NET Web services HTTPS POST SOAP

1.2. Testing

A test or live merchant account with BridgePay is necessary to successfully process transactions. To acquire a test account, contact the BridgePay Developer Support Department at [email protected] or fill out the test account request form at http://www.bridgepaynetwork.com/testAccount.php.

You may use the following cards in testing:

Card Type Number MasterCard 5439750001500347

Visa 4005550000000019

Discover 60011111111111117

Diners 36999999999999

AMEX 374255312721002

If you implement swiped, card‐present transactions (Credit, Debit, EBT, Gift Cards), please send a request to [email protected], and we will ship a set of test cards to you.

1.2.1. Testing for PIN-based Transactions

Personal identification number (PIN)‐based debit testing requires an encryption scheme‐injected PIN pad by a specific processor and either a physical live or test card to run transactions.

1.2.2. Duplicate Transaction Handling

BridgePay highly recommends that all integrators take duplicate transactions into consideration when performing PathwayLINK integration.

10

A duplicate transaction is a transaction with the same card number, expiration date, amount, and date of a previously processed transaction. At the merchant’s preference, BridgePay can enable or disable a gateway‐level option called Force Duplicates. BridgePay strongly encourages all merchant accounts enable the Force Duplicates option. If a merchant account enables Force Duplicates and a duplicate transaction occurs, the response returned contains a duplicate transaction message. Sample 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://gateway.itstgate.com/SmartPayments/"> <Result>110</Result> <RespMSG>Duplicate Transaction</RespMSG> <Message>Duplicate Transaction</Message> <PNRef>415607</PNRef> <HostCode>415606</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response> The duplicate transaction response returns a Result of 110, a RespMSG and Message of Duplicate Transaction, and HostCode property containing the PNRef of the original transaction. You can set the Force property within the ExtData field to T to force duplicate transaction processing, regardless of merchant account settings. This method of overriding individual transactions helps eliminate accidental duplicates (i.e., double charges) while still processing valid duplicates on a case‐by‐case basis.

11

Chapter 2. Web Service Functionality

PathwayLINK makes a test and documentation .asmx page available to integrators:

https://gateway.itstgate.com/SmartPayments/transact.asmx

This page contains online documentation and a testing form for each operation. During integration, it may be helpful to process sample transactions using the test forms to get a feel of how the various operations work or to troubleshoot integration problems.

The following Transaction Processing Operations are currently supported by PathwayLINK:

GetInfo – Retrieves information from the Web service. ProcessCheck – Processes check transactions for a merchant. ProcessCreditCard – Processes credit card transactions for a merchant. ProcessDebitCard – Processes debit card transactions for a merchant. ProcessEBTCard – Processes EBT card transactions for a merchant. ProcessGiftCard – Processes gift card transactions for a merchant ProcessLoyaltyCard – Processes loyalty cards for a merchant. ProcessSignature – Sends a signature to apply to a receipt transaction.

2.1. GetInfo

This Web service operation retrieves information pertaining to the transaction type (TransType) specified. The URL to access this operation is:

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=GetInfo

The following table contains parameter descriptions.

Not all processors support all of the following features, and some processors may have additional functionality or custom requirements not listed below. Please reference the Processor Addendum on page 78 for additional information and to verify the supported functionality for your processor(s).

Parameter Description UserName Required. Username assigned in the payment server.

Password Required. Password for the username assigned in the payment server.

TransType Required. Type of GetInfo transaction. Valid values are:

BatchInquiry: Returns a comma‐delimited list containing the summarized transaction dollar amount and transaction count for each payment method in the current batch. The list takes the format: Payment_Type_Amount=X.XX,Payment_Type_Count=X.

Setup: Returns a comma‐delimited list containing merchant setup information. The list takes the format: Setup_Name1=Y|N,

12

Parameter Description Setup_Name2=Y|N.

StatusCheck: Returns OK if PathwayLINK makes a successful connection to the payment server with the supplied username and password; otherwise, an error message is returned.

Initialize: Returns the merchant account setup information (e.g., Partner Number, Merchant ID, credit card type, etc.).

ExtData Optional. Extended data in XML format. Valid values are:

<TrainingMode>Mode</TrainingMode> Enables/disables training mode. Valid values are: T, F.

2.1.1. Examples

The following examples show different functions available with this Web service operation. Change the credentials and payment information fields when running test transactions.

2.1.1.1. BatchInquiry

The following example retrieves information pertaining to the BatchInquiry TransType. After listing the dollar amount and transaction count for each TransType of a payment type, there is a net count and net amount for that tender type.

Parameter Value UserName Test

Password 123

TransType BatchInquiry

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://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <ExtData>

Credit_Sale_Amount=28.00,Credit_Sale_Count=28,Credit_Return_Amount=7.00,Credit_Ret urn_Count=7,Credit_Net_Amount=21.00,Credit_Net_Count=35,Debit_Sale_Amount=9.00,Deb it_Sale_Count=6,Debit_Return_Amount=1.00,Debit_Return_Count=1,Debit_Net_Amount=8.0 0,Debit_Net_Count=7,Check_Sale_Amount=0.00,Check_Sale_Count=0,Check_Net_Amount=0.0 0,Check_Net_Count=0

</ExtData>

</Response>

13

2.1.1.2. Setup

The following example retrieves information pertaining to the Setup TransType.

Parameter

Value

UserName Test

Password 123

TransType Setup

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <ExtData>Force_Duplicates=N,Auto_Close_Batch=Y,Industry=R,DEBIT=Y,AMEX=Y,CARTBLANCH=Y, DINERS=Y,DISCOVER=Y,JAL=Y,JCB=Y,MASTERCARD=Y,VISA=Y,EBT=Y</ExtData>

</Response> 2.1.1.3. StatusCheck

The following example retrieves information pertaining to the StatusCheck TransType.

Parameter Value

UserName Test

Password 123

TransType StatusCheck

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <ExtData>OK</ExtData>

</Response> 2.1.1.4. Initialize

The following example retrieves information pertaining to the Initialize TransType.

Parameter Value

UserName Test

14

Parameter

Value

Password 123

TransType Initialize

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <ExtData>

<Partner>110</Partner> <Vendor>206</Vendor> <MerchantID /> <PinPadKeyManagement /> <LiveURL>https://www.YourWebSite.com</LiveURL> <LiveURL1>https://www1.YourWebSite.com</LiveURL1> <TestURL>https://test.YourWebSite.com</TestURL> <TestURL1>https://test.YourWebSite.com</TestURL1> <EPSPay>/pay/payxml.aspx</EPSPay> <EPSlogin>/Admin/login.aspx</EPSlogin> <Phone1>425-123-1234</Phone1> <Phone2>425-123-1234</Phone2> <Auto_Close_Batch>N</Auto_Close_Batch> <eCheck>Y</eCheck> <CreditCard>Y</CreditCard> <PaymentTypes>

<CardType>Amex</CardType> <CardType>CartBlanch</CardType> <CardType>Diners</CardType> <CardType>Discover</CardType> <CardType>JAL</CardType> <CardType>JCB</CardType> <CardType>MasterCard</CardType> <CardType>Visa</CardType>

</PaymentTypes> <ExpressPay>

<CardType>Visa</CardType> <LTAmount>25</LTAmount> <Amount>0</Amount> <EntryMethod>S</EntryMethod> <ProcessingRule>On-Line</ProcessingRule> <PrintReceipt>N</PrintReceipt>

</ExpressPay> </ExtData>

</Response>

2.2. ProcessCheck

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

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessCheck

15



Parameter Description UserName Required. Username assigned in the payment server.


TransType Required. Type of the check transaction. Valid values are:

Sale: Makes a purchase with a check.

Auth: Authorizes/verifies the amount of a check.

Return: Returns the money of a settled check transaction to the check holder.

Void: Cancels an unsettled check transaction.

Force: Forces a previous sale transaction into the current batch (ForceSale).

Capture: Settles a single transaction in the current batch. Only for terminal‐based processors.

CaptureAll: Settles all transactions in the current batch. Only for terminal‐based processors.

CheckNum Required for all TransTypes but Void, Capture, and CaptureAll. Check number that uniquely identifies each individual check.

TransitNum Required for all TransTypes but Void, Capture, and CaptureAll. The transit number uniquely identifies a bank.

AccountNum Required for all TransTypes but Void, Capture, and CaptureAll. The account number uniquely identifies a check holder’s bank account.

Amount Required for all TransTypes but Void, Capture, and CaptureAll. The total transaction amount in DDDD.CC format.

MICR Optional. The Magnetic Ink Check Recognition data line, which includes TransitNum and AccountNum. Required for processing check‐present transactions. The format of the MICR is processor‐specific. If you are unsure about what format your check processor accepts, pass the RAW MICR as well in the TOAD format.

NameOnCheck Required for all TransTypes but Void, Capture, and CaptureAll. The check holder’s name as it appears on the check. The parameter may be required, depending on the merchant’s processor setup. This parameter removes invalid characters. See XML Character Removal on page 172 for more details.

16

Parameter Description

DL Optional. The check holder’s driver’s license number. This parameter

removes invalid characters. See XML Character Removal on page 172

for more details.

SS Optional. The check holder’s Social Security Number. This parameter

removes invalid characters. See XML Character Removal on page 172

for more details.

DOB Optional. The check holder’s date of birth. This parameter removes

invalid characters. See XML Character Removal on page 172 for more

details.

StateCode Optional. The check holder’s 2‐character state code. The parameter

may be required depending on the merchant’s processor setup. This

parameter removes invalid characters See XML Character Removal on

page 172 for more details.

CheckType Optional. The type of the check. Valid values are: Personal, Corporate,

Government.

ExtData Optional unless otherwise noted below or in the Processor Addendum

on page 78. Extended data in XML format. Valid values are:

<TimeOut>Timeout</TimeOut> Timeout value in seconds. The

default value is 30.

<PNRef>PNRef</PNRef> Reference number assigned by the

payment server. Required for Return, Void, Force, and Capture

transactions.

<Phone>Phone</Phone> Phone number. The data within this XML

tag parameter removes invalid characters. See XML Character

Removal on page 172 for more details.

<EMail>Email</EMail> Email address. The data within this XML tag

parameter removes invalid characters. See XML Character Removal

on page 172 for more details.

<RawMICR>RawMICR</RawMICR> Magnetic Ink Check Reader

data from the check reader in the format of

TransitNumTAccountNumOCheckNum. Required for check‐present

transactions.

The TOAD format is the accepted default format for Raw

MICR for all check processors.

<InvNum>Num</InvNum> Invoice tracking number. The data

within this XML tag parameter removes invalid characters. See XML

Character Removal on page 172 for more details.

<TrainingMode>Mode</TrainingMode> Enables/disables Training

Mode. Valid values are: T, F.

17

Parameter

Description

<AllianceNum>AllianceNum</AllianceNum> Alliance number for

the check.

<AccType>AccType</AccType> Bank account type for the check.

Valid values are: Checking or Saving.

<CityOfAccount>City</CityOfAccount> City of the check holder's

residential address. The data within this XML tag parameter

removes invalid characters. See XML Character Removal on page

172 for more details.

<BillToStreet>Street</BillToStreet> Street of the check holder's

billing address. The data within this XML tag parameter removes

invalid characters. See XML Character Removal on page 172 for

more details.

<BillToCity>City</BillToCity> City of check holder's billing address.

The data within this XML tag parameter removes invalid characters.

See XML Character Removal on page 172 for more details.

<BillToState>State</BillToState> Two‐character state code of the

check holder's billing address. The data within this XML tag

parameter removes invalid characters. See XML Character Removal

on page 172 for more details.

<BillToPostalCode>Code</BillToPostalCode> ZIP code of the check

holder's billing address. The data within this XML tag parameter



<BillToCountry>Country</BillToCountry> Country of the check

holder's billing address. The data within this XML tag parameter



<CustomerID>ID</CustomerID> Customer ID. The data within this

XML tag parameter removes invalid characters. See XML Character


<DebugData> Simulates scensarios for QA. Available in Debug

versions only.

<ForceFinishFailure>T</ForceFinishFailure> Valid values are: T,

F. Behavior is dependent on TransType:

Standard Transaction (e.g., Sale): Exception thrown prior to

final database write. QA/Debug.

Auto‐Reversal: status of void/reversal returned to user. QA.

Capture: In a multi‐segment batch, the second segment fails.

QA/Regression.

<SerializeProcessorHandler2Data>T</SerializeProcessorHandle r2Data> Serializes the objects associated with the Process and ProcessSettle interface methods via Log4Net. Informational.

18

Parameter Description Valid values are: T, F.

<ForceAdjustmentTransactionFailure>T</ForceAdjustmentTran sactionFailure> Generates an Adjustment transaction exception before the final adjustment of the original record. Simulates cloned records but does not adjust the original transaction. QA/Debug. Valid values are: T, F.

</DebugData>

2.2.1. Examples


2.2.1.1. Manual Check Sale

The following example processes a manually entered check Sale transaction.


Password 123

TransType Sale

CheckNum 1001

TransitNum 123456780

AccountNum 1234567890

Amount 100.00

NameOnCheck John Doe

StateCode WA

ExtData <CityOfAccount>City</CityOfAccount><BillToStreet>123</BillToStreet> <BillToPostalCode>99999</BillToPostalCode>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>GUEIJQ</AuthCode> <PNRef>2400</PNRef>

19

</Response>

2.2.1.2. Swiped Check Sale

The following example processes a swiped check Sale transaction. Because a swiped check sale is a check‐present transaction, the ExtData parameter includes the RawMICR data.


Password 123

TransType Sale

CheckNum 1001



Amount 100.00

MICR 1234567801234567890


StateCode WA

ExtData <RawMICR>123456780T1234567890O1001</RawMICR>

Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>AUTH NUM 121-704</AuthCode> <PNRef>11622</PNRef>

</Response>

2.2.1.3. Manual Check Return

The following example processes a manually entered check Return transaction. Because this is a return transaction, the PNRef element is present within the ExtData parameter.

Parameter

Value

UserName Test

Password 123

20

Parameter Value TransType Return

CheckNum 100



Amount 100.00


StateCode WA

ExtData <PNRef>821</PNRef><CityOfAccount>Any Town</CityOfAccount><Bill ToStreet>123</BillToStreet><BillToPostalCode>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>GWNICP</AuthCode> <PNRef>2406</PNRef> <ExtData>InvNum=1001</ExtData>

</Response> 2.2.1.4. Check Void

The following example processes a check Void transaction. Because this is a void transaction, the PNRef element is present within the ExtData parameter.

Parameter Value

UserName Test

Password 123

TransType Void

ExtData <PNRef>2405</PNRef>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result>

21

<RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>GW5NPQ</AuthCode> <PNRef>2405</PNRef>

</Response>

2.3. ProcessCreditCard

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

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessCreditCard




UserName Required. Username assigned in the payment server.


TransType Required. Type of the credit card transaction. Valid values are:

Sale: Makes a credit card purchase.

Adjustment: Modifies the existing TipAmt, TaxAmt, TotalAmt, or

PONum for an original sale.

Support for this TransType is processor‐specific.

Auth: Authorizes an amount on a credit card.

Return: Credits the cardholder’s account.

Void: Removes an unsettled transaction from the open batch. Pass

null values for CardNum and ExpDate when running void

transactions.

Force: Places an Auth transaction into the current batch (PostAuth)

or places a transaction that is unprocessed by the payment server

into the current batch (ForceAuth).

Capture: Settles a single transaction in the current batch; only for

terminal‐based processors.

CaptureAll: Settles all transactions in the current batch; only for

terminal‐based processors or host‐based processors that support a

batch release feature.

22

Parameter Description RepeatSale: Performs a recurring billing or installment payment transaction.

Reversal: Performs a manual full reversal on a credit sale or repeat sale. Reversals must process within 24 hours of the original transaction.

CardNum Optional for all TransTypes but Sale, Auth, Return, and Force (ForceAuth). Credit card number.

ExpDate Optional for all TransTypes but Sale, Auth, Return, and Force (ForceAuth). Credit card’s expiration date in MMYY format.

MagData Required for swiped card transactions. Data located on the track 2 of the card’s magnetic strip. Once this field is populated, the transaction is a card‐present transaction and usually results in a more favorable retail discount rate.

The format of the MagData (or track 2 data) is CardNum=ExpDate + the service code + the checksum. For example, 36438999960016=05121015432112345678.

This parameter removes invalid characters. See XML Character Removal on page 172 for more details.

NameOnCard Optional, depending on different merchant processor setups. The cardholder’s name as it appears on the card. This parameter removes


details.

Amount Required for Auth, Sale, Return, Force (both PostAuth and ForceAuth) TransTypes. The total transaction amount in DDDD.CC format.

InvNum Optional. Invoice tracking number. This parameter removes invalid

characters. See XML Character Removal on page 172 for more details. See table A3 in Appendix for Invoice formatting by Processor.

PNRef Required for Void, Force (PostAuth), and Capture TransTypes. Reference number assigned by the payment server.

Zip Optional, depending on different merchant processor setups. The ZIP code from the cardholder billing address that is used in address

verification. This parameter removes invalid characters. See XML


Street Optional, depending on different merchant processor setup. Street address from cardholder’s billing address that is used in address verification. This parameter removes invalid characters. See XML


CVNum Optional. Card Verification Number. A 3 or 4‐digit security code that is printed on the front or back of a card but not encoded on the magnetic

stripe data.

23

Parameter Description ExtData Optional unless otherwise noted below or in Processor Addendum on page 78. Extended data in XML format. Valid values are:

<AuthCode>Code</AuthCode> Original authorization code. Required for ForceAuth transactions.

<CustCode>Code</CustCode> Customer code or PO number of the customer. The data within this XML tag parameter removes invalid characters See XML Character Removal on page 172 for more details.

<ConvenienceAmt>Amount</ConvenienceAmt> Convenience amount in DDDD.CC format.

<TipAmt>Amount</TipAmt> Tip amount in DDDD.CC format.

<TaxAmt>Amount</TaxAmt> Tax amount in DDDD.CC format.

<TotalAmt>Amount</TotalAmt> Total amount in DDDD.CC format.

<SequenceNum>Num</SequenceNum> Sequence number used with RepeatSale installments that designates which number in the sequence the transaction is. Must be a positive integer less than or

equal to SequenceCount.

<SequenceCount>SequenceCount</SequenceCount> Used with RepeatSale installment transactions. Designates the total number of charges to be charged. Must be a positive integer greater than

or equal to SequenceNum.

<ServerID>ID<ServerID> Unique server identification number. The data within this XML tag parameter removes invalid characters. See XML Character Removal on page 172 for more details.

<TimeOut>TimeOut</TimeOut> for timeout value in seconds (default value is 40 for a transaction, 300 for a settlement transaction).

<TrainingMode>Mode</TrainingMode> Enables/disables Training Mode. Valid values are: T, F.

<TransactionID>ID</TransactionID> Numerical string value that you can pass with the original request to identify a transaction. May be used for identification and voids. Please see Credit Void

with Transaction ID page 32 for a detailed example.

<Target>Target</Target> Identifies the TransactionID of the original transaction you wish to void.

<Force>Force</Force> Enables/disables the processing of this current transaction if it is a duplicate transaction. Valid values are: T, F.

<RegisterNum>Num</RegisterNum> Register number. The data within this XML tag parameter removes invalid characters. See XML Character Removal on page 172 for more details.

24


<City>City</City> City of the cardholder's billing address. The data within this XML tag parameter removes invalid characters. See XML Character Removal on page 172 for more details.

<BillToState>State</BillToState> Two‐character state code of

the cardholder's billing address. The data within this XML tag parameter removes invalid characters. See XML Character Removal on page 172 for more details.

<CustomerID>ID</CustomerID> Customer ID.

<PONum>Num</PONum> Purchase Order Number. The data

within this XML tag parameter removes invalid characters. See XML Character Removal on page 172 for more details.

<BillPayment>BillPayment</BillPayment> Indicates if a transaction

is a utility bill payment. Valid values are: T, F. Only supported for Sale and RepeatSale transactions. This tag is only relevant in Retail, MOTO, and eCommerce markets.

<Authentication> Required to process a transaction using Visa’s

Verified By Visa and MasterCard’s SecureCode programs.

<XID>AuthenticationID</XID> The Unique Transaction Identifier (applies to Verified By Visa) <UCAF>UCAF</UCAF> Universal Card Holder Authentication (applies to MasterCard’s SecureCode).

Verified by Visa may return a CAVV value in the response ExtData.

<TrustAttempt>T</TrustAttempt> Indicates Verified By Visa or SecureCode attempted, but there was no XID or UCAF available for the transaction. Valid values are: T, F.

</Authentication>

<CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID is sent with the request. Valid values are: None, NotSubmitted, Submitted, Illegible, NotPresent [on card].

<Presentation> Indicates card presence in a transaction.

<CardPresent>CardPresent Value</CardPresent> Valid values are: True: Card is present. False: The card is not present or unknown.

</Presentation>

<EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY. <TPP ID> tppid </TPP ID > Id for Conttactless needed by Omaha.

<Invoice> Required for Level III purchase card processing but

25


optional for fuel purchases. Indicates the beginning of invoice details.

All elements within Invoice are processed sequentially, so they must be sent in the order listed below.

<InvNum>Num</InvNum> Purchase invoice number.

<Date>Date</Date> Date of invoice in YYMMDD format. <BillTo>

<CustomerId>ID</CustomerId> Customer ID number.

<Name>Name</Name> Customer

name. <Address> Customer address.

<Street>Street</Street> Street of customer’s

address. <City>City</City> City of customer’s address.

<State>State</State> State of customer’s address.

<Zip>ZIP</Zip> ZIP code of customer’s address.

<Country>Country</Country> Country of customer’s address.

</Address> <Email>Email</Email> Customer’s email.

<Phone>Phone</Phone> Customer’s phone number.

<Fax>Fax</Fax> Customer’s fax number. <CustCode>Code</CustCode> Customer code.

<PONum>Num</PONum> Purchase order number from customer.

<TaxExempt>TaxExempt</TaxExempt> Customer’s tax‐exempt status.

</BillTo>

<Description>Description</Description> Description of purchase.

<Items> Required for Level III purchase card and fuel purchases (Sale and Force TransTypes). Items contained in invoice. Contains one or more Item elements.

<Item>One item in invoice. There may be multiple Item tags within the Items tag.

<SKU>SKU</SKU> SKU number of item.

<UPC>UPC</UPC> Required for Level III purchase card processing and fuel purchases. Valid values depend on the type of purchase: For purchase card Level III processing: The UPC

26


number of item. For fuel processing: National Association of Convenience Stores (NACS) product code.

<Description>Description</Description> Item description.

<Quantity>Quantity</Quantity> Required for Level III purchase card processing and fuel purchases. Quantity of item purchased.

<UnitOfMeasurement>Unit</UnitOfMeasurement> Unit of measurement for item.

<UnitPrice>Price</UnitPrice> Required for Level III purchase card processing and fuel purchases. Unit price of item.

<DiscountAmt>Amount</DiscountAmt> Discount amount on item. <TaxAmt>Amount</TaxAmt> Tax amount on item. <TotalAmt>Amount</TotalAmt> Total amount of item.

<Category>Category</Category> Required for Level III purchase card processing and fuel purchases. Item category. If making a fuel purchase, the value is Fuel. <TaxRate>Rate</TaxRate> Tax rate applied to item.

</Item> </Items>

<DiscountAmt>Amount</DiscountAmt> Total discount for invoice.

<ShippingAmt>Amount</ShippingAmt> Shipping amount for invoice. <DutyAmt>Amount</DutyAmt> Duty amount for invoice <TaxAmt>Amount </TaxAmt> Tax amount for invoice.

<NationalTaxInc>NationalTax</NationalTaxInc> Additional tax amount included in invoice total.

<TotalAmt>Amount</TotalAmt> Total amount of the transaction on the invoice.

</Invoice>

<Fleet> Required for fleet card purchases (Sale and Force TransTypes). Information on fleet member making purchase.

Please note that all elements nested within Fleet are processed sequentially, so they must be in the order listed below.

<VehicleNum>Num</VehicleNum> May be required for specific

27


purchases. Vehicle number.

<DriverNum>Num</DriverNum> May be required for specific purchases. The vehicle driver’s number.

<OdometerReading>Reading</OdometerReading> May be required for specific purchases. The current odometer reading of the fleet vehicle.

</Fleet>

<CardType>Type</CardType> Describes the payment methods to settle or card type. Requirements and values depend on TransType:

‐ Capture: This element does not apply to the Capture TransType

as only one transaction settles. ‐ CaptureAll: Optional. Valid values are:

ALL to specify all payment methods to settle.

A combination of the specific payment methods to settle, separated by a colon (e.g., CREDIT:DEBIT:EBT:EGC).

Host‐based processors that support a manual batch settlement require all payment methods to be settled at the same time.

‐ All other TransTypes: Required for manually entered fleet card transactions where the ISO prefix of the card is only present on the track data (not embossed on the front of the card). Valid values are: WEX, Voyager.


versions only. <ForceFinishFailure>T</ForceFinishFailure> Valid values are: T, F. Behavior is dependent on TransType:

Standard Transaction (e.g., Sale): Exception thrown prior to final database write. QA/Debug.

Auto‐Reversal: status of void/reversal returned to user. QA. Capture: In a multi‐segment batch, the second segment fails. QA/Regression.

<SerializeProcessorHandler2Data>T</SerializeProcessorHandle r2Data> Serializes the objects associated with the Process and ProcessSettle interface methods via Log4Net. Informational. Valid values are: T, F.


28

Parameter

Description

</DebugData>

2.3.1. Purchase Card Level III Data

PathwayLINK supports purchase card Level III data for credit transactions. Located in the ExtData, Invoice and its child elements pass invoice information in line‐item detail to processors for verification.

Not all processors support this functionality. For more information on this feature and its supporting processors, please see Processor Addendum on page 78.

2.3.2. Fuel Purchases

PathwayLINK supports fuel purchases on both standard credit and fleet cards using the Items element nested under Invoice.


2.3.3. Examples


2.3.3.1. Manual Credit Sale

The following example processes a manually‐entered credit Sale transaction. Because the ExtData field has Force set to T, the payment processes, even if it is a duplicate transaction.

Parameter

Value

UserName Test

Password 123

TransType Sale

CardNum 5454545454545454

ExpDate 0509

NameOnCard John Doe

Amount 1.00

ExtData <Force>T</Force>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>006063</AuthCode> <PNRef>2296</PNRef> <HostCode>03530EVV3K2ZA2F453Q</HostCode> <GetAVSResult>N</GetAVSResult> <GetAVSResultTXT>No Match</GetAVSResultTXT> <GetStreetMatchTXT>No Match</GetStreetMatchTXT> <GetZipMatchTXT>No Match</GetZipMatchTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response>

2.3.3.2. Manually Entered Credit Auth

The following example processes a manually entered credit Auth transaction as a commercial card.


Password 123

TransType Auth

CardNum 4055016727870315

ExpDate 0509

NameOnCard John Doe

Amount 1.00

InvNum 1001

ExtData <TaxAmt>0.50</TaxAmt><CustCode>102</CustCode>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL VITAL1</Message> <AuthCode>VITAL1</AuthCode>

30

<PNRef>2275</PNRef> <GetCommercialCard>True</GetCommercialCard> <ExtData>InvNum=1001,CardType=VISA</ExtData>

</Response> 2.3.3.3. Swiped Credit Return

The following example processes a swiped credit Return transaction.

Parameter Value

UserName Test

Password 123

TransType Return

CardNum 371449635398431

ExpDate 1205

MagData 371449635398431=05121015432112345678

NameOnCard John Doe

Amount 1.00

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL VITAL7</Message> <AuthCode>VITAL7</AuthCode> <PNRef>2307</PNRef> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=AMEX</ExtData>

</Response> 2.3.3.4. Credit Void with PNRef

The following example processes a credit Void transaction. The request identifies the transaction to void using the PNRef from the original transaction.

You must pass null values for the card number and ExpDate on void transactions.

Parameter Value

UserName Test

31

Parameter

Value

Password 123

TransType Void

PNRef 2308

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <AuthCode>VITAL4</AuthCode> <PNRef>2309</PNRef>

</Response> 2.3.3.5. Credit Void with Transaction ID

The following example processes a credit Void transaction using the TransactionID element. Note that in order to void a transaction using its Transaction ID, you must send it within the ExtData of the original transaction.

For illustrative purposes, this example includes the original sale transaction.

Original Sale Transaction


Password 123

TransType Sale

CardNum 5439750001500347

ExpDate 1211

NameOnCard John Smith

Amount 3

ExtData <TransactionID>12345</TransactionID>

Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/">

32

<Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>000312</AuthCode> <PNRef>32</PNRef> <HostCode>801020000032</HostCode> <GetAVSResult>0</GetAVSResult> <GetAVSResultTXT>Issuer did not perform AVS</GetAVSResultTXT> <GetStreetMatchTXT>Service Not Requested</GetStreetMatchTXT> <GetZipMatchTXT>Service Not Requested</GetZipMatchTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData> <TransactionID>12345</TransactionID>

</Response>

Void Transaction To void this transaction using the TransactionID, you must pass it in the ExtData of the void request.

Please note that the value of the Transaction ID is nested within a child element of

TransactionID, Target.

Parameter

Value

UserName Test

Password 123

TransType Void

CardNum 5439750001500347

ExpDate 1211


Amount 3

ExtData <TransactionID><Target>12345</Target></TransactionID>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>000312</AuthCode> <PNRef>33</PNRef> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

33

</Response>

2.3.3.6. Credit Force with Training Mode

The following example processes a credit Force (PostAuth) transaction in Training Mode.


Password 123

TransType Force

NameOnCard John Doe

Amount 1.00

PNRef 2310

ExtData <TrainingMode>T</TrainingMode>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <AuthCode>DEMO-2</AuthCode> <PNRef>2318</PNRef>

</Response> 2.3.3.7. Manually Entered Credit Force

The following example processes a manually entered credit Force (ForceAuth) transaction.

Parameter Value

UserName Test

Password 123

TransType Force

CardNum 5454545454545454

ExpData 0515

NameOnCard John Doe

Amount 1.00

ExtData <AuthCode>123456</AuthCode>

34

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>123456</AuthCode> <PNRef>2317</PNRef> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response> 2.3.3.8. Credit Capture

The following example processes a credit Capture transaction to settle a single transaction in the current batch. The request targets the individual transaction using its PNRef.


Password 123

TransType Capture

PNRef 2327

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>ACCEPTED</Message> <AuthCode>GB00029 ACCEPTED</AuthCode> <ExtData>Net_Count=1,Net_Amount=1,Settle_DT=2004-04-13 15:36:26</ExtData>

</Response> 2.3.3.9. Credit Capture All

The example data below processes a credit CaptureAll transaction to settle all transactions in the current batch.

Parameter

Value

UserName Test

Password 123

35

Parameter Value TransType CaptureAll

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>ACCEPTED</Message> <AuthCode>GB00030 ACCEPTED</AuthCode> <ExtData>Net_Count=1,Net_Amount=1,Settle_DT=2004-04-13 15:42:45</ExtData>

</Response> 2.3.3.10. Responses with Single/Multiple Batch Detail

The following examples highlight differences between single and multi‐batch settlement details.

Single Batch Success Response

The example below shows the response detail of a successful single batch settlement. Note that the ExtData only has one Detail child element.



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>ACCEPTED</Message> <Message1></Message1> <Message2></Message2> <AuthCode>GB00258 ACCEPTED</AuthCode> <PNRef></PNRef>

<HostCode>GB00258 ACCEPTED</HostCode> <HostURL></HostURL> <ReceiptURL></ReceiptURL> <GetAVSResult></GetAVSResult> <GetAVSResultTXT></GetAVSResultTXT> <GetStreetMatchTXT></GetStreetMatchTXT> <GetZipMatchTXT></GetZipMatchTXT> <GetCVResult></GetCVResult> <GetCVResultTXT></GetCVResultTXT> <GetGetOrigResult></GetGetOrigResult> <GetCommercialCard>False</GetCommercialCard> <WorkingKey></WorkingKey> <KeyPointer></KeyPointer>

<ExtData> CardType=ALL,Net_Count=3,Net_Amount=-3.00,Settle_DT=2006-06-27

36

12:41:52,BatchNum=258,Batch= <Summary>Net_Count=3,Net_Amount=-3.00,Settle_DT=2006-06-27 12:41:52,Result=0</Summary> <Detail>Net_Count=3,Net_Amount=-3.00,Settle_DT=2006-06-27 12:41:52,Result=0,Number=258,AuthCode=GB00258 ACCEPTED,Message=ACCEPTED</Detail>

</ExtData> </Response> Multi-Batch Success The example below shows the response detail of a successful multiple batch settlement. Note that the ExtData has three Detail child elements, one for each batch. <?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://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>ACCEPTED</Message> <Message1></Message1> <Message2></Message2> <AuthCode>GB00261 ACCEPTED</AuthCode> <PNRef></PNRef> <HostCode>GB00261 ACCEPTED</HostCode> <HostURL></HostURL> <ReceiptURL></ReceiptURL> <GetAVSResult></GetAVSResult> <GetAVSResultTXT></GetAVSResultTXT> <GetStreetMatchTXT></GetStreetMatchTXT> <GetZipMatchTXT></GetZipMatchTXT> <GetCVResult></GetCVResult> <GetCVResultTXT></GetCVResultTXT> <GetGetOrigResult></GetGetOrigResult> <GetCommercialCard>False</GetCommercialCard> <WorkingKey></WorkingKey> <KeyPointer></KeyPointer> <ExtData>

CardType=ALL,Net_Count=9,Net_Amount=-9.00,Settle_DT=2006-06-27 12:43:49,BatchNum=261,Batch= <Summary>Net_Count=9,Net_Amount=-9.00,Settle_DT=2006-06-27 12:43:49, Result=0</Summary> <Detail>Net_Count=4,Net_Amount=-4.00,Settle_DT=2006-06-27

12:43:49,Result=0,Number=259,AuthCode=GB00259 ACCEPTED, Message=ACCEPTED</Detail> <Detail>Net_Count=4,Net_Amount=- 4.00,Settle_DT=2006-06-27 12:43:52,Result=0,Number=260,AuthCode=GB00260 ACCEPTED, Message=ACCEPTED</Detail> <Detail>Net_Count=1,Net_Amount=-1.00,Settle_DT=2006-06-27 12:43:54, Result=0,Number=261,AuthCode=GB00261 ACCEPTED, Message=ACCEPTED</Detail>

</ExtData> </Response>

37

Multi-Batch Partial Success

In a multi‐batch settlement, you may receive a partially successful response if the individual batches have mixed results. Note that in the ExtData, only the third Detail element has a successful Result Code (Result = 0).



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>15</Result> <RespMSG>Partial</RespMSG> <Message>ACCEPTED</Message> <Message1></Message1> <Message2></Message2> <AuthCode>GB00262 ACCEPTED</AuthCode> <PNRef></PNRef> <HostCode>GB00262 ACCEPTED</HostCode> <HostURL></HostURL> <ReceiptURL></ReceiptURL> <GetAVSResult></GetAVSResult> <GetAVSResultTXT></GetAVSResultTXT> <GetStreetMatchTXT></GetStreetMatchTXT> <GetZipMatchTXT></GetZipMatchTXT> <GetCVResult></GetCVResult> <GetCVResultTXT></GetCVResultTXT> <GetGetOrigResult></GetGetOrigResult> <GetCommercialCard>False</GetCommercialCard> <WorkingKey></WorkingKey> <KeyPointer></KeyPointer> <ExtData>

CardType=ALL,Net_Count=1,Net_Amount=-1.00,Settle_DT=2006-06-27 12:48:15,BatchNum=262,Batch= <Summary>Net_Count=1,Net_Amount=-1.00,Settle_DT=2006-06-27 12:48:15,Result=15</Summary> <Detail>Net_Count=4,Net_Amount=-4.00,Settle_DT=2006-06-27 12:48:15,Result=12,Number=262,Message=RB E 0004 D 24</Detail> <Detail>Net_Count=4,Net_Amount=-4.00,Settle_DT=2006-06-27 12:48:17,Result=12,Number=262,Message=RB E 0006 D 24</Detail> <Detail>Net_Count=1,Net_Amount=-1.00,Settle_DT=2006-06-27 12:48:19,Result=0,Number=262,AuthCode=GB00262 ACCEPTED,Message=ACCEPTED</Detail>

</ExtData> </Response>

2.3.3.11. Credit RepeatSale

The following example processes a credit RepeatSale transaction as a recurring payment based on the PNRef number of a previous sale transaction.

Parameter

Value

UserName Test

Password 123

TransType RepeatSale

38

Parameter

Value

PNRef 2329

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL VITAL2</Message> <AuthCode>VITAL2</AuthCode> <PNRef>2332</PNRef> <GetCommercialCard>False</GetCommercialCard>

</Response>

2.3.3.12. Tip Adjustment

The following example processes an Adjustment transaction to modify the tip for an original sale transaction.




Password 123

TransType Sale

CardNum 5439750001500347

ExpDate 1208


Amount 12.00

Zip 33019

Street 123 Main Street

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/">

39

<Result>0</Result> <RespMSG>Approved</RespMSG> <Message>NO MATCH</Message> <AuthCode>TAS770</AuthCode> <PNRef>27722</PNRef> <HostCode>704623500829</HostCode> <GetAVSResult>N</GetAVSResult> <GetAVSResultTXT>No Match</GetAVSResultTXT> <GetStreetMatchTXT>No Match</GetStreetMatchTXT> <GetZipMatchTXT>No Match</GetZipMatchTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response>

Adjustment Transaction

To add a tip to the original sale transaction, you must send an adjustment transaction with credentials, the PNRef of the original sale, and a TipAmt in the ExtData.


Password 123

TransType Adjustment

PNRef 27722

ExtData <TipAmt>3.00</TipAmt>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <PNRef>27723</PNRef> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response> 2.3.3.13. Manual Credit Reversal

The following example processes a credit Reversal transaction.

Reversal transactions are not supported by all processors, and there may be processor‐specific requirements that differ than the data shown below. See Processor Addendum on page 78 for more information.

40



Parameter Value

UserName Test

Password 123

TransType Sale

CardNum 5439750001500347

ExpDate 1211


Amount 10.00

InvNum 12345

CVNum 998

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL TAS275</Message> <AuthCode>TAS275</AuthCode> <PNRef>23851</PNRef> <HostCode>833115500058</HostCode> <GetAVSResult>0</GetAVSResult> <GetAVSResultTXT>Issuer did not perform AVS</GetAVSResultTXT> <GetStreetMatchTXT>Service Not Requested</GetStreetMatchTXT> <GetZipMatchTXT>Service Not Requested</GetZipMatchTXT> <GetCVResult>M</GetCVResult> <GetCVResultTXT>Match</GetCVResultTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>InvNum=12345,CardType=MASTERCARD</ExtData>

</Response>

Reversal Transaction To target a sale transaction, the reversal transaction uses the PNRef returned in the original sale transaction’s response.

Parameter

Value

UserName Test

Password 123

41

Parameter

Value

TransType Reversal

PNRef 23851

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL TAS275</Message> <AuthCode>TAS275</AuthCode> <PNRef>23852</PNRef> <HostCode>23852</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData><Voided>T</Voided></ExtData>

</Response> 2.3.3.14. Credit Sale with CVPresence

The following example processes a credit Sale transaction with the CVPresence element. Note that the request uses the extended 9‐digit ZIP code and the CV presence of the card is marked Illegible in the ExtData.

Parameter Value

UserName Test

Password 123

TransType Sale

CardNum 4012000033330026

ExpDate 1208


Amount 29.95

Zip 631461234

Street 12115 Lackland

ExtData <CVPresence>Illegible</CVPresence>

Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

42

xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL TAS275</Message> <AuthCode>TAS275</AuthCode> <PNRef>23851</PNRef> <HostCode>833115500058</HostCode> <GetAVSResult>0</GetAVSResult> <GetAVSResultTXT>Issuer did not perform AVS</GetAVSResultTXT> <GetStreetMatchTXT>Service Not Requested</GetStreetMatchTXT> <GetZipMatchTXT>Service Not Requested</GetZipMatchTXT> <GetCVResult>M</GetCVResult> <GetCVResultTXT>Match</GetCVResultTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>InvNum=12345,CardType=MASTERCARD</ExtData>

</Response>

2.3.3.15. Credit Sale with Contactless

The following example processes a credit Sale transaction with the Proximity element. Note that the request uses the Entry mode element to denote a NFC or contactless transaction. The MagData field is where you pass your NFC payload.

Parameter Value

UserName Test

Password 123

TransType Sale

CardNum 4005578000000978

ExpDate 1215

MagData

%B4005578000000978^CARDHOLDER/VISA^151210155555012340000

0000005561034150200004005578000000978=1012101555554150302

1

Amount 1.00

ExtData <EntryMode>Proximity</EntryMode><TPP ID>.I01<TPP ID>

Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

42

xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL TAS275</Message> <AuthCode>TAS275</AuthCode> <PNRef>23851</PNRef> <HostCode>833115500058</HostCode> <GetAVSResult>0</GetAVSResult> <GetAVSResultTXT>Issuer did not perform AVS</GetAVSResultTXT> <GetStreetMatchTXT>Service Not Requested</GetStreetMatchTXT> <GetZipMatchTXT>Service Not Requested</GetZipMatchTXT> <GetCVResult> Service Not Requested </GetCVResult> <GetCVResultTXT>Match</GetCVResultTXT> <GetCommercialCard>False</GetCommercialCard> <ExtData>InvNum=12345,CardType=VISA</ExtData>

</Response>

2.4. ProcessDebitCard

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

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessDebitCard






TransType Required. Type of the debit card transaction. Valid values are:

Sale: Makes a debit card purchase.

Return: Credits the cardholder’s account.



CaptureAll: Settles all transactions in the current batch; only for

terminal‐based processors or host‐based processors that support

a batch release feature.

Reversal: Performs a manual full reversal on a debit sale or repeat

sale. Reversals must process within 24 hours of the original

transaction.

43

Parameter

Description

CardNum Required for all TransTypes except Capture and CaptureAll. Debit

card number.

ExpDate Required for all TransTypes except Capture and CaptureAll. Debit

card’s expiration date in MMYY format.

MagData Required for all TransTypes except Capture and CaptureAll. Data

located on the track 2 of the magnetic strip of the card. Once this field

is populated, the transaction is a card‐present transaction and usually

results in a more favorable retail discount rate.

The format of the MagData (or Track 2 data) is CardNum=ExpDate +

the service code + the checksum. For example,

36438999960016=05121015432112345678.

This parameter removes invalid characters. See XML Character


NameOnCard Optional, depending on different merchant processor setups. The

cardholder’s name as it appears on the card. This parameter removes


details.

Amount Required for all TransTypes except CaptureAll. The total transaction

amount in DDDD.CC format. This amount includes CashBackAmt and

SureChargeAmt.


characters. See XML Character Removal on page 172 for more

details. See table A3 in Appendix for Invoice formatting by Processor.

PNRef Optional except for Force and Capture TransTypes. Reference number

assigned by the payment server.

Pin Required except for Capture, CaptureAll, and PIN‐less debit

transactions. The encrypted PIN block returned by the PIN pad. The

transaction fails if an unencrypted PIN value is used.

RegisterNum Optional. A number that uniquely identifies the register or computer

performing transactions. This parameter removes invalid characters.

See XML Character Removal on page 172 for more details.

SureChargeAmt Optional. The fee a merchant charges for processing debit

transactions. In DDDD.CC format.

CashBackAmt Optional. The amount a cardholder requests for cash back. In

DDDD.CC format.

ExtData Optional unless otherwise noted below or in Processor Addendum on

page 78. Extended data in XML format. Valid values are:

Extended data in XML format. Valid values are:

<TimeOut>TimeOut</TimeOut> Timeout value in seconds.

44


Default value is 40.

<TrainingMode>Mode </ TrainingMode> Enables/disables processing transaction in Training Mode. Valid values are: T, F.

<KeySerialNumber>Number</ KeySerialNumber> Required for all Sale, Auth, Force, and Return transactions that require PIN. Manages DUKPT PIN pads transactions that require PIN input.


<Items> Required for purchase card Level III processing and fuel purchases. Items contained in invoice. Contains one or more Item elements.

<Item>One item in invoice.

<SKU>SKU</SKU> SKU number of item.

<UPC>UPC</UPC> Required for purchase card –Level III and fuel purchases. UPC number of item for purchase card ‐ Level III processing or the NACS (National Association of Convenience Stores) product code for fuel purchases. <Description>Description</Description> Item description.

<Quantity>Quantity</Quantity> Required for purchase card ‐Level III processing and fuel purchases. Quantity of item purchased.

<UnitOfMeasurement>Unit</UnitOfMeasurement> Unit of measurement for item.

<UnitPrice>UnitPrice</UnitPrice> Required for purchase card Level III processing and fuel purchases. Unit price of item.

<DiscountAmt>DiscountAmount</DiscountAmt> Discount amount on item.

<TaxAmt>Amount</TaxAmt> Tax amount on item.

<TotalAmt>Amount</TotalAmt> Total amount of item.

<Category>Category</Category> Required for for purchase card Level III processing and fuel purchases. Item category for Purchase Card Level III or Fuel to designate a fuel purchase item. <TaxRate>TaxRate</TaxRate> Tax rate applied to item.

</Item> </Items>

<DebugData> Simulates scensarios for QA. Available in Debug versions only.

<ForceFinishFailure>T</ForceFinishFailure> Valid values are:

45


T, F. Behavior is dependent on TransType:



Capture: In a multi‐segment batch, the second segment fails. QA/Regression.

<SerializeProcessorHandler2Data>T</SerializeProcessorHandl er2Data> Serializes the objects associated with the Process and ProcessSettle interface methods via Log4Net. Informational. Valid values are: T, F.

<ForceAdjustmentTransactionFailure>T</ForceAdjustmentTra nsactionFailure> Generates an Adjustment transaction exception before the final adjustment of the original record. Simulates cloned records but does not adjust the original transaction. QA/Debug. Valid values are: T, F.

</DebugData>

2.4.1. PIN-less Debit Transactions

PathwayLINK supports the ability to process a debit transaction without the customer’s PIN, a “PIN‐less” debit transaction. The transaction sends the same information as a typical PIN‐based debit transaction, with the exception of the encrypted PIN‐block and Key Serial Number. This functionality is only supported by certain processors. See Processor Addendum on page 78 for more information.

2.4.2. Debit Fuel Purchases

PathwayLINK supports fuel purchases using standard debit cards. Debit fuel purchases require passing item‐level purchase information to the gateway to ensure correct processing. This functionality is only supported by certain processors. See Processor Addendum on page 78 for more information.

2.4.3. Examples


46

2.4.3.1. Swiped Debit Sale

The following example processes a swiped debit Sale transaction. Note that the sale amount of $6.00 includes a cash back amount of $5.00.

Parameter Value

UserName test

Password 123

TransType Sale

CardNum 4055011111111111

ExpDate 1205

MagData 4055011111111111=05121015432112345678

NameOnCard John Doe

Amount 6.00

InvNum 1001

Pin 6366C0466A74C3F6

CashBackAmt 5.00

ExtData <Timeout>100</Timeout><KeySerialNumber>4A003102930003BB</Ke ySerialNumber>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL VITAL7</Message> <AuthCode>VITAL7</AuthCode> <PNRef>2428</PNRef> <ExtData>InvNum=1001,CardType=DEBIT</ExtData>

</Response> 2.4.3.2. Swiped Debit Return

The following example processes a swiped debit Return transaction.

Parameter Value UserName test

Password 123

TransType Return

47

Parameter Value CardNum 4055011111111111

ExpDate 1205

MagData 4055011111111111=05121015432112345678

Amount 1.00

PNRef 2428

Pin 6366C0466A74C3F6

ExtData <KeySerialNumber>4A003102930003BB</KeySerialNumber>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL VITAL9</Message> <AuthCode>VITAL7</AuthCode> <PNRef>2430</PNRef> <ExtData>CardType=DEBIT</ExtData>

</Response> 2.4.3.3. Manual Debit Reversal

The following example processes a manual debit Reversal transaction.

Reversal transactions are not supported by all processors, and processor‐specific requirements may differ than those shown below. See Processor Addendum on page 78 for more information.



Parameter Value

UserName test

Password 123

TransType Sale

CardNum 9999999800002773

ExpDate 0509


48

Parameter

Value

Amount 20.00

Pin 402ABE473425535E

ExtData <KeySerialNumber>0123456780269000008</KeySerialNumber>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVAL TAS332</Message> <AuthCode>TAS332</AuthCode> <PNRef>23853</PNRef> <HostCode>833115500674</HostCode> <ExtData>CardType=DEBIT</ExtData>

</Response>

Reversal Transaction To target the transaction for reversal, this example uses the PNRef of the original sale transaction.


Password 123

TransType Reversal

CardNum 9999999800002773

ExpDate 0509

PNRef 23853

Response



</Response>

49

2.5. ProcessEBTCard

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

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessEBTCard



Parameter Value UserName Required. Username assigned in the payment server.


TransType Required. Type of the EBT card transaction. Valid values are:

FoodStampSale: Makes a purchase on an EBT cardholder’s food stamp account.

FoodStampReturn: Applies a credit to an EBT cardholder’s food stamp account.

CashBenefitSale: Makes a purchase on an EBT cardholder’s cash benefit account.

Inquire: Checks the balance of an EBT cardholder’s account.

Capture: Settles a single transaction in the current batch; only for terminal‐based processors.

CaptureAll: Settles all transactions in the current batch; only for terminal‐based processors or host‐based processors that support a

batch release feature.

Force (Voucher Clear): Allows a merchant perform a PIN‐less EBT sale by passing a voucher number and an authorization code obtained via voice approval.

CardNum Required for all TransTypes but Capture and CaptureAll. EBT card number to process the transaction.

ExpDate Required for all TransTypes but Capture and CaptureAll. EBT card’s expiration date in MMYY format.

50

Parameter Value MagData Required for swiped card transactions. Data located on the track 2 of the card’s magnetic strip. Once this field is populated, the transaction is a card‐present transaction and usually results in a more favorable retail discount rate.

The format of the MagData (or Track 2 data) is CardNum=ExpDate + the service code + the checksum. For example, 36438999960016=05121015432112345678.


NameOnCard Optional, depending on different merchant processor setup. The cardholder’s name as it appears on the card.

Amount Required for all TransTypes but CaptureAll. The total transaction amount in DDDD.CC format. This amount includes CashBackAmt and SureChargeAmt.



PNRef Optional for all TransTypes but Capture and FoodStampReturn. The reference number assigned by the payment server.

Pin Required for all TransTypes except for Capture and CaptureAll. The encrypted PIN block returned by the PIN pad. The transaction fails if an

unencrypted PIN value is used.

RegisterNum Optional. A number uniquely identifies a register or computer, on which the transaction is performed. This parameter removes invalid

characters. See XML Character Removal on page 172 for more details.

SureChargeAmt Optional. The fee a merchant charges for processing an EBT card transaction. In DDDD.CC format.

CashBackAmt Optional, and only applies to CashBenefitSale TransType. The amount a cardholder requests for cash back. In DDDD.CC format.

ExtData Optional unless otherwise noted below or in Processor Addendum on page 78. Extended data in XML format. Valid values are:

<TimeOut>TimeOut</TimeOut> for timeout value in seconds (default = 40).

<TrainingMode>Mode</TrainingMode> to process transaction in Training Mode. Valid values are: T, F.

<KeySerialNumber>Number</KeySerialNumber > Required for all FoodStampSale, FoodStampReturn, CashBenefitSale, and Inquire transactions that require PIN. Manages DUKPT PIN pads transactions that require PIN input.

<Force>Force</Force> Enables/disables the processing of this

51

Parameter

Value

current transaction if it is a duplicate transaction. Valid values are:

T, F.

<AuthCode>Code</AuthCode> Original authorization code.

Required for Force transactions.

<VoucherNumber>VoucherNumber<VoucherNumber> Required

for Force TransType. Number provided in voice authorization.


versions only.

<ForceFinishFailure>T</ForceFinishFailure> Valid values are: T,

F. Behavior is dependent on TransType:

Standard Transaction (e.g., Sale): Exception thrown prior to

final database write. QA/Debug.


Capture: In a multi‐segment batch, the second segment fails.

QA/Regression.



</DebugData>

2.5.1. Examples


2.5.1.1. Swiped EBT Food Stamp Sale

The following example processes a swiped EBT FoodStampSale transaction.

Parameter Value

UserName test

Password 123

TransType FoodStampSale

CardNum 4055011111111111

52

Parameter

Value

ExpDate 0613

MagData 4055011111111111=05121015432112345678

Amount 10.00

Pin 6366C0466A74C3F6


Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>FoodStampBalanceAmount: 6543.21</Message> <AuthCode>VITAL1</AuthCode> <PNRef>2431</PNRef> <ExtData>CardType=EBT</ExtData>

</Response> 2.5.1.2. Manually Entered EBT Food Stamp Return

The following example processes a manually entered EBT FoodStampReturn transaction.


Password 123

TransType FoodStampReturn

CardNum 4055011111111111

ExpDate 0613

Amount 10.00

PNRef 2459

Pin 6366C0466A74C3F6


Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/">

53

<Result>0</Result> <RespMSG>Approved</RespMSG> <Message>FoodStampBalanceAmount: 6553.21</Message> <AuthCode>VITAL6</AuthCode> <PNRef>2460</PNRef> <ExtData>CardType=EBT</ExtData>

</Response> 2.5.1.3. Manually Entered EBT Cash Benefit Sale

The following example processes a manually entered EBT CashBenefitSale transaction.


Password 123

TransType CashBenefitSale

CardNum 4055011111111111

ExpDate 0613

Amount 10.00

InvNum 1002

Pin 6366C0466A74C3F6

CashBackAmt 5


Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>CashBenefitBalanceAmount: 1234.56</Message> <AuthCode>VITAL8</AuthCode> <PNRef>2461</PNRef> <ExtData>CardType=EBT</ExtData>

</Response>

54

2.5.1.4. EBT Force (Voucher Clear)

The following example processes an EBT Force (Voucher Clear) transaction that allows for a merchant to perform a PIN‐less EBT transaction using the voucher slip reference number and an authorization code obtained through a voice approval.

Parameter

Value

UserName test

Password 123

TransType Force

CardNum 9999999800002773

ExpDate 0809

Amount 2.00

ExtData <AuthCode>999999</AuthCode><VoucherNumber>123456</Voucher

Number>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVAL TAS597</Message> <AuthCode>TAS597</AuthCode> <PNRef>31028</PNRef> <HostCode>723519513832</HostCode> <ExtData>CardType=EBT</ExtData>

</Response>

2.6. ProcessGiftCard

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

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessGiftCard



55

Parameter Value UserName Required. Username assigned in the payment server.


TransType Required. Type of the gift card transaction. Valid values are:

Redeem: Makes a purchase on a gift card.

Reload: Increases the balance on a gift card.

Refund: Refunds money back to a gift card.

Activate: Activates a gift card.

Deactivate: Deactivates a gift card.

Inquire: Checks the balance on a gift card.

Void: Undoes an unsettled transaction.

Capture: Settles a single transaction in the current batch; only for terminal‐based processors.

CaptureAll: Settles 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 Required for swiped card transactions. Data located on the track 2 of the card’s magnetic strip. Once this field is populated, the transaction is a card‐present transaction and usually results in a more favorable retail

discount rate.

The format of the MagData (or Track 2 data) is CardNum=ExpDate + the service code + the checksum. For example, 36438999960016=05121015432112345678.


Amount Required for all TransTypes except Inquire. The total transaction amount in DDDD.CC format.



PNRef Optional for all TransTypes except Void. Reference number assigned by the payment server.

ExtData Optional unless otherwise noted below or in Processor Addendum on page 78. Extended data in XML format. Valid values are:


<Force>Force</Force> Enables/disables the processing of this current transaction if it is a duplicate transaction. Valid values are:

56

Parameter Value T, F.

<TimeOut>TimeOut</TimeOut> Timeout value in seconds (default value is 40).


<AuthCode>Code</AuthCode> Required for Force transactions. Original authorization code of a previously authorized Redeem transaction. See Gift Force Transactions on page 57 for more information.

<ForceAuth> Required for previously authorized Redeem, Reload, or Activate transactions if the request is placing them into the current batch. See Gift Force Transactions on page 57 for more information. <AuthCode>Code</AuthCode> Original authorization code of previous Redeem, Reload, or Activate transaction.

</ForceAuth>

<DebugData> Simulates scensarios for QA. Available in Debug versions only.

<ForceFinishFailure>T</ForceFinishFailure> Valid values are: T, F. Behavior is dependent on TransType:


Auto‐Reversal: status of void/reversal returned to user. QA. Capture: In a multi‐segment batch, the second segment fails.

QA/Regression.



</DebugData>

2.6.1. Gift Force Transactions

PathwayLINK supports Force (ForceAuth) transactions for previously authorized Redeem, Reload, and Activate transactions.

57


2.6.2. Examples


2.6.2.1. Swiped Gift Redeem

The following example processes a swiped Redeem transaction on a gift card. The ExtData includes the enabled Force element to ensure processing even if this is a duplicate transaction.

Parameter Value

UserName test

Password 123

TransType Redeem

CardNum 6032250001350000156

ExpDate 0509

MagData 6032250001350000156=09051015432112345678

Amount 10.00

InvNum 1001

ExtData <Force>T</Force>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>GiftCardBalanceAmount: 10.00</Message> <PNRef>2355</PNRef> <HostCode>100004389913</HostCode> <ExtData>InvNum=1001,CardType=EGC</ExtData>

</Response>

2.7. ProcessLoyaltyCard

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

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessLoyaltyCard

58



Parameter

Value



TransType Required. Type of the loyalty card transaction. Valid values are:

Redeem: Makes a purchase on a loyalty card.

Reload: Increases the balance on a loyalty card.

Refund: Refunds value back to a loyalty card.

Activate: Activates a loyalty card.

Deactivate: Deactivates a loyalty card.

Inquire: Checks the balance on a loyalty card.

Void: Removes an unsettled transaction from the open batch.



CaptureAll: Settles all transactions in the current batch or host‐

based processors that support a batch release feature.

CardNum Required. Loyalty card number used to process the transaction.

ExpDate Required. Loyalty card’s expiration date in MMYY format.

MagData Required for swiped card transactions. Data located on the track 2 of

the card’s magnetic strip. Once this field is populated, the transaction is

a card‐present transaction and usually results in a more favorable retail

discount rate.

The format of the MagData (or Track 2 data) is CardNum=ExpDate +

the service code + the checksum. For example,

36438999960016=05121015432112345678.

This parameter removes invalid characters. See XML Character


Amount Required for all TransTypes except Inquire. The total transaction

amount in DDDD.CC format.



PNRef Optional for all TransTypes except Void. Reference number assigned by

the payment server.

59

Parameter Value ExtData Optional unless otherwise noted below or in Processor Addendum on




<TimeOut>TimeOut</TimeOut> Timeout value in seconds (default value is 40).


2.7.1. Examples


2.7.1.1. Loyalty Redeem

The following example processes a Redeem transaction for a loyalty card.

Parameter Value

UserName test

Password 123

TransType Redeem

CardNum 6043990501000200

ExpDate 1212

MagData 6043990501000200=12129881

Amount 1

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>LoyaltyCardBalanceAmount: 953</Message> <AuthCode>A</AuthCode> <PNRef>27120</PNRef>

60

<ExtData>CardType=LOYALTY</ExtData>

</Response> 2.7.1.2. Loyalty Reload

The following example processes a Reload transaction for a loyalty card. This request adds 5 points to the card balance.

Parameter Value

UserName test

Password 123

TransType Reload

CardNum 6043990501000200

ExpDate 1212

MagData 6043990501000200=12129881

Amount 5

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>LoyaltyCardBalanceAmount: 957</Message> <AuthCode>A</AuthCode> <PNRef>27122</PNRef> <ExtData>CardType=LOYALTY</ExtData>

</Response>

2.8. ProcessSignature

This Web service operation processes signature image data and saves it on the payment server. The URL to access this operation is:

https://gateway.itstgate.com/SmartPayments/transact.asmx?op=ProcessSignature



61

Parameter Value



SignatureType Required. Type of signature to capture. Valid values are:

Signature1: Legacy format for Lipman credit.

Signature2: Legacy format for Lipman check.

Signature3: Legacy format for handheld applications using

AppForge.

Signature4: Standard vector coordinate format.

Receipt1: TIFF file.

SignatureData Required.

For Signature4: A string value of vector coordinates delimited with

a ^ character in the following format: x1,y1^x2,y2^xN,yN^~.

‐ The carat (^) is the coordinate delimiter.

‐ The tilde (~) is the ending delimiter.

‐ The comma (,) is the vector delimiter.

For pen‐up events, use the coordinate 0,65535 to signal

a break in the line.

For Receipt1: Compress and Base64 encode the image data. See

the following section, Creating a Receipt Image Transaction from a

File, for more information.

PNRef Required. The unique payment reference number assigned to the

transaction.

Result Optional. An indicator that specifies if the processed transaction was

approved.

AuthCode Optional. Original authorization code.

ExtData Optional unless otherwise noted below or in Processor Addendum on


<TrainingMode>Mode</TrainingMode> Enables/disables Training

Mode. Valid values are: T, F.

2.8.1. Creating a Receipt Image Transaction from a File

Due to the overall complexity of creating a receipt image with ProcessSignature, here is a general list of steps your client‐side application must perform in order to send images to the payment server:

1. If image is not already in TIF format, convert it now.

62

Perform LZW compression on the image data to reduce as the payment server rejects images larger than 25KB.

2. Compress the image using Zip compression to reduce the file size.

You may use any PKZip‐compatible Zip compressor/decompressor.

3. To ensure that the binary‐based information properly converts into text‐based

characters for ProcessSignature, use Base64 to encode the image.

4. Input the compressed, Base64‐encoded image data into the SignatureData parameter and send the request to the payment server.

2.8.2. Examples


2.8.2.1. Drawing a Square

The following example uses the Signature4 SignatureType to draw a square on the receipt and associates it with the transaction with a PNRef of 9568.


Password 123

PNRef 9568

SignatureType Signature4

SignatureData 20,20^20,30^30,30^30,20^20,20^~

63

Result

2.8.2.2. Saving a Receipt Image

The following example uses the Receipt1 SignatureType to save a receipt image to the payment server and associate it with the transaction with a PNRef of 3.

Parameter Value

UserName test

Password 123

PNRef 3

SignatureType Receipt1

SignatureData UEsDBBQAAAAIAI2MPzKHziuFjggAAAo+AAA/AAAAUHJvZ3JhbSBGaWxlc y9Db21tb24gRmlsZXMvU21hcnRQYXltZW50cyBTaGFyZWQvVGVtcFJlY2 VpcHQuYm1w7dp/TBvXHQBw82MEOnfhx4TIymoIldL9gUSKOkBR4gaiLF K7dNKm/gFS+GGpVPJSkkWCRC65/KAxVRmQ5Y9tKpPJH1VXJov+UduZL HRNQGbTKDBpdRJcOMAVnjSOw0Oc7dyPt3d3vmLfe4dCFxam3gWf7/mj 9+6979179+4u9T995phJXqSvF+Hnc/h5OdNkyoD/pKW/1oRdAADSB7/Ey 8oMM8wwwwzbFROJbfKRuha9lp3TUhL/YCE2xji2Vg8kY2n32VCXoM0s5

xNo969D55Cdysb1Z5UUHsAbC7PCP2yZcUbaTFjwbcAuhhlmmLxQqcZtY

64

Parameter Value 0Lar+kmyuuI/Ic3l1p4mgEiueJ1TM5sQY1ULYIapRqHGqMaj1pMWlmlVRZ iCWk1o4aBSTPx68yoyY2Iq5WJpRup7tCJGty9yQobzhM448Fn8Hvj60ZuG ZM8TjMYiyWPBYkxLnksSLUdKSYkf6a0ZpUbL+8qIh3iFOM/s0glylWM7wf DhLhlcesiAUtUjvkGcDlTDAb6yj64oyLpJx6QiRSTt0wmq3KSmQjRlG6wEp S6CURLum2AlKU93RKpVptufKqB5037dfvY0p7p04btsm3gLDlAyl8xVcTk3 Kaw/KrptfhNc8twUU2vzdS+MVR2ykko5ok5GkOC27/wkZc7uzBPbdjP3K eS9mmNvS3EV96pH/Zy3ffmKdreOKvajdbeiSrhE/NXB8xHLrYXOOnftNW pZfpgj+bkuZQodACKoqWeqphQLdVfHliAMAD+AP4CT3LxKcYzpfslZ39bJq bkILds+WS12XQKVPOvlLxjKz1oKSzv+35me3KuOEb7O4MizTV1iom/NRM en+MfLKXYusetWLhTjBxpIN715f6iOGlsoNp8ovadai5QIkavvWnxZgxdL3c qJlWRgJXhCFGukTzmJfNFYS27gBRRXg7qwP8iZrqmnJrrWFPOUAFjUXhq 2viZye/wx6fP8+2DWRM/W3xNnZfDU5PifMwvxaBnVAx1MvTPG0OqwV OzgfOF379c7Lkthi4ySykGT83I+gxdcOzvf70lrhQwq+bBKtWkA80BGoAaA B6RBLMhX4KUuiin5jgQD0nXCjAQ3u2YGbanjEEtPlOWI6cCz04TGhO8NC WnONJDIhZVLIKxqYoFOUWhtnk5OZUYR22dUGakYM2K1OWx2vckLb6N

qR0dF88rDiU1eRSNJ00qqUcUGjPVVjDWmyxzAbVNdSf3UFvvUOu5B+L5

OIaN5wdKChdPr1VJ4eIZSP6Ci2dfssydxlO1/+N4Lv/oiJLC9Hd2JJnC9Pd11

TD9nc1Olonp7wl1noHp71E1tRf6u2GGGfYtssltjNG15RO2m/t+KLaUtFkR 2yQr7b8Cgp+OUYhFe2j7aYvgXxtHjZ3OGgwfFfyWN9AyWXlT8DveROuyJ G+KNjNrwbQBu+yylWxjY1hbPnEup2vZ3DoU3o8YjOc8YD0++xkKMRjPeX

jT6bPXo8ZO5z3oYnNbbx2yoAbAvHJfjOZbkp6Iyhcll04bkMUww76lZtnGS

F2LBqquVliKnyltIKdsJXcPr7ZezTyYU6H0zTG34wz4cMTOAN8YzQYZt70p6

BlT5uzvur/baPlw5K0OxdZeftU++8VR2bjpvMGw9WZG6TjptQ2xC5t/uvjG

j93hlPHzt9IzeN/ovzoXPG57Y8IzqtxbyFYhPTGZai3KPpXTej2z4Eb5Hoy1vk

X7LpftIwewxs6TTc1bT0zTTKCIH9zXMW4avDVJzuDL9JD2Jp188ZeO5WcB

fF22a8PumPyeQi8fqWeLReXke6WF56jezFdMGmO9Mdcc53GDuaDHr7F

Nb6xj7jlooWLvEY1FzWWHxqv6z1P3yl9waMuE90chjhRAKO0loVIXuPF7Y

E3AFQjvqO17x+JXql64m+skSntf/955jbFe2t55nwL2RsozqrFYANqsYre11 nfYHDvgJFYnrN4L2jKB0CFNvxgK+JC6gPhPJl0AOF1gv9Z2o+27YdG+c71di SstOOMild0gwVRibYh+FrCrUawF8n7XxfZXYE3aYnXqIm191YG17drwVIz

A22I+F81rK8Ia6wFck9eHtc0pgo/8GT9GRj/36xocP7mmIL7MxTLi3wUT2s

OwR+OpY8snD1O99fk95bn1+SaTNc1YOGrCoRNegYM+x0J6vvUxDkTqpi

8MRepmtMaOcZSeJTwjumVGA2VgUK5JT5mtJN12o+27YdHCC9k2Em/w

UhSidPJJ1qBnebdK2/XK3K4umpumx23DXrL4tbLT/PCN7IyX0PtNlo41ix/ N0/YOErHYao1VHJ53v4+ztdbT/IEbFfnjqLGMPPIwgEEtPiC/lZ0BovWJte+/ sR5C39Z08sV7svm3a5mwqQI1Yd4trtwH9NsUxhYqxblZwPWPY6ynQeyt Y2LPR1DbJMAjEgBaBKitE9JbTRCNY0xnMcwww3Zg8avHKQD45x5EPkH m0AL9urTtAE1CDLXj+tZbDcsE3V9Ojs1oLfk+7ixoRvMp7zf51ng4OqC1b9 q+3TQyfRIq29L1wxS8V225c/cS0gbWKz2HFvxUlxdpOxtY0rc+KZ6C/8uYF y1THjgFP9MVJJG6yJui7Z+TD53fpH2GGWaYYU/GyJ3ZeyUvnoCj1qyLEuu

mWtMtyH7shteKL2C2oM+XboFi2f5oBaDY50+3UG1OAxxBPyaB+PDTbo

2J8mvCEQKIQQ+dbk5e/o+M+QQAdVPVTzmeS9sYp2N8hqX3Vf6S2ebC5

Oti5h4KPj9FYMzB3AuCrjsNOOt2PTh4ecm8YsHYWSYCBN/WU5rUulywT

KbdIe2R83MHFp+4xLeVxm+aczPbtSaQNVyzQxj1zwUpxHpi3LhDuO1vKk

ZtupxbyeerzSfLnVrbJGIcwQkkvF1H8sGbJJ4ACdfWO869GTPDNPYfUEsBA

65

Parameter Value hQLFAAAAAgAjYw/MofOK4WOCAAACj4AAD8AAAAAAAAAAAAgALaBAA AAAFByb2dyYW0gRmlsZXMvQ29tbW9uIEZpbGVzL1NtYXJ0UGF5bWVud HMgU2hhcmVkL1RlbXBSZWNlaXB0LmJtcFBLBQYAAAAAAQABAG0AAAD rCAAAAAA=

Result

2.8.2.3. Saving a Check Image

The following example uses the Receipt1 SignatureType to save a check image to the payment server and associate it with the transaction with a PNRef of 5454.

Parameter

Value

UserName test

Password 123

PNRef 5454

SignatureType Receipt1

66

Parameter Value SignatureData UEsDBBQAAAAIAAJt9zC2UqllAxYAAEAYAAAzAAAAUHJvamVjdHMvU0RL L1RQSSBTb2Z0d2FyZS9FUFNDbGllbnQvVGVtcFJlY2VpcHQuYm1wdVgHX BPZ1gcMEKoJXQkQEkQsYKTHFkoksEhRUSy4kbWBjSKIojBLQIiABBBlxQbI YlsXUCwrCyMgC+uiUj6NAhKpCyIiLDVlzjdB93v7vvd7JzNzz71z59w7c//nf 8+Jj4/CYgUFBXX81FFUUCDgpbw4p6j4t65kojhHYc6sjrcoqnzV5RctBSW8 MMDPAUXtWZ0qv6U4d1bHbSpSFUl/91Fcqkj+26ZiuKLOVzvymsE/xjL8W zdoUpyvoPy1P1vR+P/0dYpWX5/FLSsun7WvimsBirazuh6uBymunNVn5y mX5bYMe4ajA4OxnOHkxJCLvb0j3h6w3NbO3sHRyZkRQKX+rTMZflSqg7 2drYLCBrYP1T0sMtwG77vWHX+eEfrvtr6Yb/g61mxpa7PchonfkI+ygrEcP 6hyRX4oQFb+KiI94ZeErGbKIoqaSzknPWH996tWE/mn5zAOURK6Oi7pM X0jnlHKnlFqz1Iy+4K3bLjgadXhdPkn+0Enz/Kzhc67EyKH+qLohfRCy3TaigV bw5OiOB4B88wcTzerpBU6H3QW7CX+etyIHcVhn3yUFO6oGEv+N4ka8o saFEYNJNgbdedubdZmauYwwz0jd2Xz6s1VnfspLzatVfHv0w56xsCnkdB1 nqncUda4JVbPcqPLyeE9Amv7gYz0ZlP6PYW7nN0RWd3HQg2+u7UqLeG Hvf8juGjrrOvq+nR3MX/giam6FdvT2EyPqRJDP1L98UdlW0UDFvVXk5+CL

A2OyeIk4jsIwBSUwKx03L+BfmABBhOAypAK2CQvPuG1c68DwewT+ur3R

3UlgHRvdatEiqOVtDwOzDM6MSX0pFar3pFF+7Cwu1YfzvrFzoT+qHw+i7

aVfQdgcLASEQe0+aEzEQOxCCrIdQAY1c4240rtBT9OQcO1SoYXAgTt3CQ Us77VhcBrLR4XotuJy+Dd4QQEKzTO50KQJMAA/asAXsOkMMwbJrNshpf B+Tx/Un1ZA2kh3N7OhfCaNhTbdjZRQ3NxC0ajrUQmsG/I+JKQq3NsXS/U

XwsKeXkvQZMYv8bOnfr2aOya7eBGawpWIYW2hRaXflw4WaDqhQzbg6

TSXtaKQuj1OFmcbCBTjI41Be3p3DGyfes+m87TIox0eAgePPYDyTggQpisP

yyBEj3wRKSnKl2hsF6a9HhiKYLA9BsWGv/oFqCWtd8h2MWZXYIKDzNxk

WhpxMeyWhjb5wKPx+ql9yqOycRalw3hlgr09MzEfATk7VA0SO/ltnuf+CC

TWlZ9urq3bZ8ZSL4RChFsaDkSavSQ2DNOFCAzcw0clxw/jrlXTTKPjbw7w9

rc5oVC3BoJAuVnQTh8MhAm8ybE0AYdDtOn3qPS9HAfFVIwMZjIT7PKJ6

Xx+TtT8tNZp+Apm80OiS6pgp+zsT23HGgr6L+NDWSoJi6kCWDtI6G+4cE

MvAvXbLRc1674zYZ5CneZ7le0qlZfMYQvQDZda4IsffQILpB+Lzh7oeAKMS SDL2ZdrYds3qq9F2osOHQyv8kl0ck0I0v6xCUhyYj6yu7QxvswWHx5aPJyy 1TID5/eYeOo9KVHfPqId/9vZ868nqlwDFa9SG00ngiD8XcrWgfjooZ/hEEn

dGgQwSq4LRCIfwKoRAY/s4+jkNq2UfDtEniwuEQWI4zPTYUuy0XLkO7b0

dO31Zbp/4VePwDv7iATcWGj3Kmh9nN1LEzrWvvtadoq6WtZ90xZTfzBkx

EFPfBuS1p0MXZRzD2eIYy7DthagEPI0EUWwMaeEqzqzB8gu/8Bk3gDF4Z

vn9h8XiRlnEclWiewKyAN2FwvMjf9GIhKSOj+84C1bteIkToIy4dV8kLvtIW W4ID8h7Dgq4w0/OpOb5Z+fsG7pB67kH5Bmj6v+IBd4+glu3qxlDrhozrA8 rFv9bEHLK1y4E1/Y3X5AbHj6vlWL5qvrlp/ZZtBY7s9XSVor2Z/mPNezQkQ Hx6/GtYSVl7+YXDw9WCrn18A7xYCLUhJSTFqsgO5vv6K1curAt2cT7J5HS NcmIoVDJBNfxNeHpGVNLTplG1O/A2NHRTCxIuR7iJfv7oNnVV1Jx0659Pr 9H3tzRfg8724pOq1eOQ2msdqdObROx9fdwbARB1v+jn9dREHYzynZCh7 nW/OJ6mFCQKisv6j0uN5xX+JKw8gI8IPgyH003wUJkZG2kXcpcf9RCAlm1

59qcDH0MGFgAlP7Ig62Da1n6fy+/hVCfdMxuLVgt7DzWWIrPzhfWFxu/cf

z3+cfHCntTXUwcdhE1cfZtR2TTrfVGelDu362flGTyqpCcc2nw+S4EOqB96

VvNlemqdpmUeG98/OyTEeiC1iYeg0PmEU/ouUyGAIEPEXMpSWJ2WZG

MrpO4rTKC8i6YWrdpCbTcjNZvTCFV8OG/5ABn6ckVdmNfkxYyLvNfbPLjN

JcjO7Z42xT8p7CejETHzfQMXkEDZ7KyWTxrQ4VXQqv4l/1qSuOIk9K64Fet

67

Parameter Value le5mT8sZ0J5mSaNr4drN8Ad1M8Cxpcn1FIlt96WWS5F2Wv1c52q7Zlkmv IzZQNK+jJOl56K9ya3c8zd2W6virmcGUWRLyJ6Z6zwsuCmMHzoqWEmp P1npIs1cyd+7Txe/Y0WnCLVQRlgUGNGQQTWuRmk7K9LFKPZluFu2R7pq 5kd3yy1mPWE9Qs8kguSbzP/t3NROf8VJM0rpT9H+KjEwMG6EyougX/Ay r2QkZDMtD4be4hgqJcsF68jrZGODSe7ZmBYjX0YUTiZcEHsF6q3k7Ee20t2 OJamOITj/qU8gA7XX25B2RL15C4MFSpAVDhEw+jAURBPIru5A/BVHsc8i bWk2yCyNIO2a6A6d26271FUqPD2ROgdbOT37SHEMKXEDg7oD+5hn7t 3npeiIOb28FXACf28xZq3XQOIZtESz9aS46Onz3c9QjivVVmmiHOafg+vMe gBVroJdjzuaI7E0hUtiy+V4Mq7KwUYs04tDeuZlVaC7AWb5hJtNnTW6PFN NXdRygzFsrsOVy0hVjbdjTL/40/+7gS/U0wlT8I49n4xGX7ZaudknWihj40m 8RXbbMumQraHOAoKSnKhvGSbVD4tkbi2+YdbIm/WpfJKHC/zTLZqJenh w8oixXJsA7GFXaHBYq0oNExnfPLyGQziIh7kOPgk73POm0twi3xDWk9uN GfjRzw7F52hR2F0K8RnxtzSFyM5oz7xaicq3UokSnOvfVWRzL8+4n+8zav O6Ltpu3fT6nN4lgd2erOo4uwX9RXuhKsCQZWOEovW+CAdc13OUvcwBh WImRSvfTkgHHL9lKil4hu7l2xkB0VTG5Or8VBvkRnfm1R1i4eocUlwT7psZf

FS3pDDdF8Z4KFf18GUZeQ7WWfWd7Qb70AWpYWk03ItRakee7nCoJw

UPv3bXXPYW60ikxZkqDkZepJssgszzJR9yKmulnTik+d+12JgIN8YxFRZ602

MeNUzvqJDwFjLjoJpQK5w/+HCEae9uqytVzLIy8oo2N6mxPIYwUUD2/5C 2Wwj9DrbeVuyUg3h4HPxt1fGJkOLVpCaAmDb6uiQDTJmZdwyZ7jth4kj+ 3Xdz1e5QSgHNihA0Pi15mnWmMlgIWKRThNIPAJBSEmevhwCCZrvA3py

XXL4Dv9exTrJJA7BiKRMwkX50iZzaF4KfLtoXi8jmmASNwFqBnAcznVTMA

Ifh3FtqUtP1a1wzitkGmIdywg+HdReRrEghrCJFEfwbZ973q3vn6qcwn0FW

1+MDIdD9hvnNdLiMuSSFwudrOGKKgV4JGch3GpnD0QWegjnMJe3f1U

wvrB4/gdE/L4DsO0pzEw1mJPFm0rOoNXcSJKK+IPtNF74/BdH+MRutzog

L1BIhDY1vN0F1YH0P9wtBadbk+Bz+wTCHRV9reqn8WIBokgrhECFvtX86

PHjsJpKheIy3K6yE0uV6ZvRKwVgoRIPlFD4BTi56WJ9OXkEI82cvFDcmgBYI

PxZ6v9h2bXCWASO3fjBBdkiH4XFpf117ykCKOMtc29HA/bAUGW3NG8p

XRBO0a0Xp1kqKak7Hf/N3zrFPslHkBqhV2jEfiHbYmVrb59QAxaU0RdFGb 23V7IwZf3mmK2Rt22wYLiMI3Uem8i6XMCyyqcHU8j2hB7kjiABfry25bw 2YsZp6MiyE8a5/tbmn/73NSc49+xxTX4tx7/oM0sWLDzG62NDU+DGuT0

bebIH8C/KudLxGMGDcYEyqeQJepORNd6Lsw2gbTBTb6M/21z+brjg/CrJg

MxVCAYKi+HcFDgPwDhkmxkquGR+xw7O7fVphnpklWNBIZ5w/vGxvQ9b

xuoCAQYueYPb3IYccVuAtz3lWATklZ4gfnuqQqy3wEzGUHHw1tlhgjsCHu

1eqjErwji+6KuYqzOOjxOlcaL54PInFaKyMYWpA4arAQzGC3FmFdAdhLBq hIRxsR48NigZOYqYDuULFidNkSS+PzIvQ/LpHg6kOu+7w6GImollSWATQq Fkuvt3svj23JRMOdSNo8NlzR4SkN+PTCij8Dk1Za4KdktOIrCeI2m9dD++1J GXkzo4C2Y/ttH8fhTgFOsDJEi2NZzy0AEDaXFBMe9NbpZ0+OIo11IkxvP6U qjeviZP+m7WeDn51dR0Vq5scUPeouvJCdrPp3vdMuhKvZMWH/BnUE6B 8CvtQSVgE/oRoCPJ4xorNjH46wbde5mMKV6d0dldO+2XVkmB88ULQNp WsLHFfFEQR1r4k0YSKt/NbUhm/38y8TzC8X9ploA+Z2etQeGnq/5E/2r82

05wF9+2MnRkSlMthpAInk9iQ4jpeceIhDPjtiujw7RmKTuKjeXD2/wEHF+2

53r1+OKLxfrVnDhX5meTrMG9PwLAvIln5VxmKkHMYqvwldMIF9CE2Q2F

pFfRH/nZf94VAxT5/PrYKxxC8cjLrv/eB5hhXrUPCplxmS9JpX6As+YtiZodu

mpaYWV5s2tCZ8xF8Fw/umKmHhfc91nNvPtzp74eLEthAXtUbpHX933PV

vU7jsRPQ3Y0GHJaIFXGQ5n6CyJmwxGZCU/wIQo6NNMykku2hFohs1cho

68

Parameter Value fD4+iQ5creeqF4GnYVM53+zDKFwapLORe+z50QhU3ZL4mNcZ9oFdWjW EWgGFv5QdoMKMSL25M1TjDf7YgNnPmDOZCOTJUcetwR86ri0GasJVlfp cxs4tdzauVt3ww+Ntba/s2rQ+pumUPwUej33Z2p/LrlanFPPVC0mzav/bR RJHVZz0yJTcp56L9zssYpq9d68TYICnWsJt6H+BDMScbSHwIuyh2e2m5t6 1kDAZWvo9Zus1vraTvn8nkPlUC7l3RiLUPQ13M8mfPy2vFjTcZZb00MVel JNg1deZw9zRQGhzZzNMxGL6ORfXSHoUq2c2hWracgq5uZBVBct0+h0b4 x1S6k0Ilca5WhtTt8u+ZNJVWac14j06g3kEw2v7Qdnq79IbLe/AZT2fwZpe BZ23p/cpu/Q9aT0VyV3iO5KpQUijRmjV7vrqydP/Tfe7t9kVWw/wm7s5GJ Sw7sibB9OQsbox8ijanXV6vv1kXwXeTA/6MQ6T0m9x+YAa4MJ0Uhd0SO Hdyf7vHVfRtcTjn7QfHlEhi6DjPKHsVs2zVRpJykhaTXlORF1EUkzk4e6S1R7 5L7lsjwPsVEl9773j+vsy0A6Tn1PFKrFSNvfwgxcd2FeUZk+1ZfoWtOz/x3cu uDQwgU4+ME3dh7b2t07ry4izcex4lyt0ZcvCtxsMM5EGK0J9AR37hPXncv T1RNiH8ZqMQnfMYYLZngDo58IUDYBAMnYArPTOUi4aKVyAj04LAz9zM n0AmAOWA9uL90oxMw17UEb8ffdMAaH/3nq/B7hOd3kZTP37AmtmW OB1v1wIuZX2rp6ltLNwGmt7gt6uqMkV6+tUhNFdKG8G2oq6o/T42FmR

wX6yzIRadFQkhyC9lzsitLS6MXxLQPngtX7XbnxzGNouXsKxLB+PuKQFzjes

OVZT19AC8MR8f+BHSMAXhohH9nBHxi5N5btQSfzxpU7p4zIt7u772IBzd

FAOT0wdR9zMMQTwC5nVfFsnjh6xoB9vizMJjHb/VxQEdnSCuz55R9PLh 5jLTGX83MTI9G/xGr2LFhskqIPaiA+z6bVm7YHFxj8Lj4ZnFqZZJm08ZFrH9 G2Dg1WLu9gj8Yz8k1Ogr5VTFPjungyUYQqy+/VLOW8VNC1537z/rKzGyI

O/SfFHb9FKRJVih3Tk9L9jR3I1jMnaNtoZFJc0lofOb4IjFjwUMh1eVP5ro6j

o4bPVGJZvGu8To7gtj1c0y+KSEpukynKUjL3f+9957ozP1LEi5QHDy7PEefB

uvQnHeraCp2EbuyjJUjnfdmPfns1PB9IR5F2W/MDKBYnqQ2ffagJGa4ZxD

1M2MSaXPvakX4siM7eAmtq3TvPXGij+Wf3htZ/7vr+6Ytvfba7g4vTWNsP

n5W93Cmfuvf+44Q8WIVLcVyBRuPUrtMLkV/5/qoP3L+G5dszX6ejgal6Zu

XKonV2ivmLW/imOB9meZ/UHqS9MspZDOChnrlDQty/XojF/40x4RWb9n

HdE/Spfc1ZqQVOi9QVvV3KectajZLMhy35r/ni0kPHtIHyCZKi7pOhfZH1tO

Y5Gry2Grz96l/RhKZy5vWavMInJpFL5zDtOcSg6kv+pjvT1GuW/Z2CDSOaL sfjDR5z+tOgQxdzMj76cvuWuc/KT18WU+giceCXzrzu5D6ypzprqyxNWq5i wnqRktPxnAHzBnD5weVCI7XKT35a51pK1yV6nfJxGbJx5JriIb5GSyxTTaxo

MW8Hs/KYhwuv1QoCnzBpBhFprDKE/Skhj085UKW1DH3DE/5Usx6KaPU

pYzXRTnJeLSYcswaIWgoH0hMp/rKkjQ647j5+06oEwU9dXFiw5UgKAp+dt

K9Rmta8IC3LlQr622MCZU/oK9OH0txDVSz4VRTIsa1UIIGQcN0OUUnuVn

vBNnr7ffROxOI1WldSjXKm2vJBm04Lc0nkw2Swoce8Epds96aEdRX6WsT DXmEqs4EJWTQo6E/6EqEqEb5c6rpM3wp8ERzTz9pKcmqnri0J8nwfcIuL TZC5pHJevLwNPhfgXvqSJKGptWWUcy5Pn662nydvdoWl1sMlxw2ycaIn0 6uJxtSjnJc9Vb/WOrdc3xXSrgLStaZp9Bm7z94EM+cI8jBbqTMB9a4vTSiB4 nPL2/4y6jAkxpQrb7u1yQ2783OI65B7p541nNT5XKCXi+RUvaC6evfH7n8 WTZPveeK0kc3Nxy5PUS5dyV7Gt9dIOW18FSTd9akUHc2ftbRUU30L0tZd Jl7byG11icg8fCT7A5vl+JDZPYhw93hbfS7eC4x30Y1cWv6G1NV5S2HkirOJ

9hz5lQX/WLmsbPN0/Yh+UmHwPj5NfrmoLlaEqa5ZgEO1xxXz0XryhoOZG

zpY86p7ZrcsDFzP2V8aYRz/277t1o5jF69/QH4C50mRaZQE/mnD3tGpqZ3

09iUm/zThH1+maVPvqQ5+lgZKJBm/1v/X1BLAQIUCxQAAAAIAAJt9zC2U

qllAxYAAEAYAAAzAAAAAAAAAAAAIAC2gQAAAABQcm9qZWN0cy9TREs

vVFBJIFNvZnR3YXJlL0VQU0NsaWVudC9UZW1wUmVjZWlwdC5ibXBQSw

69

Parameter Value UGAAAAAAEAAQBhAAAAVBYAAAAA

Result

70

Chapter 3. Response Values

3.1. Transact.asmx Response Fields

The following table contains descriptions of the fields returned in the responses from PathwayLINK.

Response Field Description

AuthCode The transaction result code from the payment processor.

GetAVSResult The overall address verification result code from the payment

processor.

When programmatically validating an AVS result, you

should always use this value instead of any formatted

response message describing the result.

GetAVSResultTXT The formatted response message describing the results of address

verification.

Never use this value when programmatically validating a

transaction’s AVS result; please see the GetAVSResult

field.

GetCommercialCard The payment processor's response indicator that specifies if the card is

a commercial card.

GetCVResult The card verification result code from the payment processor.

This value only applies to credit card transactions. The card verification

number is typically printed on the back of the card and not embossed

on the front. It is an extra authentication method for card‐not‐present

transactions.

When programmatically validating a CV result, you

should always use this value instead of any formatted

response message describing the result.

GetCVResultTXT The formatted response message describing the results of card

verification. This value only applies to credit card transactions.


transaction’s CV result; please see GetCVResult field.

GetStreetMatchTXT The formatted response message describing the results of street

number address verification.

71

Response Field

Description

GetZipMatchTXT The formatted response message describing the results of ZIP code

address verification.

HostCode Returns a number which uniquely identifies the transaction in the

payment processor.

Not all payment processors return this value.

Message A formatted response message concerning the processed transaction.

This value is typically APPROVAL for approved transactions or an error

message for declined transactions.


transaction’s result; please see the Result field.

Message1 Additional formatted response message to give more information

about the processed transaction.

The payment server only populates this field when there

is applicable information from the payment processor to

return.

Message2 Additional formatted response message to give more information

about the processed transaction.

The payment server only populates this field when there

is applicable information from the payment processor to

return.

PNRef Number that uniquely identifies the transaction in the payment

gateway.

RespMSG Response message concerning the processed transaction.


transaction’s result; please see the Result field.

Result Result code that signifies the result of the transaction.

For a list of these codes and their descriptions, see Result Code on page

73.

When programmatically validating a transaction’s result,

always use this value instead of any response message

describing the result.

72

Response Field

Description

ExtData Returns extended data from the processed transaction. Valid values

are:

<CAVVResponse>CAVVResponse</CAVVResponse> CAVV

Response.

<Summary>Summary</Summary> Summary of detail elements.

Includes Net_Count, Net_Amount, Settle_DT, and Result.

<Detail>Detail</Detail> Results of each batch segment processed

in a settlement transaction. Includes the Net_Count, Net_Amount,

Settle_DT, Result, Number, AuthCode, and Message.

The following returned fields follow a format consisting of the name of

the data field, an equal sign, and then the value for the data field.

When there are multiple returned fields, they are separated with a

comma. For example: Field1=X,Field2=X,Field3=X. Valid values are:

BatchNum: Current batch number, returned by the payment processor, for transactions, settlement, and batch inquiries.

CardType: The card brand.

InvNum: The same invoice number for the transaction that was originally sent in the request to the payment server.

Net_Count: Number of transactions in the closed batch. Additional information returned in a batch close.

Net_Amount: Net amount of transactions in the closed batch. Additional information returned in a batch close.

Settle_DT: The date and time of the requested batch close in YYYY‐MM‐DD HH:MM:SS format. Additional information returned in a batch close.

Batch: Pseudo root element. Indicates batch information.

3.2. Result Code Descriptions

3.2.1. Result Code

The following table contains descriptions of the result codes returned in the Result response field from PathwayLINK. Please note that when programmatically validating a transaction’s result, you should use this value instead of any other response message describing the result.

Value

Description

‐100 Transaction not processed; generic host error.

0 Approved.

1 User authentication failed.

73

Value

Description

2 Invalid transaction.

3 Invalid transaction type.

4 Invalid amount.

5 Invalid merchant information.

7 Field format error.

8 Not a transaction server.

9 Invalid parameter stream.

10 Too many line items.

11 Client timed out waiting for response.

12 Decline.

13 Referral.

14 Transaction type not supported in this version.

19 Original transaction ID not found.

20 Customer reference number not found.

22 Invalid ABA number.

23 Invalid account number.

24 Invalid expiration date.

25 Transaction type not supported by host.

26 Invalid reference number.

27 Invalid receipt information.

28 Invalid check holder name.

29 Invalid check number.

30 Check DL verification requires DL state.

40 Transaction did not connect (to NCN because SecureNCIS is not running on the

Web server).

50 Insufficient funds available.

99 General error.

100 Invalid transaction returned from host.

101 Timeout value too small or invalid timeout value.

102 Processor not available.

103 Error reading response from host.

74

Value

Description

104 Timeout waiting for processor response.

105 Credit error.

106 Host not available.

107 Duplicate suppression timeout.

108 Void error.

109 Timeout waiting for host response.

110 Duplicate transaction.

111 Capture error.

112 Failed AVS check.

113 Cannot exceed sales cap.

1000 Generic host error.

1001 Invalid login.

1002 Insufficient privilege or invalid amount.

1003 Invalid login blocked.

1004 Invalid login deactivated.

1005 Transaction type not allowed.

1006 Unsupported processor.

1007 Invalid request message.

1008 Invalid version.

1010 Payment type not supported.

1011 Error starting transaction.

1012 Error finishing transaction.

1013 Error checking duplicate.

1014 No records to settle (in the current batch).

1015 No records to process (in the current batch).

75

3.2.2. AVS Response Code

The following table contains the descriptions of possible response values returned for address verification (AVS).

If the response returned is blank for this specific field tag, there is a chance that your processor does not support these AVS codes.

Value

Description

‐100 Transaction not processed; generic host error.

X Exact; Address and nine‐digit ZIP match.

Y Yes: Address and five‐digit ZIP match.

A Address: Address matches, ZIP does not.

Z 5‐digit Zip: 5‐digit ZIP matches, address doesn’t.

W Whole Zip: 9‐digit ZIP matches, address doesn’t.

N No: Neither address nor ZIP matches.

U Unavailable: Address information not available.

G Unavailable: Address information not available for international transaction.

R Retry: System unavailable or timeout.

E Error: Transaction unintelligible for AVS or an edit error found in the message

prevents performing AVS.

S Not supported: Issuer doesn’t support AVS service.

B * Street match: Street addresses match for international transaction, but postal

code doesn’t.

C * Street address: Street addresses and postal code not verified for international

transaction.

D * Match: Street addresses and postal codes match for international transaction.

I * Not Verified: Address Information not verified for international transaction.

M * Match: Street addresses and postal codes match for international transaction.

P * Postal match: Postal codes match for international transaction, but street

address doesn’t.

0 ** No response sent.

5 Invalid AVS response.

* These values are Visa‐specific. ** These values are returned by the payment server and not the processor.

76

3.2.3. CV Response Code

The following table contains descriptions of the possible response values returned for a CVV2/CVC2/CID check.

If the response returned is blank for this specific field tag, there is a chance that your processor does not support these CVV response codes.

Value

Description

M CVV2/CVC2/CID Match.

N CVV2/CVC2/CID No Match.

P Not processed.

S Issuer indicates that the CV data should be present on the card, but the merchant

indicates that the CV data is not present on the card.

U Unknown: Issuer has not certified for CV or issuer has not provided

Visa/MasterCard with the CV encryption keys.

X Server provider did not respond.

77

Chapter 4. Processor Addendum

This section covers processor‐specific requirements, parameters, and elements. If you have questions regarding the information here or need additional help with your processor(s), please contact our integration specialists at [email protected].

4.1. American Express

This section details requirements and features specific to American Express. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].

Unless otherwise noted, assume that all parameters and elements inherit the same requirements as specified in main document.

4.1.1. ProcessCheck

The following table contains additional information for using the ProcessCheck Web service operation with American Express.


ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are:

UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY.

<CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID is sent with the request. Valid values are: None,

NotSubmitted, Submitted, Illegible, NotPresent [on card].

<Phase>Phase</Phase> Required for Capture TransType. Indicates the settlement phase. Because American Express uses a two‐phase

settlement, you must perform two distinct calls, a submission and a confirmation of the result. Valid values are: Submit, Confirm.

4.1.2. ProcessCreditCard

The following table contains additional information for using the ProcessCreditCard Web service operation with American Express.

Parameter

Description

ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values

for the payment information were obtained. Valid values are:

UNKNOWN,MANUAL,MAGNETICSTRIPE, ICC, PROXIMITY.

78

Parameter

Description

<CVPresence>CVPresence</CVPresence> Indicates if a

CVV2/CVC2/CID is sent with the request. Valid values are: None, NotSubmitted, Submitted, Illegible, [on card].

<Phase>Phase</Phase> Required for Capture TransType. Indicates

the settlement phase. Because American Express uses a two‐phase settlement, you must perform two distinct calls, a submission and a confirmation of the result. Valid values are: Submit, Confirm.

4.1.3. ProcessDebitCard

The following table contains additional information for using the ProcessDebitCard Web service operation with American Express.

Parameter

Description





CVV2/CVC2/CID is sent with the request. Valid values are: None,

NotSubmitted, Submitted, Illegible, [on card].


the settlement phase. Because American Express uses a two‐phase

settlement, you must perform two distinct calls, a submission and a

confirmation of the result. Valid values are: Submit, Confirm.

4.1.4. ProcessEBTCard

The following table contains additional information for using the ProcessEBTCard Web service operation with American Express.

Parameter

Description








the settlement phase. Because American Express uses a two‐phase

settlement, you must perform two distinct calls, a submission and a

confirmation of the result. Valid values are: Submit, Confirm.

79

4.1.5. ProcessGiftCard

The following table contains additional information for using the ProcessGiftCard Web service operation with American Express.


ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN,MANUAL,MAGNETICSTRIPE, ICC, PROXIMITY.


<Phase>Phase</Phase> Required for Capture TransType. Indicates the settlement phase. Because American Express uses a two‐phase settlement, you must perform two distinct calls, a submission and a confirmation of the result. Valid values are: Submit, Confirm.

4.1.6. Response Values

The following table contains descriptions of response values specific to American Express.

Parameter Description ExtData Net_Count=X,Net_Amount=X,Settle_DT=YYYY‐MM‐DD HH:MM:SS

Additional information with details of the settled batch if you

perform a batch close.

‐ Net_Count: Total number of transactions in the closed batch. ‐ Net_Amount: Net amount of transactions in the closed batch.

‐ Settle_DT: The date and time of the requested batch close.

Batch=<Summary>Net_Count=3,Net_Amount=‐ 3.00,Settle_DT=2006‐06‐27 12:41:52,Result=0</Summary>This batch response information is not an XML string. <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID is sent with the request. Valid values are: None, NotSubmitted, Submitted, Illegible, [on card].

<Phase>Phase</Phase> Required for Capture TransType. Indicates the settlement phase. Because American Express uses a two‐phase settlement, you must perform two distinct calls, a submission and a confirmation of the result. Valid values are: Submit, Confirm.

80

4.2. Ceridian Stored Value Solutions (SVS)

This section details requirements and features specific to Ceridian Stored Value Solutions (SVS). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessGiftCard Web service operation with Ceridian Stored Value Solutions.


TransType Adjustment: Modifies an existing TipAmt or TotalAmt for an original sale.

Deactivate: Not supported.

ExtData <ActivationType>ActivationType</ActivationType> Indicates the type of gift card activation. Valid values are: Issue, Virtual, Activate.

<PIN>PIN</PIN> Gift card PIN.

<TransSubType>TransSubType</TransSubType> Extension/qualifier for cashing out the value of a gift card. Valid values are: CashOut.

4.2.1.1. Transaction Subtypes: CashOut & Issue

To cash out the value of a gift card, run a Redeem transaction with an Amount of 0 and pass the TransSubType with a value of CashOut in the ExtData.

To perform a gift card issue, run an Activate transaction and pass ActivationType with a value of Issue in the ExtData.


The following table contains descriptions of response values specific to Ceridian Stored Value Solutions (SVS).


ExtData <ReceiptData> Indicates data that should print on the receipt. <Requested_Amt>Requested_Amt</Requested_Amt> Total amount requested.

<Approved_Amt>Approved_Amt</Approved_Amt> Total

81

Parameter

Description

amount approved.

</ReceiptData>

<AC>AC</AC> IVR access code.

<CardNo>CardNo</CardNo> Virtual activation result.

<PIN>PIN</PIN> Virtual activation result.

4.3. Campus Card (CBORD)

This section details requirements and features specific to Campus Card (CBORD). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains descriptions of response values specific to Campus Card (CBORD).

Parameter

Description

ExtData <Patron>Patron</Patron>

4.4. Card Group

This section details requirements and features specific to Card Group. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessGiftCard Web service operation with Card Group.

Parameter

Description

TransType Deactivate: PathwayLINK does not currently support reactivating

deactivated cards, so take care when exercising this TransType.

82


The following table contains descriptions of response values specific to Card Group.

Parameter Description ExtData <ReceiptData> Indicates data that should print on the receipt.

<Requested_Amt>Requested_Amt</Requested_Amt> Total amount requested.

<Approved_Amt>Approved_Amt</Approved_Amt> Total amount approved.

</ReceiptData>

4.5. Certegy

This section details requirements and features specific to Certegy. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].

Unless otherwise specified, assume that all parameters have the same requirements as specified in main document.

4.5.1. ProcessCheck

The following table contains additional information for using the ProcessCheck Web service operation with Certegy.


ExtData <ID1>ID1</ID1>

<ID1_Type>ID_Type1<ID1_Type>

<SecondTransaction>SecondTransaction</SecondTransaction> Valid values are: True.

<CertegyUniqueId>CertegyUniqueId</CertegyUniqueId>

<DeviceMICR>DeviceMICR</DeviceMICR>

83


The following table contains descriptions of response values specific to Certegy.

Parameter

Description

ExtData <ReceiptData>

<Reference_Number>Number</Reference_Number>

<Service_Charge>Charge</Service_Charge>

<Financial_Institution>Institution</Financial_Institution>

<Additional_Receipt_Info>Info></Additional_Receipt_Info>

<Lane>Lane</Lane>

<Clerk>Clerk</Clerk>

</ReceiptData>

<ResponseCode>Code</ResponseCode>

<CertegyUniqueId>ID</CertegyUniqueId>

4.6. Concord (EFSNet)

This section details requirements and features specific to Concord (EFSNet). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCreditCard Web service operation with Concord (EFSNet).


ExtData <Invoice> … <Items> <Item> … <UPC>UPC</UPC> NACS is an industry standard that Concord (EFSNet) uses. For a list of NACS product codes, please contact EFSNet customer support at [email protected] or 1‐877‐852‐2637.

…

84


</Item> </Items> …

</Invoice>

<CardType>CardType</CardType> Concord (EFSNet) does not currently support manually entered Voyager cards.

4.6.1.1. Purchase Card Level III Data

Concord (EFSNet) supports purchase card Level III data for credit transactions using the Invoice element and its nested elements. See Swiped Credit Sale with Purchase Card Level‐III Data on page 86 for a detailed example.

Some of Invoice’s child elements share the same purpose as other parameters and

ExtData elements. In the event that you specify a value in multiple places, the elements within Invoice take precedence. For example, if you populate values for the TaxAmt element within Invoice and the freestanding ExtData TaxAmt element, the system ignores the latter.

4.6.1.2. Fuel Purchases

Concord (EFSNet) supports fuel purchases on both standard and fleet cards using the Items element in the ExtData. Though the Invoice tag is not required for fuel transactions, the Items tag and its child elements are. You can pass Items alone or as a child element of Invoice.

Standard Credit Cards The Items tag holds one or more Item elements that contain details of each item from an invoice. Within each Item element are several description tags, including Category. In order to mark a transaction for fuel processing, at least one Item in a request must have a Category value of Fuel. See Swiped Credit Sale with Purchase Card Level‐III Data on page 86 and Swiped Credit Sale Fuel Transaction on page 87 for detailed examples.

Fleet Cards Concord currently supports fuel purchases on WEX, Voyager, and MasterCard Fleet cards. Like standard credit cards, fleet cards require at least on Item with a Category of Fuel.

In some cases, fleet cards can purchase non‐fuel items on a transaction marked for fuel processing, but Item‐level information must be present for all items in the transaction. Contact our integration specialists at [email protected] for more information.

Fleet requests require an additional tag, Fleet, for Sale, Auth, Force, and Return transactions. The child elements of Fleet (VehicleNum, DriverNum, OdometerReading) provide additional member information and may or may not be required, depending on the type of fleet card. For

85

example, WEX card transactions typically require DriverNum. See Swiped Fleet Sale on page for 88 a detailed example.

Fleet cards are unique in that the account data embossed on a card is often not the same as the track data. This poses a problem for manually entered fleet transactions where the card type is usually discerned from the account number. For this reason, manual fleet transactions require the CardType tag when the embossed data does not include the fleet ISO prefix. At present, Concord (EFSNet) doesn’t support manually entered Voyager cards, so the only valid value is WEX. See Manually Entered Fleet Sale on page 89 for a detailed example.

Typically, attempting to run a fleet transaction without Fleet data generates an error. MasterCard Fleet is the exception, allowing manual transactions to process without fleet data. If you run a MasterCard Fleet card without passing Fleet data, the transaction processes as if it were a standard credit fuel transaction.

Because MasterCard Fleet does not require Fleet data, the CardType element does not apply.

4.6.1.3. Examples


4.6.1.3.1. Swiped Credit Sale with Purchase Card Level-III Data

The following example processes a swiped credit Sale transaction as a fuel transaction. Because this is a fuel purchase, the ExtData includes one Item with a Category value of Fuel. This transaction also makes use of the optional Invoice tag to send purchase card level‐3 data.

Parameter Value

UserName Test

Password 123

TransType Sale

CardNum 5233272716340016

ExpDate 0208

MagData 5233272716340016=080212121228

NameOnCard John Doe

Amount 26.50

ExtData <Invoice><InvNum>123</InvNum><Date>050421</Date><BillTo><Cust omerId>CID101</CustomerId><Name>John Doe</Name><Address><St reet>123 Main Street</Street><City>Any City</City><State>WA</State

><Zip>98052</Zip><Country>USA</Country></Address><Email>test@t est.com</Email><Phone>132‐123‐1234</Phone><Fax>123‐123‐

1235</Fax><CustCode>CCode123</CustCode><PONum>PO123</PONu

86

Parameter Value m><TaxExempt>True</TaxExempt></BillTo><Description>One big sale</Description><Items><Item><TotalAmt>1</TotalAmt><UPC>001< /UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice><Category>Fue l</Category><Description>UnLeaded</Description><UnitOfMeasureme nt>Gallon</UnitOfMeasurement></Item></Items><DiscountAmt>0</D iscountAmt><ShippingAmt>1.11</ShippingAmt><DutyAmt>0</DutyAm t><TaxAmt>1.22</TaxAmt><NationalTaxInc>0</NationalTaxInc><Total Amt>26.50</TotalAmt></Invoice>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>OK</RespMSG> <Message>APPROVAL</Message> <AuthCode>990477</AuthCode> <PNRef>38473</PNRef> <HostCode>100008693148</HostCode> <GetCommercialCard>True</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response> 4.6.1.3.2. Swiped Credit Sale Fuel Transaction

The following example processes a swiped credit Sale transaction as a fuel transaction. Because this is a fuel purchase, the ExtData includes one Item with a Category value of Fuel.

Parameter Value

UserName Test

Password 123

TransType Sale

CardNum 5233272716340016

ExpDate 0208

MagData 5233272716340016=080212121228

NameOnCard John Doe

Amount 26.50

ExtData <Items><Item><UPC>001</UPC><Quantity>1</Quantity><UnitPrice>1< /UnitPrice><Category>Fuel</Category><Description>UnLeaded</Descri ption><UnitOfMeasurement>Gallon</UnitOfMeasurement></Item></I

tems>

87

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>OK</RespMSG> <Message>APPROVAL</Message> <AuthCode>333333</AuthCode> <PNRef>39081</PNRef> <HostCode>100008778024</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=MASTERCARD</ExtData>

</Response> 4.6.1.3.3. Swiped Fleet Sale

The following example processes a swiped Fleet Sale transaction as a fuel transaction. Note that the ExtData contains both required and optional tags for this transaction.


Password 123

TransType Sale

CardNum 6900460420001234566

ExpDate 0306

MagData 6900460420001234566=06031000563100000

NameOnCard John Doe

Amount 1.00

ExtData <Fleet><DriverNum>123</DriverNum><OdometerReading>78964</Od ometerReading></Fleet><Items><Item><UPC>001</UPC><Quantity>1<

/Quantity><UnitPrice>1</UnitPrice><Category>Fuel</Category><Descri ption>UnLeaded</Description><UnitOfMeasurement>Gallon</UnitOf Measurement></Item></Items>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>OK</RespMSG> <Message>APPROVAL</Message> <AuthCode>333333</AuthCode>

88

<PNRef>39082</PNRef> <HostCode>100008778025</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=WEX</ExtData>

</Response> 4.6.1.3.4. Manually Entered Fleet Sale

The following example processes a manually entered fleet Sale transaction as a fuel transaction. Because this is a manual fleet sale, the ExtData contains the CardType in addition to the fleet and level‐3 data.


Password 123

TransType Sale

CardNum 0420001234566

ExpDate 0306

NameOnCard John Doe

Amount 50.00

ExtData <Fleet><VehicleNum>321</VehicleNum><DriverNum>123</DriverNum ><OdometerReading>78964</OdometerReading></Fleet><Items><Ite

m><UPC>001</UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice> <Category>Fuel</Category><Description>UnLeaded</Description><Uni tOfMeasurement>Gallon</UnitOfMeasurement></Item></Items><Car

dType>WEX</CardType>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>OK</RespMSG> <Message>APPROVAL</Message> <AuthCode>333333</AuthCode> <PNRef>39083</PNRef> <HostCode>100008778047</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=WEX</ExtData>

</Response>

89


The following table contains additional information for using the ProcessDebitCard Web service operation with Concord EFSNet.

Parameter

Description

TransType Auth: Authorizes an amount on a debit card.

Force: Places and Auth transaction into the current batch

(PostAuth).

4.6.2.1. PIN-less Debit Transactions

Concord (EFSNet) supports PIN‐less processing for qualifying debit transactions.

To perform a PIN‐less debit transaction, your request requires all of the same information in a typical PIN‐based transaction except for the encrypted PIN‐block (Pin) and key serial number (KeySerialNumber). The request must have neither piece of data for the transaction to process as PIN‐less. See Swiped PIN‐less Debit Sale on page 91 for a detailed example.

If you send both the Pin and KeySerialNumber, the transaction processes as a standard PIN‐based debit transaction. Sending only one field or the other generates an error.

Phone & Internet PIN-less Transactions Transactions with phone or Internet origins require additional consideration when processing with Concord.

The payment server checks the RegisterNum passed in the request against the register number settings in the merchant account. When it locates a match, the server sends Concord the terminal ID configured to correspond to that register number.

If the payment server doesn’t send a terminal ID, the field assumes whatever value the processor has set as default (usually “01”). If you support phone‐originating (VRU) transactions, you must create a separate terminal ID field in the merchant account registers and submit it in your requests.

If the merchant wants to concurrently support transactions originating from the Internet and the phone, the value for the terminal ID must be able to differentiate between the two. For example, you could specify a terminal ID value of “01” for Internet transactions and “02” for phone transactions, and transmit the corresponding RegisterNum in the requests.

4.6.2.2. Fuel Purchases

Concord (EFSNet) supports fuel purchases on standard debit cards using the Items element in the ExtData.

The Items tag holds one or more Item elements that contain details of each item from an invoice. Within each Item element are several description tags, including Category. In order to mark a transaction for fuel processing, at least one Item in a request must have a Category value of Fuel. See Swiped Debit Fuel Sale on page 93 for a detailed example.

90

4.6.2.3. Examples


4.6.2.3.1. Swiped PIN-less Debit Sale

The following example processes a swiped PIN‐less debit Sale transaction. Note that in order to be processed as a PIN‐less transaction, both the PIN‐block and key serial number must be omitted.

Parameter Value

UserName test

Password 123

TransType Sale

CardNum 4011190070070071

ExpDate 0606

MagData 4011190070070071=060600199100

NameOnCard John Doe

Amount 1.00

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVAL</Message> <AuthCode>216880</AuthCode> <PNRef>38472</PNRef> <HostCode>100008691797</HostCode> <ExtData>CardType=DEBIT</ExtData>

</Response> 4.6.2.3.2. Swiped Debit Auth

The following example processes a swiped debit Auth transaction.

Parameter

Value

UserName test

Password 123

TransType Auth

CardNum 4011190070070071

91

Parameter

Value

ExpDate 0606

MagData 4011190070070071=060600199100

NameOnCard John Doe

Amount 50.00

Pin A0C98099B1341075


Response



</Response> 4.6.2.3.3. Swiped Debit Force

The following example processes a swiped debit card Force transaction as a fuel purchase using the authorization obtained in Swiped Debit Auth above. Because this is a fuel purchase, the ExtData includes one Item with a Category value of Fuel.

Parameter Value

UserName test

Password 123

TransType Force

CardNum 4011190070070071

ExpDate 0606

MagData 4011190070070071=060600199100

NameOnCard John Doe

Amount 50.00

PNRef 39549

Pin A0C98099B1341075

92

Parameter Value ExtData <KeySerialNumber>1234567890000343</KeySerialNumber><Items><It

em><UPC>001</UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice ><Category>Fuel</Category><Description>UnLeaded</Description><U nitOfMeasurement>Gallon</UnitOfMeasurement></Item></Items>

Response



</Response> 4.6.2.3.4. Swiped Debit Fuel Sale

The following example processes a swiped debit Sale transaction as a fuel purchase. In order to process as a fuel transaction, at least one Item element within the Items tag has a Category value of Fuel.


Password 123

TransType Sale

CardNum 4011190070070071

ExpDate 0606

MagData 4011190070070071=060600199100

NameOnCard John Doe

Amount 1.00

Pin A0C98099B1341075

ExtData <KeySerialNumber>1234567890000343</KeySerialNumber><Items><It em><UPC>001</UPC><Quantity>1</Quantity><UnitPrice>1</UnitPrice ><Category>Fuel</Category><Description>UnLeaded</Description><U nitOfMeasurement>Gallon</UnitOfMeasurement></Item></Items>

93

Response



</Response>

4.7. CredoRax

This section details requirements and features specific to CredoRax. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.7.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with CredoRax.


ExtData <PNRef>PNRef</PNRef> PNRef of transaction you’re targeting for information.

<BillToEmail>BillToEmail</BillToEmail> Bill‐to email.

4.7.2. ProcessCheck

The following table contains additional information for using the ProcessCheck Web service operation with CredoRax.

Parameter

Description

ExtData <BillToURL>BillToURL</BillToURL> Bill‐to IP URL.


94


The following table contains additional information for using the ProcessCreditCard Web service operation with CredoRax.




<Authentication> <XID>AuthenticationID</XID> <UCAF>UCAF</UCAF> </Authentication>


The following table contains additional information for using the ProcessDebitCard Web service operation with CredoRax.


ExtData <BillTo> You must send at least one of BillTo’s child elements, but you are not required to send all.

<BillToURL>BillToURL</BillToURL> Bill‐to IP URL.


<Authentication> XID>AuthenticationID</XID>

<UCAF>UCAF</UCAF>

</Authentication>


The following table contains additional information for using the ProcessEBTCard Web service operation with CredoRax.




95


The following table contains additional information for using the ProcessGiftCard Web service operation with CredoRax.

Parameter

Description



4.8. Echo/Intuit

This section details requirements and features specific to Echo/Intuit. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.8.1. ProcessCheck

The following table contains additional information for using the ProcessCheck Web service operation with Echo/Intuit.

Parameter

Description

ExtData <AccType>AccType</AccType>

<ID1>ID1</ID1>

<ID1_Type>ID_Type1</ID1_Type>

<ACH_Payment_Type>Type</ACH_Payment_Type>

<Cust_Bank>Bank</Cust_Bank>

4.9. Elavon/Nova

This section details requirements and features specific to Elavon/Nova. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


96

4.9.1. ProcessCheck

The following table contains additional information for using the ProcessCheckWeb service operation with Elavon/Nova.

Parameter

Description

ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for

the payment information were obtained. Valid values are: UNKNOWN,

MANUAL,MAGNETICSTRIPE, ICC, PROXIMITY.


The following table contains additional information for using the ProcessCreditCard Web service operation with Elavon/Nova.

Parameter

Description




<VoucherNumber>VoucherNumber</VoucherNumber> Voucher number.


The following table contains additional information for using the ProcessDebitCard Web service operation with Elavon/Nova.


ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY.


97


The following table contains additional information for using the ProcessEBTCard Web service operation with Elavon/Nova.



<VoucherNumber>VoucherNumber</VoucherNumber> Voucher

number.


The following table contains additional information for using the ProcessGiftCard Web service operation with Elavon/Nova.

Parameter

Description



MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY.

4.10. FastCheck/Cyclone (GETI)

This section details requirements and features specific to FastCheck/Cyclone (GETI). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.10.1. ProcessCheck

The following table contains additional information for using the ProcessCheck Web service operation with FastCheck/Cyclone (GETI).

Parameter Description TransType Force: Must replace an existing declined transaction.

98


SS Last 4 digits of check holder’s social security number.

Terminals that require identity verification only require

one identifying element, accepting the social security

number or date of birth. If you pass both parameters,

the server drops DOB and uses SS.

DOB Check holder’s date of birth. Only the year is necessary, and it can be

parsed from the following formats: YYYY, MMDDYY, MMDDYYYY.

Terminals that require identity verification only require

one identifying element, accepting the social security

number or date of birth. If you pass both parameters,

the server drops DOB and uses SS.




<CashBack>CashBack</CashBack> Amount cash back.

<Track1>Track1</Track1> Track1 data from an ID.


<MICRStatus>MICRStatus</MICRStatus>

<MICRType>MICRType</MICRType> MICR qualifier. Valid values

are: Canadian.

<EchoData>EchoData</EchoData> Data echoed back in response.

<ClerkID>ClerkID</ClerkID>

<TerminalID>TerminalID</TerminalID> Originating device ID.

<ProductCode>ProductCode</ProductCode>

<ReleaseType>ReleaseType</ReleaseType> Valid values are:

CarryOut, TodayPickup, Delivery, PreOrder, FuturePickup,

ShipToStore, Express.

<CustECAApproval>CustECAApproval</CustECAApproval>

Indicates if the customer accepts the terms of the Electronic Check

Acceptance (ECA) transaction. Valid values are: T, F.

<IP>IP</IP> In nnn.nnn.nnn.nnn format.

<CheckImageFormat>Format</CheckImageFormat> Indicates the

image data format of CheckImageFront and CheckImageBack. Valid

values are: Receipt1 and Base64. For more information, please see

Uploading Check Image at Transaction Time on page 100.

<CheckImageFront>Front</CheckImageFront> For more

information, please see Uploading Check Image at Transaction

99

Parameter

Description

Time on page 100.

<CheckImageBack>Back</CheckImageBack> Image data for the back of the check. For more information, please see Uploading Check Image at Transaction Time on page 100.

4.10.2. Uploading Check Image at Transaction Time

PathwayLINK supports uploading a check image at the time of a Sale, Auth, or Force transaction. To perform an image upload, the ExtData of the transaction request must contain the format of the image data (CheckImageData), the image data for the front of the check (CheckImageFront), and the image data for the back of the check (CheckImageBack).

The two supported data formats for the check image are:

Receipt1: A tiff image that is zipped and Base64‐encoded. This is the same format used in

ProcessSignature. Tiff_Img: A Base64‐encoded tiff image.

If an approved transaction has image data in Tiff_Img format, fore saving it to the database to conserve size. This, essentially, converts the data into Receipt1 format.

4.10.2.1. Supported SEC Types

FastCheck/Cyclone (GETI) supports the following SEC types:

Check 21 (C21): Supported transactions: Sale, Auth. Supported industries: Retail. Image upload required.

Point‐of‐Purchase Entry (POP): Supported transactions: Sale, Auth. Supported industries: Retail. Image upload not required.

Internet Initiated Entry (WEB): Supported transactions: Sale. Telephone Initiated Entry (TEL): Supported transactions: Sale. Prearranged Payment and Deposit Entry (PPD): Recurring billing personal checks.

Supported transactions: Sale. Corporate Credit or Debit(CCD): Recurring billing for corporate checks. Supported

transactions: Sale.


The following table contains additional information for using the ProcessGiftCard Web service operation with FastCheck/Cyclone (GETI).

Parameter Description TransType Deactivate: Not supported.

100



<CardType>CardType</CardType> Required to process an eCertificate issuance. Valid value: Certificate.

<ServerID>ServerID<ServerID> Required for all transactions. Unique server identification number. This parameter removes invalid characters. See XML Character Removal on page 172 for more details.

4.10.3.1. eCertificates

FastCheck/Cyclone (GETI) supports eCertificate processing. An eCertificate is a gift card that lacks a physical card. eCertificate transactions are exactly the same as normal gift transactions with the exception of issuance.

To issue an eCertificate, run an Issue transaction and pass CardType with a value of Certificate in the ExtData. A successful issuance returns a new gift certificate number in the ExtData under CardNum. eCertificates display in the reports and database like normal gift issues.


The following table contains descriptions of response values specific to FastCheck/Cyclone (GETI).


ExtData <ReceiptData> Indicates data that should print on the receipt. <Requested_Amt>Requested_Amt</Requested_Amt> Total amount requested.


</ReceiptData>

<AccountData> <CardNum>CardNum</CardNum> eCertificate issuance result. </AccountData>

4.11. FirstData BuyPass

This section details requirements and features specific to FirstData BuyPass. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].

101



The following table contains additional information for using the ProcessCheck Web service operation with FirstData BuyPass.


ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN, MANUAL,MAGNETICSTRIPE, ICC, PROXIMITY.


The following table contains additional information for using the ProcessCreditCard Web service operation with FirstData BuyPass.

Parameter

Description

ExtData <CustCode>CustomerCode</CustCode> Not supported.

<TaxAmt>TaxAmt</TaxAmt> Required for purchasing cards.

<PONum>PONum</PONum> Required for purchasing cards.

<TerminalType>TerminalType</TerminalType> Identifies card

terminal admittance. Valid values are: Unspecified, Attended,

Unattended.

<EntryMode>EntryMode</EntryMode> Indicates how the values



<Fleet> Required for fleet card purchases (Sale and Force

TransTypes). Information on fleet member making purchase.

Please note that all elements nested within Fleet are

processed sequentially, so they must be in the order

listed below.

<VehicleNum>VehicleNum</VehicleNum> May be required for

specific purchases. Vehicle number.

<DriverNum>DriverNum</DriverNum> May be required for

specific purchases. The vehicle driver’s number.

<OdometerReading>OdometerReading</OdometerReading>

May be required for specific purchases. The current odometer

reading of the fleet vehicle.

</Fleet>

102

Parameter

Description

<Partial_Indicator>Partial_Indicator</Partial_Indicator> When

enabled, instructs the host to process the transaction as a partial

authorization for available funds. Valid values are: T, F.

<QHP_Amount>QHP_Amount</QHP_Amount> Optional subtotal

amount for qualified medical expenses (over‐the‐counter medical

items). Only applies to Visa transactions.

<RX_Amount>RX_Amount</RX_Amount> Optional prescription

subtotal.

<Vision_Amount>Vision_Amount</Vision_Amount> Optional

vision subtotal.

<Dental_Amount>Dental_Amount</Dental_Amount> Optional

dental subtotal.

<Clinical_Amount>Clinical_Amount</Clinical_Amount> Optional

clinical subtotal.

All of the above optional amounts are 13‐character fields

with explicit decimal. The total of all sub‐amounts must

match the total of the transaction's total authorization

amount.


The following table contains additional information for using the ProcessDebitCard Web service operation with FirstData BuyPass.

Parameter

Description

ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When





UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, and PROXIMITY.

<PIN‐less> Required for PIN‐less debit transactions.

<PhoneNum>PhoneNum</PhoneNum>

<AccountNum>AccountNum</AccountNum> Account number.

Valid values depend on TransType:

Sale: Consumer account number.

Return: Cardholder card number.

<ID>ID</ID> ID. Valid values depend on TransType:

Sale: Merchant name.

103

Parameter

Description

Return: Cardholder name.

<Origin>Origin</Origin> Origin. Valid values are: POS,

CallCenter, VoiceResponseUnit, Recurring, Internet.


FirstData BuyPass supports PIN‐less debit processing using PIN‐less and its nested elements.

To perform a PIN‐less debit transaction, the ExtData of your request must contain the PhoneNum, AccountNum, ID, and Origin elements within the PIN‐less tag. Refer to the table above for more details.


The following table contains additional information for using the ProcessEBTCard Web service operation with FirstData BuyPass.

Parameter Description ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When




The following table contains additional information for using the ProcessGiftCard Web service operation with FirstData BuyPass.


ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY.

104


The following table contains descriptions of response values specific to FirstData BuyPass.




<BalanceAmount>BalanceAmount</BalanceAmount> Remaining balance on the account.

</ReceiptData>

4.12. FirstData Nashville

This section details requirements and features specific to FirstData Nashville. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with FirstData Nashville.

Parameter Description ExtData <BillPayment>BillPayment</BillPayment> Indicates if a transaction is a

utility bill payment. Valid values are: T, F. Only supported for Sale and

RepeatSale transactions.


The following table contains additional information for using the ProcessCreditCard Web service operation with FirstData Nashville.

Parameter

Description

TransType Adjustment: Modifies the existing TipAmt, TaxAmt, or PONum for an

original sale.

105

Parameter

Description

ExtData <BillPayment>BillPayment</BillPayment> Indicates if a transaction

is a utility bill payment. Valid values are: T, F. Only supported for

Sale and RepeatSale transactions.

<Partial_Indicator>Partial_Indicator</Partial_Indicator> When enabled, instructs the host to process the transaction as a partial authorization for available funds. Valid values are: T, F.


The following table contains additional information for using the ProcessDebitCard Web service operation with FirstData Nashville.


ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When enabled, instructs the host to process the transaction as a partial authorization for available funds. Valid values are: T, F.


is a utility bill payment. Valid values are: T, F. Only supported for Sale and RepeatSale transactions.


The following table contains additional information for using the ProcessEBTCard Web service operation with FirstData Nashville.


ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When enabled, instructs the host to process the transaction as a partial


<BillPayment>BillPayment</BillPayment> Indicates if a transaction is a utility bill payment. Valid values are: T, F. Only supported for


106


The following table contains additional information for using the ProcessGiftCard Web service operation with FirstData Nashville.

Parameter

Description

ExtData <BillPayment>BillPayment</BillPayment> Indicates if a transaction is a

utility bill payment. Valid values are: T, F. Only supported for Sale and

RepeatSale transactions.


The following table contains descriptions of response values specific to FirstData Nashville.

Parameter

Description

ExtData <ReceiptData> Indicates data that should print on the receipt.

<Partial_Reversal_Flag>Flag</Partial_Reversal_Flag> Indicates

that transaction processed as a partial reversal. Valid values: T.

<Total_Amount>Total_Amount</Total_Amount> Total amount

authorized.

<Requested_Amt>Requested_Amt</Requested_Amt> Total

amount requested.

<Approved_Amt>Approved_Amt</Approved_Amt> Total amount

approved.

<BalanceAmount>BalanceAmount</BalanceAmount> Remaining

balance on the account.

</ReceiptData>

4.13. FirstData North

This section details requirements and features specific to FirstData North. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


107


The following table contains additional information for using the ProcessCheck Web service operation with FirstData North.




CVV2/CVC2/CID is sent with the request. Valid values are: None, NotSubmitted, Submitted, Illegible, NotPresent [on card].

<BillPayment>BillPayment</BillPayment> Indicates if a

transaction is a utility bill payment. Valid values are: T, F. Only supported for Sale and RepeatSale transactions.


The following table contains additional information for using the ProcessCreditCard Web service operation with FirstData North.

Parameter

Description

TransType Reversal: Performs a manual full reversal on a credit sale or repeat


transaction.

To perform a Reversal for a transaction that had partial

authorzation, you must pass the IIAS_Indicator element

in the ExtData. See Credit Partial Reversal with IIAS on

page 110 for a detailed example.

Adjustment: Modifies the existing TipAmt, TaxAmt, or PONum for

an original sale.










<IIAS_Indicator>IIAS_Indicator</IIAS_Indicator> Indicates if the

current transaction is authorized by an Inventory Information

108

Parameter

Description

Approval System. Industry must be Retail, and card issuer must be

Visa orMasterCard. Industry must be Retail, and card issuer must

be Visa or MasterCard. Valid values are: T, F.




4.13.2.1. Examples


4.13.2.1.1. Swiped Credit Sale with IIAS

The following example processes a swiped credit Sale transaction with IIAS data.

Parameter Value

UserName Test

Password 123

TransType Sale

CardNum 466206000000005

ExpDate 0412

MagData 466206000000005=120410123456789

NameOnCard John Doe

Amount 130.50

ExtData <IIAS_Indicator>T</IIAS_Indicator><QHP_Amount>1.00</QHP_Amount ><RX_Amount>1.00</RX_Amount><Vision_Amount>1.00</Vision_Amo

unt><Dental_Amount>1.00</Dental_Amount><Clinical_Amount>1.00</

Clinical_Amount><Misc_Amount>1.00</Misc_Amount>

Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>OK948C</AuthCode> <PNRef>2417</PNRef> <HostCode>2417</HostCode>

109

<GetCommercialCard>False</GetCommercialCard> <ExtData>CardType=VISA

<ReceiptData> <Requested_Amt>130.50</Requested_Amt> <Approved_Amt>50.00</Approved_Amt> <BalanceAmount>0.00</BalanceAmount>

</ReceiptData> </ExtData>

</Response> 4.13.2.1.2. Swiped Credit Reversal with IIAS

The following example processes a swiped credit Reversal transaction with IIAS data.

Parameter Value

UserName Test

Password 123

TransType Reversal

PNRef 2417

ExtData <Force>T</Force><IIAS_Indicator>T</IIAS_Indicator>

Response



xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>868686</AuthCode> <PNRef>2421</PNRef> <HostCode>2421</HostCode> <GetCommercialCard>False</GetCommercialCard>

</Response> 4.13.2.1.3. Credit Partial Reversal with IIAS

The following example processes a swiped credit partial Reversal transaction with IIAS data. Partial reversals have the Amount field set to the portion of the original authorized amount to be reversed.

Parameter Value

UserName Test

Password 123

110

Parameter

Value

TransType Reversal

Amount 125.00

PNRef 2417

ExtData <Force>T</Force><IIAS_Indicator>T</IIAS_Indicator>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>APPROVAL</Message> <AuthCode>868686</AuthCode> <PNRef>2420</PNRef> <HostCode>2420</HostCode> <GetCommercialCard>False</GetCommercialCard>

</Response>


The following table contains additional information for using the ProcessDebitCard Web service operation with FirstData North.


TransType Reversal: Performs a manual full reversal on a debit sale or repeat sale.

Reversals must process within 24 hours of the original transaction.

Supported industries: Retail, Restaurant. Support for all card issuers.

Each processor requires different levels of original debit

card sale information to be passed in the reversal

request. Please contact our integration specialists at

[email protected] for more

information.

ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When







111

Parameter

Description



<BillPayment>BillPayment</BillPayment> Indicates if a transaction is a utility bill payment. Valid values are: T, F. Only supported for Sale and RepeatSale transactions.


The following table contains additional information for using the ProcessEBTCard Web service operation with FirstData North.

Parameter

Description

ExtData <IIAS_Indicator>IIAS_Indicator</IIAS_Indicator> Indicates if the



Visa or MasterCard. Valid values are: T, F.











The following table contains additional information for using the ProcessGiftCard Web service operation with FirstData North.





112


The following table contains descriptions of response values specific to FirstData North.


<Partial_Reversal_Flag> Flag</Partial_Reversal_Flag> Indicates that transaction processed as a partial reversal. Valid values: T.

<Total_Amount>Total_Amount</Total_Amount> Total amount authorized.


<Approved_Amt>Approved_Amt</Approved_Amt> Total amount approved. <BalanceAmount>BalanceAmount</BalanceAmount> Remaining balance on the account.

</ReceiptData>

4.14. FirstData Omaha

This section details requirements and features specific to FirstData Omaha. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with FirstData Omaha.

Parameter Description ExtData <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID

is sent with the request. Valid values are: None, NotSubmitted,

Submitted, Illegible, NotPresent [on card].

113


The following table contains additional information for using the ProcessCreditCard Web service operation with FirstData Omaha.

Parameter Description TransType Adjustment: Modifies the existing TipAmt, TaxAmt, or PONum for an

original sale.

ExtData <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID is sent with the request. Valid values are: None, NotSubmitted, Submitted, Illegible, NotPresent [on card].


The following table contains additional information for using the ProcessDebitCard Web service operation with FirstData Omaha.

Parameter

Description

ExtData <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID




The following table contains additional information for using the ProcessEBTCard Web service operation with FirstData Omaha.

Parameter Description ExtData <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID




The following table contains additional information for using the ProcessGiftCard Web service operation with FirstData Omaha.



114


The following table contains descriptions of response values specific to FirstData Omaha.

Parameter

Description


4.15. FirstData South

This section details requirements and features specific to FirstData South. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCreditCard Web service operation with FirstData South.

Parameter

Description

TransType Adjustment: Modifies the existing TipAmt for an original sale.

4.16. FirstData Telecheck

This section details requirements and features specific to FirstData Telecheck. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with FirstData Telecheck.


TransType Sale: Not supported.

Auth: You must follow‐up an Auth with a Force to approve or decline the transaction. The Force must contain CustECAApproval within the ExtData.

115


ExtData <Phone>Phone</Phone> Required for Auth transactions in eCommerce.

<BillToStreet>BillToStreet</BillToStreet> Required for Auth transactions in eCommerce.

<BillToStreet2>BillToStreet2</BillToStreet2> Required for Auth transactions in eCommerce.

<BillToCity>BillToCity</BillToCity> Required for Auth transactions in eCommerce.

<BillToPostalCode>BillToPostalCode</BillToPostalCode> Required for Auth transactions in eCommerce.

<EMail>EMail</EMail> Required for Auth transactions in eCommerce.

<IP>IP</IP> Required for Auth transactions in eCommerce. In nnn.nnn.nnn.nnn format.

<PNRef>PNRef</PNRef> Required for Force transactions in eCommerce.

<CustECAApproval>CustECAApproval</CustECAApproval> Required for Force transactions in eCommerce. Indicates if the customer accepts the terms of the Electronic Check Acceptance (ECA) transaction. Valid values are: T, F.

<ProductCode>ProductCode</ProductCode>

<ReleaseType>ReleaseType</ReleaseType> Valid values are: CarryOut, TodayPickup, Delivery, PreOrder, FuturePickup, ShipToStore, Express.

<CashBack>CashBack</CashBack> Amount cash back.



<MICRStatus>MICRStatus</MICRStatus> The MICR status. Valid values are: MICRRead, MICRReadImg, BadRead, NoInkDetected, Manual.

<MICRType>MICRType</MICRType> MICR qualifier. Valid values are: Canadian.

<EchoData>EchoData</EchoData> Data echoed back in response.

<ClerkID>ClerkID</ClerkID>

<TerminalID>TerminalID</TerminalID> Originating device ID.

116


The following table contains descriptions of response values specific to FirstData Telecheck.


<ReturnedCheckFee>ReturnedCheckFee</ReturnedCheckFee> <ReturnedCheckNote>ReturnedCheckNote</ReturnedCheckNote>

<DenialRecNum>DenialRecNum</DenialRecNum> <Message1>Message1</Message1> <Message2>Message1</Message2>

</ReceiptData>

4.17. GiveX

This section details requirements and features specific to GiveX. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.17.1. Additional Extended Data

The following table contains additional extended data that GiveX supports.


ExtData <Unit>Unit</Unit>

<PromoCode>PromoCode</PromoCode>

4.18. Global East

This section details requirements and features specific to Global East. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


117

4.18.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with Global East.

Parameter

Description

TransType KeyChangeRequest: Contacts the Global host to get a new key sent to

the PIN pad in use. You would perform this request when the PIN pad is

initialized for the first time or after a necessary reboot.

ExtData <BatchSequenceNum>Number</BatchSequenceNum> Indicates if the

payment server should query the processor for information for the

current or a previous batch. Valid values are:

0: Current open batch (default value if BatchSequenceNum is left

unspecified in ExtData).

1: Previous batch.

2: The batch before the previous batch specified with the value 1.

N: And so on…


The following table contains additional information for using the ProcessCheck Web service operation with Global East.


ExtData <AuthenticationCapability> Sent by the POS application to indicate if a PIN pad is connected to the POS system. <PINCapability>PINCapability</PINCapability> PIN capability. Valid values are: Capable, Incapable, Inoperative, Unknown.

</AuthenticationCapability>

<EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY.



118


The following table contains additional information for using the ProcessCreditCard Web service operation with Global East.


TransType Reversal: Performs a manual full reversal on a credit sale or repeat sale. A reversal transaction acts as a void host and must be processed within the open batch time period. Support for all industries and card issuers.

Adjustment: Modifies the existing TipAmt or TotalAmt for an original sale.

ExtData <CustCode>CustomerCode</CustCode> If CustCode is left blank, Global Payments East defaults to PONum for level 2 data.

<AuthenticationCapability> Sent by the POS application to indicate if a PIN pad is connected to the POS system.

<PINCapability>PINCapability</PINCapability> PIN capability. Valid values are: Capable, Incapable, Inoperative, Unknown.



<Presentation> Indicates card presence in a transaction. <CardPresent>CardPresent Value</CardPresent> Valid values are: True (card present), False (card not present or unknown).

</Presentation>



119


The following table contains additional information for using the ProcessDebitCard Web service operation with Global East.


TransType Reversal: Performs a manual full reversal on a debit card sale or repeat

sale. The reversal must process within the open batch time period.






information.

ExtData <AuthenticationCapability> Sent by the POS application to indicate

if a PIN pad is connected to the POS system.

<PINCapability>PINCapability</PINCapability> PIN capability.

Valid values are: Capable, Incapable, Inoperative, Unknown.






<CardPresent>CardPresent Value</CardPresent> Valid values

are: True (card present), False (card not present or unknown).

</Presentation>








transaction is a utility bill payment. Valid values are: T, F. Only

supported for Sale and RepeatSale transactions.


number.


Global East supports PIN‐less processing for qualifying debit transactions.

120



4.18.4.2. Examples



The following example processes a swiped PIN‐less debit Sale transaction. In order to process as a PIN‐less transaction, both the PIN‐block (Pin) and Key Serial Number (KeySerialNumber) are omitted.


Password 123

TransType Sale

CardNum 4011190070070071

ExpDate 0606

MagData 4011190070070071=060600199100

NameOnCard John Doe

Amount 1.00

Response



</Response>

121


The following table contains additional information for using the ProcessEBTCard Web service operation with Global East.




<IIAS_Indicator>IIAS_Indicator</IIAS_Indicator> Indicates if the current transaction is authorized by an Inventory Information Approval System. Industry must be Retail, and card issuer must be Visa or MasterCard. Valid values are: T, F.

<Partial_Indicator>Partial_Indicator</Partial_Indicator> When enabled, instructs the host to process the transaction as a partial authorization for available funds. Valid values are: T, F..


</Presentation>

<EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are:





122


The following table contains additional information for using the ProcessGiftCard Web service operation with Global East.




<EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN,MANUAL,MAGNETICSTRIPE, ICC, PROXIMITY.




The following table contains descriptions of response values specific to Global East.


<Partial_Reversal_Flag>Partial_Reversal_Flag</Partial_Reversal_F lag> Indicates that transaction processed as a partial reversal. Valid values: T.




</ReceiptData>

123

4.19. Global Interac (Canada)

This section details requirements and features specific to Global Interac (Canada). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.19.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with Global Interac (Canada).


TransType Initialize: Returns the merchant account setup information (e.g., Partner Number, Merchant ID, credit card type, etc.).

ExtData <TID>TID</TID> Required for the KeyChangeRequest TransType. Terminal Identification Number derived from the PIN pad used in the

transaction.


The following table contains additional information for using the ProcessDebitCard Web service operation with Global Interac (Canada).


TransType AddReversal: If the host sends a response for information validation, and the customer’s PIN input is invalid, this TransType reverses the

transaction sent to the host.

PNRef Required for AddReversal TransType.

ExtData <MAC> Required. Instead of using a KeySerialNumber, Global Interac (Canada) uses MAC tags to facilitate the transaction. See Swiped Debit Sale on page 126 for a detailed example. <TID>TID</TID Required for the AddReversal TransType. Terminal Identification Number derived from the PIN pad used in the transaction.

<PSN>PSN</PSN> Required. The Point‐of‐Sale sequence number. Maintained by the SmartPayments Client application, valid values are: 001–999.

<Value>Value</Value> Required. MAC value obtained from the PIN pad device.

124

Parameter

Description

<Language>Language</Language> Required. Sets the language

used for the transaction. Valid values are: English, French.

</MAC>

<AccountType>AccountType</AccountType> Required for AddReversal. Valid values are: Checking, Saving.


Global Payments East supports PIN‐less processing for qualifying debit transactions.



4.19.2.2. Examples



The following example processes a swiped PIN‐less debit Sale transaction. In order to process as a PIN‐less transaction, both the PIN‐block (Pin) and Key Serial Number (KeySerialNumber) are omitted.


Password 123

TransType Sale

CardNum 4011190070070071

ExpDate 0606

MagData 4011190070070071=060600199100

NameOnCard John Doe

Amount 1.00

Response

<?xml version="1.0" encoding="utf-8" ?> <Response xmlns:xsd="http://www.w3.org/2001/XMLSchema"

125

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVAL</Message> <AuthCode>216880</AuthCode> <PNRef>38472</PNRef> <HostCode>100008691797</HostCode> <ExtData>CardType=DEBIT</ExtData>

</Response> 4.19.2.2.2. Swiped Debit Sale

The example data below illustrates a swiped debit Sale transaction. Instead of the U.S. standard, KeySerialNumber, Canadian debit uses MAC and its child elements to facilitate the transaction.


Password 123

TransType Sale

CardNum 4506364400038106

ExpDate 0716

MagData 45063644000381061=1607200000000000001

Amount 1.04

Pin 6ED86600FF81627A

ExtData <MAC><TID>700005110</TID><PSN>15</PSN><Value>FC498D57</Val ue><Language>English</Language></MAC><AccountType>Checking</ AccountType>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVED 00</Message> <AuthCode>145023</AuthCode> <PNRef>201302</PNRef> <ExtData>

CardType=DEBIT,BatchNum=0001 <BatchNum>0001</BatchNum> <MAC>

<PINKey>3B4E9397606D4F0E</PINKey> <ItemNum>0009</ItemNum>

126

<BatchAmount>1029</BatchAmount> <TransCode>00</TransCode> <MACKey>085A04123CA3377C</MACKey> <PSN>0010010150</PSN> <Value>07457906</Value> <FieldKey>9ECFCFDDC6226041</FieldKey> <BRC>001</BRC> <TransNum>00</TransNum>

</MAC> </ExtData>

</Response>


The following table contains descriptions of response values specific to Global Interac (Canada).

Parameter

Description

ExtData <MAC>MAC</MAC> Message Authentication Code.

4.20. Heartland Payments

This section details requirements and features specific to Heartland Payments. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with Heartland Payments.

Parameter Description ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for



127


The following table contains additional information for using the ProcessCreditCard Web service operation with Heartland Payments.


ExtData <Presentation> Indicates card presence in a transaction. <CardPresent>CardPresent Value</CardPresent> Valid values are: True (card present), False (card not present or unknown). </Presentation>

<EntryMode>EntryMode</EntryMode> Indicates how the values for

the payment information were obtained. Valid values are: UNKNOWN, MANUAL, MAGNETICSTRIPE, ICC, PROXIMITY.


The following table contains additional information for using the ProcessDebitCard Web service operation with Heartland Payments.

Parameter

Description

ExtData <Presentation> Indicates card presence in a transaction.



</Presentation>



The following table contains additional information for using the ProcessEBTCard Web service operation with Heartland Payments.


ExtData <Presentation> Indicates card presence in a transaction. <CardPresent>CardPresent Value</CardPresent> Valid values are: True (card present), False (card not present or unknown).

</Presentation>


128


The following table contains additional information for using the ProcessGiftCard Web service operation with Heartland Payments.

Parameter

Description



MANUAL,MAGNETICSTRIPE, ICC, PROXIMITY.

4.21. IntegraPay

This section details requirements and features specific to IntegraPay. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCreditCard Web service operation with IntegraPay.


TransType Adjustment: Not supported.

Auth: Not supported.

Return: Must be associated with a Sale (no blind returns).

Void: Not supported.

Force: Not supported.

RepeatSale: Not supported.

NameOnCard Required for Sale TransType.


The following table contains additional information for using the ProcessDebitCard Web service operation with IntegraPay.

Parameter Description TransType Return: Must be associated with a Sale (no blind returns).

NameOnCard Required for Sale TransType.

129

4.22. Litle

This section details requirements and features specific to Litle. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with Litle.


ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN,



The following table contains additional information for using the ProcessCreditCard Web service operation with Litle.







<XID>AuthenticationID</XID> The Unique Transaction Identifier

(applies to Verified By Visa).

<UCAF>UCAF</UCAF> Universal Card Holder Authentication

(applies to MasterCard’s SecureCode).

Verified by Visa may return a CAVV value in the

response ExtData.

<TrustAttempt>T</TrustAttempt> Indicates Verified By Visa or

SecureCode attempted, but there was no XID or UCAF available

for the transaction. Valid values are: T, F.

</Authentication>

130


The following table contains additional information for using the ProcessDebitCard Web service operation with Litle.

Parameter

Description











response ExtData.




</Authentication>


The following table contains additional information for using the ProcessEBTCard Web service operation with Litle.

Parameter Description ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for




The following table contains additional information for using the ProcessGiftCard Web service operation with Litle.

Parameter

Description




131

4.23. Mercury Payment Systems

This section details requirements and features specific to Mercury Payment Systems. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with Mercury Payment Systems.


ExtData <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID is sent with the request. Valid values are: None, NotSubmitted,



The following table contains additional information for using the ProcessCreditCard Web service operation with Mercury Payment Systems.

Parameter

Description

TransType Adjustment: Modifies the existing TipAmt or TotalAmt for an original

sale.

ExtData <CVPresence>CVPresence</CVPresence> Indicates if a



<PaymentOrigin>PaymentOrigin</PaymentOrigin> Source attribute. Valid values are: Internet, Back_Office, Bounced_Check, Drop_Box, Mailed_In, Retail_POS.


The following table contains additional information for using the ProcessDebitCard Web service operation with Mercury Payment Systems.

Parameter

Description

ExtData <CVPresence>CVPresence</CVPresence> Indicates if a CVV2/CVC2/CID



132


The following table contains additional information for using the ProcessEBTCard Web service operation with Mercury Payment Systems.



<IIAS_Indicator>IIAS_Indicator</IIAS_Indicator> Indicates if the current transaction is authorized by an Inventory Information Approval System. Industry must be Retail, and card issuer must be Visa orMasterCard. Valid values are: T, F.



The following table contains additional information for using the ProcessGiftCard Web service operation with Mercury Payment Systems.



<GiftCVV>GiftCVV</GiftCVV> Indicates if a CVV2/CVC2/CID is sent

with the request. Valid values are: None, NotSubmitted, Submitted, Illegible, NotPresent [on card].


The following table contains additional extended data that Mercury Payment Systems supports.


ExtData <ShiftID>ShiftID</Unit> Shift description.

<DemographicInfo>DemographicInfo</DemographicInfo>

133


The following table contains descriptions of response values specific to Mercury Payment Systems.




</ReceiptData>

4.24. Paymentech (Tampa)

This section details requirements and features specific to Paymentech (Tampa). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCheck Web service operation with Paymentec (Tampa).






The following table contains additional information for using the ProcessCreditCard Web service operation with Paymentec (Tampa).

Parameter

Description

TransType Adjustment: Modifies the existing TipAmt for an original sale.

134





</Presentation>



The following table contains additional information for using the ProcessDebitCard Web service operation with Paymentec (Tampa).


ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When enabled, instructs the host to process the transaction as a partial authorization for available funds. Valid values are: T, F.

<EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN,MANUAL,MAGNETICSTRIPE, ICC, and PROXIMITY.




<CardPresent>CardPresent Value</CardPresent> Valid values are: True (card present), False (card not present or unknown).

</Presentation>

135


The following table contains additional information for using the ProcessEBTCard Web service operation with Paymentec (Tampa).

Parameter

Description




Visa orMasterCard. Valid values are: T, F.













</Presentation>


The following table contains additional information for using the ProcessGiftCard Web service operation with Paymentec (Tampa).


TransType Force: Places a transaction unprocessed by the payment server into the current batch (ForceAuth).

ExtData <EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are: UNKNOWN,MANUAL,MAGNETICSTRIPE, ICC, and PROXIMITY.


136

4.24.5.1. Gift ForceAuth Transactions

ForceAuth Element

You may place a previously authorized Redeem, Reload, and Activate transaction into the current batch by running the respective transaction with the ForceAuth and AuthCode elements in the ExtData. See Manual Gift Force (ForceAuth Redeem) on page 138 and Manual Gift Force (ForceAuth Reload) on page 138 for detailed examples.

Force TransType

There is an additional method of placing a previously authorized Redeem transaction into the current batch. Using the Force TransType, send a request with the AuthCode of the original transaction within the ExtData. See Swiped Gift Force on page 137 for a detailed example.

4.24.5.2. Examples


4.24.5.2.1. Swiped Gift Force

The following example places a previously authorized swiped Redeem transaction into the current batch by using the Force TransType and sending the AuthCode in the ExtData.


Password 123

TransType Force

CardNum 6035718888880552378

ExpDate 1210

MagData 6035718888880552378=1012000876414

NameOnCard John Doe

Amount 3.00

ExtData <AuthCode>104013</AuthCode>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVED</Message> <AuthCode>104013</AuthCode>

137

<PNRef>39782</PNRef> <HostCode>00000014</HostCode> <ExtData>CardType=EGC</ExtData>

</Response> 4.24.5.2.2. Manual Gift Force (ForceAuth Redeem)

The following example places a gift Redeem transaction into the current batch using the ForceAuth and AuthCode elements.


Password 123

TransType Redeem

CardNum 6035718888880552378

ExpDate 1210

NameOnCard John Doe

Amount 3.00

ExtData <ForceAuth><AuthCode>105258</AuthCode></ForceAuth>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVED</Message> <AuthCode>105259</AuthCode> <PNRef>39783</PNRef> <HostCode>00000015</HostCode> <ExtData>CardType=EGC</ExtData>

</Response> 4.24.5.2.3. Manual Gift Force (ForceAuth Reload)

The following example places a gift Reload transaction into the current batch using the ForceAuth and AuthCode elements.


Password 123

TransType Reload

138

Parameter

Value

CardNum 6035718888880552378

ExpDate 1210

NameOnCard John Doe

Amount 20.00

ExtData <ForceAuth><AuthCode>105260</AuthCode></ForceAuth>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <Message>APPROVED</Message> <AuthCode>105261</AuthCode> <PNRef>39784</PNRef> <HostCode>00000016</HostCode> <ExtData>CardType=EGC</ExtData>

</Response>


The following table contains descriptions of response values specific to Paymantec (Tampa).





</ReceiptData>

4.25. Planet Payment

This section details requirements and features specific to Planet Payment. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


139

4.25.1. ProcessDCCLookup

Planet Payment supports Dynamic Currency Conversion (DCC) with ProcessDCCLookup. This Web service uses currency exchange rates to tell the merchant the equivalent transaction amount to charge in the cardholder’s currency. The URL to access this service is:

https://gateway.itstgate.com/SmartPayments/validate.asmx/ProcessDCCLookup

DCC determines the cardholder’s currency code from the card number and uses the merchant’s configuration when the MID registers with the host. Using the two currency codes and the original amount, ProcessDCCLookup returns the exchange rate between the two currencies and the transaction amount in the cardholder’s currency.


Parameter Value



CardNum Required. Credit card number used to process the transaction.

ExpDate Required. Credit card’s expiration date in MMYY format.

Amount Required. The total transaction amount.

4.25.1.1. Examples

The following examples show different functions available with this Web service. Change the credentials and payment information fields when running test transactions.

4.25.1.1.1. DCC Lookup

The following example performs a DCC lookup from Yen to USD. To see a follow‐on transaction using DCC in a credit sale, see Credit Sale with DCC on page 144.

Parameter Value UserName Planet

Password Pw4planet

CardNum 4051700000003926

ExpDate 1213

Amount 100

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/">

140

<Result>0</Result> <RespMSG>Approved</RespMSG> <Message>Approved</Message> <AuthCode>305801060593</AuthCode> <PNRef>149316</PNRef> <ExtData>

<Currency> <ConversionRate>97.23219</ConversionRate> <FromTransactionAmount>100.00</FromTransactionAmount> <FromCurrencyCode>840</FromCurrencyCode> <ToTransactionAmount>9723</ToTransactionAmount> <ToCurrencyCode>392</ToCurrencyCode> <RRN>305801060593</RRN>

</Currency> </ExtData>

</Response>

4.25.2. ProcessMCPLookup

Planet Payments supports Multi‐Currency Pricing (MCP) through ProcessMCPLookup. This Web servies uses currency exchange rates to tell the merchant the equivalent amount of a transaction in a foreign currency. URL to access this service is:

https://gateway.itstgate.com/SmartPayments/validate.asmx/ProcessMCPLookup

Using the the currency code of the desired foreign currency (FromCurrencyCode) and the merchant’s currency code (determined from merchant configuration when MID regisers with the host), MCP returns the exchange rate between the two currencies and the transaction amount in the cardholder’s currency.

A merchant would use this form of currency conversion to set prices ahead of time for specific foreign currencies.


Parameter Value



Amount Required. The total transaction amount.

FromCurrencyCode Required. The cardholder’s currency code.

4.25.2.1. Supported Currency Codes

The following table displays currency codes currently supported by Planet Payments.

Code

Currency Code

Currency

124 Canadian Dollar 422 Lebanese Pound

141

360 Indonesian Rupiah 826 Pound Sterling

392 Yen 840 United States Dollar

414 Kuwaiti Dinar 978 Euro

4.25.2.2. Examples

The following examples show different functions available with this Web service. Change the credentials and payment information fields when running test transactions.

4.25.2.2.1. MCP Lookup

The following example performs an MCP lookup from Yen to USD. To see a follow‐on transaction using MCP in a credit sale, see Credit Sale with MCP on page 145.

Parameter Value UserName Planet

Password Pw4planet

Amount 1000

FromCurrencyCode 392

ToCurrencyCode 840

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>Approved</Message> <AuthCode>305801060606</AuthCode> <PNRef>149316</PNRef> <ExtData>

<Currency> <ConversionRate>0.0123493</ConversionRate> <FromTransactionAmount>1000</FromTransactionAmount> <FromCurrencyCode>392</FromCurrencyCode> <ToTransactionAmount>12.35</ToTransactionAmount> <ToCurrencyCode>840</ToCurrencyCode>


</Response>

142

4.25.3. GetInfo

The following table contains additional information for using the GetInfo Web service operation with Planet Payment.

Parameter

Description

ExtData <RegisterNum>RegisterNum</RegisterNum> Register number. The

data within this XML tag parameter removes invalid characters. See

XML Character Removal on page 172 for more details.

<EchoRequest>EchoRequest</EchoRequest>


The following table contains additional information for using the ProcessCreditCard Web service operation with Planet Payment.

Parameter

Description

TransType Adjustment: Modifies the existing TipAmt or TotalAmt for an original

sale.

Amount If performing an MCP Sale or Auth, set this value to 0.

ExtData <Authentication>

<XID>AuthenticationID</XID>

<UCAF>UCAF</UCAF>

</Authentication>







<TID>TID</TID> Provides a method to change the terminal ID per

transaction. This is only for use during certification.

<EchoRequest>EchoRequest</EchoRequest> Optional for Initialize

TransType. When enabled, initiates an EchoRequest. Valid values

are: true and false. Used for troubleshooting host issues.

<TestRequest>TestRequest</TestRequest> Optional for Initialize

TransType. When enabled, initiates a TestRequest. Valid values are:

true, false. Used for troubleshooting host issues.

<Currency> Required for MCP/DCC currency conversion in Sales

and Auths.

<Type>Type</Type> Required. Indicates the type of currency

143

Parameter

Description

conversion. Valid values are: DCC, MCP.

< FromCurrencyCode>FromCurrencyCode</FromCurrencyCode>

Required for MCP processing. Cardholder’s currency code.

<TransAmount>TransAmount</TransAmount> Required for

MCP processing. The transaction amount in the cardholder’s

currency.

When performing an MCP Sale or Auth, you must set the

Amount parameter to 0. The payment server will

populate the proper sale amount after the conversion.

</Currency>

4.25.4.1. Currency Conversion

Planet Payment supports two methods of currency conversion for Sale and Auth transactions using the Currency tag and its child elements.

Direct Currency Conversion (DCC) takes the sale amount in the merchant’s currency and converts it to the cardholder’s currency. DCC examines the card number to determine the cardholder’s local currency. To perform a DCC Sale or Auth transaction, you must pass the Currency and Type elements in the ExtData.

Multi‐Currency Processing (MCP) takes the sale amount in the cardholder’s currency and converts it to the merchant’s currency. MCP uses the cardholder’s currency code to convert the transaction amount back to the merchant’s currency. To perform an MCP Sale or Auth transaction, you must pass the Currency, Type, FromCurrencyCode, and TransAmount elements in the ExtData.

4.25.4.2. Examples


4.25.4.2.1. Credit Sale with DCC

The following example processes a DCC credit Sale of 15.00 USD for a merchant who accepts the 392 currency code (Yen).

Parameter Value UserName planet

Password Pw4planet

TransType Sale

CardNum 4051700000003926

ExpDate 1213

144

Parameter

Value

Amount 15.00

ExtData <Force>T</Force><Currency><Type>DCC</Type></Currency>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>Approved</Message> <AuthCode>00174A</AuthCode> <PNRef>149322</PNRef> <HostCode>305801061374</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData>

<Currency> <ConversionRate>97.23219</ConversionRate> <FromTransactionAmount>15.00</FromTransactionAmount> <FromCurrencyCode>840</FromCurrencyCode> <ToTransactionAmount>1458</ToTransactionAmount> <ToCurrencyCode>392</ToCurrencyCode> <WholeSaleRate>0</WholeSaleRate>


</Response> 4.25.4.2.2. Credit Sale with MCP

The following example processes an MCP credit Sale. In this example, the cardholder currency is 392 (Yen). This transaction converts 564 Yen to $6.88USD and processes a sale. PathwayLINK returns the conversion rate and final transaction amount in the merchant's currency.

The payment server processes the value in the standard Amount parameter in the merchant's currency format. This can cause decimal errors on final reports because not all currencies support decimals (e.g., Yen). To avoid this issue, pass 0 in Amount and pass the amount in the cardholder currency using the TransAmount field within ExtData.

Parameter Value UserName planet

Password Pw4planet

TransType Sale

CardNum 40515450000004140

145

Parameter

Value

ExpDate 1213

Amount 0

ExtData <Force>T</Force><Currency><Type>MCP</Type><FromCurrencyCode>

392</FromCurrencyCode><TransAmount>564</TransAmount></Curre

ncy>

Response


<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://gateway.itstgate.com/SmartPayments/"> <Result>0</Result> <RespMSG>Approved</RespMSG> <Message>Approved</Message> <AuthCode>00174A</AuthCode> <PNRef>149322</PNRef> <HostCode>305801061374</HostCode> <GetCommercialCard>False</GetCommercialCard> <ExtData>

<Currency> <ConversionRate>0.0122045</ConversionRate> <FromTransactionAmount>564</FromTransactionAmount> <FromCurrencyCode>392</FromCurrencyCode> <ToTransactionAmount>6.88</ToTransactionAmount> <ToCurrencyCode>840</ToCurrencyCode>


</Response>


The following table contains descriptions of response values specific to Planet Payment.


ExtData <Currency> Indicates currency conversion information. <ConversionRate>Rate</ConversionRate> <FromTransactionAmount>Amount</FromTransactionAmount>

<FromCurrencyCode>Code</FromCurrencyCode>

<ToTransactionAmount>Amount</ToTransactionAmount>

<ToCurrencyCode>Code</ToCurrencyCode>

<WholeSaleRate>Rate</WholeSaleRate>

<RRN>RRN</RRN>

</Currency>

146

4.26. Profit Stars

This section details requirements and features specific to Profit Stars. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCreditCard Web service operation with Profit Stars.


ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When enabled, instructs the host to process the transaction as a partial



The following table contains additional information for using the ProcessDebitCard Web service operation with Profit Stars.

Parameter Description ExtData <Partial_Indicator>Partial_Indicator</Partial_Indicator> When




The following table contains additional information for using the ProcessEBTCard Web service operation with Profit Stars.

Parameter

Description




Visa orMasterCard. Valid values are: T, F.




147

4.27. TSYS (Host)

This section details requirements and features specific to TSYS (Host). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.27.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with TSYS (Host).

Parameter

Description




0: Current open batch (default value if BatchSequenceNum is left unspecified in ExtData).

1: Previous batch.


N: And so on…


The following table contains additional information for using the ProcessCheck Web service operation with TSYS (Host).

Parameter

Description












148


The following table contains additional information for using the ProcessCreditCard Web service operation with TSYS (Host).

Parameter

Description


sale. Reversals must process within 2 hours of the original transaction.





</Presentation>

<AuthenticationCapability> Sent by the POS application to indicate












The following table contains additional information for using the ProcessDebitCard Web service operation with TSYS (Host).





Manual debit reversals require the CardNum, ExpDate,

and PNRef of the original sale transaction.

149


ExtData <Presentation> Indicates card presence in a transaction. <CardPresent>CardPresent Value</CardPresent> Valid values are: True (card present), False (card not present or unknown).

</Presentation>

<AuthenticationCapability> Sent by the POS application to indicate if a PIN pad is connected to the POS system. <PINCapability>PINCapability</PINCapability> PIN capability. Valid values are: Capable, Incapable, Inoperative, Unknown. </AuthenticationCapability>



4.27.4.1. Examples


4.27.4.1.1. Manual Debit Reversal

The following example processes a manual debit Reversal transaction. For manual debit reversals, TSYS requires the CardNum, ExpDate, and original sale PNRef.




Password 123

TransType Sale

CardNum 9999999800002773

ExpDate 0509


Amount 20.00

Pin 402ABE473425535E

150

Parameter Value ExtData <KeySerialNumber>0123456780269000008</KeySerialNumber>

Response



</Response>

Reversal Transaction


Password 123

TransType Reversal

CardNum 9999999800002773

ExpDate 0509

PNRef 23853

Response



</Response>

151


The following table contains additional information for using the ProcessEBTCard Web service operation with TSYS (Host).

Parameter

Description




</Presentation>

<AuthenticationCapability> Sent by the POS application to indicate












The following table contains additional information for using the ProcessGiftCard Web service operation with TSYS (Host).






152


The following table contains additional extended data that TSYS (Host) supports.

Parameter

Description

ExtData <FreeFormText>FreeFormText</FreeFormText>

<AlternateMerchantDBAName>AlternateMerchantDBAName</

AlternateMerchantDBAName>

<PaymentTransactionIdentifier>PaymentTransactionIdentifier</Pa

ymentTransactionIdentifier> Format: Cnn, where nn is 01–06.

<SoftDescriptor>SoftDescriptor</SoftDescriptor>

<OrigTransType>OrigTransType</OrigTransType>


The following table contains descriptions of response values specific to TSYS (Host).

Parameter

Description



amount requested.

<Approved_Amt>Approved_Amt</Approved_Amt> Total

amount approved.

<BalanceAmount>BalanceAmount</BalanceAmount>

Remaining balance on the account.

<EBT_Transaction>EBT_Transaction</EBT_Transaction> Echo of

transaction type if EBT card.

</ReceiptData>

<PendingTransactionCount>Count</PendingTransactionCount>

<TransactionOriginalNumber>Number</TransactionOriginalNumb

er>

<FreeFormText>Text</FreeFormText>

<TrackStatusCode>Code</TrackStatusCode>

<MerchantAdviceCode>Code</MerchantAdviceCode>

<CardLevelResults>Result</CardLevelResults>

<CardType>Type</CardType>

<ReturnACI>ACI</ReturnACI>

<NetworkID>ID</NetworkID>

153

4.28. TSYS (Terminal)

This section details requirements and features specific to TSYS (Terminal). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.28.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with TSYS (Terminal).

Parameter

Description





1: Previous batch.


N: And so on…


The following table contains additional information for using the ProcessCheck Web service operation with TSYS (Terminal).

Parameter

Description












154


The following table contains additional information for using the ProcessCreditCard Web service operation with TSYS (Terminal).

Parameter

Description



transaction. Supported industries: Retail, Restaurant. Support for

all card issuers.

Adjustment: Modifies the existing TipAmt, TotalAmt, or PONum

for an original sale.













response ExtData.




</Authentication>








number.




155


The following table contains additional information for using the ProcessDebitCard Web service operation with TSYS (Terminal).





Manual debit reversals require the CardNum, ExpDate,

and PNRef of the original sale transaction.













response ExtData.




</Authentication>








number.




156

4.28.4.1. Examples


4.28.4.1.1. Manual Debit Reversal

The following example processes a manual debit Reversal transaction. For manual debit reversals, TSYS requires the CardNum, ExpDate, and original sale PNRef.




Password 123

TransType Sale

CardNum 9999999800002773

ExpDate 0509


Amount 20.00

Pin 402ABE473425535E


Response



</Response>

Reversal Transaction

Parameter Value

UserName test

Password 123

157

Parameter

Value

TransType Reversal

CardNum 9999999800002773

ExpDate 0509

PNRef 23853

Response



</Response>


The following table contains additional information for using the ProcessEBTCard Web service operation with TSYS (Terminal).


ExtData <AuthenticationCapability> Sent by the POS application to indicate if a PIN pad is connected to the POS system.

<PINCapability>PINCapability</PINCapability> PIN capability. Valid values are: Capable, Incapable, Inoperative, Unknown.





<IIAS_Indicator>IIAS_Indicator</IIAS_Indicator> Indicates if the current transaction is authorized by an Inventory Information Approval System. Industry must be Retail, and card issuer must be Visa or MasterCard. Valid values are: T, F.

158

Parameter

Description


enabled, instructs the host to process the transaction as a partial authorization for available funds. Valid values are: T, F.


The following table contains additional information for using the ProcessGiftCard Web service operation with TSYS (Terminal).

Parameter

Description













The following table contains descriptions of response values specific to FirstData Nashville.

Parameter Description ExtData <ReceiptData> Indicates data that should print on the receipt. <Partial_Reversal_Flag>Partial_Reversal_Flag</Partial_Reversal_F lag> Indicates that transaction processed as a partial reversal. Valid values: T.





</ReceiptData>

159

4.29. Valutec

This section details requirements and features specific to Valuetec. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.29.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with Valuetec.

Parameter

Description





1: Previous batch.


N: And so on…

4.30. Vantiv (Cincinnati)

This section details requirements and features specific to Vantiv (Cincinnati). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].



The following table contains additional information for using the ProcessCreditCard Web service operation with Vantiv (Cincinnati).

Parameter

Description

TransType Auth: Not supported in Retail or Restaurant.

160

Parameter

Description






The following table contains additional information for using the ProcessDebitCard Web service operation with Vantiv (Cincinnati).






The following table contains additional information for using the ProcessEBTCard Web service operation with Vantiv (Cincinnati).






161


The following table contains additional information for using the ProcessGiftCard Web service operation with Vantiv (Cincinnati).

Vantiv does not support Gift transactions in eCommerce.





4.30.5. ProcessLoyaltyCard

Vantiv does not support Loyalty transactions in eCommerce.


The following table contains descriptions of response values specific to Vantiv (Cincinnati).

Parameter

Description



amount requested.


approved.



</ReceiptData>

4.31. Vantiv (St. Petersburg)

This section details requirements and features specific to Vantiv (St. Petersburg). If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


162

4.31.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with Vantiv (St. Petersburg).

Parameter Description ExtData <BatchSequenceNum>Number</BatchSequenceNum> Indicates if the payment server should query the processor for information for the current or a previous batch. Valid values are:



1: Previous batch.


N: And so on…


The following table contains additional information for using the ProcessCreditCard Web service operation with Vantiv (St. Petersburg).

Parameter

Description

TransType Auth: Not supported in Retail or Restaurant.

Reversal: Performs a manual full reversal on a credit sale or repeat

sale. A reversal transaction acts as a void host and must be

processed within the open batch time period. Support for all

industries and card issuers.

Adjustment: Modifies the existing TipAmt or TotalAmt for an

original sale.




</Presentation>











163

Parameter

Description




The following table contains additional information for using the ProcessDebitCard Web service operation with Vantiv (St. Petersburg).



sale. The reversal restores must process within the open batch time

period. Supported industries: Retail, Restaurant. Support for all card

issuers.





information.




</Presentation>













164


The following table contains additional information for using the ProcessEBTCard Web service operation with Vantiv (St. Petersburg).

Parameter

Description




</Presentation>


















The following table contains additional information for using the ProcessGiftCard Web service operation with Vantiv (St. Petersburg).

Vantiv does not support Gift transactions in eCommerce.

Parameter

Description








165

Parameter

Description



4.31.6. ProcessLoyaltyCard

Vantiv does not support Loyalty transactions in eCommerce.


The following table contains descriptions of response values specific to Vantiv (St. Petersburg).

Parameter

Description



amount requested.


approved.



</ReceiptData>

4.32. WorldPay

This section details requirements and features specific to WorldPay. If you have any questions or need additional information regarding this processor, please contact our integration specialists at [email protected].


4.32.1. GetInfo

The following table contains additional information for using the GetInfo Web service operation with Global East.

Parameter Description TransType KeyChangeRequest: Contacts the Global host to get a new key sent to

the PIN pad in use. You would perform this request when the PIN pad is

initialized for the first time or after a necessary reboot.

166

Parameter Description ExtData <BatchSequenceNum>Number</BatchSequenceNum> Indicates if the payment server should query the processor for information for the current or a previous batch. Valid values are:



1: Previous batch.


N: And so on…


The following table contains additional information for using the ProcessCheck Web service operation with WorldPay.

Parameter

Description





<ServiceType>ServiceType</ServiceType> Transaction override for

check transactions. Not currently exposed. Valid values are: None, Verification, Guarantee, Conversion.


The following table contains additional information for using the ProcessCreditCard Web service operation with WorldPay.

Parameter Description TransType Reversal: Performs a manual full reversal on a credit sale or repeat

sale. A reversal transaction acts as a void host and must be processed

within the open batch time period. Support for all industries and card

issuers.

ExtData <Authentication> Required to process a transaction using Visa’s Verified By Visa and MasterCard’s SecureCode programs.

<XID>AuthenticationID</XID> The Unique Transaction Identifier (applies to Verified By Visa).


167

Parameter

Description



response ExtData.




</Authentication>




<TerminalType>TerminalType</TerminalType> Identifies card

terminal admittance. Valid values are: Unspecified, Attended, Unattended.


enabled, instructs the host to process the transaction as a partial authorization for available funds. Valid values are: T, F.


The following table contains additional information for using the ProcessDebitCard Web service operation with WorldPay.



sale. The reversal restores must process within the open batch time

period. Supported industries: Retail, Restaurant. Support for all card

issuers.





information.

168

Parameter

Description

ExtData <Authentication> Required to process a transaction using Visa’s







response ExtData.




</Authentication>













</Presentation>

169


The following table contains additional information for using the ProcessEBTCard Web service operation with WorldPay.

Parameter

Description




















The following table contains additional information for using the ProcessGiftCard Web service operation with WorldPay.




<EntryMode>EntryMode</EntryMode> Indicates how the values for the payment information were obtained. Valid values are:



170

A. Appendix

A.1. Valid Input Characters

The following table displays all characters accepted by the payment server. All other characters may yield undesirable results.

DEC HEX

Character DEC HEX Character DEC HEX Character

32 20 Space 63 3F ? 96 60 `

33 21 ! 64 40 @ 97 61 a

34 22 " 65 41 A 98 62 b

35 23 # 66 42 B 99 63 c

36 24 $ 67 43 C 100 64 d

37 25 % 68 44 D 101 65 e

38 26 & 69 45 E 102 66 f

39 27 ' 70 46 F 103 67 g

40 28 ( 71 47 G 104 68 h

41 29 ) 72 48 H 105 69 i

42 2A * 73 49 I 106 6A j

43 2B + 74 4A J 107 6B k

44 2C , 75 4B K 108 6C l

45 2D ‐ 76 4C L 109 6D m

46 2E . 77 4D M 110 6E n

47 2F / 78 4E N 111 6F o

48 30 0 79 4F O 112 70 p

49 31 1 80 50 P 113 71 q

50 32 2 81 51 Q 114 72 r

51 33 3 82 52 R 115 73 s

52 34 4 83 53 S 116 74 t

53 35 5 84 54 T 117 75 u

54 36 6 85 55 U 118 76 v

55 37 7 86 56 V 119 77 w

171

DEC HEX

Character DEC HEX Character DEC HEX Character

56 38 8 87 57 W 120 78 x

57 39 9 88 58 X 121 79 y

58 3A : 89 59 Y 122 7A z

59 3B ; 90 5A Z 123 7B {

60 3C < 92 5C \ 124 7C |

61 3D = 94 5E ^ 125 7D }

62 3E > 95 5F _ 126 7E ~

A.2. XML Character Removal

The following table displays all acceptable characters that must be removed by the payment server before submitting information to the Web service operations. This character removal ensures that the payment servers’ internal XML parsers can properly read the information of the Web service operation.

Many XML parsers encode these characters for you. In that case, the characters will not be converted back to their proper values by the payment server; they will be taken literally. Additionally, if you pass the encoded character through an input parameter that removes the characters listed in the table below, then certain characters may be removed (see Examples below).

If you are not using a parser, or if the parser does not handle this encoding, then the characters in the table listed below may still be removed, depending on the input parameter for the Web service operation you are using.

Character XML Parser Encoding < <

> >

& &

' '

" "

Examples

The following examples show how characters would be removed if the data passes through the NameOnCard parameter of the ProcessCreditCard operation.

Valid: John James

Invalid: John & James becomes John James

Invalid: John & James becomes John amp; James

172

A.3. Invoice Number We recommend using 10 Numeric, though any value passed will be sent to the processor. In order to take

advantage of the below table, you need to know the processor prior to sending the transaction. To fully

comply with the Invoice formatting rules of your specific processor, please contact them directly.

The chart below is meant to serve as a Processor based guideline for Invoice numbers:

Processor Field Type Length

Elavon Nova Alphanumeric 25

First Data Nashville Numeric 10

First Data North Numeric 10

First Data Omaha Alphanumeric 8

Global East Alphanumeric 25

Heartland Alphanumeric 25

Litle Alphanumeric 15

Mercury Payment Systems Alphanumeric 16

PaymentTech Tampa Numeric 6

WorldPay Unspecified Unspecified

TSYS Alphanumeric 15

pathwaylink transaction processing developers api

Documents