Paypal Gateway 2013 Developers Guide Payflow Developer And Reference
Gateway - 2013 - Developer Guide and Reference payflowgateway_2013_ug Free User Guide for PayPal Software, Manual
2015-07-27
: Paypal Paypal-Gateway-2013-Developers-Guide-777945 paypal-gateway-2013-developers-guide-777945 paypal pdf
Open the PDF directly: View PDF 
.
Page Count: 256
| Download | |
| Open PDF In Browser | View PDF |
Gateway Developer Guide and Reference PayPal Payments Advanced PayPal Payments Pro Payflow Pro Payflow Link Last updated: 07 February 2013 Gateway Developer Guide and Reference Document Number: 200045.en_US-201302 © 2013 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal (Europe) S.à r.l. et Cie., S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard Royal, L-2449, Luxembourg, R.C.S. Luxembourg B 118 349. Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it does not require the approval of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully. Notice of non-liability: PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express, implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice. Content Chapter Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Who Should Use This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Chapter 1 Introducing the Gateway Checkout Solutions . . . . . . . . 23 About the Gateway Checkout Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Summary of the Gateway Checkout Solutions . . . . . . . . . . . . . . . . . . . . . 23 Gateway Product Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 About the Gateway Transaction Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 About Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Secure Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Hosted Checkout Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 PCI Compliance Without Hosted Pages: Transparent Redirect . . . . . . . . . . . . . 27 Processing Platforms Supporting Card-Present Transactions . . . . . . . . . . . . . . . . 28 Supported Payment Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Supported Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Recurring Billing Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Fraud Protection Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Chapter 2 Secure Token . . . . . . . . . . . . . . . . . . . . . . . . 31 About the Secure Token . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Integrating the Secure Token With the Hosted Checkout Pages . . . . . . . . . . . . . . 31 Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect . 32 Secure Token Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Posting To the Hosted Checkout Page . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Chapter 3 Configuring Hosted Checkout Pages . . . . . . . . . . . . 37 Configuring Hosted Checkout Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Gateway Developer Guide and Reference 07 February 2013 3 Content Configuring Hosted Pages Using PayPal Manager . . . . . . . . . . . . . . . . . . . . . 37 Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Customize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Integrate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Using a Secure Token to Pass Hosted Pages Customization Parameters . . . . . . . . . 41 Using the PARMLIST Parameter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Hosted Pages and Mobile Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Mobile Optimized Checkout Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Silent Posts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Force Silent Post Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Data Returned by the Silent Post Features . . . . . . . . . . . . . . . . . . . . . . . 48 Passing Other Data to Your Server Using Post or Silent Post . . . . . . . . . . . . . . . . 48 Chapter 4 Payflow SDK . . . . . . . . . . . . . . . . . . . . . . . . . 49 Preparing the Payflow Gateway Client Application . . . . . . . . . . . . . . . . . . . . . 49 Activating Your Payflow Gateway Account. . . . . . . . . . . . . . . . . . . . . . . . . . 50 Host URL Addresses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Chapter 5 Sending a Simple Transaction to the Server . . . . . . . . 51 About Name-Value Pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Using Special Characters In Values . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Name-Value Parameter Syntax Guidelines . . . . . . . . . . . . . . . . . . . . . . . 52 Do Not URL Encode Name-Value Parameter Data . . . . . . . . . . . . . . . . . . . 52 Payflow Connection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 User Parameter Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Sale Transaction Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Typical Sale Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Formatting Payflow Gateway Transactions . . . . . . . . . . . . . . . . . . . . . . . . . 54 Chapter 6 Submitting Credit Card Transactions . . . . . . . . . . . . 55 Obtaining an Internet Merchant Account . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 About Credit Card Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Credit Card Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Planning Your Gateway Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Complying With E-commerce Indicator . . . . . . . . . . . . . . . . . . . . . . . . . 58 Handling Credit Card Type Information . . . . . . . . . . . . . . . . . . . . . . . . . 58 4 07 February 2013 Gateway Developer Guide and Reference Content Core Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Submitting Account Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 When To Use Account Verifications . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Required Account Verification Parameters . . . . . . . . . . . . . . . . . . . . . . . 62 Example Account Verification String . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Submitting Authorization/Delayed Capture Transactions . . . . . . . . . . . . . . . . . . 63 When to Use Authorization/Delayed Capture Transactions . . . . . . . . . . . . . . . 63 Required Authorization Transaction Parameters . . . . . . . . . . . . . . . . . . . . 64 Typical Authorization Transaction Parameter String . . . . . . . . . . . . . . . . . . . 64 Submitting Balance Inquiry Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Processing Platforms Supporting Balance Inquiry Transactions . . . . . . . . . . . . 65 Required Balance Inquiry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Example Balance Inquiry Transaction String . . . . . . . . . . . . . . . . . . . . . . 65 Submitting Card Present (SWIPE) Transactions. . . . . . . . . . . . . . . . . . . . . . . 65 Processing Platforms Supporting Card-Present Transactions. . . . . . . . . . . . . . 66 Card Present Transaction Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Submitting Credit Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Required Credit Transaction Parameters . . . . . . . . . . . . . . . . . . . . . . . . 67 Submitting Inquiry Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 When To Use an Inquiry Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Required Parameters When Using the PNREF . . . . . . . . . . . . . . . . . . . . . 70 Inquiry Transaction Parameter String Using the PNREF . . . . . . . . . . . . . . . . 70 Required Parameters When Using the CUSTREF . . . . . . . . . . . . . . . . . . . 70 Inquiry Transaction Parameter String Using the CUSTREF . . . . . . . . . . . . . . . 71 Required Parameters When Using the Secure Token . . . . . . . . . . . . . . . . . . 71 Inquiry Parameter String Using the Secure Token . . . . . . . . . . . . . . . . . . . . 72 Submitting Partial Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 When To Use Partial Authorizations . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Required Partial Authorization Parameters . . . . . . . . . . . . . . . . . . . . . . . 72 Example Partial Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Submitting Purchasing Card Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Submitting Reference Transactions (Tokenization) . . . . . . . . . . . . . . . . . . . . . 74 When To Use a Reference Transaction . . . . . . . . . . . . . . . . . . . . . . . . . 74 Transaction Types That Can Be Used As the Original Transaction . . . . . . . . . . . 75 Fields Copied From Reference Transactions . . . . . . . . . . . . . . . . . . . . . . 75 Example Reference Transaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Data Upload - Storing Credit Card Data on the Gateway Server . . . . . . . . . . . . 76 Submitting Sale Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 When To Use a Sale Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Gateway Developer Guide and Reference 07 February 2013 5 Content Additional Parameters For Sale Transactions . . . . . . . . . . . . . . . . . . . . . . 77 Typical Sale Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . . 78 Submitting Soft Merchant Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 About Soft Merchant Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Ways to Send Soft Merchant Information . . . . . . . . . . . . . . . . . . . . . . . . 79 Submitting Voice Authorization Transactions . . . . . . . . . . . . . . . . . . . . . . . . 80 When To Use a Voice Authorization Transaction . . . . . . . . . . . . . . . . . . . . 80 Required Voice Authorization Transaction Parameters . . . . . . . . . . . . . . . . . 80 Submitting Void Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 When To Use a Void Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Required Void Transaction Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 81 Fields Copied From the Original Transaction Into the Void Transaction. . . . . . . . . 81 Example Void Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . 82 Using Address Verification Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Example Address Verification Service Parameter String . . . . . . . . . . . . . . . . 82 Using Card Security Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Chapter 7 Testing Transactions . . . . . . . . . . . . . . . . . . . . 85 Setting Up The Payflow Gateway Testing Environment . . . . . . . . . . . . . . . . . . . 85 Testing Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Processors Other Than PayPal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Credit Card Numbers for Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Testing Address Verification Service. . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Testing Card Security Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 PayPal Processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Credit Card Numbers for Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Result Values Based On Amount . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Chapter 8 Transaction Responses . . . . . . . . . . . . . . . . . . . 95 Credit Card Transaction Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Address Verification Service Responses From PayPal . . . . . . . . . . . . . . . . . . . 98 Card Security Code Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100 Normalized Card Security Code Results . . . . . . . . . . . . . . . . . . . . . . . .100 PayPal Card Security Code Results . . . . . . . . . . . . . . . . . . . . . . . . . . .100 BALAMT Response and Stored Value Cards . . . . . . . . . . . . . . . . . . . . . . . .101 American Express Stored Value Card Example . . . . . . . . . . . . . . . . . . . . .101 PNREF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 6 07 February 2013 Gateway Developer Guide and Reference Content RESULT Values and RESPMSG Text . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 RESULT Values For Communications Errors . . . . . . . . . . . . . . . . . . . . . .108 Chapter A Processors Requiring Additional Transaction Parameters 111 American Express Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . 111 Retail Transaction Advice Addendum (for SWIPE transactions) . . . . . . . . . . . . 111 Internet Transaction Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Address Verification Service Parameters . . . . . . . . . . . . . . . . . . . . . . . . 113 Location Transaction Advice Addendum Parameters . . . . . . . . . . . . . . . . . . 113 Transaction Advice Detail Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . 115 Airline Passenger Data Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 American Express Other Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Elavon Additional Credit Card Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . 117 First Data Merchant Services Nashville, Additional Credit Card Parameters . . . . . . . . 118 First Data Merchant Services North, Additional Credit Card Parameters . . . . . . . . . . 118 Heartland, Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . 119 Litle Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Merchant e-Solutions, Additional Credit Card Parameters. . . . . . . . . . . . . . . . . .121 Paymentech Salem (New Hampshire) Additional Credit Card Parameters for American Express . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121 Internet Transaction Data Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .121 AVS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122 Additional Credit Card Parameters for M Record . . . . . . . . . . . . . . . . . . . .123 PayPal Credit Card Transaction Request Parameters . . . . . . . . . . . . . . . . . . . .123 SecureNet Additional Credit Card Parameters for American Express . . . . . . . . . . . .128 Retail Transaction Advice Addendum (for SWIPE transactions) . . . . . . . . . . . .128 Internet Transaction Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 AVS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129 Location Transaction Advice Addendum Parameters . . . . . . . . . . . . . . . . . .130 Transaction Advice Detail Parameters. . . . . . . . . . . . . . . . . . . . . . . . . .131 Airline Passenger Data Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .131 Other Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133 Vantiv Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .133 Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .133 Soft Merchant Descriptor Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .134 WorldPay Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . .135 Chapter B TeleCheck Electronic Check Processing . . . . . . . . . 137 Gateway Developer Guide and Reference 07 February 2013 7 Content TeleCheck NFTF Overview of Services . . . . . . . . . . . . . . . . . . . . . . . . . . .137 TeleCheck NFTF Processing Overview . . . . . . . . . . . . . . . . . . . . . . . . . . .137 NFTF Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .137 NFTF Processing Considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 NFTF Guidelines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 TeleCheck Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140 Required TeleCheck Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . .141 Testing TeleCheck Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143 Example Test Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143 Preparing for TeleCheck Production Transactions . . . . . . . . . . . . . . . . . . . . . .144 Responses to TeleCheck Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . .144 Transaction Responses Common to All Tender Types . . . . . . . . . . . . . . . . .144 Response Code Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145 Sale Response Code Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145 Adjustment Code Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146 Response Codes For Status Response Packets . . . . . . . . . . . . . . . . . . . .146 TeleCheck Authorization Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . .147 Authorization – Sales Consent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147 Authorization – Sales Decline/Error . . . . . . . . . . . . . . . . . . . . . . . . . . .150 Chapter C Submitting Purchasing Card Level 2 and 3 Transactions . 151 About Purchasing Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151 About Program Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151 Accepted BIN Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152 About American Express Purchasing Card Transactions . . . . . . . . . . . . . . . . . .152 Supported Transaction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152 Avoiding Downgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153 Submitting Successful Level 3 Transactions . . . . . . . . . . . . . . . . . . . . . .153 Edit Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153 Accepted BIN Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154 American Express Purchasing Card Transaction Processing . . . . . . . . . . . . . . . .154 American Express Level 2 Parameters for American Express . . . . . . . . . . . . .154 Example American Express Level 2 Transaction Parameter String . . . . . . . . . . .157 American Express Level 3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . .157 Example American Express Level 3 Transaction Parameter String . . . . . . . . . . .159 Elavon (Formerly Nova) Purchasing Card Transaction Processing . . . . . . . . . . . . .160 Elavon Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160 Elavon Additional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .160 8 07 February 2013 Gateway Developer Guide and Reference Content Example Elavon Level 2 Transaction Parameter String . . . . . . . . . . . . . . . . .161 First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing.161 FDMS Nashville Commercial Card Parameters . . . . . . . . . . . . . . . . . . . . .161 First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing . .162 FDMS North Purchasing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . .162 FDMS North Purchasing Card Line Item Parameters . . . . . . . . . . . . . . . . . .163 First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing . .163 FDMS South Level 2 and Level 3 Purchasing Card Parameters . . . . . . . . . . . .164 FDMS South Line Item Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .165 Example FDMS South Purchasing Card Level 2 and 3 Parameter String . . . . . . . .166 Example FDMS South Line Item Parameter String . . . . . . . . . . . . . . . . . . .166 Global Payments - Central Purchasing Card Transaction Processing . . . . . . . . . . . .167 Global Payments - Central Level 2 Parameters . . . . . . . . . . . . . . . . . . . . .167 Global Payments - East Purchasing Card Transaction Processing . . . . . . . . . . . . .167 Global Payments - East Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . .167 Example Global Payments - East Level 2 Visa or MasterCard Transaction Parameter String 168 Heartland Purchasing Card Transaction Processing. . . . . . . . . . . . . . . . . . . . .168 Heartland Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168 Heartland Level 3 MasterCard Parameters . . . . . . . . . . . . . . . . . . . . . . .169 Heartland Level 3 Visa Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . .171 Litle Purchasing Card Transaction Processing. . . . . . . . . . . . . . . . . . . . . . . .174 Litle Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174 Litle Level 3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175 Merchant e-Solutions Purchasing Card Transaction Processing . . . . . . . . . . . . . .177 Merchant e-Solutions Level 2 Parameters. . . . . . . . . . . . . . . . . . . . . . . .177 Merchant e-Solutions Level 3 MasterCard Parameters . . . . . . . . . . . . . . . . .177 Merchant e-Solutions Level 3 Visa Parameters . . . . . . . . . . . . . . . . . . . . .180 Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing . . . . . .182 Paymentech Salem (New Hampshire) Level 2 Parameters for American Express . . .182 Paymentech Salem (New Hampshire) Level 3 Purchasing Card Parameters. . . . . .185 Paymentech Tampa Level 2 Purchasing Card Transaction Processing . . . . . . . . . . .188 Paymentech Tampa Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . .189 Example Paymentech Tampa Level 2 Visa and MasterCard Transaction Parameter String 189 SecureNet Purchasing Card Transaction Processing . . . . . . . . . . . . . . . . . . . .189 SecureNet Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189 SecureNet Level 3 MasterCard Parameters . . . . . . . . . . . . . . . . . . . . . . .190 SecureNet Acquiring Solutions Level 3 Visa Parameters . . . . . . . . . . . . . . . .192 Gateway Developer Guide and Reference 07 February 2013 9 Content TSYS Acquiring Solutions Purchasing Card Transaction Processing . . . . . . . . . . . .195 TSYS Acquiring Solutions Level 2 Parameters . . . . . . . . . . . . . . . . . . . . .195 TSYS Acquiring Solutions Level 3 MasterCard Parameters. . . . . . . . . . . . . . .196 TSYS Acquiring Solutions Level 3 Visa Parameters. . . . . . . . . . . . . . . . . . .198 Vantiv Purchasing Card Transaction Processing . . . . . . . . . . . . . . . . . . . . . .201 Vantiv Purchasing Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .201 Vantiv Purchasing Card Line Item Parameters . . . . . . . . . . . . . . . . . . . . .201 WorldPay Purchasing Cards Transaction Processing . . . . . . . . . . . . . . . . . . . .202 WorldPay Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202 WorldPay Level 3 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204 Chapter D Payflow Header Parameters . . . . . . . . . . . . . . . . 207 Sending Requests Directly to PayPal Bypassing Payflow . . . . . . . . . . . . . . . . . .207 Posting Transactions Directly Without the Payflow SDK. . . . . . . . . . . . . . . . . . .208 The Payflow Message Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208 Payflow Message Protocol Headers . . . . . . . . . . . . . . . . . . . . . . . . . . .209 Transaction Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Integrator-Provided Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212 Chapter E VERBOSITY: Processor-Specific Transaction Results . . 215 Chapter F ISO Country Codes . . . . . . . . . . . . . . . . . . . . 217 Chapter G Codes Used by FDMS South Only . . . . . . . . . . . . . 219 MasterCard Country Codes for FDMS South Only . . . . . . . . . . . . . . . . . . . . .219 Visa Country Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226 Units of Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .233 Chapter H PayPal Acquirer . . . . . . . . . . . . . . . . . . . . . . 241 Countries and Regions Supported by PayPal . . . . . . . . . . . . . . . . . . . . . . . .241 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 PayPal Currency Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241 Appendix I Additional Processor Information . . . . . . . . . . . . . 243 Moneris Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243 10 07 February 2013 Gateway Developer Guide and Reference Content Chapter J Payflow Link Migration . . . . . . . . . . . . . . . . . . 245 Migrating from a legacy Payflow Link Integration . . . . . . . . . . . . . . . . . . . . . .245 Chapter K Payflow Gateway MagTek Parameters . . . . . . . . . . . 247 MagTek MagneSafe Secure Card Readers and Qwick Codes . . . . . . . . . . . . . . .247 MagneSafe Secure Card Reader Authenticators . . . . . . . . . . . . . . . . . . . .247 MagTek Qwick Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .248 Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway . . . . . .248 Encrypted Card Swipe Payflow Example . . . . . . . . . . . . . . . . . . . . . . . .249 Qwick Code (PCode) Payflow Example . . . . . . . . . . . . . . . . . . . . . . . . .249 Parameters for Encrypted Card Swipe Transactions . . . . . . . . . . . . . . . . . . . .250 Parameters for MagTek Qwick Code (PCode) Transactions. . . . . . . . . . . . . . . . .253 MagTek Error Codes and Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254 Gateway Developer Guide and Reference 07 February 2013 11 Content 12 07 February 2013 Gateway Developer Guide and Reference Preface This guide describes the data parameters for the Gateway payments solutions. Scope This guide is a reference to the payment card data parameters available for submitting in transaction requests over the Gateway to multiple supported processors. It also covers the resulting response data parameters and errors. The guide describes the requirements of an ever growing list of processing platforms. It organizes parameters into a core set of request parameters supported by all processors, additional parameters unique to individual processors, and purchasing card parameters specialized to monitor credit card use in businesses. It also provides a section on response parameters and error codes (PNREF values that are not 0). Although this guide provides guidance on getting started with the SDK, setting up credit card processing, and testing your integration, its broad scope does not lend to use as a tutorial on integration. Refer to the PayPal Developer website and the Payflow Gateway SDK for detailed working examples and use cases. Related Documentation For additional information on the Gateway payments solutions: See PayPal Manager at: https://manager.paypal.com/ For more information on Payflow documentation, examples, and very current information, see the PayPal developer site at the following URL: https://www.x.com/developers/paypal Intended Audience This guide provides Gateway payments solutions to readers who: Are web or application developers Have a background in payments services Gateway Developer Guide and Reference 07 February 2013 13 Preface Intended Audience Who Should Use This Document This comprehensive developer guide includes integration information for multiple Gateway solutions. Legacy Payflow Link features are not included in this guide. For legacy Payflow Link features refer to the Payflow Link User’s Guide. Additionally, all the Gateway features explained in this guide are not necessarily available to every Gateway customer. This section will help you determine whether you should use this document and which sections of the document are relevant to you. To view the Gateway solutions available to you, login to PayPal Manager at https://manager.paypal.com/. PayPal Manager displays your Gateway Services in the Service Summary box. Payflow Link Payflow Link customers can choose PayPal or another merchant bank to process their transactions via the Payflow Gateway. A) Legacy Payflow Link users will see the following in the Service Summary box in PayPal Manager: Payflow Link If you are a legacy Payflow Link user, do not use this guide; instead, use the Payflow Link User’s Guide. B) New Payflow Link users will see the following in the Service Summary box in PayPal Manager: Hosted Checkout Pages & Payflow SDK/API (Limited Access). (If PayPal Payments Advanced is also listed, then you are not a Payflow Link customer). 14 07 February 2013 Gateway Developer Guide and Reference Preface Intended Audience New Payflow Link users who are using the Secure Token or the API should use this guide. However, new Payflow Link users who are using the legacy Payflow Link input tag integration should use the Payflow Link User’s Guide instead. Limited API Access means you can perform all API functions except for Sales and Authorization transactions. For Sales and Authorization type transactions you must use the Hosted Checkout Pages. Payflow Pro Payflow Pro customers can choose PayPal or another merchant bank to process their transactions via the Gateway. A) Legacy Payflow Pro users will see the following in the Service Summary box in PayPal Manager: Payflow Pro Legacy Payflow Pro users should use this guide; however, these users can only use the API integration and do not have the Hosted Checkout Pages service. If you are a legacy Payflow Pro user, you should skip the chapter on Hosted Checkout Pages - “Configuring Hosted Checkout Pages” on page 37. B) New Payflow Pro users can take advantage of all of the Gateway features including Hosted Checkout Pages. These users will see the following in the Service Summary box in PayPal Manager: Hosted Checkout Pages & Payflow SDK/API (Full Access) Gateway Developer Guide and Reference 07 February 2013 15 Preface Intended Audience PayPal Payments Advanced Transactions submitted by PayPal Payments Advanced customers are processed through the Gateway with PayPal acting as the merchant bank. PayPal Payments Advanced users will see the following in the Service Summary box in PayPal Manager: PayPal Payments Advanced with Hosted Checkout Pages & Payflow SDK/API (Limited Access) Limited API Access means you can perform all API functions except for Sales and Authorization transactions. For Sales and Authorization type transactions you must use Hosted Checkout Pages. PayPal Payments Pro Transactions submitted by PayPal Payments Pro customers are processed through the Gateway with PayPal acting as the merchant bank. PayPal Payments Pro users can use all of the Gateway features supported by PayPal. These users will see the following in the Service Summary box in PayPal Manager: PayPal Payments Pro with Hosted Checkout Pages & Payflow SDK/API (Full Access) 16 07 February 2013 Gateway Developer Guide and Reference Preface Revision History Revision History Revision History for the Gateway Developer Guide and Reference: Date Description 28 Jan 2013 Added a new Appendix on Payflow Header Parameters. Added information about duplicate parameters in the Name-Value Parameter Syntax Guidelines. In the Hosted Pages Chapter, added the Passing Other Data to Your Server Using Post or Silent Post section, and clarified that Silent Posts are returned for both approved and declined transactions. Updated the Payflow Link legacy parameters and the equivalent Payflow parameters parameter table. Removed legacy Payflow Link parameters with identical Payflow equivalents. Updated the description of the BILLTOSTATE and SHIPTOSTATE parameters in the Core Credit Card Parameters table. Added a note to the introduction of the Submitting Credit Card Transactions chapter. Revised the introduction to the Payflow SDK chapter. Updated some of the external links in the guide. Corrected the format of the ORDERDATE parameter in TSYS Acquiring Solutions Level 3 Visa Extended Data. 28 Dec 2012 Updated the description of the Driver’s Licencse - DL field in Required TeleCheck Parameters. 11 Dec 2012 Added info on forcing the Cancel URL with layout template C to Configuring Hosted Pages Using PayPal Manager. Added Secure Token error codes to Secure Token Errors and to RESULT Values and RESPMSG Text. 04 Oct 2012 Added a new section on Hosted Pages and Mobile Browsers and updated the Configuring Hosted Checkout Pages chapter. Added a new section: Supported Languages. Added a new section: Using the PARMLIST Parameter. Added information to the Host URL Addresses section. 29 Aug 2012 Added the Payflow Gateway MagTek Parameters Appendix. 31 July 2012 Added a list of Setup Params and Customize Params. These parameters override PayPal Manager settings for Hosted Pages. Gateway Developer Guide and Reference 07 February 2013 17 Preface Revision History Date Description Briefly explained the differences between Submitting Credit Transactions and Submitting Void Transactions. Updated the parameters in the Payflow Link legacy parameters and the equivalent Payflow parameters table. Added DATE_TO_SETTLE to Credit Card Transaction Responses parameters table. Added a note to the About Credit Card Processing section. 23 July 2012 Added the Bill Me Later feature to the Gateway Product Details section. 16 July 2012 Updated required value for BILLTOCITY, BILLTOSTATE & BILLTOCOUNTRY in PayPal Credit Card Transaction Request Parameters table. June 2012 Who Should Use This Document section added to the Preface. Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect section: corrected value of SILENTTRAN to “True” Silent Posts section added to Hosted Checkout Pages chapter. ISO Country Codes: removed the legacy paramater CORPCOUNTRY May 2012 Added new sections to the Testing Transactions chapter: Testing Address Verification ServiceTesting Card Security Code Added PayPal Acquirer chapter: Contains links to PayPal API Ref country and currency codes 18 May 2012 (cont.) Document maintenance: Added cross-references and external links; reorganized content; removed no longer applicable content. April 2012 Added new transaction type: Balance Inquiry(TRXTYPE=B) can be used to obtain the balance of a pre-paid card. 07 February 2013 Gateway Developer Guide and Reference Preface Revision History Date Description Updated TeleCheck chapter: Updated MICR values in Testing TeleCheck Transactions section Added TeleCheck Adjustment Response Code Values table Updated parameters and examples: Added a description for response parameters HOSTCODE, RESPTEXT, PROCCARDSECURE, ADDLMSGS and an explanation on how to use these parameters to obtain the processor’s raw response codes and response messages. Changed Litle parameters from STREET2,STREET3 to BILLTOSTREET2, BILLTOSTREET3 Corrected description of MERCHSVC parameter for FDMS North, Heartland, Litle, Merchant e-Solutions, Paymentech Salem Updated examples and removed legacy parameters to include:FIRSTNAME, LASTNAME, STREET, CITY, STATE, ZIP, COUNTRY Updated processor and entity names: Vantiv, previously known as Fifth Third Processing Solutions PayPal Australia, previously known as First Data Australia January 2012 Added new processors: First Third International Heartland Payment Systems Planet Payment SecureNet TeleCheck WorldPay Added new transaction types: TRXTYPE=L can be used to upload credit card data, easing PCI compliance. You can store the resulting PNREF locally for use in performing reference transactions. Gateway Developer Guide and Reference 07 February 2013 19 Preface Revision History Date Description January 2012 (cont.) Added request NVPs: ADDLAMTn ADDLAMTTYPEn AUTHDATE CATTYPE CONTACTLESS CUSTDATA CUSTOMERID CUSTOMERNUMBER DISCOUNT DUTYAMT DLNAME DLNUM DOB L_ALTTAXAMTn L_ALTTAXIDn L_ALTTAXRATEn L_CARRIERSERVICELEVELCODEn L_COMMCODEn L_EXTAMTn L_PRODCODEn L_TAXTYPEn ORDERID MERCHANTDESCR MERCHANTINVNUM MERCHANTNAME MERCHANTURL MERCHANTVATNUM MERCHANTZIP MISCDATA REPORTGROUP SILENTTRAN STREET3 VATINVNUM VATTAXAMT VATTAXRATE Added response NVPs: DUPLICATE (response) EXTRMSG (response) 20 07 February 2013 Gateway Developer Guide and Reference Preface Revision History Date Description January 2012 (cont.) Added concepts: Gateway Product Solutions - PayPal Payments Advanced, PayPal Payments Pro, Payflow Pro, Payflow Link Transaction Flow Transparent Redirect February 2011 First publication. Gateway Developer Guide and Reference 07 February 2013 21 Preface Revision History 22 07 February 2013 Gateway Developer Guide and Reference 1 Introducing the Gateway Checkout Solutions The Gateway provides checkout solutions for novice and advanced use. It provides merchants with a rich set of options to handle payment transactions. “About the Gateway Checkout Solutions” on page 23 “About the Gateway Transaction Flow” on page 25 “About Security” on page 26 “Processing Platforms Supporting Card-Present Transactions” on page 28 “Supported Payment Types” on page 29 “Recurring Billing Service” on page 30 About the Gateway Checkout Solutions Gateway checkout consists of the following four solutions: Payflow Link Payflow Pro PayPal Payments Advanced PayPal Payments Pro Summary of the Gateway Checkout Solutions Below is a basic comparison of the Gateway checkout solutions: Payflow Link uses hosted checkout pages to send transactions to a supported processor. Merchants can use the Payflow SDK APIs to perform all transactions except authorization and sale transactions. By using hosted pages with a secure token, the merchant adheres to compliance rules for handling customer data in a secure way: data is stored on PayPal so that it is not exposed to compromise. Payflow Pro can send transactions to a number of different supported processors, requirements for which are described in this documentation. Merchants select a supported processor and obtain an acquiring bank. Typically merchants integrate with, and have full access to, the Payflow SDK or use HTTPS to send transactions to the processor. Using hosted pages is an option. PayPal Payments Advanced uses web pages hosted by PayPal (also known as hosted checkout pages) to send transactions to the PayPal processor. With PayPal Payments Advanced, PayPal is the acquiring bank. By using hosted checkout pages with a secure Gateway Developer Guide and Reference 07 February 2013 23 1 Introducing the Gateway Checkout Solutions About the Gateway Checkout Solutions token, the merchant adheres to compliance rules for handling customer data in a secure way: data is stored on PayPal so that it is not exposed to compromise. Like PayPal Payments Advanced, PayPal Payments Pro sends transactions to the PayPal processor and PayPal is the acquiring bank. Using hosted checkout pages is an option. Typically merchants integrate with the Payflow SDK or use HTTPS to send transactions to the PayPal processor. NOT E : PayPal strongly recommends that all users of Gateway checkout solutions take advantage of the secure token and the hosted checkout pages. Doing so provides automatic compliance with processing card industry (PCI) standards for protecting cardholder data. Gateway Product Details The table below compares how the Gateway checkout solutions support payment processing features. PayPal Payments Advanced Payflow Link PayPal Payments Pro Payflow Pro Hosted checkout page (including an iFrame version) Yes Yes PayPal payments Included Optional Bill Me Later payments (Available to US merchants only on Hosted checkout pages.) Included Optional PayPal branding on full page templates Yes Optional Transparent Redirect No Yes Supports PayPal as a processor and an acquirer Yes Yes Credit and debit cards Yes Yes Level 2 and Level 3 purchase cards Yes Yes TeleCheck (guaranteed electronic checks) No Yes ACH (electronic checks) No Yes Virtual Terminal support, including card-present data passage Yes Yes Virtual Terminal Payflow Link only Yes API Limited access (no authorization or sale) Full access Feature 24 07 February 2013 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions About the Gateway Transaction Flow Feature PayPal Payments Advanced Payflow Link PayPal Payments Pro Payflow Pro Reference transactions (Tokenization) Yes Yes Secure token to preset hosted checkout page Yes Yes Reporting APIs Yes Yes Desktop integration Yes Yes Recurring billing Yes Yes Basic fraud protection Yes Yes Advanced fraud protection Yes Yes Partner/channel distribution support (Partner Manager, registration, XML registration) resale and referral Yes Yes 1 About the Gateway Transaction Flow The traditional transaction flow is as follows. Numbers correspond to numbers in the figure. 1. At your website, the customer clicks Buy to purchase merchandise. 2. You send the transaction request to the Gateway server. 3. The Gateway sends the transaction to the payment processing network. 4. Your processor sends the response back to the Gateway server and processes the transaction (obtains the payment from the customer bank and deposits it in the merchant bank). 5. The Gateway server returns the response to your website. 6. Your website displays the result to the customer. You can use the core transaction parameters supported by all Gateway processors described in this dcumentation to send transaction data to your processor. In addition: Gateway Developer Guide and Reference 07 February 2013 25 1 Introducing the Gateway Checkout Solutions About Security Each Gateway processor may support various additional parameters beyond the core set that you can send in transaction requests. Your processor may also support purchasing cards (credit cards employers issue for business-related charges). Purchasing card Level 2 and Level 3 parameters provide specialized reporting so an employer can monitor card use. The parameter information may appear on the customer’s statement or describe line items in greater detail. Be sure to check for your processor’s Level 2 and 3 parameters in this documentation. The sections in this documentation describing the above parameters alphabetically organize parameters by processor name. About Security It is your responsibility to adhere to PCI compliance standards to protect personal information and implement security safeguards on your website when processing payment card transactions. Gateway solutions make available a secure token and hosted checkout pages to help you meet PCI compliance. Hosted pages are optional to PayPal Payments Pro and Payflow Pro users. If you do not use a secure token or hosted pages, you must provide your own means of meeting compliance requirements. NOT E : PayPal Payments Advanced and Payflow Link merchants are required to use hosted pages. Secure Token The secure token stores request transaction data on the Gateway server. It eliminates the need to resend the parameter data for display in a hosted checkout page where the data might be subject to compromise. Hosted Checkout Pages The Gateway enables the use of hosted checkout pages, which help you achieve PCI compliance. The hosted checkout pages enable you to pass transaction data securely to the server and to collect credit card acceptance data. NOT E : You are required to use hosted pages with PayPal Payments Advanced and Payflow Link. The following figure shows the transaction flow when using hosted pages and a secure token. 26 07 February 2013 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions About Security 1 Numbers in the figure correspond to the numbered comments below: 1. The customer clicks Buy to purchase merchandise on your website. 2. You request a secure token by passing a token ID to the Gateway server. 3. The Gateway server returns the secure token and your token ID to your website. 4. You submit the secure token and token ID in an HTTP post to pages hosted on the Gateway server and redirect the customer’s browser to the hosted pages. 5. The Gateway server uses the secure token to retrieve the amount and other transaction data. The customer submits their credit card number, expiration date, and other sensitive data directly to the host pages rather than to your website, easing your PCI compliance requirements. 6. The Gateway processes the payment through the payment processing network. 7. The Gateway server transparently returns the customer to the location on your website that you specified in the request to obtain a secure token. You display the results to the customer on your website. NOT E : If you do not get a response from the Gateway server, submit an Inquiry transaction, passing in the secure token to see if the transaction has completed. For details, see “Submitting Inquiry Transactions” on page 69. PCI Compliance Without Hosted Pages: Transparent Redirect PayPal Payments Pro and Payflow Pro merchants who want PCI compliance while maintaining full control over designing and hosting checkout pages on their website can use Transparent Redirect. Transparent Redirect posts payment details silently to the Gateway server, so this sensitive information never goes through the merchant’s website. Gateway Developer Guide and Reference 07 February 2013 27 1 Introducing the Gateway Checkout Solutions Processing Platforms Supporting Card-Present Transactions Implementing Transparent Redirect is very similar to implementing hosted pages. It differs only in the steps shown in boldface below: 1. The customer clicks Buy to purchase merchandise on your website. 2. You request a secure token by passing a secure token ID to the Gateway server. In the request, you pass the name-value pair, SILENTTRAN=TRUE. This name-value pair prevents the hosted pages from displaying. 3. The Gateway server returns the secure token and your token ID to your website. 4. You display the credit card fields to the customer in a checkout page on your website. 5. The customer enters their credit card number, expiration date, and other sensitive data into the credit card fields and clicks Submit. The browser posts the payment data directly to the Gateway server, avoiding your website and easing your PCI compliance requirements. NOT E : To ensure that the post goes from the browser directly to PayPal and not back to your website, you should add scripting. 6. The Gateway processes the payment through the payment processing network. 7. The Gateway server transparently sends the customer to the location on your website that you specified in the request to obtain a secure token. You display the results to the customer on your website. Processing Platforms Supporting Card-Present Transactions The following processing platforms support card-present transactions. American Express American Express APAC Elavon First Data Merchant Services (FDMS) Nashville First Data Merchant Services (FDMS) North First Data Merchant Services (FDMS) South Global Payments Central Global Payments East Heartland Payment Systems Litle Merchant e-Solutions 28 07 February 2013 Gateway Developer Guide and Reference Introducing the Gateway Checkout Solutions Supported Payment Types 1 Moneris Solutions Paymentech Salem Paymentech Tampa PayPal SecureNet TeleCheck TSYS Acquiring Solutions Vantiv WorldPay Supported Payment Types Credit cards PayPal (supported by PayPal’s Express Checkout product) Pinless debit cards Electronic checks Check cards Purchasing cards (also referred to as commercial cards, corporate cards, procurement cards, or business cards) Level 2 and Level 3 Automated Clearing House (ACH). For information on performing ACH transactions, contact your PayPal Sales Representative. Supported Languages The Payflow Gateway only supports customer input and API parameter values that are in regular ASCII (English language) characters. Payflow does not support extended ASCII characters or any other character sets other than regular ASCII at this time. Additionally, the Payflow hosted checkout pages and PayPal manager account settings pages are available in English only. For information on a similar PayPal product that offers multi-lingual support, see Website Payments Pro Hosted Solution. Gateway Developer Guide and Reference 07 February 2013 29 1 Introducing the Gateway Checkout Solutions Recurring Billing Service Recurring Billing Service The Recurring Billing Service is a scheduled payment solution that enables you to automatically bill your customers at regular intervals—for example, you can bill your customers a monthly fee of $42 for 36 months with an initial fee of $129. You enroll separately for the Recurring Billing Service. You can learn about the Recurring Billing Service in the Payflow Pro – Recurring Billing Service User’s Guide. If you already have this service, this user guide will show you how to define and manage recurring transactions programmatically. You can also manage Recurring Billing tasks in PayPal Manager. Fraud Protection Service Fraud Protection Services can help you significantly reduce the cost of fraud and the resulting damage to your business. This service uses Fraud Protection filters to help protect you from fraudsters using stolen or false credit card information. These filters identify potentially fraudulent activity and let you decide whether to accept or reject the suspicious transaction. Fraud Protection Service can also minimize the risk of hacking your customer database by enabling you to place powerful constraints on access to and use of your PayPal Manager and Payflow Gateway accounts. You enroll separately for the Fraud Protection Service. You can learn more about Fraud Protection Service in the Payflow Pro Fraud Protection Services User’s Guide. If you already have this service, this user guide will show you how to setup Fraud Protection filters. You can also manage some aspects of your Fraud Protection Service in PayPal Manager. 30 07 February 2013 Gateway Developer Guide and Reference 2 Secure Token This section describes the secure token. “Secure Token” on page 31 “Integrating the Secure Token With the Hosted Checkout Pages” on page 31 “Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect” on page 32 “Posting To the Hosted Checkout Page” on page 34 “Using the PARMLIST Parameter” on page 44 About the Secure Token Use a secure token to send non-credit card transaction data to the Gateway server for safer storage. The secure token prevents anyone from intercepting or manipulating the data. You must use a secure token if you use hosted checkout pages. The token is good for a one-time transaction and is valid for 30 minutes. NOT E : PayPal Payments Pro and Payflow Pro merchants who do not use a secure token must host their own payment pages. When hosting your own pages, you are responsible for meeting PCI requirements by handling data securely. PayPal Payments Advanced and Payflow Link merchants must use a secure token with hosted checkout pages. To obtain a secure token, pass a unique, 36-character secure token ID and set CREATESECURETOKEN=Y in a request to the Gateway server. The Gateway server associates your ID with a secure token and returns the token as a string of up to 32 alphanumeric characters. To pass the transaction data to the hosted checkout page, you pass the secure token and secure token ID in an HTTP form post. The token and ID trigger the Gateway server to retrieve your data and display it for customer approval. NOT E : You cannot modify the data sent with a secure token, with one exception. You can configure PayPal Manager to allow you to modify billing and shipping information. Integrating the Secure Token With the Hosted Checkout Pages To create a secure token, pass all parameters that you need to process the transaction except for payment details parameters such as the credit card number, expiration date, and check number. For details on transaction parameters, see “Submitting Credit Card Transactions” on page 55. In addition, pass the following Payflow parameters to create the secure token. Gateway Developer Guide and Reference 07 February 2013 31 2 Secure Token Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect NOT E : The secure token is valid for 30 minutes, and you can only use it one time. If you attempt to use the token after the time limit has expired, your transaction will fail with Result value 7, “Secure Token Expired.” If you attempt to reuse the token, you receive an error. 1. Set SECURETOKENID to a unique alphanumeric value up to 36 characters in length. SECURETOKENID=9a9ea8208de1413abc3d60c86cb1f4c5 2. Set CREATESECURETOKEN to the value Y to request that Payflow gateway return a token. CREATESECURETOKEN=Y Secure Token Example The following is an example of a request parameter string that creates a secure token. TRXTYPE=A&BILLTOSTREET=123 Main St.&BILLTOZIP=95131&AMT=23.45&CURRENCY=USD& INVNUM=INV12345&PONUM=PO9876&CREATESECURETOKEN=Y&SECURETOKENID=9a9ea8208de1 413abc3d60c86cb1f4c5 The Gateway server returns SECURETOKEN and SECURETOKENID in the response. A tag follows the SECURETOKEN to indicate the length of the token value returned. RESULT=0&RESPMSG=Approved&SECURETOKEN[25]=Fj+1AFUWft0+I0CUFOKh5WA==&SECURET OKENID=9a9ea8208de1413abc3d60c86cb1f4c5 Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect To use your own checkout pages while complying with PCI guidelines (sending the customer’s sensitive data directly to the Gateway server), pass all parameters that you need to process the transaction except for sensitive payment details such as the credit card number, expiration date, and check number. For details on sending transactions, see “Submitting Credit Card Transactions” on page 55. In addition, pass the following 3 Payflow parameters in your request. The first 2 parameters obtain a secure token. The third parameter implements Transparent Redirect, which suppresses hosted pages. NOT E : The secure token is valid for 30 minutes, and you can only use it one time. If you attempt to use the token after the time limit has expired, your transaction will fail with Result value 7, “Secure Token Expired.” If you attempt to reuse the token, you receive an error. 1. Set SECURETOKENID to a unique alphanumeric value up to 36 characters in length. SECURETOKENID=9a9ea8208de1413abc3d60c86cb1f4c5 32 07 February 2013 Gateway Developer Guide and Reference Secure Token Secure Token Errors 2 2. Set CREATESECURETOKEN to the value Y to request that the Gateway server return a token. CREATESECURETOKEN=Y 3. Set SILENTTRAN to the value TRUE to suppress the display of hosted pages. SILENTTRAN=TRUE Transparent Redirect Example The following is an example of an authorization parameter string that suppresses hosted pages. TRXTYPE=A&BILLTOSTREET=123 Main St.&BILLTOZIP=95131&AMT=24.35&INVNUM=INV123 45&PONUM=PO12345&CURRENCY=USD&CREATESECURETOKEN=Y&SECURETOKENID=9a9ea8208de 1413abc3d60c86cb1f4c5&SILENTTRAN=TRUE The Gateway server returns a SECURETOKEN and SECURETOKENID in the response. A tag follows the SECURETOKEN to indicate the length of the token value returned. RESULT=0&RESPMSG=Approved&SECURETOKEN[25]=Fj+1AFUWft0+I0CUFOKh5WA==&SECURET OKENID=9a9ea8208de1413abc3d60c86cb1f4c5 When the customer enters their sensitive data into the credit card fields on your website and clicks Submit, the browser posts the data to the Gateway server rather than to your website. NOT E : It is highly recommended that you add scripting to ensure the the browser posts the sensitive data directly to the PayPal Gateway server rather than to your website. If you are using the PARMLIST parameter with the Transparent Redirect, see “Using the PARMLIST Parameter” on page 44 for more information. Secure Token Errors A successful Payflow transaction will return RESULT=0 in the response. If your Secure Token transaction is unsuccessful, you can pass the token 2 more times to Payflow before the token expires. A Payflow Secure Token will expire: If the same Secure Token is passed to Payflow a total of 3 times. 20 minutes after the Secure Token was generated. When the token is used in a successful transaction. If you receive one of the following error codes in the RESULT response parameter, then your Secure Token has expired. Gateway Developer Guide and Reference 07 February 2013 33 2 Secure Token Posting To the Hosted Checkout Page 160 Secure Token already been used. Indicates that the secure token has expired due to either a successful transaction or the token has been used three times while trying to successfully process a transaction. You must generate a new secure token. 161 Transaction using secure token is already in progress. This could occur if a customer hits the submit button two or more times before the transaction completed. 162 Secure Token Expired. The time limit of 20 minutes has expired and the token can no longer be used. If you see a different error code in the RESULT parameter, refer to the RESULT Values and RESPMSG Text section for more information. Posting To the Hosted Checkout Page To display the transaction information to the Gateway hosted checkout page, you perform an HTTP form post. 1. Direct the HTTP post to the Gateway applications server at the following URL. https://payflowlink.paypal.com 2. Send the following parameter data: – SECURETOKEN returned in the transaction response – SECURETOKENID HTTP Form Post Examples The following is an example request string that displays the transaction information to the hosted checkout page.34 07 February 2013 Gateway Developer Guide and Reference Secure Token Posting To the Hosted Checkout Page 2 For more information on the Payflow parameters that are used to pass information to the Gateway hosted checkout pages, see “Using a Secure Token to Pass Hosted Pages Customization Parameters” on page 41 The following example uses Payflow name-value pairs to pass values in a form post to the hosted checkout pages. For details on the name-value pair strings used in this example, see “Sending a Simple Transaction to the Server” on page 51.PageTitle
-113
Unable to round and truncate the currency value simultaneously
07 February 2013
Gateway Developer Guide and Reference
A
Processors Requiring Additional
Transaction Parameters
Additional parameters are those required by individual processors beyond the core parameters.
Parameters are organized alphabetically by processor.
“American Express Additional Credit Card Parameters” on page 111
“Elavon Additional Credit Card Parameters” on page 117
“First Data Merchant Services Nashville, Additional Credit Card Parameters” on page 118
“First Data Merchant Services North, Additional Credit Card Parameters” on page 118
“Heartland, Additional Credit Card Parameters” on page 119
“Litle Additional Credit Card Parameters” on page 119
“Merchant e-Solutions, Additional Credit Card Parameters” on page 121
“Paymentech Salem (New Hampshire) Additional Credit Card Parameters for American
Express” on page 121
“PayPal Credit Card Transaction Request Parameters” on page 123
“SecureNet Additional Credit Card Parameters for American Express” on page 128
“Vantiv Additional Credit Card Parameters” on page 133
“WorldPay Additional Credit Card Parameters” on page 135
American Express Additional Credit Card Parameters
In addition to the core credit card parameters, American Express accepts the parameters
described below to meet AMEX reporting and statement requirements.
PayPal recommends that you include these parameters if you would like to impact what
appears on AMEX statements and reports.
NOT E :
The PayPal processor does not support SWIPE (card-present) transactions.
Retail Transaction Advice Addendum (for SWIPE transactions)
Field
Description
L_DESCn
(Optional) Description of this line-item (n is a line item number from 1 to 6).
Character length and limitations: 19 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
111
A
Processors Requiring Additional Transaction Parameters
American Express Additional Credit Card Parameters
Field
Description
L_AMTn
(Optional) Amount of this line-item (n is a line item number from 1 to 6).
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
L_QTYn
(Optional) Quantity of this line-item (n is a line item number from 1 to 6).
Character length and limitations: 3 numeric characters
Internet Transaction Data
112
Field
Description
BILLTOEMAIL
(Optional) Account holder’s email address.
Character length and limitations: 60 alphanumeric characters
BILLTOPHONENUM
(Optional) Account holder’s telephone number.
Character length and limitations: 10 characters
PHONETYPE
(Optional) Telephone company provided ANI information identifier digits indicating
the telephone call type. Examples: cellular (61-63), payphone (27)
Character length and limitations: 2 characters
CUSTHOSTNAME
(Optional) Name of the server that the account holder is connected to. Example:
PHX.QW.AOL.COM.
Character length and limitations: 60 alphanumeric and special characters
CUSTBROWSER
(Optional) Name of the server that the account holder is connected to. Example:
MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WINDOWS~95)
Character length and limitations: 60 alphanumeric and special characters
CUSTIP
(Optional) Account holder’s IP address.
Character length and limitations: 15 alphanumeric and special characters
SHIPTOCOUNTRY
(Optional) Numeric country code of ship-to country. Example: USA: 840.
Character length and limitations: 3 characters
SHIPMETHOD
(Optional) Shipping method code. The values are:
01 = Same day
02 = Overnight/next day
03 = Priority, 2 - 3 days
04 = Ground, 4 or more days
05 = Electronic delivery
06 - ZZ = Reserved for future use
SKU
(Optional) Merchant product SKU.
Character length and limitations: 15 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
American Express Additional Credit Card Parameters
A
Address Verification Service Parameters
Field
Description
BILLTOSTREET
(Optional) Account holder’s street address (number and street name).
Character length and limitations: 20 characters
BILLTOZIP
(Optional) Account holder’s 5- to 9-digit ZIP (postal) code excluding spaces,
dashes, and non-numeric characters. Example: 951121737
Character length and limitations: 9 characters
BILLTOPHONENUM
(Optional) Account holder’s telephone number. The formats are:
xxx-xxx-xxxx (US numbers)
+xxxxxxxxxxx (international numbers)
Character length and limitations: 10 characters
SHIPTOFIRSTNAME
(Optional) First name in the shipping address.
Character length and limitations: 30 characters
SHIPTOLASTNAME
(Optional) Last name in the shipping address.
Character length and limitations: 30 characters
SHIPTOSTREET
(Optional) Shipping street address.
Character length and limitations: 30 characters
SHIPTOCOUNTRY
(Optional) Numeric country code of ship-to country. Example: USA: 840.
Character length and limitations: 3 alphanumeric characters
SHIPTOZIP
(Optional) Shipping 5- to 9-digit zip (postal) code excluding spaces, dashes, and
non-numeric characters. Example: 951121737
Character length and limitations: 9 alphanumeric characters
SHIPTOPHONENUM
(Optional) Shipping telephone number.
Character length and limitations: 10 alphanumeric characters
Location Transaction Advice Addendum Parameters
Field
Description
MERCHANTNAME
(Optional) Name of merchant.
Character length and limitations: 38 alphanumeric characters
MERCHANTSTREET
(Optional) Merchant’s street address (number and street name).
Character length and limitations: 38 alphanumeric characters. If more than 38
characters, use proper and meaningful abbreviation. Do not truncate.
Gateway Developer Guide and Reference
07 February 2013
113
A
Processors Requiring Additional Transaction Parameters
American Express Additional Credit Card Parameters
Field
Description
MERCHANTCITY
(Optional) The name of the city were the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another
entity), you must enter the name of the city in which the seller is located.
If you are a mail order, phone order, or internet industry, you may substitute the
name of the city in which the merchant’s order processing facility is located.
Character length and limitations: 21 alphanumeric characters. If more than 21
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTSTATE
(Optional) The region code that corresponds to the state, province, or country
subdivision of the merchant location where the transaction took place.
Region code examples:
CA = California, USA
NS = Nova Scotia, Canada
COS = Colima Mexico
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the region code that corresponds to the state, province, or country
subdivision in which the seller is located.
Character length and limitations: 3 alphanumeric characters
MERCHANTZIP
(Optional) The 5- to 9-digit zip (postal) code excluding spaces, dashes, and nonnumeric characters where the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the postal code that corresponds to the seller’s location.
Character length and limitations: 15 alphanumeric characters
MERCHANTCOUNTRYCODE
(Optional) Country code of the location where the transaction took place.
Character length and limitations: 3 alphanumeric characters
MERCHANTLOCATIONID
(Optional)Merchant-assigned store or location number (or name) that uniquely
identifies where the transaction took place.
Character length and limitations: 15 alphanumeric characters
MERCHANTID
(Required) American Express-assigned service establishment number used to identify
and facilitate payments to merchants.
Character length and limitations: 15 alphanumeric characters.
MERCHANTCONTACTINFO
(Optional) Merchant’s telephone number or web address. (URLs and e-mail
addresses may be lowercase, as appropriate.) This entry may appear on the
descriptive bill on the card-member’s statement, or may be used to resolve billing
inquiries and disputes.
N O TE :
American Express strongly recommends that aggregators (third-parties who
bill for goods or services rendered by another entity) always fill in this field
with the URL, e-mail address, or telephone number of the contact responsible
for resolving disputes or inquiries.
Character length and limitations: 40 alphanumeric characters
114
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
American Express Additional Credit Card Parameters
A
Transaction Advice Detail Parameters
Field
Description
ADDLAMTn
(Optional) Detail of a charge where n is a value from 1 - 5. Use for additional
breakdown of the amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
ADDLAMTTYPEn
(Optional) A 3-digit code indicating the type of the corresponding charge detail,
where n is a value from 1 - 5.
Character length and limitations: 3 numeric characters
Airline Passenger Data Parameters
Field
Description
AIR-DEPARTUREDATE
(Optional) Departure date in the format YYYYMMDD.
Character length and limitations: 8 alphanumeric characters
AIR-PASSENGERNAME
(Optional) Name of the passenger in the following format with fields separated by a
space: surname firstname middleinitial title
Character length and limitations: 60 alphanumeric characters
AIR-ORIGIN
(Optional) Airport code of the originating airport. For a list of airport codes, see
http://www.world-airport-codes.com/alphabetical/airport-code/a.html.
N O TE :
Present day airport codes are three characters in length. The five character
length is designed to allow for future expansion
Character length and limitations: 5 alphanumeric characters
AIR-DESTINATION
(Optional) Destination airport code for the first segment of the trip; this is not
necessarily the final destination. For example, if a passenger flies from STL to MIA
with a layover at JFK, the destination airport is JFK For a list of airport codes, see
http://www.world-airport-codes.com/alphabetical/airport-code/a.html.
N O TE :
Present day airport codes are three characters in length. The five character
length is designed to allow for future expansion
Character length and limitations: 5 alphanumeric characters
AIR-NUMBEROFCITIES
(Optional) Number of unique cities in this trip including the cities of origin and
destination, where a maximum value of 10 is allowed. For example, AIRNUMBEROFCITIES is 3 for the following trip:
DEN to LAX
LAX to SFO
SFO to DEN
If not provided, this value is equal to the number of AIR-ROUTINGCITYn parameters.
Gateway Developer Guide and Reference
07 February 2013
115
A
Processors Requiring Additional Transaction Parameters
American Express Additional Credit Card Parameters
Field
Description
AIR-ROUTINGCITYn
(Optional) Airport codes of each city in this flight including cities of origin and
destination, where n is a value from 1 to 10.
Character length and limitations: 5 alphanumeric characters
AIR-CARRIERn
(Optional) Two character airline code for each unique airline in this flight, where n is
a value from 1 to 10.
If the same carrier is used for multiple segments of the trip, it is passed only once. For
example, the two AIR-CARRIERn values for the following trip are UA and AA:
UA flight from IAD to DEN
UA flight from DEN to LAX
UA flight from LAX to SFO
AA flight from SFO to DFW
For information about airlines codes, see http://en.wikipedia.org/wiki/Airline_codesAll
Character length and limitations: 24 alphanumeric characters
AIR-FAREBASIS
(Optional) List discounts associated with the travel.
Character length and limitations: 24 alphanumeric characters
AIRNUMBEROFPASSENGERS
(Optional) Number of passengers on this trip.
Character length and limitations: numeric
AIR-ISETICKET
(Optional) If this is an electronic ticket. The values are:
Y = yes
N = no
Character length and limitations: 1 alphanumeric character
AIR-RESERVATIONCODE
(Optional) Code assigned to the travel reservation before the ticket was purchased.
Character length and limitations: 15 alphanumeric characters
American Express Other Parameters
Field
Description
BILLTOFIRSTNAME
(Optional) Account holder's first and last name.
N O TE :
Even though the parameter name indicates only the first name, this single
parameter holds all of the person's name information (both first and last
name, at a minimum).
Character length and limitations: 13 alphanumeric characters
BILLTOLASTNAME
116
(Optional) Account holder's last name.
Character length and limitations: 13 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
Elavon Additional Credit Card Parameters
Field
Description
INVNUM
(Optional) Merchant invoice number. The merchant invoice number is used for
authorizations and settlements and, depending on your merchant bank, will appear on
your customer's credit card statement and your bank reconciliation report. If you do
not provide an invoice number, the transaction ID (PNREF) will be submitted.
Character length and limitations: 9 alphanumeric characters
ORDERDATE
(Optional) Specifies an order date.
Character length and limitations: 6 numeric characters
Format: mmddyy (with no slashes or dashes). For example, July 28, 2003 is 072803.
ORDERDATETIME
(Optional) Specifies an order time and date.
Character length and limitations: 19 alphanumeric characters
Format is either YYYY-MM-DD or YYYY-MM-DD HH:MI:SS
(where HH is in 24-hour time). If the value does not conform to one of the formats or
if the date is not valid (for example, 2004-17-35), then the transaction is rejected
with: RESULT=7(SIG_FIELD_ERR) RESPMSG=Invalid ORDERTIME
A truncated version of the ORDERTIME value (up to 7 characters) overwrites any
value provided by ORDERDATE. If no value is provided, a NULL value is stored.
A
Elavon Additional Credit Card Parameters
In addition to the core credit card parameters, Elavon (formerly Nova) accepts the parameter
described below.
Field
Description
RECURRING
(Optional) Identifies the transaction as recurring. This value does not activate the
Payflow Recurring Billing Service API.
If the RECURRING parameter was set to Y for the original transaction, then the setting
is ignored when forming credit, void, and force transactions.
If you subscribe to Payflow Fraud Protection Services:
To avoid charging you to filter recurring transactions that you know are reliable,
the fraud filters do not screen recurring transactions.
To screen a prospective recurring customer, submit the transaction data using
PayPal Manager’s Manual Transactions page. The filters screen the transaction in
the normal manner. If the transaction triggers a filter, then you can follow the
normal process to review the filter results.
Character length and limitations: 1 alphanumeric character (Y or N)
Gateway Developer Guide and Reference
07 February 2013
117
A
Processors Requiring Additional Transaction Parameters
First Data Merchant Services Nashville, Additional Credit Card Parameters
First Data Merchant Services Nashville, Additional Credit Card
Parameters
In addition to the core credit card parameters, First Data Merchant Services (FDMS) Nashville
accepts the parameters described below.
Field
Description
INVNUM
(Optional) Merchant invoice number. The merchant invoice number is used for
authorizations and settlements and, depending on your merchant bank, will appear on
your customer's credit card statement and your bank reconciliation report. If you do
not provide an invoice number, the transaction ID (PNREF) will be submitted.
Character length and limitations: 9 alphanumeric characters
First Data Merchant Services North, Additional Credit Card
Parameters
In addition to the core credit card parameters, First Data Merchant Services (FDMS) North
accepts the parameters described
Field
Description
DESC
(Optional) Use the DESC* parameters to pass in your DBA name and other data
describing the transaction. This information will be displayed in the account holder’s
statement.
N O TE :
Note: FDMS North passes the descriptive data to the card associations with
the following character lengths:
Visa: 25
MasterCard: 22
AMEX: 20
DISC: 22
Some card associations truncate the value to 19 characters. If you have questions,
consult the card association.
Character length and limitations: 25 alphanumeric characters
MERCHDESCR
118
(Optional) Use this parameter to pass in your DBA name and other data describing
the transaction. This information is usually displayed in the account holder’s
statement.
Character length and limitations: 25 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
Heartland, Additional Credit Card Parameters
Field
Description
MERCHSVC
(Optional) Defaults to the city where the merchant outlet is located for retail and to
the merchant’s phone number for non-retail. For example, 800 111-1111. This
information is usually displayed in the account holder’s statement.
Character length and limitations: 13 alphanumeric characters
A
Heartland, Additional Credit Card Parameters
In addition to the core credit card parameters, Heartland accepts the parameters described
below.
Field
Description
INVNUM
(Optional) Merchant invoice number. The merchant invoice number is used for
authorizations and settlements and, depending on your merchant bank, will appear on
your customer's credit card statement and your bank reconciliation report. If you do
not provide an invoice number, the transaction ID (PNREF) will be submitted.
N O TE :
Not supported by Payflow Link.
Character length and limitations: 17 alphanumeric characters
MERCHDESCR
(Optional) Use this parameter to pass in your DBA name and other data describing
the transaction (default: merchant name). This information is usually displayed in the
account holder’s statement.
Character length and limitations: 25 alphanumeric characters
MERCHSVC
(Optional) Defaults to the city where the merchant outlet is located for retail and to
the merchant’s phone number for non-retail. For example, 800 111-1111. This
information is usually displayed in the account holder’s statement.
Character length and limitations: 13 alphanumeric characters
Litle Additional Credit Card Parameters
Field
Description
AUTHDATE
Required for Force transactions. Authorization date.
Character length and limitations: 11alphanumeric characters
CUSTOMERID
(Optional) Customer identification.
Character length and limitations: 18 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
119
A
Processors Requiring Additional Transaction Parameters
Litle Additional Credit Card Parameters
Field
Description
INVNUM
(Optional) Merchant invoice number. The merchant invoice number is used for
authorizations. If you do not provide an invoice number, the transaction ID (PNREF)
will be submitted.
Character length and limitations: 20 alphanumeric characters
MERCHANTCITY
(Optional) The name of the city were the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another
entity), you must enter the name of the city in which the seller is located.
If you are a mail order, phone order, or internet industry, you may substitute the
name of the city in which the merchant’s order processing facility is located.
Character length and limitations: 21 alphanumeric characters
MERCHANTURL
(Optional) Merchant’s website. This information is usually displayed in the account
holder’s statement.
Character length and limitations: 40 alphanumeric characters
MERCHDESCR
(Optional) Use this parameter to pass in your DBA name and other data describing
the transaction. This information is usually displayed in the account holder’s
statement.
Character length and limitations: 25 alphanumeric characters
MERCHSVC
(Optional) Defaults to the city where the merchant outlet is located for retail and to
the merchant’s phone number for non-retail. For example, 800 111-1111. This
information is usually displayed in the account holder’s statement.
Character length and limitations: 13 alphanumeric characters
PONUM
(Optional) Purchase order number.
Character length and limitations: 25 alphanumeric characters
REPORTGROUP
(Optional) Category that the transaction is in, for example, coffee mugs. This field is
for your own use.
Character length and limitations: 25 alphanumeric characters
BILLTOSTREET2
(Optional) Second street address.
Character length and limitations: 35 alphanumeric characters
BILLTOSTREET3
(Optional) Third street address.
Character length and limitations: 35 alphanumeric characters
TAXAMT
(Optional) Total tax amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
TAXEXEMPT
(Optional) Indicates whether the customer is tax exempt. It is one of the following
values:
Y – The customer is tax exempt.
N – The customer is not tax exempt (default).
Character length and limitations: 1 alpha character
120
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
Merchant e-Solutions, Additional Credit Card Parameters
A
Merchant e-Solutions, Additional Credit Card Parameters
In addition to the core credit card parameters, Merchant e-Solutions accepts the parameters
described below.
Field
Description
INVNUM
(Optional) Merchant invoice number. The merchant invoice number is used for
authorizations and settlements and, depending on your merchant bank, will appear on
your customer's credit card statement and your bank reconciliation report. If you do
not provide an invoice number, the transaction ID (PNREF) will be submitted.
N O TE :
Not supported by Payflow Link.
Character length and limitations: 17 alphanumeric characters
MERCHDESCR
(Optional) Use this parameter to pass in your DBA name and other data describing
the transaction (default: merchant name). This information is usually displayed in the
account holder’s statement.
Character length and limitations: 25 alphanumeric characters
MERCHSVC
(Optional) Defaults to the city where the merchant outlet is located for retail and to
the merchant’s phone number for non-retail. For example, 800 111-1111. This
information is usually displayed in the account holder’s statement.
Character length and limitations: 13 alphanumeric characters
Paymentech Salem (New Hampshire) Additional Credit Card
Parameters for American Express
In addition to the core credit card parameters, Paymentech Salem accepts the parameters to
meet American Express statement and reporting requirements described below.
Internet Transaction Data Parameters
Field
Description
BILLTOEMAIL
(Optional) Account holder’s email address.
Character length and limitations: 60 alphanumeric characters
BILLTOPHONENUM
(Optional) Account holder’s telephone number.
Character length and limitations: 20 characters
PHONETYPE
(Optional) Telephone company provided ANI information identifier digits indicating
the telephone call type. Examples: cellular (61-63), payphone (27)
Character length and limitations: 2 characters
Gateway Developer Guide and Reference
07 February 2013
121
A
Processors Requiring Additional Transaction Parameters
Paymentech Salem (New Hampshire) Additional Credit Card Parameters for American Express
Field
Description
CUSTHOSTNAME
(Optional) Name of the server that the account holder is connected to. Example:
PHX.QW.AOL.COM.
Character length and limitations: 60 alphanumeric and special characters
CUSTBROWSER
(Optional) Name of the server that the account holder is connected to. Example:
MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WINDOWS~95)
Character length and limitations: 60 alphanumeric and special characters
CUSTIP
(Optional) Account holder’s IP address.
Character length and limitations: 15 alphanumeric and special characters
SHIPTOCOUNTRY
(Optional) Numeric country code of ship-to country. Example: USA: 840.
Character length and limitations: 3 alphanumeric characters
SHIPMETHOD
(Optional) Shipping method code. The values are:
01 = Same day
02 = Overnight/next day
03 = Priority, 2 - 3 days
04 = Ground, 4 or more days
05 = Electronic delivery
06 - ZZ = Reserved for future use
SKU
(Optional) Merchant product SKU.
Character length and limitations: 15 alphanumeric and special characters
AVS Parameters
Field
Description
BILLTOSTREET
(Optional) Account holder’s street address (number and street name).
Character length and limitations: 20 characters
BILLTOZIP
(Optional) Account holder’s 5- to 9-digit ZIP (postal) code excluding spaces,
dashes, and non-numeric characters. Example: 951121737
Character length and limitations: 9 characters
BILLTOPHONENUM
(Optional) Account holder’s telephone number. The formats are:
xxx-xxx-xxxx (US numbers)
+xxxxxxxxxxx (international numbers)
Character length and limitations: 10 characters
122
SHIPTOFIRSTNAME
(Optional) First name in the shipping address.
Character length and limitations: 30 characters
SHIPTOLASTNAME
(Optional) Last name in the shipping address.
Character length and limitations: 30 characters
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
PayPal Credit Card Transaction Request Parameters
Field
Description
SHIPTOSTREET
(Optional) Shipping street address.
Character length and limitations: 30 characters
SHIPTOCOUNTRY
(Optional) Numeric country code of ship-to country. Example: USA: 840.
Character length and limitations: 3 alphanumeric characters
SHIPTOZIP
(Optional) Shipping 5- to 9-digit zip (postal) code excluding spaces, dashes, and
non-numeric characters. Example: 951121737
Character length and limitations: 9 alphanumeric characters
SHIPTOPHONENUM
(Optional) Shipping telephone number.
Character length and limitations: 10 alphanumeric characters
A
Additional Credit Card Parameters for M Record
Field
Description
MERCHDESCR
(Optional) Use this parameter to pass in your DBA name and other data describing
the transaction. This information is usually displayed in the account holder’s
statement.
Character length and limitations: 25 alphanumeric characters
MERCHSVC
(Optional) Defaults to the city where the merchant outlet is located for retail and to
the merchant’s phone number for non-retail. For example, 800 111-1111. This
information is usually displayed in the account holder’s statement.
Character length and limitations: 13 alphanumeric characters
PayPal Credit Card Transaction Request Parameters
In addition to the core credit card parameters, PayPal accepts the parameters described below.
Parameter
Description
ACCTTYPE
(Optional) Credit card type. The following card types are supported:
0 = Visa
1 = MasterCard
2 = Discover
3 = AMEX
4 = DinersClub
5 = JCB
8 = Other
Gateway Developer Guide and Reference
07 February 2013
123
A
Processors Requiring Additional Transaction Parameters
PayPal Credit Card Transaction Request Parameters
Parameter
Description
AMT
(Required) Amount (US Dollars) U.S. based currency.
AMT=ITEMAMT + TAXAMT + FREIGHTAMT + HANDLINGAMT + INSURANCEAMT
- DISCOUNT
N O TE :
You must set CURRENCY to one of the three-character currency codes for any
of the supported PayPal currencies. See CURRENCY in this table for details.
Limitations: Must not exceed $10,000 USD in any currency. Nine numeric characers
plus decimal (.) character. No currency symbol. Specify the exact amount to the cent
using a decimal point—use 34.00, not 34. Do not include comma separators—use
1199.95 not 1,199.95.
Nine numeric characters plus decimal.
CURRENCY
(Required) The currency code.
N O TE :
CURRENCY is applicable only to processors that support transaction-level
currency.
Limitations: Three characters.
BUTTONSOURCE
(Optional) Identification code for use by third-party applications to identify
transactions.
Limitations: 32 alphanumeric characters.
CUSTIP
(Optional) IP address of payer’s browser as recorded in its HTTP request to your
website. This value is optional but recommended.
N O TE :
PayPal records this IP address as a means to detect possible fraud.
Limitations: 15-character string in dotted quad format: xxx.xxx.xxx.xxx
CAPTURECOMPLETE
(Optional) Indicates if this Delayed Capture transaction is the last capture you intend
to make. The values are:
Y (default)
N
N O TE :
If CAPTURECOMPLETE is Y, any remaining amount of the original
reauthorized transaction is automatically voided.
Limitations: 12-character alphanumeric string.
124
CUSTOM
(Optional) A free-form field for your own use.
Limitations: 256-character alphanumeric string.
EMAIL
(Optional) Email address of payer.
Limitations: 127 alphanumeric characters.
INVNUM
(Optional) Your own unique invoice or tracking number.
Limitations: 127 alphanumeric characters.
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
PayPal Credit Card Transaction Request Parameters
Parameter
Description
ITEMAMT
(Required if L_COSTn is specified) Sum of cost of all items in this order.
ITEMAMT = L_QTY0*LCOST0 + L_QTY1*LCOST1...L_QTYn*L_COSTn
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
Limitations: Nine numeric characters plus decimal.
TAXAMT
(Required if L_TAXAMTn is specified) Sum of tax for all items in this order.
TAXAMT=L_QTY0*L_TAXAMT0 + L_QTY1*L_TAXAMT1 +...L_QTYn
*L_TAXAMTn
N O TE :
A
You must set CURRENCY to one of the three-character currency codes for any
of the supported PayPal currencies. See CURRENCY in this table for details.
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
Nine numeric characters plus decimal.
FREIGHTAMT
(Optional) Total shipping costs for this order.
N O TE :
You must set CURRENCY to one of the three-character currency codes for any
of the supported PayPal currencies. See CURRENCY in this table for details.
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
Nine numeric characters plus decimal.
HANDLINGAMT
(Optional) Total handling costs for this order.
N O TE :
You must set CURRENCY to one of the three-character currency codes for any
of the supported PayPal currencies. See CURRENCY in this table for details.
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
Nine numeric characters plus decimal.
DISCOUNT
(Optional) Shipping discount for this order. Specify the discount as a positive
amount.
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
INSURANCEAMT
(Optional) Total shipping insurance cost for this order.
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
Gateway Developer Guide and Reference
07 February 2013
125
A
Processors Requiring Additional Transaction Parameters
PayPal Credit Card Transaction Request Parameters
Parameter
Description
L_NAMEn
(Optional) Line-item name.
N O TE :
To enable line-item support, you must contact Merchant Technical Support at
http://www.paypal.com/mts
Character length and limitations: 36 alphanumeric characters.
L_DESCn
(Optional) Line-item description of the item purchased such as hiking boots or
cooking utensils.
N O TE :
To enable line-item support, you must contact Merchant Technical Support at
http://www.paypal.com/mts
Limitations: 127 alphanumeric characters.
L_COSTn
(Required if L_QTYn is supplied) Cost of the line item. The line-item unit price can be
a positive or a negative value but not 0.
N O TE :
To enable line-item support, you must contact Merchant Technical Support at
http://www.paypal.com/mts
N O TE :
You must set CURRENCY to one of the three-character currency codes for any
of the supported PayPal currencies. See CURRENCY in this table for details.
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
Nine numeric characters plus decimal.
L_QTYn
(Required if L_COSTn is supplied) Line-item quantity.
N O TE :
To enable line-item support, you must contact Merchant Technical Support at
http://www.paypal.com/mts
Limitations: 10-character integer.
L_SKUn
(Optional) Product number.
N O TE :
To enable line-item support, you must contact Merchant Technical Support at
http://www.paypal.com/mts
Limitations: 18-characters.
L_TAXAMTn
(Optional) Line-item tax amount.
N O TE :
To enable line-item support, you must contact Merchant Technical Support at
http://www.paypal.com/mts
Limitations: Nine numeric characers plus decimal (.) character. No currency symbol.
Specify the exact amount to the cent using a decimal point—use 34.00, not 34. Do not
include comma separators—use 1199.95 not 1,199.95.
MERCHANTSESSIONID
126
(Optional) Your customer Direct Payment session identification token.
PayPal records this session token as an additional means to detect possible fraud.
Limitations: 64 characters.
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
PayPal Credit Card Transaction Request Parameters
Parameter
Description
NOTIFYURL
(Optional) Your URL for receiving Instant Payment Notification (IPN) about this
transaction. If you do not specify NOTIFYURL in the request, the notification URL
from your Merchant Profile is used, if one exists.
Limitations: 2048 alphanumeric characters.
ORDERDESC
(Optional) Description of items the customer is purchasing.
Limitations: 127 alphanumeric characters.
RECURRINGTYPE
(Optional) Type of transaction occurrence. The values are:
F = First occurrence
S = Subsequent occurrence (default)
A
Limitations: One alpha character.
BILLTOCITY
(Conditional) Bill-to city address.
Limitations: 40 alphanumeric characters.
N O TE :
BILLTOSTATE
(Conditional) Bill-to state or province address.
Limitations: 40 alphanumeric characters.
N O TE :
BILLTOCOUNTRY
Some merchants maybe required to pass this billing information. Please test
your integration first to determine if the billing information fields are
required.
(Conditional) Bill-to country address.
Limitations: 2 alphanumeric characters.
N O TE :
SHIPTOSTREET
Some merchants maybe required to pass this billing information. Please test
your integration first to determine if the billing information fields are
required.
Some merchants maybe required to pass this billing information. Please test
your integration first to determine if the billing information fields are
required.
(Optional) Ship-to street address.
N O TE :
If you pass in any of the ship-to address parameters such as SHIPTOCITY or
SHIPTOSTATE, you must pass in the complete set (that is, SHIPTOSTREET,
SHIPTOCITY, SHIPTOSTATE, SHIPTOCOUNTRY, and SHIPTOZIP).
Limitations: 30-character string.
SHIPTOCITY
(Optional) Ship-to city address.
N O TE :
If you pass in any of the ship-to address parameters such as SHIPTOCITY or
SHIPTOSTATE, you must pass in the complete set (that is, SHIPTOSTREET,
SHIPTOCITY, SHIPTOSTATE, SHIPTOCOUNTRY, and SHIPTOZIP).
Limitations: 40-character string.
Gateway Developer Guide and Reference
07 February 2013
127
A
Processors Requiring Additional Transaction Parameters
SecureNet Additional Credit Card Parameters for American Express
Parameter
Description
SHIPTOSTATE
(Optional) Ship-to state or province address.
N O TE :
If you pass in any of the ship-to address parameters such as SHIPTOCITY or
SHIPTOSTATE, you must pass in the complete set (that is, SHIPTOSTREET,
SHIPTOCITY, SHIPTOSTATE, SHIPTOCOUNTRY, and SHIPTOZIP).
Limitations: 10-character string.
SHIPTOCOUNTRY
(Optional) Ship-to country code.
N O TE :
If you pass in any of the ship-to address parameters such as SHIPTOCITY or
SHIPTOSTATE, you must pass in the complete set (that is, SHIPTOSTREET,
SHIPTOCITY, SHIPTOSTATE, SHIPTOCOUNTRY, and SHIPTOZIP).
Limitations: Two alpha characters.
SHIPTOZIP
(Optional) U.S. ship-to zip code or other country-specific postal code.
N O TE :
If you pass in any of the ship-to address parameters such as SHIPTOCITY or
SHIPTOSTATE, you must pass in the complete set (that is, SHIPTOSTREET,
SHIPTOCITY, SHIPTOSTATE, SHIPTOCOUNTRY, and SHIPTOZIP).
Limitations: 20-character string.
SecureNet Additional Credit Card Parameters for American
Express
In addition to the core credit card parameters, SecureNet accepts the parameters described
below to meet American Express reporting and statement requirements.
Retail Transaction Advice Addendum (for SWIPE transactions)
128
Field
Description
L_DESCn
(Optional) Description of this line-item (n is a line item number from 1 to 6).
Character length and limitations: 19 alphanumeric characters
L_AMTn
(Optional) Amount of this line-item (n is a line item number from 1 to 6).
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
L_QTYn
(Optional) Quantity of this line-item (n is a line item number from 1 to 6).
Character length and limitations: 3 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
SecureNet Additional Credit Card Parameters for American Express
A
Internet Transaction Data
Field
Description
BILLTOEMAIL
(Optional) Account holder’s email address.
Character length and limitations: 60 alphanumeric characters
BILLTOPHONENUM
(Optional) Account holder’s telephone number.
Character length and limitations: 10 characters
PHONETYPE
(Optional) Telephone company provided ANI information identifier digits indicating
the telephone call type. Examples: cellular (61-63), payphone (27).
Character length and limitations: 2 alphanumeric characters
CUSTHOSTNAME
(Optional) Name of the server that the account holder is connected to. Example:
PHX.QW.AOL.COM.
Character length and limitations: 60 alphanumeric and special characters
CUSTBROWSER
(Optional) Name of the server that the account holder is connected to. Example:
MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WINDOWS~95)
Character length and limitations: 60 alphanumeric and special characters
CUSTIP
(Optional) Account holder’s IP address.
Character length and limitations: 15 alphanumeric and special characters
SHIPTOCOUNTRY
(Optional) Numeric country code of ship-to country. Example: USA: 840.
Character length and limitations: 3 alphanumeric characters
SHIPMETHOD
(Optional) Shipping method code. The values are:
01 = Same day
02 = Overnight/next day
03 = Priority, 2 - 3 days
04 = Ground, 4 or more days
05 = Electronic delivery
06 - ZZ = Reserved for future use
AVS Parameters
Field
Description
BILLTOSTREET
(Optional) Account holder’s street address (number and street name).
Character length and limitations: 20 characters
BILLTOZIP
(Optional) Account holder’s 5- to 9-digit ZIP (postal) code excluding spaces,
dashes, and non-numeric characters. Example: 951121737
Character length and limitations: 9 characters
Gateway Developer Guide and Reference
07 February 2013
129
A
Processors Requiring Additional Transaction Parameters
SecureNet Additional Credit Card Parameters for American Express
Field
Description
BILLTOPHONENUM
(Optional) Account holder’s telephone number. The formats are:
xxx-xxx-xxxx (US numbers)
+xxxxxxxxxxx (international numbers)
Character length and limitations: 10 characters
SHIPTOFIRSTNAME
(Optional) First name in the shipping address.
Character length and limitations: 30 characters
SHIPTOLASTNAME
(Optional) Last name in the shipping address.
Character length and limitations: 30 characters
SHIPTOSTREET
(Optional) Shipping street address.
Character length and limitations: 30 characters
SHIPTOCOUNTRY
(Optional) Numeric country code of ship-to country. Example: USA: 840.
Character length and limitations: 3 alphanumeric characters
SHIPTOZIP
(Optional) Shipping 5- to 9-digit zip (postal) code excluding spaces, dashes, and
non-numeric characters. Example: 951121737
Character length and limitations: 9 alphanumeric characters
SHIPTOPHONENUM
(Optional) Shipping telephone number.
Character length and limitations: 10 alphanumeric characters
Location Transaction Advice Addendum Parameters
Parameter
Description
MERCHANTNAME
(Optional) Name of merchant.
Character length and limitations: 38 alphanumeric characters
MERCHANTSTREET
(Optional) Merchant’s street address (number and street name).
Character length and limitations: 38 alphanumeric characters. If more than 38
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTCITY
(Optional) The name of the city were the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another
entity), you must enter the name of the city in which the seller is located.
If you are a mail order, phone order, or internet industry, you may substitute the
name of the city in which the merchant’s order processing facility is located.
Character length and limitations: 21 alphanumeric characters. If more than 21
characters, use proper and meaningful abbreviation. Do not truncate.
130
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
SecureNet Additional Credit Card Parameters for American Express
Parameter
Description
MERCHANTSTATE
(Optional) The region code that corresponds to the state, province, or country
subdivision of the merchant location where the transaction took place.
Region code examples:
CA = California, USA
NS = Nova Scotia, Canada
COS = Colima Mexico
A
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the region code that corresponds to the state, province, or country
subdivision in which the seller is located.
Character length and limitations: 3 alphanumeric characters
MERCHANTCOUNTRYCODE
(Optional) Country code of the location where the transaction took place.
Character length and limitations: 3 alphanumeric characters
MERCHANTZIP
(Optional) The 5- to 9-digit zip (postal) code excluding spaces, dashes, and nonnumeric characters where the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the postal code that corresponds to the seller’s location.
Character length and limitations; 15 alphanumeric characters
Transaction Advice Detail Parameters
Field
Description
ADDLAMTn
(Optional) Detail of a charge where n is a value from 1 - 5. Use for additional
breakdown of the amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
ADDLAMTTYPEn
(Optional) A 3-digit code indicating the type of the corresponding charge detail,
where n is a value from 1 - 5.
Character length and limitations: 3 numeric characters
Airline Passenger Data Parameters
Field
Description
AIR-DEPARTUREDATE
(Optional) Departure date in the format: YYYYMMDD.
Character length and limitations: 8 alphanumeric characters
AIR-PASSENGERNAME
(Optional) Name of the passenger in the following format with fields separated by a
space: surname firstname middleinitial title
Character length and limitations: 40 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
131
A
Processors Requiring Additional Transaction Parameters
SecureNet Additional Credit Card Parameters for American Express
Field
Description
AIR-ORIGIN
(Optional) Airport code of the originating airport. For a list of airport codes, see
http://www.world-airport-codes.com/alphabetical/airport-code/a.html.
N O TE :
Present day airport codes are three characters in length. The five character
length is designed to allow for future expansion.
Character length and limitations: 5 alphanumeric characters
AIR-DESTINATION
(Optional) Destination airport code for the first segment of the trip; this is not
necessarily the final destination. For example, if a passenger flies from STL to MIA
with a layover at JFK, the destination airport is JFK. For a list of airport codes, see
http://www.world-airport-codes.com/alphabetical/airport-code/a.html.
N O TE :
Present day airport codes are three characters in length. The five character
length is designed to allow for future expansion.
Character length and limitations: 5 alphanumeric characters
AIR-NUMBEROFCITIES
(Optional) Number of unique cities in this trip including the cities of origin and
destination, where a maximum value of 10 is allowed. For example, AIRNUMBEROFCITIES is 3 for the following trip:
DEN to LAX
LAX to SFO
SFO to DEN
If not provided, this value is equal to the number of AIR-ROUTINGCITYn
parameters.
Character length and limitations: numeric, maximum value is 10
AIR-ROUTINGCITYn
(Optional) Airport codes of each city in this flight including cities of origin and
destination, where n is a value from 1 to 10. For a list of airport codes, see
http://www.world-airport-codes.com/alphabetical/airport-code/a.html.
N O TE :
Present day airport codes are three characters in length. The five character
length is designed to allow for future expansion.
Character length and limitations: 5 alphanumeric characters
AIR-CARRIERn
(Optional) Two character airline code for each unique airline in this flight, where n is
a value from 1 to 10. If the same carrier is used for multiple segments of the trip, it is
passed only once. For example, the two AIR-CARRIERn values for the following trip
are UA and AA:
UA flight from IAD to DEN
UA flight from DEN to LAX
UA flight from LAX to SFO
AA flight from SFO to DFW
For information about airlines codes, see http://en.wikipedia.org/wiki/Airline_codesAll.
Character length and limitations: 5 alphanumeric characters
AIR-FAREBASIS
132
(Optional) List discounts associated with the travel.
Character length and limitations: 24 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
Vantiv Additional Credit Card Parameters
Field
Description
AIRNUMBEROFPASSENGERS
(Optional) Number of passengers on this trip.
Character length and limitations: numeric
AIR-ISETICKET
(Optional) If this is an electronic ticket.
Character length and limitations: 1 alphanumeric character (Y or N)
AIR-RESERVATIONCODE
(Optional) Code assigned to the travel reservation before the ticket was purchased.
Character length and limitations: 15 alphanumeric characters
A
Other Parameters
Field
Description
BILLTOFIRSTNAME
(Optional) Account holder's first and last name.
N O TE :
Even though the parameter name indicates only the first name, this single
parameter holds all of the person's name information (both first and last
name, at a minimum).
Character length and limitations: 13 alphanumeric characters
BILLTOLASTNAME
(Optional) Account holder's last name.
Character length and limitations: 13 alphanumeric characters
INVNUM
(Optional) Merchant invoice number. The merchant invoice number is used for
authorizations and settlements and, depending on your merchant bank, will appear on
your customer's credit card statement and your bank reconciliation report. If you do
not provide an invoice number, the transaction ID (PNREF) will be submitted.
Character length and limitations: 17 alphanumeric characters
ORDERDATE
(Optional) Specifies an order date.
Character length and limitations: 6 numeric characters
Format: mmddyy (with no slashes or dashes). For example, July 28, 2003 is 072803.
Vantiv Additional Credit Card Parameters
Additional Credit Card Parameters
Field
Description
MERCHDESCR
(Optional) Use this parameter to pass in your DBA name and other data describing
the transaction. This information will be displayed in the account holder’s statement.
Character length and limitations: 25 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
133
A
Processors Requiring Additional Transaction Parameters
Vantiv Additional Credit Card Parameters
Soft Merchant Descriptor Parameters
Field
Description
MERCHANTNAME
(Optional) Name of merchant.
Character length and limitations: 38 alphanumeric characters
MERCHANTSTREET
(Optional) Merchant’s street address (number and street name).
Character length and limitations: 38 alphanumeric characters. If more than 38
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTCITY
(Optional) The name of the city were the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another
entity), you must enter the name of the city in which the seller is located.
If you are a mail order, phone order, or internet industry, you may substitute the
name of the city in which the merchant’s order processing facility is located.
Character length and limitations: 21 alphanumeric characters. If more than 21
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTSTATE
(Optional) The region code that corresponds to the state, province, or country
subdivision of the merchant location where the transaction took place.
Region code examples:
CA = California, USA
NS = Nova Scotia, Canada
COS = Colima Mexico
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the region code that corresponds to the state, province, or country
subdivision in which the seller is located.
Character length and limitations: 3 alphanumeric characters
134
MERCHANTZIP
(Optional) The 5- to 9-digit zip (postal) code excluding spaces, dashes, and nonnumeric characters where the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the postal code that corresponds to the seller’s location.
Character length and limitations: 15 alphanumeric characters
MERCHANTCOUNTRYCODE
(Optional) Country code of the location where the transaction took place.
Character length and limitations: 3 alphanumeric characters
MERCHANTLOCATIONID
(Optional)Merchant-assigned store or location number (or name) that uniquely
identifies where the transaction took place.
Character length and limitations: 15 alphanumeric characters
MERCHANTID
(Required) American Express-assigned service establishment number used to identify
and facilitate payments to merchants.
Character length and limitations: 15 alphanumeric characters.
07 February 2013
Gateway Developer Guide and Reference
Processors Requiring Additional Transaction Parameters
WorldPay Additional Credit Card Parameters
Field
Description
MERCHANTCONTACTINFO
(Optional) Merchant’s telephone number or web address. (URLs and e-mail
addresses may be lowercase, as appropriate.) This entry may appear on the
descriptive bill on the card-member’s statement, or may be used to resolve billing
inquiries and disputes.
N O TE :
A
American Express strongly recommends that aggregators (third-parties who
bill for goods or services rendered by another entity) always fill in this field
with the URL, e-mail address, or telephone number of the contact responsible
for resolving disputes or inquiries.
Character length and limitations: 40 alphanumeric characters
WorldPay Additional Credit Card Parameters
Field
Description
ADDLAMTn
(Optional) Detail of a charge, where n is a value from 1 - 5. Use for additional
breakdown of the amount.
Character length and limitations: 11 alphanumeric characters
ADDLAMTTYPEn
(Optional) A 3-digit code indicating the type of the corresponding charge detail,
where n is a value from 1 - 5.
Character length and limitations: 18 alphanumeric characters
CATTYPE
(Optional) Type of terminal.
Character length and limitations: numeric characters
CONTACTLESS
(Optional) Describes the card input capability. It is the value RFD, which means the
card contains a radio frequency identification (RFID) chip for communicating with a
point-of-sale device with an RFID receiver.
Character length and limitations: alpha characters
Gateway Developer Guide and Reference
07 February 2013
135
A
136
Processors Requiring Additional Transaction Parameters
WorldPay Additional Credit Card Parameters
07 February 2013
Gateway Developer Guide and Reference
B
TeleCheck Electronic Check
Processing
This appendix describes the host-based capture version of the TeleCheck Non-Face-To-Face
Check Acceptance (NFTF) services.
TeleCheck NFTF Overview of Services
NFTF offers merchants the convenience of electronic check deposits. When a NFTF
transaction is approved by TeleCheck, the manually entered MICR data from the check is
electronically converted to an ACH debit and is processed through the ACH Network. The
merchant receives funds within two banking days.
NFTF includes TeleCheck Internet Check Acceptance (ICA), Checks By Phone (CBP), and
Prearranged Deposit Services (NFTF PPD). Each of these products requires a separate
Merchant ID also known as a Subscriber ID. See below for more details.
ICA provides merchants with the capability to authorize and electronically settle checks
presented by customers over the internet. ICA can be single entry or recurring. This is
based on customer's authorization received over the internet.
CBP authorizes and electronically settles checks presented over the phone through
customer interaction with a merchant call center representative. CBP services are single
entry only. Partial debits and recurring entries are not allowable per NACHA guidelines.
NFTF prearranged payment and deposit entry (NFTF PPD) may be used for either
recurring or non-recurring debits to a customer's account, when the merchant has provided
the customer with a written authorization, which the customer has signed or similarly
authenticated. Actual payments are facilitated via the internet or via IVR or over the phone.
The application type value must be set to PPD. PPD accounts must establish an end date to
clearly define terms between customer and merchant, but do not have time period caps.
TeleCheck NFTF Processing Overview
NFTF requirements, processing considerations, and guidelines for processing check payments
are described below.
NFTF Requirements
The following requirements must be followed as standard operating procedures to
electronically process a NFTF check payment:
A TeleCheck Merchant ID is required on all transactions and is unique to each location.
Gateway Developer Guide and Reference
07 February 2013
137
B
TeleCheck Electronic Check Processing
TeleCheck NFTF Processing Overview
138
Dual ID is required for all transactions. For personal checks, it must be MICR data and
personal check writer identification such as a driver’s license. For company checks, it must
be MICR data and Federal Tax ID. In the event that a company does not have a Federal Tax
ID, the driver’s license can also be used.
For ICA and NFTF PPD, the merchant must retain the customer’s authorization of the
transaction for a period of 2 years and, for ICA, prompt the customer to print a copy of this
confirmation for their records. The merchant must adhere to all authorization requirements,
data elements, legal verbiage, and check return fee requirements.
For CBP, the merchant must audio record the customer’s verbal confirmation of the
transaction or provide a written confirmation of the transaction to the customer prior to
settlement. In either case, the confirmation must be live; IVR is not acceptable for
confirmation. If a merchant chooses audio, the merchant must have the technical capability
to retain these recordings for a period of 2 years; else the written confirmation may be
substituted and retained for the same time period. The merchant must adhere to all
authorization requirements; data elements, legal verbiage, and check return fee
requirements.
Only select US accounts drawn on U.S. banks participating in the ACH Network are
eligible for processing via the ACH Network.
TeleCheck Trace ID (TTID) is required for all supplemental messages, change, void, and
adjustment transactions.
Merchant Trace ID is required for all adjustment transactions. This field allows additional
capabilities to be enabled such as Overflow Credits and MIA Duplicate Checking.
Change and Void transactions are only allowed within the original Sale processing
window. For NFTF, cutoff time is 4:00PM CST (recommend working with 3:30PM CST).
Adjustment transactions are electronically allowed within 90 days after the Sale
transaction. After the 90 day period, all adjustments must be manually processed.
A prompt or process must be in place to identify a check as either personal or company.
Duplicate Checking – TeleCheck has the ability to detect duplicate sale transactions at the
point of sale if sent within a predetermined time limit. Duplicates are identified when a sale
inquiry is received with the same amount, MICR number, and check number matching a
sale inquiry received within the last 2 minutes. If a duplicate is detected it will return an
ineligible response for ACH. The 2nd transaction will also receive an ineligible response
for ACH with the same ACH Transaction Status and Response Code as the original sale
transaction.
The appropriate Application Type value must be sent to TeleCheck to indicate the type of
NFTF transaction (ICA, CBP, or NFTF PPD).
In the NFTF technical specification several data element fields and features are described
as “optional.” While these are technically optional, meaning that the product can be
technically implemented with or without them, TeleCheck may require the merchant to
code to one or more of these optional items based on the agreed upon contractual terms.
The merchant may need to account for and enable additional data element fields and
product features in their system(s) and in communications to TeleCheck’s Authorization
07 February 2013
Gateway Developer Guide and Reference
TeleCheck Electronic Check Processing
TeleCheck NFTF Processing Overview
B
System. Various optional data elements throughout each of the message packets could be
affected by this requirement.
First Data Gateway Partners, External Gateway vendors, First Data Platforms, and the
Global Gateway Router (GGR) that route merchant transactions to TeleCheck via this
specification must code for all fields, features, and functionality available in this
specification. Nothing is optional for these partners. Additionally, these partners are
required to maintain their NFTF specification as new revisions and addendums become
available.
NFTF Processing Considerations
TeleCheck and the Merchant must determine any of the following additional optional features
during contract negotiations.
MIA Duplicate Checking – TeleCheck has the ability to detect duplicate adjustment
transactions in back end processes. Adjustments can be submitted up to 90 days after the
original Sale transaction. While multiple adjustment transactions are allowed for a given
sale transaction, each adjustment transaction must have a unique merchant trace ID.
Duplicates are detected when an adjustment transaction is submitted that has the same
merchant trace ID as a previously submitted adjustment transaction. If a duplicate
adjustment is detected, and the original adjustment was accepted by TeleCheck, the
duplicate will also be accepted. The duplicate transaction will then be filtered out by
TeleCheck’s back end settlement processes.
NFTF Guidelines
The following guidelines should be followed when adhering to the above NFTF Requirements
to electronically process a check payment:
Fields marked as Required are required to process an electronic transaction.
Not all fields are required by every merchant.
Unused fields should be completely omitted from the message.
Each field is variable in length (justification and fillers are not used).
The order of tagged fields from the POS and from the TeleCheck host are not significant.
Fields must not have any hard-coded data values.
The transaction number increments on every attempt.
Message formats outline fields (tags) that are required, not required, or conditional to the Sale,
Status, and Adjustment Inquiry packets.
Message Types:
Merchant Authorization Message and the TeleCheck Authorization Response Message
Merchant Delayed Capture Message and the TeleCheck Delayed Capture Response
Message
Gateway Developer Guide and Reference
07 February 2013
139
B
TeleCheck Electronic Check Processing
TeleCheck Parameters
Transaction flow Method
Messages sent from the Merchant to TeleCheck are authorization messages. Messages sent
from TeleCheck to the Merchant are Response messages.
The sale transaction process is often referred to as a 2-part hand-off. The process begins with
the merchant’s Authorization message. TeleCheck responds with an Authorization response
message indicating whether the transaction is approved and whether the check is eligible for
conversion (whether check conversion will be offered). The Merchant then responds with a
Delayed Capture message, acknowledging receipt of TeleCheck’s sale response, and
indicating whether electronic check conversion was accepted. TeleCheck completes the
transaction with a Delayed Capture response message confirming receipt of the merchant’s
status inquiry message.
TeleCheck Parameters
Parameters used for processing electronic checks through TeleCheck are described in this
section.
140
07 February 2013
Gateway Developer Guide and Reference
TeleCheck Electronic Check Processing
TeleCheck Parameters
B
Required TeleCheck Parameters
Field
Description
USER
(Required) Case-sensitive login ID for the Gateway account that you created while
registering for the account.
In the future, each account will allow multiple users. This parameter will specify the
user.
Character length and limitations: 64 alphanumeric characters
VENDOR
(Required) Case-sensitive Vendor ID that you created while registering for the
account.
Character length and limitations: 64 alphanumeric characters
PARTNER
(Required) The authorized PayPal Reseller that registered you for the Gateway
service provided you with a Partner ID. If you registered yourself, use PayPal.
This parameter is case sensitive.
Character length and limitations: 64 alphanumeric characters
PWD
(Required) Case-sensitive 6- to 32-character password that you created while
registering for the account.
Character length and limitations: 32 alphanumeric characters
AMT
(Required) This is the transaction amount (default U.S. dollars).
The transaction amount should always specify a decimal, and the exact amount to the
cent (for example, 34.00, instead of 34). Do not include comma separators in the
amount. Use 1199.95 not 1,199.95.
Character length and limitations: 7 numeric characters, U.S. dollars only
AUTHTYPE
It is one of the following values:
I – Internet Check Acceptance (ICA) provides the capability to authorize and
electronically settle checks over the intenet.
P – Checks By Phone (CBP) provides the capability to authorize and
electronically settle checks over the phone.
D – Prearranged Deposit Services (PPD) debits the customer’s account provided
the customer has previously accepted a written authorization.
BILLTOCITY
(Required) Account holder’s city.
Character length and limitations: 30 alphanumeric characters
BILLTOCOUNTRY
Account holder’s country. You are required to pass this value when AUTHTYPE=I.
Character length and limitations: 2 alphanumeric characters
BILLTOFIRSTNAME
Account holder’s first name as it appears on the check. You are required to pass this
value when CHKTYPE=C.
Character length and limitations: 30 alphanumeric characters
BILLTOLASTNAME
(Required) Account holder’s last name as it appears on the check.
Character length and limitations: 30 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
141
B
TeleCheck Electronic Check Processing
TeleCheck Parameters
Field
Description
BILLTOPHONENUM
(Required) Account holder’s telephone number.
Character length and limitations: 10 numeric characters. This value may not contain
spaces or non-numeric characters.
BILLTOSTATE
(Required) Account holder’s state.
Character length and limitations: 2 alphanumeric characters
BILLTOSTREET
(Required) Account holder’s street address.
Character length and limitations: 50 alphanumeric characters
BILLTOZIP
(Required) Account holder’s postal code (called ZIP code in the USA). Do not use
spaces, dashes, or non-numeric characters.
Character length and limitations: 11 alphanumeric characters
CHKNUM
(Required) Account holder’s next unused (available) check number.
Character length and limitations: 7 numeric characters
CHKTYPE
(Required) Check type. It is one of the following values:
P – The check is a personal check (default). If CHKTYPE=P, you are required to
pass a value for either DL or SS as an identifier.
C – The check is a company check. If CHKTYPE=C, you are required to pass the
Federal Tax ID for SS.
Character length and limitations:1 alphanumeric character
CUSTIP
Account holder’s IP address. You are required to pass this value when AUTHTYPE=I.
Character length and limitations: 15 alphanumeric characters
DL
(Required) Driver’s license number. If CHKTYPE=P, you are required to pass a value
for either DL or SS as an identifier.
The format of the driver’s license is nnnnnnnn where:
nnnnnnnn – Driver’s license number
Character length and limitations: 33 alphanumeric characters
NOT E :
142
Beginning on 21st Feb. 2013, Payflow will require the Driver’s License twoletter State code appended to the beginning of the Driver’s license number.
BILLTOEMAIL
Account holder’s e-mail address. You are required to pass this value when
AUTHTYPE=I.
Character length and limitations: 100 alphanumeric characters
INVNUM
(Optional) Check invoice number.
Character length and limitations: 9 alphanumeric characters
MICR
(Required) Magnetic ink check reader. The value is the entire line of numbers at the
bottom of all checks. It includes the transit number, account number, and check
number.
Character length and limitations: 65 numeric characters
07 February 2013
Gateway Developer Guide and Reference
TeleCheck Electronic Check Processing
Testing TeleCheck Transactions
Field
Description
SS
Account holder’s social security number. You are required to pass a value for SS
when a value for CHKTYPE is passed:
If CHKTYPE=P, you are required to pass a value for either DL or SS as an identifier.
If CHKTYPE=C, you are required to pass the Federal Tax ID.
B
Character length and limitations: 35 alphanumeric characters
TENDER
(Required) Method of payment. Use only the value K (electronic check).
Character length and limitations: 1 alphabetic character
TRXTYPE
(Required) Type of transaction that should be processed. It is one of the following
values:
A – The transaction is an Authorization.
D – The transaction is a Delayed Capture.
V – The transaction is a Void.
I – The transaction is an Inquiry.
Character length and limitations: 1 alpha character
Testing TeleCheck Transactions
PayPal provides a test server to support testing and configuration. For information on the test
server URL, see “Host URL Addresses” on page 50.
Example Test Transaction
This is the authorization request and response.
TRXTYPE=A&TENDER=K&PARTNER=partner&USER=user&VENDOR=vendor&PWD=pwd&AMT=35.0
0&BILLTOSTREET=1234 Main&BILLTOCITY=Buffalo&DL=CA123456&CHKNUM=1001&BILLTOE
MAIL=john@xyz.com&MICR=3333333333&AUTHTYPE=I&INVNUM=12345&BILLTOFIRSTNAME=S
ally&BILLTOLASTNAME=Smith&BILLTOSTATE=CA&BILLTOZIP=95050&BILLTOCOUNTRY=US&C
USTIP=10.15.5.23&BILLTOPHONENUM=9876542143&VERBOSITY=HIGH RESULT=0&PNREF=EQ
RB8A32CD69&RESPMSG=Approved&AUTHCODE=12&TRACEID=1234567890&ACHSTATUS=A&HOST
CODE=07&TRANSTIME=2012-0209 15:23:37&BILLTOFIRSTNAME=Sally&BILLTOLASTNAME=Smith&AMT=35.00&CARDTYPE=P
This is the delayed capture request and response.
TRXTYPE=D&TENDER=K&PARTNER=partner&USER=user&VENDOR=vendor&PWD=pwd&ORIGID=E
QRB8A32CD69&VERBOSITY=HIGH
RESULT=0&PNREF=EQRB8A32CD6A&RESPMSG=Approved&AUTHCODE=00&TRACEID=1234567890
&ACHSTATUS=A&HOSTCODE=07&TRANSTIME=2012-02-09 15:24:22
Gateway Developer Guide and Reference
07 February 2013
143
B
TeleCheck Electronic Check Processing
Preparing for TeleCheck Production Transactions
MICR values for testing
You may view a complete list of TeleCheck response codes at “Sale Response Code Values”
on page 145
MICR
HOSTCODE
TeleCheck Result
3333333333
07
Approved
1111111111
08
Rejected (negative data)
2222222222
88
Rejected Code 3 (Risk)
Preparing for TeleCheck Production Transactions
Before going into production with your check integration, you must certify your storefront
with TeleCheck. To begin the certification process, send an e-mail to
iica_certification@telecheck.com. Be sure to include the following information:
Your test website address where test transactions can be processed
The name, e-mail address, and phone number of the person to contact about any needed
corrections.
The certification process usually takes 2-3 days.
Use the host address of the live server described in “Host URL Addresses” on page 50.
Responses to TeleCheck Transactions
When a transaction finishes, PayPal returns a response string made up of name-value pairs.
For example:
RESULT=0&PNREF=VXYZ01234567&HOSTCODE=000500&RESPMSG=Approved
TeleCheck transaction response values are described in the table below.
Transaction Responses Common to All Tender Types
144
Field
Description
RESULT
The outcome of the attempted transaction. A result of 0 (zero) indicates the
transaction was approved. Any other number indicates a decline or error.
Character length and limitations: numeric, variable number of characters
PNREF
PayPal Reference ID, a unique number that identifies the transaction.
Character length and limitations: 12 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
TeleCheck Electronic Check Processing
Response Code Values
Field
Description
HOSTCODE
TeleCheck’s response code representing the results of the transaction
authorization attempt.
Character length and limitations: 6 numeric characters
RESPMSG
A descriptive message associated with decline or error result values.
Character length and limitations: alphanumeric, variable number of characters
B
Response Code Values
For your service, below is a complete list of possible Response Codes. Depending upon the
merchants risk parameters and service type, some of these may not apply. Please confirm
applicable codes with TeleCheck’s Merchant Boarding and Certification group.
NOT E :
Merchants should establish policies and procedures for each applicable response code.
For example, if a clerk enters a transaction and receives Response Code 27, they
should retry the transaction. If, after entering the item a second time they receive a
Response Code 27 again, the merchant may choose to cancel or terminate the
transaction and a) retry the transaction b) call TeleCheck Live Operator Authorization
Center, or c) request another form of payment from the check writer.
Sale Response Code Values
Sale Approval Responses
Code
Description
Merchant Action
07
Approved
No action needed.
Sale Decline Responses
Code
Description
Merchant Action
08
Rejected (Negative Data)
Ask for other form of payment or decline sale
to customer.
73
Lost or Stolen check
Ask for other form of payment or decline sale
to customer.
88
Rejected Code 3 (Risk)
Ask for other form of payment or decline sale
to customer.
25
Ineligible – ACH Not Offered
Ask for other form of payment.
NOT E :
Gateway Developer Guide and Reference
Do NOT use the verbiage
“decline” this is not a true decline.
07 February 2013
145
B
TeleCheck Electronic Check Processing
Response Code Values
Sale Referral Responses
Code
Description
Merchant Action
09
Risk Referral requested
Contact TeleCheck.
69
Call Center
Contact TeleCheck.
Sale Error Responses
Code
Description
Merchant Action
46
Merchant setup does not allow this type of
transaction
49
Processor Not Available
98
Invalid MICR Data
27
Invalid Value for Field
78
Invalid RT (Routing/Bank Number)
97
Unable to Process (Time Out)
Re-send message later.
Re-send message later.
Adjustment Code Values
Adjustment (Refund/Change/Void) Responses
Code
Description
Merchant Action
26
Merchant allowed to send full/partial
adjustments/refunds without transaction
errors
No action needed
46
Merchant setup does not allow this type of
transaction
Adjustment cannot be processed by
TeleCheck
79
Original transaction was not approved
Adjustment cannot be processed by
TeleCheck
80
Refund or partial amount is greater than
the original sale amount
Adjustment cannot be processed by
TeleCheck
81
Unable to locate original transaction
(TCK Trace ID)
Adjustment cannot be processed by
TeleCheck
Response Codes For Status Response Packets
Response Codes for Status Response Packets
146
Code
Description
OK
Inquiry (POS system) Packet was accepted and successfully processed by TeleCheck
07 February 2013
Gateway Developer Guide and Reference
TeleCheck Electronic Check Processing
TeleCheck Authorization Requirements
Code
Description
ACK
Inquiry Packet was accepted by the TeleCheck Host
NAK
Inquiry Packet was not successfully processed by TeleCheck (general error)
49
Inquiry Packet was not successfully processed by TeleCheck (scheduled maintenance)
97
Inquiry Packet was not successfully processed by TeleCheck (timeout)
27
Inquiry Packet was not successfully processed by TeleCheck (invalid data)
B
TeleCheck Authorization Requirements
With the TeleCheck Non Face-To-Face (NFTF) Host Based Capture Service, the merchant is
responsible for handling all front-end aspects of the point of sale, including displaying the
appropriate disclosures to the customer. TeleCheck will provide form language for the
merchant to use.
NOT E :
It is the merchant’s responsibility to ensure that they have the most current language
from TeleCheck. TeleCheck will send out a Service Notice when updated language or
system changes are required. Additionally, the Merchant should be familiar with
NACHA, FCRA and Reg. E compliance requirements.
There are two different situations during which the merchant must display legal language:
Authorization – Sales Consent
The language varies slightly between the Internet Check Acceptance and Checks By Phone
services.
Authorization – Sales Decline
The language is identical for Internet Check Acceptance and Checks By Phone services.
Authorization – Sales Consent
With the Non Face-To-Face Host Based Capture Service, the merchant is responsible for
handling all front-end aspects of the point of sale, including displaying the appropriate
disclosures to the customer. TeleCheck will provide form language for the merchant to use.
Internet Check Acceptance Authorizations
At the end of the check out process, the merchant must display consent language for the
customer to accept prior to submitting the authorization request as follows:
Internet Check Acceptance Authorization Consent Required Language
FULL DEBIT
By entering my account number above and clicking Authorize, I authorize my payment to be
processed as an electronic funds transfer or draft drawn from my account. If the payment is
returned unpaid, I authorize you or your service provider to collect the payment and my state’s
Gateway Developer Guide and Reference
07 February 2013
147
B
TeleCheck Electronic Check Processing
TeleCheck Authorization Requirements
return item fee by electronic funds transfer(s) or draft(s) drawn from my account. Click here
to view your state’s returned item fee. If this payment is from a corporate account, I make
these authorizations as an authorized corporate representative and agree that the entity will be
bound by the NACHA Operating Rules.
PARTIAL SHIPMENTS & PARTIAL DEBITS
By entering my account number above and clicking Authorize, I authorize my payment to be
processed as an electronic funds transfer or draft drawn from my account. If my full order is
not available at the same time, I authorize partial debits to my account, not to exceed the total
authorized amount. The partial debits will take place upon each shipment of partial goods. If
any of my payments are returned unpaid, I authorize you or your service provider to collect the
payment and my state’s return item fee by electronic fund transfer(s) or draft(s) drawn from
my account. Click here to view your state’s returned item fee. If this payment is from a
corporate account, I make these authorizations as an authorized corporate representative and
agree that the entity will be bound by the NACHA Operating Rules.
Internet Check Acceptance Recurring Payments (WEB R)
By entering my account number above and clicking Authorize, I authorize my payments to be
processed as electronic funds transfers or drafts drawn from my account. {INSERT
INFORMATION ON PAYMENT AMOUNT, TIMING, ETC.} If any of my payments are
returned unpaid, I authorize you or your service provider to collect the payment and my state’s
return item fee by electronic fund transfer(s) or draft(s) drawn from my account. Click here
to view your state’s returned item fee. If this payment is from a corporate account, I make
these authorizations as an authorized corporate representative and agree that the entity will be
bound by the NACHA Operating Rules. This authorization is to remain in full force and effect
until {NAME OF MERCHANT} has received written notification from me of my
termination in such time and manner as to afford {NAME OF MERCHANT} a reasonably
opportunity to act on it.
This text, Click here to view your state’s returned item fee, in the consent language above
represents a link to the state fee table. TeleCheck has posted a table of current state returned
check fees at
http://www.firstdata.com/support/telecheck_returned_check/returned_check_fees.htm. The
merchant should link directly to the TeleCheck-hosted URL provided above. State fees are
updated on a regular basis and linking to a TeleCheck-hosted page will minimize the number
of maintenance updates required. The merchant may choose how to display the state fees.
Suggestions include a new pop-up window, a full browser window, or directly on the checkout
page.
Checks By Phone Service Authorizations
At the end of the check out process, the customer service agent must read the consent language
to the consumer and, either audio record the consumer’s authorization or send a written
notification of the authorization and the transaction to the consumer prior to settlement of the
transaction. The consent language for the customer to accept prior to submitting the payment
authorization request is as follows:
Checks By Phone Authorization Consent Required Language
FULL DEBIT
148
07 February 2013
Gateway Developer Guide and Reference
TeleCheck Electronic Check Processing
TeleCheck Authorization Requirements
B
Today (insert today’s date), I’d like to confirm that you, (insert first and last name), are
authorizing a payment in the amount of (insert amount) to be processed as an electronic funds
transfer or draft drawn from your account. Do you agree? If your payment is returned unpaid,
you authorize us or our service provider to collect the payment and your state’s return item fee
of (insert state returned item fee) by electronic funds transfer(s) or draft(s) drawn from your
account. Do you agree and authorize the payment?
The merchant should link directly to the TeleCheck-hosted URL provided above. State fees
are updated on a regular basis and linking to a TeleCheck-hosted page will minimize the
number of maintenance updates required. The merchant may choose how you want to display
the state fees. Suggestions include a new pop-up window, a full browser window, or directly
on the checkout page.
NOT E :
For an additional fee, TeleCheck can send the written notification of the authorization
and transaction to the consumer on the merchant’s behalf.
Prearranged Payments and Deposits Authorizations (PPD)
Payments are facilitated, not authorized.
Authorization is via paper from consumer to merchant.
PPD Authorization Requirements:
Must be face-to-face, in writing and signed.
Must clearly and conspicuously state it terms, such as consumer name, payment amount,
payment timing (if recurring) and bank routing/account information. Must also provide that
authorization may be revoked in the manner specified in the authorization.
Customer must be provided a copy.
Language Sample for PPD
By providing a check as payment, I authorize you to use information from my check to make a
one-time electronic funds transfer (EFT) or draft from my account, or to process the payment
as a check transaction. When you use information from my check to make an EFT, funds may
be withdrawn from my account as soon as the same day my payment is received, and I will not
receive my check back from my financial institution. The account referenced above is a
(check one):
Consumer account
Business account
If my payment is returned unpaid, I authorize you or your service provider to collect my
payment and my state’s return fee set forth below by EFT(s) or draft(s) from my account. I
understand that I can revoke this authorization by sending written notice to _____ in such time
and manner as to afford ____ a reasonable opportunity to act on it. If this payment is from a
corporate owned account, I make these authorizations as an authorized corporate
representative and agree that the entity will be bound by the NACHA Operating Rules.
Returned Check Fees:
TeleCheck has posted a table of current state returned check fees at
http://www.firstdata.com/support/telecheck_returned_check/returned_check_fees.htm. The
Gateway Developer Guide and Reference
07 February 2013
149
B
TeleCheck Electronic Check Processing
TeleCheck Authorization Requirements
merchant should link directly to the TeleCheck-hosted URL provided above. State fees are
updated on a regular basis and linking to a TeleCheck-hosted page will minimize the number
of maintenance updates required. The merchant may choose how to display the state fees.
Suggestions include a new pop-up window, a full browser window, or directly on the checkout
page.
AK
$30-
AL
$30
AR
$25
AZ
$25
CA
$25
CO
$20-
CT
$20-
DE
$40
DC
$25
FL
$25_ƒ
GA
$30^
GU
$20
HI
$30-
IA
$30
ID
$20-
IL
$25-
IN
$20-
KS
$30
KY
$50
LA
$25^
MA
$25
MD
$35
ME
$25
MI
$25
MN
$30_œ
MO
$25
MS
$40
MT
$30
NC
$25
ND
$30
NE
$35
NH
$25
NJ
$30
NM
$30
NV
$25
NY
$20-
OH
$30^^
OK
$25
OR
$25
PA
$30
PR
$10
RI
$25
SC
$30
SD
$40
TN
$30-
TX
$30†~
UT
$20-
VA
$50
VI
$20
VT
$25‡
WA
$30_◊
WI
$25-
WV
$25
WY
$30
Authorization – Sales Decline/Error
Authorization requests can fail for a number of reasons, ranging from missing or invalid fields
to business decisions based on risk assessment. These different scenarios need to be handled
differently by the merchant, and require different legal language to be displayed to the
customer.
Sale Decline Required Language
We are sorry that we cannot accept your check at this time. Our decision is based, in whole or
in part, on information provided to us by TeleCheck. We encourage you to call TeleCheck at
1-800.366.2425 or write TeleCheck Customer Care at P.O. Box 4513, Houston, TX 772104513. Please provide TeleCheck your driver's license number and the state where it was
issued, and the complete banking numbers printed on the bottom of your check. Under the Fair
Credit Reporting Act, you have the right to a free copy of your information held in
TeleCheck's files within 60 days from today. You may also dispute the accuracy or
completeness of any information in TeleCheck's consumer report. TeleCheck did not make the
adverse decision to not accept your payment item and is unable to explain why this decision
was made.
Sale Error Responses
We are unable to process this transaction with the payment information provided. Please use a
different form of payment at this time.
150
07 February 2013
Gateway Developer Guide and Reference
C
Submitting Purchasing Card
Level 2 and 3 Transactions
PayPal Payment Services supports passing Purchasing Card Level 2 information (such as
purchase order number, tax amount, and charge description) in the settlement file.
If additional required invoice information and line-item details are included in the transaction,
PayPal formats Purchasing Card Level 3 information in an appropriate format, for example,
EDI (Electronic Data Interchange) 810 format as required by American Express during
settlement processing.
Please contact your merchant bank to determine which parameters are required to obtain the
best rate for level 2 or level 3 type transactions. If in doubt, we recommend you send all the
level 2 and level 3 fields specified below for your processor.
About Purchasing Cards
The procurement process uses purchasing cards for a number of reasons. Purchasing cards:
Eliminate paper-based order systems and associated costs
Improve control and accountability through itemized statements
Foster better risk controls through spending limits and buying from approved vendors
Reduce administrative overhead by empowering employees to make small purchases
Enable enterprises to negotiate better contract pricing and discounts with suppliers by using
vendor detail reports
To promote acceptance and usage of purchasing card programs, card issuers have established
incentive rates for merchants. The incentive rates are available to merchants who comply at
transaction processing Level 2 or Level 3. Transactions that comply at transaction processing
Level 1 qualify as normal credit card transactions.
NOT E :
Card issuing institutions perform strict data verification on the enhanced data that
merchants submit with Level 2 or Level 3 transactions. Issuers may charge stiff
penalties when fields contain either inaccurate or filler data. Only transactions that
contain accurate data are eligible for the incentive rates.
About Program Levels
The term Level does not apply to the card, but to the transaction data submitted for that card.
Generally, a higher level means more detailed data for reporting.
The following table describes the recognized transaction levels.
Gateway Developer Guide and Reference
07 February 2013
151
C
Submitting Purchasing Card Level 2 and 3 Transactions
About American Express Purchasing Card Transactions
Level
Description
Level 1
Function as normal credit cards and are authorized and associated with normal
transaction data in authorization and settlement. Any merchant who accepts credit
cards supports this level..
Level 2
Additional data regarding sales tax, customer code, purchase order number, invoice
number are captured at the point of sale. In most cases, this information is combined
with the merchant’s tax ID number, state, and postal code data and is then passed
through during settlement. For some processors and banks, however, a Level 2
authorization may include some of this data.
Level 3
Significant additional information such as line items, product codes, item
descriptions, unit price, unit quantities, and ship-to postal data are added to the Level
2 data to provide optimal reporting to buyers and sellers. Settlement transactions
typically carry Level 3 data.
Level 2 and Level 3 data is generally considered non-financial data. Lack of adequate data
may cause a transaction to be downgraded.
PayPal generally requires up to Level 2 information in an authorization transaction followed
by additional Level 3 data in the associated delayed capture transaction. A sale transaction
should include all Level 3 data since it is authorized and later settled.
Accepted BIN Ranges
Visa, MasterCard, and American Express publish specific Bank Identification Number (BIN)
ranges for purchasing cards. Sometimes the processor determines whether a card is a
purchasing card, for example, TSYS Acquiring Solutions. In other cases, the Gateway makes
the determination based on the BIN range (for example, FDMS South and American Express).
About American Express Purchasing Card Transactions
The information in this section applies to transactions processed by American Express not
necessarily to all American Express cards. Level 2 and Level 3 purchasing card rules may
differ for American Express card transactions processed by other processors such as
Paymentech or First Data Nashville.
Supported Transaction Types
You can submit Level 3 parameters with delayed capture, sale, credit, or force transactions.
Level 3 data in authorization transactions is ignored. The Gateway decides whether a
transaction meets Level 3 requirements during authorization.
Level 3 data is passed to the American Express processor only during settlement.
152
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
About American Express Purchasing Card Transactions
C
Avoiding Downgrade
If a transaction uses the purchasing card BIN range (see “Accepted BIN Ranges” on page 154)
and contains a line item but does not include all mandatory Level 3 parameters, the transaction
succeeds but is processed as Level 2 or Level 1 during settlement (depending on which data
was passed).
For downgraded transactions, with the VERBOSITY parameter set to HIGH, the ADDLMSGS
field returns a message like the following:
Features not processed: PCARD L3 (missing or invalid: InvoiceNumber
RequestorName)
— or —
Features not processed: PCARD L3 (line item 3 missing: Description)
For details on VERBOSITY, see “VERBOSITY: Processor-Specific Transaction Results” on
page 215
Submitting Successful Level 3 Transactions
If a transaction uses the purchasing card BIN range, contains all mandatory Level 3 fields, and
has at least 1 line item (with all mandatory line item fields), the Gateway flags it as Level 3.
Edit Check
The Gateway performs an edit check on the transaction’s amount fields to ensure that all line
item and tax amounts balance.
If the edit check fails, the transaction fails with Result 4: Invalid Amount.
To pass the edit check, the following relationship must be true:
Transaction Amount = Total Tax Amount + Total Freight Amount + Total
Handling Amount + Total Line Item Amount.
Transaction Amount
Total amount for the transaction, AMT
Total Tax Amount
TAXAMT
Total Freight Amount
FREIGHTAMT, or, if not present, the summation of L_FREIGHTAMTn for all line
items
Total Handling Amount
HANDLINGAMT, or, if not present, the summation of L_HANDLINGAMTn for all
line items
Total Line Item Amount
Summation of L_QTYn * L_COSTn for all line items (n as the line item
number). For example, if there are 2 line items, then the Total Line Item
Amount would be (LQTY1*LCOST1) + (LQTY2*LCOST2)
Gateway Developer Guide and Reference
07 February 2013
153
C
Submitting Purchasing Card Level 2 and 3 Transactions
American Express Purchasing Card Transaction Processing
Accepted BIN Ranges
The following BIN ranges are accepted for American Express Level 2 and Level 3
transactions:
37326
37429
37857
37859
37873
37965
American Express Purchasing Card Transaction Processing
The American Express supports Level 2 transaction data.
NOT E :
Most merchants in the United States follow American Express reporting and
statement requirements.International merchants now follow these requirements as
well, but there maybe a few exceptions. If you are not sure, contact your American
Express Representative.
American Express Level 2 Parameters for American Express
The parameters to meet American Express reporting and statement requirements are described
in the following tables.
CPC Level 2 Transaction Advice Addendum Parameters
Field
Description
PONUM
(Required) Purchase order number.
Character length and limitations: 17 alphanumeric characters
SHIPTOZIP
(Optional) Ship-to postal code (called zip code in the USA). This field must contain
one of the following values:
Zip code of the destination where the merchandise is to be shipped
(If the above is not available) Zip code of the location where the merchant
executed the transaction
Character length and limitations: 15 alphanumeric characters
154
TAXAMT
(Optional) Total tax amount. Must include a decimal and the exact amount to the cent
(42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_DESC1
(Optional) Description of this line item; if not provided, DESC1 (if present) is used.
Character length and limitations: 140 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
American Express Purchasing Card Transaction Processing
Field
Description
L_AMT1
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY1
(Optional) Quantity of this line item.
Character length and limitations: 3 numeric characters
L_DESC2
(Optional) Description of this line item; if not provided, DESC2 (if present) is used.
Character length and limitations: 40 alphanumeric characters
L_AMT2
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY2
(Optional) Quantity of this line item.
Character length and limitations: 3 numeric characters
L_DESC3
(Optional) Description of this line item; if not provided, DESC3 (if present) is used.
Character length and limitations: 40 alphanumeric characters
L_AMT3
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY3
(Optional) Quantity of this line item.
Character length and limitations: 3 numeric characters
L_DESC4
(Optional) Description of this line item; if not provided, DESC4 (if present) is used.
Character length and limitations: 30 alphanumeric characters
L_AMT4
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY4
(Optional) Quantity of this line item.
Character length and limitations: 3 numeric characters
C
Location Transaction Advice Addendum Parameters
Field
Description
MERCHANTNAME
(Optional) Name of merchant.
Character length and limitations: 38 alphanumeric characters
MERCHANTSTREET
(Optional) Merchant’s street address (number and street name).
Character length and limitations: 38 alphanumeric characters. If more than 38
characters, use proper and meaningful abbreviation. Do not truncate.
Gateway Developer Guide and Reference
07 February 2013
155
C
Submitting Purchasing Card Level 2 and 3 Transactions
American Express Purchasing Card Transaction Processing
Field
Description
MERCHANTCITY
(Optional) The name of the city were the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another
entity), you must enter the name of the city in which the seller is located.
If you are a mail order, phone order, or internet industry, you may substitute the
name of the city in which the merchant’s order processing facility is located.
Character length and limitations: 21 alphanumeric characters. If more than 21
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTSTATE
(Optional) The region code that corresponds to the state, province, or country
subdivision of the merchant location where the transaction took place.
Region code examples:
CA = California, USA
NS = Nova Scotia, Canada
COS = Colima Mexico
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the region code that corresponds to the state, province, or country
subdivision in which the seller is located.
Character length and limitations: 3 alphanumeric characters
MERCHANTZIP
(Optional) The 5- to 9-digit zip (postal) code excluding spaces, dashes, and nonnumeric characters where the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the postal code that corresponds to the seller’s location.
Character length and limitations: 15 alphanumeric characters
MERCHANTCOUNTRYCODE
(Optional) Country code of the location where the transaction took place.
Character length and limitations: 3 alphanumeric characters
MERCHANTLOCATIONID
(Optional)Merchant-assigned store or location number (or name) that uniquely
identifies where the transaction took place.
Character length and limitations: 15 alphanumeric characters
MERCHANTID
(Required) American Express-assigned service establishment number used to identify
and facilitate payments to merchants.
Character length and limitations: 15 alphanumeric characters.
MERCHANTCONTACTINFO
(Optional) Merchant’s telephone number or web address. (URLs and e-mail addresses
may be lowercase, as appropriate.) This entry may appear on the descriptive bill on
the card-member’s statement, or may be used to resolve billing inquiries and disputes.
N O TE :
American Express strongly recommends that aggregators (third-parties who
bill for goods or services rendered by another entity) always fill in this field
with the URL, e-mail address, or telephone number of the contact responsible
for resolving disputes or inquiries.
Character length and limitations: 40 alphanumeric characters
156
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
American Express Purchasing Card Transaction Processing
C
Transaction Advice Detail Parameters
Field
Description
ADDLAMTn
(Optional) Detail of a charge where n is a value from 1 - 5. Use for additional
breakdown of the amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
ADDLAMTTYPEn
(Optional) A 3-digit code indicating the type of the corresponding charge detail,
where n is a value from 1 - 5.
Character length and limitations: 3 numeric characters
Example American Express Level 2 Transaction Parameter String
TRXTYPE=S&ACCT=372449635311003&AMT=20.06&BILLTOCITY=Mountain View&DESC1=des
c1&DESC2=desc2&DESC3=desc3&DESC4=FRT10.00&EXPDATE=1215&BILLTOFIRSTNAME=Card
holder first name&BILLTOLASTNAME=Cardholder last name&PARTNER=PayPal&PONUM=
12345&PWD=pwd&SHIPTOZIP=94045&BILLTOSTATE=CA&BILLTOSTREET=123 Main St.&TEND
ER=C&USER=user&BILLTOZIP=123451234
American Express Level 3 Parameters
American Express supports Level 3 transaction data. PayPal provides the Merchant
Registration data values: Supplier Name, Supplier City, Supplier State, Supplier Postal code,
Merchant No, and Federal Tax ID. The merchant provides the values listed in the the
following table.
American Express Level 3 Parameters
Field
Description
INVNUM
(Optional) Purchase order number.
Character length and limitations: 1 to 9 alphanumeric characters
AUTHCODE
(Required) Authorization code. It is passed transparently for delayed capture. Use
only with voice authorized force capture transactions.
REQNAME
(Required) Requester name.
Character length and limitations: 1 to 40 alphanumeric characters
PONUM
(Required) Cardmember reference number.
Character length and limitations: 1 to 17 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
157
C
Submitting Purchasing Card Level 2 and 3 Transactions
American Express Purchasing Card Transaction Processing
Field
Description
SHIPTOZIP
(Required) Ship-to postal code (called zip code in the USA). This field must contain
one of the following values:
Zip code of the destination where the merchandise is to be shipped
(If the above is not available) Zip code of the location where the merchant
executed the transaction
Character length and limitations: 5 to 6 alphanumeric characters
INVOICEDATE
(Optional) Invoice date. Defaults to transaction date if not present.
Character length and limitations: 8 alphanumeric characters, in the YYYYMMDD format
AMT
(Required) Total transaction amount. The value must include a decimal and the exact
amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not
1,234.56).
NOTE:
American Express Level 3 processing requires that this parameter have a
maximum field length of 8 for Level 3 processing. .
Character length and limitations: 1 to 8 alphanumeric characters
158
TAXAMT
(Required) Total tax amount. The value must include a decimal and the exact amount
to the cent (42.00, not 42). Do not include comma separators (1234.56 not
1,234.56).
Character length and limitations: 1 to 6 numeric characters
DESC
(Optional) Charge description. Defaults to “NO.”
Character length and limitations: 1 to 40 alphanumeric characters
FREIGHTAMT
(Optional) Total freight amount.
Character length and limitations: 1 to 15 alphanumeric characters
HANDLINGAMT
(Optional) Total handling amount.
Character length and limitations: 1 to 15 alphanumeric characters
L_QTYn
Payflow SDK:
XMLPay: Item.Quantity
(Required) Quantity invoiced.
Character length and limitations: 1 to 10 numeric characters
L_UOMn
(Required) Unit of measure.
Character length and limitations: 2 alphanumeric characters
L_COSTn
(Required) Unit price.
Character length and limitations: 1 to 15 numeric characters
L_DESCn
(Required) Description of the item.
Character length and limitations: 1 to 80 alphanumeric characters
L_CATALOGNUMn
(Required) Supplier’s catalog number.
Character length and limitations: 1 to 20 alphanumeric characters
L_COSTCENTERNUMn
(Required) Cost center number
Character length and limitations: 1 to 30 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
American Express Purchasing Card Transaction Processing
Field
Description
L_PRODCODEn
(Optional) The item’s supplier stock keeping unit (SKU) number.
Character length and limitations: 1 to 30 alphanumeric characters
L_UPCn
(Optional) The item’s universal product code (UPC).
Character length and limitations: 1 to 30 alphanumeric characters
L_TAXAMTn
(Optional) Item tax amount.
Character length and limitations: 1 to 6 numeric characters
L_FREIGHTAMTn
(Optional) Freight amount.
Character length and limitations: 1 to 15 numeric characters
L_HANDLINGAMTn
(Optional)Handling amount.
Character length and limitations: 1 to 15 numeric characters
L_TRACKINGNUMn
(Optional) Tracking number.
Character length and limitations: 1 to 30 alphanumeric characters
L_PICKUPSTREETn
(Optional) Drop-off address1.
Character length and limitations: 1 to 40 alphanumeric characters
L_PICKUPCITYn
(Optional) Drop-off city.
Character length and limitations: 2 to 30 alphanumeric characters
L_PICKUPSTATEn
(Optional) Drop-off state.
Character length and limitations: 2 alphanumeric characters
L_PICKUPZIPn
(Optional) Drop-off postal or zip code.
Character length and limitations: 3 to 15 alphanumeric characters
L_PICKUPCOUNTRYn
(Optional) Drop-off country.
Character length and limitations: 2 to 3 alphanumeric characters
L_UNSPSCCODEn
(Optional) UNSPSC code.
Character length and limitations: 1 to 30 alphanumeric characters
C
Example American Express Level 3 Transaction Parameter String
TRXTYPE=S&TENDER=C&partner=partner&PWD=test&USER=test&ACCT=378734493671000&
EXPDATE=1213&AMT=5.00&COMMENT1=PCARD Test&COMMENT2=Testing&BILLTOZIP=940151
234&BILLTOSTREET=123 Lincoln WAY&CVV2=0123&SHIPTOCOUNTRY=USA&CUSTCODE=12345
&FREIGHTAMT=1.00&ORDERDATE=021700&HANDLINGAMT=1.00&PONUM=123456789012345678
9012345&SHIPFROMZIP=940151234&SHIPTOZIP=940151234&TAXAMT=1.00&TAXEXEMPT=N&L
_UPC1=PN&L_QTY1=1&L_DESC1=Test123&L_UOM1=12&L_COST1=1.00&L_PRODCODE1=123&L_
COSTCENTERNUM1=55&L_TAXAMT1=0&L_QTY2=1&L_UPC1=PN&L_DESC2=Test&L_UOM2=12&L_C
OST2=1.00&L_PRODCODE2=1234&L_COSTCENTERNUM2=55&L_TAXAMT2=1.00&REQNAME=Rober
t&SHIPTOZIP=543210&INVNUM=123456789&VERBOSITY=HIGH
Gateway Developer Guide and Reference
07 February 2013
159
C
Submitting Purchasing Card Level 2 and 3 Transactions
Elavon (Formerly Nova) Purchasing Card Transaction Processing
Elavon (Formerly Nova) Purchasing Card Transaction
Processing
Elavon supports Level 2 for Visa and MasterCard sale, credit, and delayed capture
transactions.
Elavon Level 2 Parameters
To get the discount rate, include both Level 2 parameters listed in the following table. Pass
these parameters in authorization and sale transactions.
Level 2 Parameters
Description
CUSTCODE
(Required) Customer code.
Character length and limitations: 1 to 16 alphanumeric characters
TAXAMT
(Required) Sales tax.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
Elavon Additional Parameters
The following parameters are recommended to obtain the best rates for purchasing card
transactions with Elavon:
Field
Description
COMMCARD
(Optional) Type of purchasing card account number sent. Is one of the following
values:
P = Purchase Card
C = Corporate Card
B = Business Card
U = Unknown (default)
N = None
Character length and limitations: 1 alphanumeric character, defaults to U
160
PONUM
(Optional) Purchase order number.
Character length and limitations: 25 alphanumeric characters, when used provides
best rate
TAXAMT
(Optional)Tax amount. The value must include a decimal and the exact amount to the
cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters, when used provides best
rate
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing
C
Example Elavon Level 2 Transaction Parameter String
TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1215&BILLTOFIRSTNAME=Cardholder First Name&BILLTOLASTNA
ME=Cardholder Last Name&PARTNER=PayPal&PWD=pwd&BILLTOSTATE=CA&BILLTOSTREET=
123 Main St.&TENDER=C&USER=user&BILLTOZIP=94043&CUSTCODE=123456&TAXAMT=1.34
First Data Merchant Services (FDMS) Nashville Purchasing Card
Transaction Processing
NOT E :
FDMS Nashville supports Level 2 transaction processing only.
The following parameters are recommended to obtain the best rates for purchasing card
transactions with FDMS Nashville.
FDMS Nashville Commercial Card Parameters
Field
Description
COMMCARD
(Optional) Type of purchasing card account number sent. Is one of the following
values:
P = Purchase Card
C = Corporate Card
B = Business Card
U = Unknown (default)
N = None
Character length and limitations: 1 alphanumeric character, defaults to U
DUTYAMT
(Optional) Sometimes called import tax. The value must include a decimal and the
exact amount to the cent (42.00, not 42). Do not include comma separators
(1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
FREIGHTAMT
(Optional) Freight amount. The value must include a decimal and the exact amount to
the cent (42.00, not 42). Do not include comma separators (1234.56 not
1,234.56).
Character length and limitations: 10 currency characters
PONUM
(Optional) Purchase order number.
Character length and limitations: 25 alphanumeric characters, provides best rate when
used
SHIPTOZIP
(Optional)Ship to postal code (called zip code in the USA).
Character length and limitations: 9 numeric characters, provides best rate when used
Gateway Developer Guide and Reference
07 February 2013
161
C
Submitting Purchasing Card Level 2 and 3 Transactions
First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing
Field
Description
TAXAMT
(Optional)Tax amount. The value must include a decimal and the exact amount to the
cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters, provides best rate when
used
TAXEXEMPT
(Optional) Is the customer tax exempt?
Character length and limitations: 1 alphanumeric character, Y or N
First Data Merchant Services (FDMS) North Purchasing Card
Transaction Processing
The following parameters are recommended to obtain the best rates for Level 2 and Level 3
purchasing card transactions with FDMS North.
FDMS North Purchasing Parameters
162
Field
Description
SHIPTOCOUNTRY
(Optional) Destination country code. Visa and MasterCard are different.
Character length and limitations: 3 alpha characters
DISCOUNT
(Optional) Discount amount on total sale
Character length and limitations: 10 currency characters
DUTYAMT
(Optional) Sometimes called import tax. If the currency uses a decimal, then the
value must include a decimal and the exact amount to the cent (42.00, not 42). Do
not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
FREIGHTAMT
Character length and limitations: 10 currency characters
PONUM
(Optional) Purchase order number / merchant-related data.
Character length and limitations: 25 alphanumeric characters, provides best rate when
used
SHIPFROMZIP
(Optional) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 9 numeric characters, provides best rate when used
SHIPTOZIP
(Optional) Ship to postal code (called zip code in the USA).
Character length and limitations: 9 numeric characters, provides best rate when used
TAXAMT
(Optional) Tax amount. The value must include a decimal and the exact amount to the
cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing
C
FDMS North Purchasing Card Line Item Parameters
Line item data (Level 3) describes the details of the item purchased and can be passed for each
transaction. The convention for passing line item data in name-value pairs is that each namevalue starts with L_ and ends with n where n is the line item number. For example L_QTY0=1
is the quantity for line item 0 and is equal to 1, with n starting at 0. In addition, the
SHIPFROMZIP parameter is required for Level 3 transactions.
FDMS North Line Item Parameters
Field
Description
L_QTYn
(Required) Quantity (whole units only).
Character length and limitations: 10 numeric characters
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12alphanumeric characters
L_DESCn
(Optional) Item description.
Character length and limitations: 35 alphanumeric characters
L_UOMn
(Optional) Item unit of measure.
Character length and limitations: 3 alpha characters
L_COSTn
(Optional) Cost per item, excluding tax.
Character length and limitations: 10 currency characters
L_UPCn
(Optional) Supplier specific product code.
Character length and limitations: 12 alphanumeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 10 currency characters
L_AMTn
(Optional) Total line item amount including tax and discount. + for debit, - for credits.
Character length and limitations: 10 currency characters
L_TAXAMTn
(Optional) Line item tax amount.
Character length and limitations: 10 currency characters
First Data Merchant Services South (FDMS) Purchasing Card
Transaction Processing
The following parameters are recommended to obtain the best rates for Level 2 and Level 3
purchasing card transactions with FDMS South.
Gateway Developer Guide and Reference
07 February 2013
163
C
Submitting Purchasing Card Level 2 and 3 Transactions
First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing
FDMS South Level 2 and Level 3 Purchasing Card Parameters
164
Field
Description
BILLTOCITY
(Optional) Cardholder’s city.
Character length and limitations: 13 alpha characters
SHIPTOCOUNTRY
(Optional) Destination Country Code. Visa and MasterCard are different. Refer to
Country Code tables.
Character length and limitations: 3 alpha characters
CUSTCODE
(Optional) Customer code/customer reference ID.
Character length and limitations: 17 alphanumeric characters
DISCOUNT
Discount amount on total sale.
Character length and limitations: 10 currency characters
DUTYAMT
(Optional) Sometimes called import tax. If the currency uses a decimal, then the
value must include a decimal and the exact amount to the cent(42.00, not 42). Do
not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
BILLTOFIRSTNAME
(Optional) Cardholder’s first name.
Character length and limitations: 15 alpha characters
FREIGHTAMT
(Optional) Freight amount. If the currency uses a decimal, then the value must
include a decimal and the exact amount to the cent (42.00, not 42). Do not include
comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
INVNUM
(Optional) Merchant invoice number. This reference number (PNREF—generated by
PayPal) is used for authorizations and settlements.
The acquirer decides if this information will appear on the merchant’s bank
reconciliation statement.
Character length and limitations: 9 alphanumeric characters
BILLTOLASTNAME
(Optional) Cardholder’s last name.
Character length and limitations: 15 alpha characters
ORDERDATE
(Optional) Order date. Format is mmddyy with no slashes or dashes. For example,
July 28, 2003 is 072803.
Character length and limitations: 6 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing
Field
Description
ORDERTIME
(Optional) Order time and date. Format is either YYYY-MM-DD or YYYY-MM-DD
HH:MI:SS (where HH is in 24-hour time).
If the value does not conform to one of the formats or if the date is not valid (for
example, 2004-17-35), then the transaction is rejected with a RESULT=7
(SIG_FIELD_ERR) and RESPMSG=Invalid ORDERTIME.
A truncated version of the ORDERTIME value (up to 7 characters) overwrites any
value provided by ORDERDATE.
If no value is provided, a NULL value is stored.
Character length and limitations: 19 alphanumeric characters
PONUM
(Optional) Purchase order number / merchant-related data.
Character length and limitations: 25 alphanumeric characters, provides best rate when
used
SHIPFROMZIP
(Optional) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 9 numeric characters, provides best rate when used
SHIPTOZIP
(Optional) Ship to postal code (called zip code in the USA).
Character length and limitations: 9 numeric characters, provides best rate when used
BILLTOSTATE
(Optional) Cardholder’s state.
Character length and limitations: 2 alpha characters
TAXAMT
(Optional) Tax amount. The value must include a decimal and the exact amount to the
cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters, provides best rate when
used
TAXEXEMPT
(Optional) Is the customer tax exempt?
Character length and limitations: 1 alphanumeric character, Y or N
C
FDMS South Line Item Parameters
Line item data (Level 3) describes the details of the item purchased and can be can be passed
for each transaction. The convention for passing line item data in name-value pairs is that each
name-value starts with L_ and ends with n where n is the line item number. For example
L_QTY0=1 is the quantity for line item 0 and is equal to 1, with n starting at 0.
FDMS South Purchasing Card Line Item Parameters
Field
Description
L_QTYn
(Required) Quantity (whole units only).
Character length and limitations: 10 numeric characters
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
165
C
Submitting Purchasing Card Level 2 and 3 Transactions
First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing
Field
Description
L_DESCn
(Optional) Item description.
Character length and limitations: 35 alphanumeric characters
L_UOMn
(Optional) Item unit of measure.
Character length and limitations: 3 alpha characters
L_COSTn
(Optional) Cost per item, excluding tax.
Character length and limitations: 10 currency characters
L_PRODCODEn
(Optional) Supplier-specific product code.
Character length and limitations: 12 alphanumeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 10 currency characters
L_AMTn
(Required) Total line item amount including tax and discount. + for debit, - for
credits.
Character length and limitations: 10 currency characters
L_TAXAMTn
(Optional) Line item tax amount.
Character length and limitations: 10 currency characters
Example FDMS South Purchasing Card Level 2 and 3 Parameter String
TRXTYPE=S&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P
WD=x1y2z3&BILLTOSTATE=CA&BILLTOFIRSTNAME=John&BILLTOLASTNAME=Smith&BILLTOCI
TY=Redwood&SHIPTOCOUNTRY=USA&CUSTCODE=12345&DISCOUNT=.25&DUTYAMT=34.00&FREI
GHTAMT=12.00&INVNUM=123456789&ORDERDATE=021700&PONUM=1234567890123456789012
345&SHIPFROMZIP=940151234&SHIPTOZIP=94065&TAXAMT=1.00&TAXEXEMPT=Y
Example FDMS South Line Item Parameter String
TRXTYPE=S&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P
WD=x1y2z3&BILLTOSTATE=CA&BILLTOFIRSTNAME=John&BILLTOLASTNAME=Smith&BILLTOCI
TY=Redwood&SHIPTOCOUNTRY=USA&CUSTCODE=12345&DISCOUNT=.25&DUTYAMT=34.00&FREI
GHTAMT=12.00&INVNUM=123456789&ORDERDATE=021700&PONUM=1234567890123456789012
345&SHIPFROMZIP=940151234&SHIPTOZIP=94065&TAXAMT=1.00&TAXEXEMPT=Y&L_QTY1=1&
L_UPC1=PN&L_DESC1=Test&L_UOM1=INQ&L_COST1=1.00&L_PRODCODE1=12345&L_DISCOUNT
1=.25&&L_AMT1=.75&L_TAXAMT1=0
166
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Global Payments - Central Purchasing Card Transaction Processing
C
Global Payments - Central Purchasing Card Transaction
Processing
Global Payments - Central (MAPP) supports Level 2 parameters for MasterCard, and Visa
sale, credit, and delayed capture transactions.
Global Payments - Central Level 2 Parameters
Pass the following Level 2 parameters to get the discount rate.
Global Payments - Central Level 2 parameters
Level 2 Parameters
Description
CUSTCODE
(Required) Customer code.
Character length and limitations: 1 to 16 alphanumeric characters
TAXAMT
(Required) Sales tax.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
Example Global Payments - Central Level 2 Visa or MasterCard Transaction
Parameter String
TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1209&BILLTOFIRSTNAME=Cardholder First Name&BILLTOLASTNA
ME=Cardholder Last Name&PARTNER=PayPal&PWD=pwd&BILLTOSTATE=CA&BILLTOSTREET=
123 Main St.&TENDER=C&USER=user&BILLTOZIP=94043&CUSTCODE=123456&TAXAMT=1.34
Global Payments - East Purchasing Card Transaction
Processing
Global Payments - East supports Level 2 parameters for American Express, MasterCard, and
Visa.
Global Payments - East Level 2 Parameters
Pass the following Level 2 parameters in authorization and sale transactions to get the discount
rate.
Gateway Developer Guide and Reference
07 February 2013
167
C
Submitting Purchasing Card Level 2 and 3 Transactions
Heartland Purchasing Card Transaction Processing
Level 2 Parameters
Description
CUSTCODE
(Required) Customer code.
Character length and limitations: 1 to 16 alphanumeric characters
TAXAMT
(Required) Sales tax.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
Example Global Payments - East Level 2 Visa or MasterCard Transaction
Parameter String
TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1215&BILLTOFIRSTNAME=Cardholder FirstName&BILLTOLASTNAM
E=Cardholder LastName&PARTNER=PayPal&PWD=pwd&BILLTOSTATE=CA&BILLTOSTREET=12
3 Main St.&TENDER=C&USER=user&BILLTOZIP=94043&CUSTCODE=123456&TAXAMT=1.34
Global Payments - Central (MAPP) supports Level 2 for MasterCard, and Visa Sale, Credit,
and Delayed Capture transactions.
Heartland Purchasing Card Transaction Processing
Heartland Level 2 Parameters
Heartland supports MasterCard and Visa for Level 2 processing.
Heartland indicates in the authorization response whether the credit card in the transaction is a
commercial card. Based on the commercial card indicator, Payflow will format the Level 2
information in the settlement request.
Heartland Level 2 Transaction Data
To get the discount rate, pass the Level 2 values marked Required in the following table.
168
Parameter
Description
PONUM
(Required) Customer reference ID.
Character length and limitations: 1 to 16 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Heartland Purchasing Card Transaction Processing
Parameter
Description
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
TAXEXEMPT
(Optional) Tax amount identifier.
Character length and limitations: 1 alpha character, Y or N
C
Example Heartland Level 2 Visa Transaction Parameter String
TRXTYPE=S&ACCT=4111111111111111&AMT=20.02&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1215&INVNUM=661254585&BILLTOFIRSTNAME=CardHolder Name&P
ARTNER=PayPal&PWD=pwd&BILLTOSTATE=CA&BILLTOSTREET=123 Main St.&TAXAMT=1.01&
TAXEXEMPT=N&TENDER=C&USER=user&BILLTOZIP=94043
Heartland Level 3 MasterCard Parameters
To qualify for Level 3, the authorization response for the transaction must have the
commercial card indicator set and one or more line items should be present in the delayed
capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
Heartland Level 2 MasterCard Parameters Required for Level 3 Transactions
Parameter
Description
PONUM
(Required) Purchase identifier.
Character length and limitations: 25 alphanumeric characters
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
Gateway Developer Guide and Reference
07 February 2013
169
C
Submitting Purchasing Card Level 2 and 3 Transactions
Heartland Purchasing Card Transaction Processing
Parameter
Description
NATIONALTAXAMT
(Optional) National tax amount. You may omit this parameter if there is no such tax.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase Order number or customer reference ID. The PNREF value is
sent if no value is provided.
Character length and limitations: 9 alphanumeric characters
Heartland Level 3 MasterCard Extended Data
The parameters listed in the table below apply to Level 3 MasterCard transactions as extended
data.
Parameter
Description
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional) Duty amount.
Character length and limitations: 12 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
ALTTAXAMT
(Optional) Alternate tax amount.
Character length and limitations: 9 numeric characters
Heartland Level 3 MasterCard Line Item Detail Records
NOT E :
170
For these values, n is a sequence counter that should begin with 1 and increase in
sequence. Each line item should also contain quantity (L_QTYn) and unit price
(L_COSTn) fields.
Parameter
Description
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Heartland Purchasing Card Transaction Processing
Parameter
Description
L_QTYn
(Required) Quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required) Unit of measure code.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required) Unit cost.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) VAT/tax amount.
Character length and limitations: 12 numeric characters
L_TAXRATEn
(Optional) VAT/tax rate.
Character length and limitations: 4 numeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 12 numeric characters
L_AMTn
(Optional) Line-item total.
Character length and limitations: 12 numeric characters
C
Example Heartland Level 3 MasterCard Transaction Parameter String.
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000
0005&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&BILLTOZIP=94588&ALTTAX
AMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.00&NATIONALTAXAMT=1.00&COMMCODE=
22222&VATAXAMT=1.00&VATAXPERCENT=10&TAXEXEMPT=Y&DISCOUNT=1.00&FREIGHTAMT=1.
00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=840&ORDERDA
TE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 description&L_UPC1=C
BA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.00&L_TAXAMT1=1.00&L_TAXR
ATE1=1.00&L_DISCOUNT1=1.00&L_AMT1=1.00&L_TAXTYPE1=TT3
Heartland Level 3 Visa Parameters
To qualify for Level 3 transactions, the authorization response for the transaction must have
the commercial card indicator set and one or more line items should be present in the delayed
capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
Heartland Level 2 Visa Parameters Required for Level 3 Transactions
Parameter
Description
PONUM
(Required) Purchase identifier. TheTransaction ID is sent if no value is provided.
Character length and limitations: 25 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
171
C
Submitting Purchasing Card Level 2 and 3 Transactions
Heartland Purchasing Card Transaction Processing
Parameter
Description
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax amount.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional) National tax amount.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase order number/customer reference ID. The Transaction ID is
sent if no value is provided.
Character length and limitations: 9 alphanumeric characters
Heartland Level 3 Visa Extended Data
The parameters listed in the table below apply to Level 3 MasterCard transactions as extended
data.
172
Parameter
Description
COMMCODE
(Optional) Summary commodity code identifier for the business.
Character length and limitations: 4 alphanumeric characters
DISCOUNT
(Optional) Discount amount.
Character length and limitations: 12 numeric characters
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional)Duty amount.
Character length and limitations: 12 numeric characters
ORDERDATE
(Required) Order date. Format is mmddyy with no slashes or dashes. For example,
July 28, 2003 is 072803.
Character length and limitations: 6 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Heartland Purchasing Card Transaction Processing
Parameter
Description
VATREGNUM
(Required) VAT registration number. Can be part of the registration data or passed
with each transaction.
Character length and limitations: 20 alphanumeric characters
FREIGHTAMT
(Required) Unique VAT inventory reference number. Can be part of the registration
data or passed with each transaction.
Character length and limitations: 9 alphanumeric characters
CUSTVATREGNUM
(Required) Customer VAT registration number.
Character length and limitations: 13 alphanumeric characters
VATTAXAMT
(Optional) VAT/tax amount (freight/shipping).
Character length and limitations: 12 numeric characters
VATTAXPERCENT
(Optional) VAT/tax rate (freight/shipping).
Character length and limitations: 4 numeric characters
C
Heartland Level 3 Visa Line Item Detail Records
Parameter
Description
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
L_QTYn
(Required) Quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required) Unit of measure code.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required) Unit cost.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) VAT/tax amount.
Character length and limitations: 12 numeric characters
L_TAXRATEn
(Optional) VAT/tax rate.
Character length and limitations: 4 numeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 12 numeric characters
L_AMTn
(Optional) Line-item total.
Character length and limitations: 12 numeric characters
Gateway Developer Guide and Reference
07 February 2013
173
C
Submitting Purchasing Card Level 2 and 3 Transactions
Litle Purchasing Card Transaction Processing
Example Heartland Level 3 Visa Transaction Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111
1111&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&TAXAMT=1.06&BILLTOZIP=
94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.01&NATIONALTAXAMT=1.
02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXEXEMPT=N&DISCOUNT=.50&FR
EIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=
840&ORDERDATE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 descripti
on&L_UPC1=CBA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.50&L_TAXAMT1=
1.05&L_TAXRATE1=12&L_DISCOUNT1=.50&L_AMT1=1.00&L_TAXTYPE1=TT1
Litle Purchasing Card Transaction Processing
Litle Level 2 Parameters
The Litle platform supports Level 2 transaction data.
Litle Level 2 Parameters
174
Field
Description
CUSTREF
(Optional) Reference, such as a purchase order number, used by the customer for the
purchase.
Character length and limitations: 17 alphanumeric characters
DISCOUNT
(Optional) Discount amount for the order.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
DUTYAMT
(Optional) Duty amount on the total purchased for the order.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
FREIGHTAMT
(Optional) Shipping amount for the order.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
TAXAMT
(Optional) Tax amount included in the amount of the transaction.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
L_AMTn
(Optional) Amount of this line-item including tax, where n is a line-item number
from 1 to 99. L_AMTn - L_TAXAMTn = line-item total.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Litle Purchasing Card Transaction Processing
Field
Description
L_COMMCODEn
(Optional) Identifier assigned by the card acceptor that categorizes the purchased
item, where n is a line-item number from 1 to 99.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required if L_QTYn is supplied) Price of one unit of the item purchased, where n is a
line-item number from 1 to 99.
Character length and limitations: 12 numeric characters
L_DESCn
(Required) Description of this line-item, where n is a line-item number from 1 to 99.
Character length and limitations: 26 alphanumeric characters
L_DISCOUNTn
(Optional) Discount per line item, where n is a line-item number from 1 to 99.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
L_PRODCODEn
(Optional) Supplier-specific product code of the purchased item, where n is a lineitem number from 1 to 99.
Character length and limitations: 12 numeric characters
L_QTYn
(Optional) Number of items purchased, where n is a line-item number from 1 to 99.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) Line item tax amount, where n is a line-item number from 1 to 99.
L_AMTn - L_TAXAMTn = line-item total.
Characteristic length and limitations: The decimal is implied. If, for example, you
specify 500, this value is equivalent to $5.00. 8 numeric characters
L_UOMn
(Optional) Unit of measure of the purchased item (such as kit, pair, gallon or month),
where n is a line-item number from 1 to 99.
Character length and limitations: 12 alphanumeric characters
C
Litle Level 3 Parameters
The Litle platform supports Level 3 transaction data.
Litle Level 3 Parameters
Field
Description
CUSTREF
(Optional) Reference, such as a purchase order number, used by the customer for the
purchase.
Character length and limitations: 17 alphanumeric characters
DISCOUNT
(Optional) Discount amount for the order.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
DUTYAMT
(Optional) Duty amount on the total purchased for the order.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
Gateway Developer Guide and Reference
07 February 2013
175
C
176
Submitting Purchasing Card Level 2 and 3 Transactions
Litle Purchasing Card Transaction Processing
Field
Description
FREIGHTAMT
(Optional) Shipping amount for the order.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
TAXAMT
(Optional) Tax amount included in the amount of the transaction.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
L_AMTn
(Optional) Amount of this line-item including tax, where n is a line-item number
from 1 to 99. L_AMTn - L_TAXAMTn = line-item total.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
L_COMMCODEn
(Optional) Identifier assigned by the card acceptor that categorizes the purchased
item, where n is a line-item number from 1 to 99.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required if L_QTYn is supplied) Price of one unit of the item purchased, where n is a
line-item number from 1 to 99.
Character length and limitations: 12 numeric characters
L_DESCn
(Required) Description of this line-item, where n is a line-item number from 1 to 99.
Character length and limitations: 26 alphanumeric characters
L_DISCOUNTn
(Optional) Discount per line item, where n is a line-item number from 1 to 99.
Character length and limitations: The decimal is implied. If, for example, you specify
500, this value is equivalent to $5.00. 8 numeric characters
L_PRODCODEn
(Optional) Supplier-specific product code of the purchased item, where n is a lineitem number from 1 to 99.
Character length and limitations: 12 numeric characters
L_QTYn
(Optional) Number of items purchased, where n is a line-item number from 1 to 99.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) Line item tax amount, where n is a line-item number from 1 to 99.
L_AMTn - L_TAXAMTn = line-item total.
Characteristic length and limitations: The decimal is implied. If, for example, you
specify 500, this value is equivalent to $5.00. 8 numeric characters
L_UOMn
(Optional) Unit of measure of the purchased item (such as kit, pair, gallon or month),
where n is a line-item number from 1 to 99.
Character length and limitations: 12 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Merchant e-Solutions Purchasing Card Transaction Processing
C
Merchant e-Solutions Purchasing Card Transaction Processing
Merchant e-Solutions Level 2 Parameters
Merchant e-Solutions supports MasterCard and Visa for Level 2 processing.
Merchant e-Solutions indicates in the authorization response whether the credit card in the
transaction is a commercial card. Based on the commercial card indicator, Payflow will format
the Level 2 information in the settlement request.
Merchant e-Solutions Level 2 Transaction Data
To get the discount rate, Level 2 values marked as Required in the following table must be
present.
Parameter
Description
PONUM
(Required) Customer reference ID.
Character length and limitations: 1 to 16 alphanumeric characters
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
TAXEXEMPT
(Optional) Tax amount identifier.
Character length and limitations: 1 alpha character, Y or N
Example Merchant e-Solutions Level 2 Visa Transaction Parameter String
TRXTYPE=S&ACCT=4111111111111111&AMT=20.02&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1215&INVNUM=661254585&BILLTOFIRSTNAME=CardHolder Name&P
ARTNER=PayPal&PWD=pwd&BILLTOSTATE=CA&BILLTOSTREET=123 Main St.&TAXAMT=1.01&
TAXEXEMPT=N&TENDER=C&USER=user&BILLTOZIP=94043
Merchant e-Solutions Level 3 MasterCard Parameters
To qualify for Level 3, the authorization response for the transaction must have the
commercial card indicator set and one or more line items should be present in the delayed
capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
Gateway Developer Guide and Reference
07 February 2013
177
C
Submitting Purchasing Card Level 2 and 3 Transactions
Merchant e-Solutions Purchasing Card Transaction Processing
Merchant e-Solutions Level 2 MasterCard Parameters Required for Level 3
Transactions
Parameter
Description
PONUM
(Required) Purchase identifier.
Character length and limitations: 25 alphanumeric characters
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional) National tax amount. You may omit this parameter if there is no such tax.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase Order number or customer reference ID. The PNREF value is
sent if no value is provided.
Character length and limitations: 9 alphanumeric characters
Merchant e-Solutions Level 3 MasterCard Extended Data
The parameters listed in the table below apply to Level 3 MasterCard transactions as extended
data.
178
Parameter
Description
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional) Duty amount.
Character length and limitations: 12 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
ALTTAXAMT
(Optional) Alternate tax amount.
Character length and limitations: 9 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Merchant e-Solutions Purchasing Card Transaction Processing
C
Merchant e-Solutions Level 3 MasterCard Line Item Detail Records
NOT E :
For the following values, n is a sequence counter that should begin with 1 and increase
in sequence. With each line item, include the quantity (L_QTYn) and unit price
(L_COSTn) fields.
Parameter
Description
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
L_QTYn
(Required) Quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required) Unit of measure code.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required) Unit cost.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) VAT/tax amount.
Character length and limitations: 12 numeric characters
L_TAXRATEn
(Optional) VAT/tax rate.
Character length and limitations: 4 numeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 12 numeric characters
L_AMTn
(Optional) Line-item total.
Character length and limitations: 12 numeric characters
Example Merchant e-Solutions Level 3 MasterCard Transaction Parameter String.
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000
0005&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&BILLTOZIP=94588&ALTTAX
AMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.00&NATIONALTAXAMT=1.00&COMMCODE=
22222&VATAXAMT=1.00&VATAXPERCENT=10&TAXEXEMPT=Y&DISCOUNT=1.00&FREIGHTAMT=1.
00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=840&ORDERDA
TE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 description&L_UPC1=C
BA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.00&L_TAXAMT1=1.00&L_TAXR
ATE1=1.00&L_DISCOUNT1=1.00&L_AMT1=1.00&L_TAXTYPE1=TT3
Gateway Developer Guide and Reference
07 February 2013
179
C
Submitting Purchasing Card Level 2 and 3 Transactions
Merchant e-Solutions Purchasing Card Transaction Processing
Merchant e-Solutions Level 3 Visa Parameters
To qualify for Level 3 transactions, the authorization response for the transaction must have
the commercial card indicator set and one or more line items should be present in the delayed
capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
Merchant e-Solutions Level 2 Visa Parameters Required for Level 3
Transactions
Parameter
Description
PONUM
(Required) Purchase identifier. TheTransaction ID is sent if no value is provided.
Character length and limitations: 25 alphanumeric characters
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax amount.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional) National tax amount.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase order number/customer reference ID. The Transaction ID is
sent if no value is provided.
Character length and limitations: 9 alphanumeric characters
Merchant e-Solutions Level 3 Visa Extended Data
The parameters listed in the table below apply to Level 3 MasterCard transactions as extended
data.
180
Parameter
Description
COMMCODE
(Optional) Summary commodity code identifier for the business.
Character length and limitations: 4 alphanumeric characters
DISCOUNT
(Optional) Discount amount.
Character length and limitations: 12 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Merchant e-Solutions Purchasing Card Transaction Processing
Parameter
Description
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional)Duty amount.
Character length and limitations: 12 numeric characters
ORDERDATE
(Required) Order date. Format is mmddyy with no slashes or dashes. For example,
July 28, 2003 is 072803.
Character length and limitations: 6 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
VATREGNUM
(Required) VAT registration number. Can be part of the registration data or passed
with each transaction.
Character length and limitations: 20 alphanumeric characters
FREIGHTAMT
(Required) Unique VAT inventory reference number. Can be part of the registration
data or passed with each transaction.
Character length and limitations: 9 alphanumeric characters
CUSTVATREGNUM
(Required) Customer VAT registration number.
Character length and limitations: 13 alphanumeric characters
VATTAXAMT
(Optional) VAT/tax amount (freight/shipping).
Character length and limitations: 12 numeric characters
VATTAXPERCENT
(Optional) VAT/tax rate (freight/shipping).
Character length and limitations: 4 numeric characters
C
Merchant e-Solutions Level 3 Visa Line Item Detail Records
Parameter
Description
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
L_QTYn
(Required) Quantity.
Character length and limitations: 12 numeric characters
Gateway Developer Guide and Reference
07 February 2013
181
C
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing
Parameter
Description
L_UOMn
(Required) Unit of measure code.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required) Unit cost.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) VAT/tax amount.
Character length and limitations: 12 numeric characters
L_TAXRATEn
(Optional) VAT/tax rate.
Character length and limitations: 4 numeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 12 numeric characters
L_AMTn
(Optional) Line-item total.
Character length and limitations: 12 numeric characters
Example Merchant e-Solutions Level 3 Visa Transaction Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111
1111&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&TAXAMT=1.06&BILLTOZIP=
94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.01&NATIONALTAXAMT=1.
02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXEXEMPT=N&DISCOUNT=.50&FR
EIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=
840&ORDERDATE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 descripti
on&L_UPC1=CBA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.50&L_TAXAMT1=
1.05&L_TAXRATE1=12&L_DISCOUNT1=.50&L_AMT1=1.00&L_TAXTYPE1=TT1
Paymentech Salem (New Hampshire) Purchasing Card
Transaction Processing
Paymentech Salem (New Hampshire) Level 2 Parameters for American
Express
The Paymentech Salem (New Hampshire) platform supports Level 2 parameters for American
Express, MasterCard, Visa, and Switch/Solo Maestro. The parameters in the following tables
meet card acceptance and American Express reporting and statement requirements.
CPC Level 2 Transaction Advice Addendum Parameters
182
Field
Description
PONUM
(Required) Purchase order number.
Character length and limitations: 17 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing
Field
Description
SHIPTOZIP
(Required) Ship-to postal code (called zip code in the USA).
Character length and limitations: 15 alphanumeric characters
TAXAMT
(Optional) Total tax amount. Must include a decimal and be exact to the cent (42.00,
not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_DESC1
(Optional) Description of this line item; if not provided, DESC1 (if present) is used.
Character length and limitations: 140 alphanumeric characters
L_AMT1
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY1
(Optional) Quantity of this line item.
Character length and limitations: 3 numeric characters
L_DESC2
(Optional) Description of this line item; if not provided, DESC2 (if present) is used.
Character length and limitations: 40 alphanumeric characters
L_AMT2
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY2
(Optional) Quantity of this line item
Character length and limitations: 3 numeric characters
L_DESC3
(Optional) Description of this line item; if not provided, DESC3 (if present) is used
Character length and limitations: 40 alphanumeric characters
L_AMT3
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY3
(Optional) Quantity of this line item
Character length and limitations: 3 numeric characters
L_DESC4
(Optional) Description of this line item; if not provided, DESC4 (if present) is used
Character length and limitations: 30 alphanumeric characters
L_AMT4
(Optional) Charge for this line item. Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56).
Character length and limitations: 12 numeric characters
L_QTY4
(Optional) Quantity of this line item
Character length and limitations: 3 numeric characters
Gateway Developer Guide and Reference
07 February 2013
C
183
C
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing
Location Transaction Advice Addendum Parameters
Field
Description
MERCHANTNAME
(Optional) Name of merchant.
Character length and limitations: 38 alphanumeric characters
MERCHANTSTREET
(Optional) Merchant’s street address (number and street name).
Character length and limitations: 38 alphanumeric characters. If more than 38
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTCITY
(Optional) The name of the city were the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another
entity), you must enter the name of the city in which the seller is located.
If you are a mail order, phone order, or internet industry, you may substitute the
name of the city in which the merchant’s order processing facility is located.
Character length and limitations: 21 alphanumeric characters. If more than 21
characters, use proper and meaningful abbreviation. Do not truncate.
MERCHANTSTATE
(Optional) The region code that corresponds to the state, province, or country
subdivision of the merchant location where the transaction took place.
Region code examples:
CA = California, USA
NS = Nova Scotia, Canada
COS = Colima Mexico
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the region code that corresponds to the state, province, or country
subdivision in which the seller is located.
Character length and limitations: 3 alphanumeric characters
MERCHANTZIP
(Optional) The 5- to 9-digit zip (postal) code excluding spaces, dashes, and nonnumeric characters where the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the postal code that corresponds to the seller’s location.
Character length and limitations; 15 alphanumeric characters
MERCHANTCOUNTRYCODE
(Optional) Country code of the location where the transaction took place.
Character length and limitations: 3 alphanumeric characters
MERCHANTLOCATIONID
(Optional)Merchant-assigned store or location number (or name) that uniquely
identifies where the transaction took place.
N O TE :
Paymentech must enable your division for soft merchant processing or your
transaction will fail with response reason code 258. Contact your Paymentech
Account Manager for details.
Character length and limitations: 15 alphanumeric characters
184
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing
Field
Description
MERCHANTID
(Required) American Express-assigned service establishment number used to identify
and facilitate payments to merchants.
N O TE :
C
Paymentech must enable your division for soft merchant processing or your
transaction will fail with response reason code 258. Contact your Paymentech
Account Manager for details.
Character length and limitations: 15 alphanumeric characters
MERCHANTCONTACTINFO
(Optional) Merchant’s telephone number or web address. (URLs and e-mail addresses
may be lowercase, as appropriate.) This entry may appear on the descriptive bill on
the card-member’s statement, or may be used to resolve billing inquiries and disputes.
N O TE :
Paymentech must enable your division for soft merchant processing or your
transaction will fail with response reason code 258. Contact your Paymentech
Account Manager for details.
Character length and limitations: 40 alphanumeric characters
Transaction Advice Detail Parameters
Field
Description
ADDLAMTn
(Optional) Detail of a charge where n is a value from 1 - 5. Use for additional
breakdown of the amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
ADDLAMTTYPEn
(Optional) A 3-digit code indicating the type of the corresponding charge detail,
where n is a value from 1 - 5.
Character length and limitations: 3 numeric characters
Paymentech Salem (New Hampshire) Level 3 Purchasing Card Parameters
Paymentech Salem (New Hampshire) supports Level 3 parameters for MasterCard and Visa.
Both Level 2 transaction parameters in the following table are required for Level 3
transactions. Level 3 transactions that do not include them are rejected.
Paymentech Salem (New Hampshire) Level 2 Parameters Required for Level 3
Transactions
To get the discount rate, pass both Level 2 parameters in the following table.
Level 2 Parameters Required for Level 3 Transactions
Parameter
Description
PONUM
(Required) Customer reference number.
Character length and limitations: 1 to 17 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
185
C
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing
Parameter
Description
TAXAMT
(Required) Sales tax.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
Paymentech Salem (New Hampshire) Level 3 MasterCard Parameters
Level 3 MasterCard Order Parameters
Parameter
Description
FREIGHTAMT
(Required) Freight amount.
Character length and limitations: numeric
DUTYAMT
(Required) Duty amount.
Character length and limitations: numeric
SHIPTOZIP
(Required) Destination zip code.
SHIPTOCOUNTRY
(Optional) Destination country.
SHIPFROMZIP
(Required) Ship from zip code.
DISCOUNT
(Required) Discount amount.
Character length and limitations: numeric
ALTERNATETAXID
(Optional) Alternate tax ID.
ALTERNATETAXAMT
(Optional) Alternate tax amount.
Character length and limitations: numeric
. Level 3 MasterCard Line Item Record #1 Parameters
186
Parameter
Description
L_DESCn
(Required) Description.
L_PRODCODEn
(Optional) Product code.
L_QTYn
(Required) Quantity.
Character length and limitations: numeric characters
L_UOMn
(Required) Unit of measure.
TAXAMTn
(Optional) Tax amount.
Character length and limitations: numeric
L_TAXRATEn
(Optional) Tax rate.
Character length and limitations: 4 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing
C
. Level 3 MasterCard Line Item Record #2 Parameters
Parameter
Description
L_AMTn
(Optional) Line-item total.
Character length and limitations: numeric
L_DISCOUNTn
(Optional) Discount amount.
Character length and limitations: numeric
L_TAXTYPEn
(Optional) Tax type applied.
Paymentech Salem (New Hampshire) Level 3 Visa Parameters
Level 3 Visa Order Parameters
Parameter
Description
FREIGHTAMT
(Required) Freight amount.
Character length and limitations: numeric
DUTYAMT
(Required) Duty amount.
Character length and limitations: numeric
SHIPTOZIP
(Required) Destination zip code.
SHIPTOCOUNTRY
(Optional) Destination country.
SHIPFROMZIP
(Required) Ship from zip code.
DISCOUNT
(Required) Discount amount.
Character length and limitations: numeric
TAXAMT
(Optional) VAT/Tax ID.
Character length and limitations: numeric
TAXPERCENTAGE
(Optional) VAT/Tax amount.
. Level 3 Visa Line Item Record #1 Parameters
Parameter
Description
L_DESCn
(Required) Description.
L_PRODCODEn
(Required) Product code.
L_QTYn
(Required) Quantity.
Character length and limitations: numeric characters
L_UOMn
(Required) Unit of measure.
TAXAMTn
(Optional) Tax amount.
Character length and limitations: numeric
L_TAXRATEn
(Optional) Tax rate.
Character length and limitations: 4 numeric characters
Gateway Developer Guide and Reference
07 February 2013
187
C
Submitting Purchasing Card Level 2 and 3 Transactions
Paymentech Tampa Level 2 Purchasing Card Transaction Processing
. Level 3 Visa Line Item Record #2 Parameters
Parameter
Description
L_AMTn
(Optional) Line-item total.
Character length and limitations: numeric
L_DISCOUNTn
(Optional) Discount amount.
Character length and limitations: numeric
L_UPCn
(Optional) Item commodity code.
L_COSTn
(Optional) Unit cost.
Character length and limitations: numeric
Example Paymentech Salem (New Hampshire) Level 3 MasterCard Transaction
Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&PWD=Password&USER=User&ACCT=548018000000
0024&EXPDATE=1215&AMT=1.00&COMMENT1=0508&BILLTOFIRSTNAME=Robert&BILLTOSTREE
T=123 Main St.&BILLTOZIP=94065&CVV2=426&PONUM=ABCDEFGHIJ&TAXAMT=1.00&FREIGH
TAMT=2.00&DUTYAMT=3.00&SHIPTOZIP=94543&SHIPTOCOUNTRY=840&SHIPFROMZIP=94509&
ALTERNATETAXID=10&ALTERNATETAXAMT=4.00&L_DESC1=MC Pcard&L_UPC1=1&L_QTY1=2&L
_UOM1=3&L_TAXAMT1=4&L_TAXRATE1=5&L_AMT1=6&L_DISCOUNT1=7&L_TAXTYPE1=8
Example Paymentech Salem (New Hampshire) Level 3 Visa Transaction
Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&PWD=Password&USER=User&ACCT=427533001234
5626&EXPDATE=1215&AMT=1.00&COMMENT1=0508&BILLTOFIRSTNAME=Robert&BILLTOSTREE
T=123 Main St.&BILLTOZIP=94065&CVV2=426&PONUM=ABCDEFGHIJ&TAXAMT=1.00&FREIGH
TAMT=2.00&DUTYAMT=3.00&SHIPTOZIP=94543&SHIPTOCOUNTRY=840&SHIPFROMZIP=94509&
DISCOUNT=4.00&VATAXAMT=5.00&VATAXPERCENT=10&L_DESC1=TSYS Acquiring Solution
s Pcard&L_UPC1=1&L_UOM1=2&L_QTY1=3&L_TAXAMT1=4&L_TAXRATE1=5&L_AMT1=6&L_DISC
OUNT1=7&L_COMMCODE1=8&L_COST1=9&L_COST1=10
Paymentech Tampa Level 2 Purchasing Card Transaction
Processing
Paymentech Tampa supports Level 2 purchasing card processing for MasterCard and Visa.
188
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
SecureNet Purchasing Card Transaction Processing
C
Paymentech Tampa Level 2 Parameters
Paymentech Tampa
Level 2 Parameters
Description
PONUM
(Required) Customer reference number.
Character length and limitations: 1 to 17 alphanumeric characters
TAXAMT
(Required) Sales tax.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
TAXEXEMPT
(Required) Tax exempt.
Character length and limitations: 1 alphanumeric character, Y or N
SHIPTOZIP
(Required) Ship-to postal code (called zip code in the USA).
Character length and limitations: 1 to 16 alphanumeric characters
Example Paymentech Tampa Level 2 Visa and MasterCard Transaction
Parameter String
TRXTYPE=S&TENDER=C&PWD=PWD&USER=USER&PARTNER=PARTNER&ACCT=4275330012345675&
EXPDATE=1215&AMT=12.59&VERBOSITY=HIGH&BILLTOSTREET=123 Main St.&BILLTOZIP=4
9801&CVV2=248&TAXAMT=1.22&PONUM=AB12345678&SHIPTOZIP=98765&TAXEXEMPT=N
SecureNet Purchasing Card Transaction Processing
SecureNet supports MasterCard and Visa for performing Level 2 and Level 3 purchasing card
transactions.
SecureNet Level 2 Parameters
SecureNet supports MasterCard and Visa for Level 2 purchasing card transactions.
SecureNet indicates in the authorization response whether the credit card in the transaction is a
commercial card. Based in the commercial card indicator, Payflow will format the Level 2
information in the settlement request.
To get the discount rate, Level 2 parameters marked as Required in the following table must be
present .
Gateway Developer Guide and Reference
07 February 2013
189
C
Submitting Purchasing Card Level 2 and 3 Transactions
SecureNet Purchasing Card Transaction Processing
SecureNet Level 2 Parameters
Parameter
Description
PONUM
(Required) Customer reference ID.
Character length and limitations: 1 to 17 alphanumeric characters
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
TAXEXEMPT
(Optional) Tax amount identifier.
Character length and limitations: 1 alpha character, Y or N
Example SecureNet Level 2 Visa Transaction Parameter String.
TRXTYPE=S&ACCT=4111111111111111&AMT=20.02&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1215&INVNUM=661254585&BILLTOFIRSTNAME=CardHolder First
Name&BILLTOLASTNAME=CardHolder Last Name&PARTNER=PayPal&PWD=pwd&BILLTOSTATE
=CA&BILLTOSTREET=123 Main St.&TAXAMT=1.01&TAXEXEMPT=N&TENDER=C&USER=user&BI
LLTOZIP=94043
SecureNet Level 3 MasterCard Parameters
To qualify for Level 3 purchasing card transaction processing, the authorization response for
the transaction must have the commercial card indicator set and one or more line items should
be present in the delayed capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
SecureNet Level 2 MasterCard Parameters Required for Level 3 Line Item
Transactions
190
Parameter
Description
PONUM
(Required) Purchase identifier. The transaction ID is sent if no value is provided.
Character length and limitations: 25 alphanumeric characters
TAXAMT
(Required)Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax.
Character length and limitations: 12 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
SecureNet Purchasing Card Transaction Processing
Parameter
Description
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional)National tax amount.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase order number/customer reference ID. The value of PNREF is sent
if the INVNUM parameter is not provided.
Character length and limitations: 9 alphanumeric characters
C
SecureNet Level 3 MasterCard Extended Data
The parameters listed in the table below apply to Level 3 MasterCard transactions as extended
data.
Parameter
Description
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional) Duty amount.
Character length and limitations: 12 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
ALTTAXAMT
(Optional) Alternate tax amount.
Character length and limitations: 9 numeric characters
SecureNet Level 3 MasterCard Line Item Detail Records
NOT E :
For these values, n is a sequence counter that should begin with 1 and increase in
sequence. Each line item should also contain quantity (L_QTY) and unit price
(L_COST) fields.
Parameter
Description
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
191
C
Submitting Purchasing Card Level 2 and 3 Transactions
SecureNet Purchasing Card Transaction Processing
Parameter
Description
L_QTYn
(Required) Quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required)Unit of measure/code.
Character length and limitations: 12 alphanumeric characters
L_TAXRATEn
(Optional) Tax rate applied.
Character length and limitations: 4 numeric characters
L_TAXTYPEn
(Optional) Tax type applied.
Character length and limitations: 4 alphanumeric characters
L_TAXAMTn
(Optional)Tax amount.
Character length and limitations: 12 numeric characters
L_DISCOUNTn
(Optional) Discount amount.
Character length and limitations: 12 numeric characters
Example SecureNet Level 3 MasterCard Transaction Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000
0005&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&BILLTOZIP=94588&ALTTAX
AMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.00&NATIONALTAXAMT=1.00&COMMCODE=
22222&VATAXAMT=1.00&VATAXPERCENT=10&TAXEXEMPT=Y&DISCOUNT=1.00&FREIGHTAMT=1.
00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=840&ORDERDA
TE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 description&L_UPC1=C
BA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.00&L_TAXAMT1=1.00&L_TAXR
ATE1=1.00&L_DISCOUNT1=1.00&L_AMT1=1.00&L_TAXTYPE1=TT3
SecureNet Acquiring Solutions Level 3 Visa Parameters
To qualify for Level 3 purchasing card transaction processing, the authorization response for
the transaction must have the commercial card indicator set and one or more line items should
be present in the delayed capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
SecureNet Level 2 Visa Parameters for Level 3 Line Item Transactions
192
Parameter
Description
PONUM
(Required) Purchase identifier. The transaction ID is sent if no value is provided.
Character length and limitations: 25 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
SecureNet Purchasing Card Transaction Processing
Parameter
Description
TAXAMT
(Required)Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional)National tax amount.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase order number/customer reference ID. The value of PNREF is sent
if the INVNUM parameter is not provided.
Character length and limitations: 9 alphanumeric characters
C
SecureNet Level 3 Visa Extended Data
The parameters listed in the table below apply to Level 3 Visa transactions as extended data.
Parameter
Description
COMMCODE
(Optional) Commodity code identifier for the business.
Character length and limitations: 4 alphanumeric characters
DISCOUNT
(Optional) Discount amount.
Character length and limitations: 12 numeric characters
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional) Duty amount.
Character length and limitations: 12 numeric characters
ORDERDATE
(Required) Order date. The format is mmddyy with no slashes or dashes. For example,
July 28, 2003 is 072803.
Character length and limitations: 6 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
193
C
Submitting Purchasing Card Level 2 and 3 Transactions
SecureNet Purchasing Card Transaction Processing
Parameter
Description
VATREGNUM
(Required) VAT registration number. Can be part of the registration data or passed
with each transaction.
Character length and limitations: 20 alphanumeric characters
FREIGHTAMT
(Required) Unique VAT inv reference number. Can be part of the registration data or
passed with each transaction.
Character length and limitations: 9 alphanumeric characters
CUSTVATREGNUM
(Required) Customer VAT Registration Number.
Character length and limitations: 13 alphanumeric characters
VATTAXAMT
(Optional)VAT/tax amount (freight/shipping).
Character length and limitations: 12 numeric characters
VATTAXPERCENT
(Optional) VAT/tax rate (freight/shipping).
Character length and limitations: 4 numeric characters
SecureNet Level 3 Visa Line Item Detail Records
NOT E :
194
For these values, n is a sequence counter that should begin with 1 and increase in
sequence. Each line item should also contain quantity (L_QTYn) and unit price
(L_COSTn) fields.
Parameter
Description
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
L_QTYn
(Required) Item quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required) Unit of measure/code.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required) Unit cost.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) VAT/tax amount.
Character length and limitations: 12 numeric characters
L_TAXRATEn
(Optional) VAT/tax rate.
Character length and limitations: 4 numeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 12 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
TSYS Acquiring Solutions Purchasing Card Transaction Processing
Parameter
Description
L_AMTn
(Optional) Line-item total.
Character length and limitations: 12 numeric characters
C
Example SecureNet Level 3 Visa Transaction Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111
1111&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&TAXAMT=1.06&BILLTOZIP=
94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.01&NATIONALTAXAMT=1.
02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXEXEMPT=N&DISCOUNT=.50&FR
EIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=
840&ORDERDATE=081125&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 descripti
on&L_UPC1=CBA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.50&L_TAXAMT1=
1.05&L_TAXRATE1=12&L_DISCOUNT1=.50&L_AMT1=1.00&L_TAXTYPE1=TT1
TSYS Acquiring Solutions Purchasing Card Transaction
Processing
TSYS Acquiring Solutions supports MasterCard and Visa for performing Level 2 and Level 3
purchasing card transactions.
TSYS Acquiring Solutions Level 2 Parameters
TSYS Acquiring Solutions supports MasterCard and Visa for Level 2 purchasing card
transactions.
TSYS Acquiring Solutions indicates in the authorization response whether the credit card in
the transaction is a commercial card. Based in the commercial card indicator, Payflow will
format the Level 2 information in the settlement request.
To get the discount rate, Level 2 parameters marked as required in the following table must be
present .
TSYS Acquiring Solutions Level 2 Parameters
Parameter
Description
PONUM
(Required) Customer reference ID.
Character length and limitations: 1 to 17 alphanumeric characters
TAXAMT
(Required) Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
Gateway Developer Guide and Reference
07 February 2013
195
C
Submitting Purchasing Card Level 2 and 3 Transactions
TSYS Acquiring Solutions Purchasing Card Transaction Processing
Parameter
Description
TAXEXEMPT
(Optional) Tax amount identifier.
Character length and limitations: 1 alpha character, Y or N
Example TSYS Acquiring Solutions Level 2 Visa Transaction Parameter String.
TRXTYPE=S&ACCT=4111111111111111&AMT=20.02&BILLTOCITY=Mountain View&COMMENT1
=L2 Testing&EXPDATE=1215&INVNUM=661254585&BILLTOFIRSTNAME=CardHolder First
Name&BILLTOLASTNAME=CardHolder Last Name&PARTNER=PayPal&PWD=pwd&BILLTOSTATE
=CA&BILLTOSTREET=123 Main St.&TAXAMT=1.01&TAXEXEMPT=N&TENDER=C&USER=user&BI
LLTOZIP=94043
TSYS Acquiring Solutions Level 3 MasterCard Parameters
To qualify for Level 3 purchasing card transaction processing, the authorization response for
the transaction must have the commercial card indicator set and one or more line items should
be present in the delayed capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
TSYS Acquiring Solutions Level 2 MasterCard Parameters Required for Level 3
Line Item Transactions
196
Parameter
Description
PONUM
(Required) Purchase identifier. The transaction ID is sent if no value is provided.
Character length and limitations: 25 alphanumeric characters
TAXAMT
(Required)Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional)National tax amount.
Character length and limitations: 12 numeric characters
INVNUM
(Required) Purchase order number/customer reference ID. The value of PNREF is sent
if the INVNUM parameter is not provided.
Character length and limitations: 9 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
TSYS Acquiring Solutions Purchasing Card Transaction Processing
C
TSYS Acquiring Solutions Level 3 MasterCard Extended Data
The parameters listed in the table below apply to Level 3 MasterCard transactions as extended
data.
Parameter
Description
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional) Duty amount.
Character length and limitations: 12 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
ALTTAXAMT
(Optional) Alternate tax amount.
Character length and limitations: 9 numeric characters
TSYS Acquiring Solutions Level 3 MasterCard Line Item Detail Records
NOT E :
For these values, n is a sequence counter that should begin with 1 and increase in
sequence. Each line item should also contain quantity (L_QTY) and unit price
(L_COST) fields.
Parameter
Description
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
L_QTYn
(Required) Quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required)Unit of measure/code.
Character length and limitations: 12 alphanumeric characters
L_TAXRATEn
(Optional) Tax rate applied.
Character length and limitations: 4 numeric characters
L_TAXTYPEn
(Optional) Tax type applied.
Character length and limitations: 4 alphanumeric characters
L_TAXAMTn
(Optional)Tax amount.
Character length and limitations: 12 numeric characters
Gateway Developer Guide and Reference
07 February 2013
197
C
Submitting Purchasing Card Level 2 and 3 Transactions
TSYS Acquiring Solutions Purchasing Card Transaction Processing
Parameter
Description
L_DISCOUNTn
(Optional) Discount amount.
Character length and limitations: 12 numeric characters
Example TSYS Acquiring Solutions Level 3 MasterCard Transaction Parameter
String
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000
0005&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&BILLTOZIP=94588&ALTTAX
AMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.00&NATIONALTAXAMT=1.00&COMMCODE=
22222&VATAXAMT=1.00&VATAXPERCENT=10&TAXEXEMPT=Y&DISCOUNT=1.00&FREIGHTAMT=1.
00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=840&ORDERDA
TE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 description&L_UPC1=C
BA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.00&L_TAXAMT1=1.00&L_TAXR
ATE1=1.00&L_DISCOUNT1=1.00&L_AMT1=1.00&L_TAXTYPE1=TT3
TSYS Acquiring Solutions Level 3 Visa Parameters
To qualify for Level 3 purchasing card transaction processing, the authorization response for
the transaction must have the commercial card indicator set and one or more line items should
be present in the delayed capture or sale request.
Level 2 transaction parameters marked as Required are required for Level 3 transactions.
Level 3 transactions that do not include the required Level 2 values are rejected.
IM PORT AN T :
The values required for Level 3 status vary by bank, so contact your bank for
details.
TSYS Acquiring Solutions Level 2 Visa Parameters for Level 3 Line Item
Transactions
198
Parameter
Description
PONUM
(Required) Purchase identifier. The transaction ID is sent if no value is provided.
Character length and limitations: 25 alphanumeric characters
TAXAMT
(Required)Tax amount.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: numeric
LOCALTAXAMT
(Optional) Local tax.
Character length and limitations: 12 numeric characters
TAXEXEMPT
(Optional) Local tax incl flag.
Character length and limitations: 1 alphanumeric, Y or N
NATIONALTAXAMT
(Optional)National tax amount.
Character length and limitations: 12 numeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
TSYS Acquiring Solutions Purchasing Card Transaction Processing
Parameter
Description
INVNUM
(Required) Purchase order number/customer reference ID. The value of PNREF is sent
if the INVNUM parameter is not provided.
Character length and limitations: 9 alphanumeric characters
C
TSYS Acquiring Solutions Level 3 Visa Extended Data
The parameters listed in the table below apply to Level 3 Visa transactions as extended data.
Parameter
Description
COMMCODE
(Optional) Commodity code identifier for the business.
Character length and limitations: 4 alphanumeric characters
DISCOUNT
(Optional) Discount amount.
Character length and limitations: 12 numeric characters
FREIGHTAMT
(Optional) Freight amount.
Character length and limitations: 12 numeric characters
DUTYAMT
(Optional) Duty amount.
Character length and limitations: 12 numeric characters
ORDERDATE
(Required) Order date. The format is yymmdd with no slashes or dashes. For example,
January 28, 2013 is 130128.
Character length and limitations: 6 numeric characters
SHIPTOZIP
(Required) The zip code of the address to which the goods are shipped.
Character length and limitations: 10 alphanumeric characters
SHIPFROMZIP
(Required) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 10 alphanumeric characters
SHIPTOCOUNTRY
(Optional) Destination country code.
Character length and limitations: 3 alphanumeric characters
VATREGNUM
(Required) VAT registration number. Can be part of the registration data or passed
with each transaction.
Character length and limitations: 20 alphanumeric characters
FREIGHTAMT
(Required) Unique VAT inv reference number. Can be part of the registration data or
passed with each transaction.
Character length and limitations: 9 alphanumeric characters
CUSTVATREGNUM
(Required) Customer VAT Registration Number.
Character length and limitations: 13 alphanumeric characters
VATTAXAMT
(Optional)VAT/tax amount (freight/shipping).
Character length and limitations: 12 numeric characters
VATTAXPERCENT
(Optional) VAT/tax rate (freight/shipping).
Character length and limitations: 4 numeric characters
Gateway Developer Guide and Reference
07 February 2013
199
C
Submitting Purchasing Card Level 2 and 3 Transactions
TSYS Acquiring Solutions Purchasing Card Transaction Processing
TSYS Acquiring Solutions Level 3 Visa Line Item Detail Records
NOT E :
For these values, n is a sequence counter that should begin with 1 and increase in
sequence. Each line item should also contain quantity (L_QTYn) and unit price
(L_COSTn) fields.
Parameter
Description
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12 alphanumeric characters
L_DESCn
(Required) Item descriptor.
Character length and limitations: 35 alphanumeric characters
L_UPCn
(Optional) Product code.
Character length and limitations: 12 alphanumeric characters
L_QTYn
(Required) Item quantity.
Character length and limitations: 12 numeric characters
L_UOMn
(Required) Unit of measure/code.
Character length and limitations: 12 alphanumeric characters
L_COSTn
(Required) Unit cost.
Character length and limitations: 12 numeric characters
L_TAXAMTn
(Optional) VAT/tax amount.
Character length and limitations: 12 numeric characters
L_TAXRATEn
(Optional) VAT/tax rate.
Character length and limitations: 4 numeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 12 numeric characters
L_AMTn
(Optional) Line-item total.
Character length and limitations: 12 numeric characters
Example TSYS Acquiring Solutions Level 3 Visa Transaction Parameter String
TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111
1111&EXPDATE=1215&AMT=1.00&BILLTOSTREET=5199 JOHNSON&TAXAMT=1.06&BILLTOZIP=
94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.01&NATIONALTAXAMT=1.
02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXEXEMPT=N&DISCOUNT=.50&FR
EIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&SHIPTOCOUNTRY=
840&ORDERDATE=130125&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 descripti
on&L_UPC1=CBA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.50&L_TAXAMT1=
1.05&L_TAXRATE1=12&L_DISCOUNT1=.50&L_AMT1=1.00&L_TAXTYPE1=TT1
200
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
Vantiv Purchasing Card Transaction Processing
C
Vantiv Purchasing Card Transaction Processing
The following parameters are recommended to obtain the best rates for Level 2 and Level 3
purchasing card transactions with Vantiv.
Vantiv Purchasing Parameters
Field
Description
SHIPTOCOUNTRY
(Optional) Destination country code. Visa and MasterCard are different.
Character length and limitations: 3 alpha characters
DISCOUNT
(Optional) Discount amount on total sale
Character length and limitations: 10 currency characters
DUTYAMT
(Optional) Sometimes called import tax. If the currency uses a decimal, then the
value must include a decimal and the exact amount to the cent (42.00, not 42). Do
not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
FREIGHTAMT
Character length and limitations: 10 currency characters
PONUM
(Optional) Purchase order number / merchant-related data.
Character length and limitations: 25 alphanumeric characters, provides best rate when
used
SHIPFROMZIP
(Optional) The postal code (called zip code in the USA) from which shipping occurs.
Character length and limitations: 9 numeric characters, provides best rate when used
SHIPTOZIP
(Optional) Ship to postal code (called zip code in the USA).
Character length and limitations: 9 numeric characters, provides best rate when used
TAXAMT
(Optional) Tax amount. The value must include a decimal and the exact amount to the
cent (42.00, not 42). Do not include comma separators (1234.56 not 1,234.56).
Character length and limitations: 10 currency characters
Vantiv Purchasing Card Line Item Parameters
Line item data (Level 3) describes the details of the item purchased and can be passed for each
transaction. The convention for passing line item data in name-value pairs is that each namevalue starts with L_ and ends with n where n is the line item number. For example L_QTY0=1
is the quantity for line item 0 and is equal to 1, with n starting at 0. In addition, the
SHIPFROMZIP parameter is required for Level 3 transactions.
Gateway Developer Guide and Reference
07 February 2013
201
C
Submitting Purchasing Card Level 2 and 3 Transactions
WorldPay Purchasing Cards Transaction Processing
Vantiv Line Item Parameters
Field
Description
L_QTYn
(Required) Quantity (whole units only).
Character length and limitations: 10 numeric characters
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 12alphanumeric characters
L_DESCn
(Optional) Item description.
Character length and limitations: 35 alphanumeric characters
L_UOMn
(Optional) Item unit of measure.
Character length and limitations: 3 alpha characters
L_COSTn
(Optional) Cost per item, excluding tax.
Character length and limitations: 10 currency characters
L_UPCn
(Optional) Supplier specific product code.
Character length and limitations: 12 alphanumeric characters
L_DISCOUNTn
(Optional) Discount per line item.
Character length and limitations: 10 currency characters
L_AMTn
(Optional) Total line item amount including tax and discount. + for debit, - for credits.
Character length and limitations: 10 currency characters
L_TAXAMTn
(Optional) Line item tax amount.
Character length and limitations: 10 currency characters
WorldPay Purchasing Cards Transaction Processing
The following parameters are recommended to obtain the best rates for Level 2 and Level 3
purchasing card transactions with WorldPay.
WorldPay Level 2 Parameters
Pass the following WorldPay Level 2 parameters to get the discount rate.
WorldPay Level 2 parameters
202
Level 2 Parameters
Description
ALTTAXAMT
(Optional) Alternate tax amount.
Character length and limitations: 8 alphanumeric characters
COMMCODE
(Optional) Summary commodity code identifier for the business.
Character length and limitations: 4 alphanumeric characters
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
WorldPay Purchasing Cards Transaction Processing
Level 2 Parameters
Description
COUNTRYCODE
(Optional) Country code.
Character length and limitations: 3 alphanumeric characters
CUSTDATA
(Optional) Generic data the merchant can pass to the WorldPay processor.
Character length and limitations: 95 alphanumeric characters
CUSTOMERID
(Optional) Purchase order number.
Character length and limitations: 95 alphanumeric characters
CUSTOMERNUMBER
(Optional) Customer number.
Character length and limitations: 95 alphanumeric characters
DISCOUNT
(Optional) Discount amount on total sale.
Character length and limitations: 10 currency characters
DLNAME
(Optional) Account holder’s driver license name.
Character length and limitations: 95characters
DLNUM
(Optional) Account holder’s driver license number.
Character length and limitations: 95 alphanumeric characters
DOB
(Optional) Account holder’s date of birth in the format MMDDYYYY. For example, July
28, 2011 is represented as: 07282011
Character length and limitations: 8 characters
DUTYAMT
(Optional) Sometimes called import tax.
Character length and limitations: The value must include a decimal and the exact
amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not
1,234.56). 10 currency characters
FREIGHTAMT
(Optional) Total freight amount.
Character length and limitations: The value must include a decimal and the exact
amount to the cent (42.00, not 42). Do not include comma separators (1234.56 not
1,234.56). 10 currency characters
INVNUM
(Optional) Merchant invoice number for the transaction.
Character length and limitations: 95 alphanumeric characters
MERCHANTDESCR
(Optional) Description of product.
Character length and limitations: 50 alphanumeric characters
MERCHANTINVNUM
(Optional) Merchant invoice number.
Character length and limitations: 25 alphanumeric characters
MERCHANTVATNUM
(Optional) Merchant value added tax number.
Character length and limitations: 95 alphanumericcharacters
MERCHANTZIP
(Optional) 5- to 9-digit zip (postal) code excluding spaces, dashes, and nonnumeric
characters where the transaction took place.
If you are a third-party biller (bill for services or goods rendered by another entity),
you must enter the postal code that corresponds to the seller’s location.
Character length and limitations: 15 alphanumeric characters
Gateway Developer Guide and Reference
07 February 2013
C
203
C
Submitting Purchasing Card Level 2 and 3 Transactions
WorldPay Purchasing Cards Transaction Processing
Level 2 Parameters
Description
MISCDATA
(Optional) Miscellaneous data.
Character length and limitations: 95 alphanumeric characters
ORDERDATE
(Required) Order date. The format is MMDDYY with no slashes or dashes. For example,
July 28, 2011 is 072811.
Character length and limitations: 6 numeric characters
PONUM
(Optional) Purchase order number.
Character length and limitations: 25 alphanumeric characters
SHIPTOZIP
(Optional) Ship to postal code (called zip code in the USA).
Character length and limitations: 9 numeric characters
TAXAMT
(Optional) Sales tax.
The value must include a decimal and the exact amount to the cent (42.00, not 42).
Do not include comma separators (1234.56 not 1,234.56). To qualify for Level 2
discounts, this value must not be all zeros or blank spaces.
Character length and limitations: numeric
TAXEXEMPT
(Optional) Indicates whether the customer is tax exempt. It is one of the following
values:
Y – The customer is tax exempt.
N – The customer is not tax exempt (default).
Character length and limitations: 1alpha character
VATINVNUM
(Optional) Value added tax invoice number.
Character length and limitations: 95 alphanumeric characters
VATNUM
(Optional) Customer valued added tax number.
Character length and limitations: 95 alphanumeric characters
VATTAXAMT
(Optional) VAT/tax amount (freight/shipping).
Character length and limitations: 12 numeric characters
VATTAXRATE
(Optional) VAT/tax rate (freight/shipping).
Character length and limitations: 4 numeric characters
WorldPay Level 3 Parameters
Pass the following WorldPay Level 3 parameters to get the discount rate.
WorldPay Level 3 parameters
204
Level 3 Parameters
Description
L_ALTTAXAMTn
(Optional) Alternate tax amount for this item.
Character length and limitations: 8 numeric characters plus decimal: XXXX.XX
07 February 2013
Gateway Developer Guide and Reference
Submitting Purchasing Card Level 2 and 3 Transactions
WorldPay Purchasing Cards Transaction Processing
Level 3 Parameters
Description
L_ALTTAXRATEn
(Optional) Alternate tax rate for this item.
Character length and limitations: 4 numeric characters plus decimal: XX.XX
L_ALTTAXIDn
(Optional) Alternate tax identifier for this item.
Character length and limitations: 95 alphanumeric characters
L_EXTAMTn
(Optional) Extended item amount.
Character length and limitations: 8 numeric characters
L_TAXTYPEn
(Optional) Tax type applied.
Character length and limitations: 4 alphanumeric characters
L_COMMCODEn
(Optional) Item commodity code.
Character length and limitations: 35 alphanumeric characters
L_DESCn
(Optional) Item description.
Character length and limitations: 10 currency characters
L_AMTn
(Optional) Total line item amount including tax. + for debit, - for credits
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
L_SKUn
(Optional) Item’s supplier stock keeping unit (SKU) number or product code.
Character length and limitations: 8 numeric characters
L_QTYn
(Required) Quantity (whole units only).
Character length and limitations: 10 numeric characters
L_CARRIERSERVICELEV
ELCODEn
(Optional) Service code.
Character length and limitations: 1 alphanumeric character
L_COSTn
(Optional) Item freight amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 10 currency characters
L_UOMn
(Optional) Item unit of measure.
Character length and limitations: 3 alpha characters
L_TAXAMTn
(Optional) Item tax amount.
Character length and limitations: Must include a decimal and be exact to the cent
(42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). Examples:
tip=3.00, convenience charge=2.00. 12 numeric characters
L_TAXRATEn
(Optional) Tax rate for this item.
Character length and limitations: 4 numeric characters plus decimal:XXXX
Gateway Developer Guide and Reference
07 February 2013
C
205
C
206
Submitting Purchasing Card Level 2 and 3 Transactions
WorldPay Purchasing Cards Transaction Processing
07 February 2013
Gateway Developer Guide and Reference
D
Payflow Header Parameters
The Payflow header parameters can be used to bypass Payflow and send a request message
directly to PayPal. They can also be used to post transactions directly to the Payflow servers
without installing an SDK. This appendix includes the following sections:
“Sending Requests Directly to PayPal Bypassing Payflow” on page 207
“Posting Transactions Directly Without the Payflow SDK” on page 208
Sending Requests Directly to PayPal Bypassing Payflow
Payflow will ignore the request parameters you pass and will forward them to PayPal when
you declare PAYPAL-NVP=Y in the request header. Declaring PAYPAL-NVP=Y in the request
header is required when passing negative discount amounts to PayPal through Payflow.
Please note that passing PAYPAL-NVP=Y in the request header changes the format of the
response message you receive from Payflow. For example, if PAYPAL-NVP=Y is NOT
declared in the header, the Payflow response message is formatted as follows:
RESULT=0&RESPMSG=Approved&TOKEN=EC868676987J8393917&CORRELATIONID=5f817d830101
If the request header PAYPAL-NVP=Y is declared, the response returned from Payflow
includes bracketed numbers next to the names of the response parameters. These bracketed
numbers are length tags indicating the length of the values returned. The following is a
response message that contains length tags:
RESULT=0&RESPMSG=Approved&TOKEN[20]=EC97J718043X120051H&TIMESTAMP[20]=2012-1011T15:19:37Z&CORRELATIONID[13]=274f8d4493dbe&ACK[7]=Success&VERSION[
4]=92.0&BUILD[7]=3893058
You can also use length tags in the Payflow request message to pass the special characters of
"&" and "=" in the values sent. See “Using Special Characters In Values” on page 51 for more
information.
Express Checkout for Payflow
For information on using the PayPal Express Checkout API with Payflow, see the Express
Checkout for Payflow Pro integration guide.
Gateway Developer Guide and Reference
07 February 2013
207
D
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
Posting Transactions Directly Without the Payflow SDK
The Payflow SDK is recommended for .NET and Java users to simplify the Payflow
integration. Developers who prefer to write code in other programming languages can go to
the PayPal Labs integration wizard web site (https://www.paypallabs.com/integrationwizard/index.php.). The wizard generates customizable code samples in
languages such as PHP.
Developers also have the option to post transactions directly to the Payflow servers using the
Payflow message protocol, without the need to install an SDK. This section describes the
HTTP headers that are required to post transactions directly to the Payflow servers.
The Payflow Message Protocol
What is the Payflow message protocol and what are its advantages?
PayPal’s Payflow message protocol is an HTTP-compatible protocol for transactions. The
HTTP-compliant implementation of this protocol has the following goals:
It enhances flexibility to developers integrating with the Payflow Service. Merchants can
use the protocol in either of these ways:
– Using a Payflow SDK such as .NET or Java that uses this protocol.
– Integrating this protocol directly into your own client application without using an SDK.
– It increases reliability through adherence to open standards.
– Built-in tools to prevent duplicate transactions and authorizations.
The Payflow message protocol provides the underlying transport for application-level
transactions, using either the Payflow name-value pair or XMLPay 2.0 format. All
transaction data as documented in this guide is embedded in the body of a standard HTTPS
POST and POSTed to the URLs specified.
What is the disadvantage of building your own integration?
Since you are building your own integration, you will need to add your own error handling,
retry logic and duplicate transaction handling within your code.
NOT E :
If you prefer not to write your own client, you can use the .NET SDK, which can also
be used with classic ASP, or the Java SDK if appropriate. See “Payflow SDK” on
page 49 for more information about the SDKs.
What code changes are required when migrating from a previous Payflow SDKs to this
service?
The Payflow HTTPS service uses the same name-value-pair parameters or XMLPay schema
as found in the current SDKs. The the only code change needed is the way you communicate
with the Payflow servers. Instead of using an SDK to send the data, you will use the methods
208
07 February 2013
Gateway Developer Guide and Reference
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
D
available in your programming language of choice to send the data via HTTPS. For example,
if you use PHP, you might choose to use cURL.
Payflow Message Protocol Headers
In addition to the Payflow parameters that you pass in your request, you must set the request
headers described in the following table.
Gateway Developer Guide and Reference
07 February 2013
209
D
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
Required Payflow Headers
Header Name
Description
X-VPS-REQUEST-ID
(Required) A unique identifier for each request, whether the request is a single
name-value transaction or an XMLPay 2.0 document with multiple
transactions. This identifier is associated with all the transactions in that
particular request.
X-VPS-REQUEST-ID is made up of 1 to 32 printable characters. You must
provide the X-VPS-REQUEST-ID value in the transaction request. The server
uses the X-VPS-REQUEST-ID to check for duplicate transaction requests.
When a transaction request is received, the server checks the requests table to
see if the X-VPS-REQUEST-ID has been used before by this merchant.
If the X-VPS-REQUEST-ID has been used before, the server views it as a retry
transaction and the transaction is treated as a duplicate. The response to the
original transaction request is returned and “DUPLICATE=1” is appended to the
response indicating that this transaction is a duplicate. In Manager, you will see
these DUPLICATE transactions with a TENDER type of “N”.
I MP O R TAN T :
If you send in a NEW transaction with a previously used XVPS-REQUEST-ID, the server ignores the new data and returns
the response to the original transaction associated with that XVPS-REQUEST-ID.
It is VERY IMPORTANT that you check for DUPLICATE=1 and if you receive
it and the transaction is not a re-attempt of the original request of a failed
transaction, you must change the Request ID.
If the X-VPS-REQUEST-ID has not been used before, the server stores the XVPS-REQUEST-ID to ensure that the X-VPS-REQUEST-ID is not reused and
then runs the associated transactions. Duplicate checking is designed for shortterm retries (a few minutes to a few hours after the original transaction). The XVPS-REQUEST-ID is stored for a minimum of 7 to 8 days; however, retries
should not be sent so long after the original transaction.
N O TE :
Any transaction with an ID older than 8 days will be treated as a new
transaction.
The X-VPS-REQUEST-ID check is only available if the database is up and
available. If for some reason the database is down, transactions (authorizations
and sales) will continue to be processed as normal; however, DUPLICATE=-1
(negative one) will be returned to alert you that the database is down and there
is no duplicate check being performed.
N O TE :
X-VPS-CLIENT-TIMEOUT
210
Buyer Authentication: E-Verify Enrollment, Z-Validate Authentication
transactions and PayPal Express Checkout: SetExpressCheckout and
GetExpressCheckout transactions do not use duplicate suppression and
will not return DUPLICATE=1
(Required) Time-out value in seconds. A transaction times out if the elapsed
time between ending the original transaction request and receiving the
transaction response exceeds the value of X-VPS-CLIENT-TIMEOUT. The
default value is 45.
07 February 2013
Gateway Developer Guide and Reference
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
D
Standard HTTP Headers Required
Header Name
Description
Connection
State of the connection. The server returns the value close to close the
connection after the response is sent.
Content-Length
(Required) Size of message body.
Content-Type
(Required) Provide one of the following values:
text/name value, transaction request body is in name-value pair format.
text/xml, transaction request body is in XMLPay 2.0 format.
Host
(Required) Provide one of the two host URLs:
Production: payflowpro.paypal.com
Pilot: pilot-payflowpro.paypal.com
Transaction Message
The transaction message communicates the initial transaction data to the server. It is made up
of the transaction request and response.
URLs for Sending Messages
Use the following URLs for sending transactions to PayPal’s Payflow Production servers:
Production (Live): https://payflowpro.paypal.com/
Pilot (Test): https://pilot-payflowpro.paypal.com/
Transaction Request
The transaction request consists of a transaction request header and body.
Name-Value Pair Transaction Request Header
Content-Type: text/name value
Content-Length: 233
Connection: close
Host: payflowpro.verisign.com
X-VPS-REQUEST-ID: [See Required Payflow Parameters above]
X-VPS-CLIENT-TIMEOUT: 45
X-VPS-VIT-[See Integrator-Provided Data below]
X-VPS-VIT-[See Integrator-Provided Data below]
The following is an example of a transaction request header associated with a message in
name-value format. For XMLPay, it would follow the same format except the content-type
would be text/xml and the body of the request and response would contain the XML
document.
Gateway Developer Guide and Reference
07 February 2013
211
D
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
Name-Value Pair Transaction Request Body
The transaction request body contains the transaction information. The following is an
example transaction request body in name-value pair format.
TRXTYPE[1]=S&ACCT[16]=5105105105105100&EXPDATE[4]=0109&TENDER[1]=C&INVNUM[8
]=INV12345&AMT[5]=25.12&PONUM[7]=PO12345&STREET[23]=123 Main
St.&ZIP[5]=12345&USER[6]=jsmith&VENDOR[6]=jsmith&PARTNER[6]=PayPal&PWD[8]=t
esting1
NOT E :
The bracketed numbers are length tags which allow you to use the special characters
of "&" and "=" in the value sent. See “Using Special Characters In Values” on page 51
for more information.
The Request Body should NOT be URL-encoded. Pass the data as a standard data and use the
length tags if needed.
Transaction Response
The transaction response consists of a transaction response header and body.
Name-Value Pair Transaction Response Header
The following is an example transaction response header associated with a message in namevalue format.
Connection: close
Server: VPS-3.028.00
Date: Mon, 16 May 2005 22:48:06 GMT
Content-Type: text/name value
Content-Length: 145
X-VPS-REQUEST-ID: [Same ID as sent]
Name-Value Pair Transaction Response Body
The transaction response body contains the response to the request. The following is an
example response body in name-value format.
RESULT=0&PNREF=V53A0A30B542&RESPMSG=Approved&AUTHCODE=882PNI&AVSADDR=X&AVSZ
IP=X&IAVS=X&PREFPSMSG=No Rules Triggered&POSTFPSMSG=No Rules Triggered
Integrator-Provided Data
These headers are extensions to the Payflow message protocol. The extension parameters
describe the specific version of a client and the client’s environment. Send the applicable
parameters to PayPal in the transaction request headers.
212
07 February 2013
Gateway Developer Guide and Reference
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
NOT E :
D
The parameters in this section are not required but it is highly recommended you send
them.
Payflow Recommended Headers
Header Name
Description
X-VPS-VIT-INTEGRATION-PRODUCT
Identifies the integration product that calls the PayPal server.
Format: String
Examples: iPayment, ColdFusion, MIVA, shopping cart
Default Value: Blank
X-VPS-VIT-INTEGRATION-VERSION
Version of the software as defined by the integrator/vendor.
Limited to the major version and one digit of the minor version
(can include alphanumeric characters, not just digits).
Format: String .
Examples: 1.1, 4.5, 10.0, Linux2.1
Default Value: Blank
X-VPS-VIT-OS-NAME
Name of operating system on which the client is running.
Format: String
Examples: Linux, SunOS, Windows 2000, Windows NT,
Windows XP, Mac OS X, Free BSD
Default Value: Blank
X-VPS-VIT-OS-VERSION
Version of operating system on which the client is running.
Format: String XXX.X
Example: 2.4
Default Value: Blank
X-VPS-VIT-RUNTIME-VERSION
Version of runtime environment of the language in which the
client is written and is running.
Format: String XXX.XE
Examples: 10.1, 2.5
Default Value: Blank
Gateway Developer Guide and Reference
07 February 2013
213
D
214
Payflow Header Parameters
Posting Transactions Directly Without the Payflow SDK
07 February 2013
Gateway Developer Guide and Reference
E
VERBOSITY: Processor-Specific
Transaction Results
Set the VERBOSITY parameter to HIGH to view the processor’s raw response values and
additional values. This setting returns multiple parameters. Select only the returned parameters
that you want to handle and disregard the rest.
NOT E :
VERBOSITY is being deprecated in future Gateway releases.
Gateway Developer Guide and Reference
07 February 2013
215
E
216
VERBOSITY: Processor-Specific Transaction Results
07 February 2013
Gateway Developer Guide and Reference
F
ISO Country Codes
The Gateway API uses the International Standards Organization (ISO) 3166-1 numeric
country codes in the following fields: BILLTOCOUNTRY and SHIPTOCOUNTRY. For a
complete list of the current officially assigned ISO 3166-1 numeric country codes, refer to:
http://en.wikipedia.org/wiki/ISO_3166-1_numeric
NOT E :
If PayPal is your acquirer, refer instead to the “Countries and Regions Supported by
PayPal” on page 241.
Gateway Developer Guide and Reference
07 February 2013
217
F
218
ISO Country Codes
07 February 2013
Gateway Developer Guide and Reference
G
Codes Used by FDMS South Only
The following codes are used by FDMS South only.
“MasterCard Country Codes for FDMS South Only” on page 219
“Visa Country Codes” on page 226
“Units of Measure” on page 233
MasterCard Country Codes for FDMS South Only
ALBANIA
ALB
ALGERIA
DZA
AMERICAN SAMOA
ASM
ANDORRA
AND
ANGOLA
AGO
ANGUILLA
AIA
ANTARCTICA
ATA
ANTIGUA
ATG
APHGANISTAN
AFG
ARGENTINA
ARG
ARMENIA
ARN
ARUBA
ABW
AUSTRALIA
AUS
AUSTRIA
AUT
AZERBAIJAN
AZE
BAHAMAS
BHS
BAHRAIN
BHR
BANGLADESH
BGD
BARBADOS
BRB
BELARUS
BLR
BELGIUM
BEL
Gateway Developer Guide and Reference
07 February 2013
219
G
220
Codes Used by FDMS South Only
MasterCard Country Codes for FDMS South Only
BELIZE
BLZ
BENIN
BEN
BERMUDA
BMU
BHUTAN
BTN
BOLIVIA
BOL
BOSNIA AND HERZEGOVINA
BIH
BOTSWANA
BWA
BOUVET ISLAND
BVT
BRAZIL
BRA
BRITISH INDIAN OCEAN TERRITORY
IOT
BRUNEI
BRN
BULGARIA
BGR
BURKINA FASO
BFA
BURUNDI
BDI
CAMBODIA
KHM
CANADA
CAN
CAPE VERDE
CPV
CAYMAN ISLANDS
CYM
CENTRAL AFRICAN REPUBLIC
CAF
CHAD
TCD
CHILE
CHL
CHINA
CHN
CHRISTMAS ISLAND
CXR
CMEROON, UNITED REP.
CMR
COCOS (KEELING) ISLANDS
CCK
COLOMBIA
COL
COMOROS
COM
CONGO
GOG
COOK ISLANDS
COK
COSTA RICA
CRI
COTED’IVOIRE
CIV
CROATIA
HRV
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
MasterCard Country Codes for FDMS South Only
CYPRUS
CYP
CZECH REPUBLIC
CZE
DENMARK
DNK
DJIBOUTI
DJI
DOMINICA
DMA
DOMINICAN REPUBLIC
DOM
EL SALVADOR
SLV
EQUATORIAL GUINEA
GNQ
ESTONIA
EST
ETHIOPIA
ETH
FAEROE ISLANDS
FRO
FALKLAND ISLANDS (MALVINAS)
FLK
FIJI
FJI
FINLAND
FIN
FRANCE
FRA
FRENCH GUIANA
GUF
FRENCH POLYNESIA
PYF
FRENCH SOUTHERN TERRITORIES
ATF
GABON
GAB
GAMBIA
GMB
GEORGIA
GEO
GERMAN DEMOCRATIC REP
DDR
GERMANY
DEU
GHANA
GHA
GIBRALTAR
GIB
GREECE
GRC
GREENLAND
GRL
GRENADA
GRD
GUADALUPE
GLP
GUAM
GUM
GUATEMALA
GTM
GUINEA
GIN
Gateway Developer Guide and Reference
07 February 2013
G
221
G
222
Codes Used by FDMS South Only
MasterCard Country Codes for FDMS South Only
GUINEA-BISSAU
GNB
GUYANA
GUY
HAITI
HTI
HEARD AND MCDONALD ISLANDS
HMD
HONDURAS
HND
HONG KONG
HKG
HUNGARY
HUN
ICELAND
ISL
INDIA
IND
INDONESIA
IDN
IRAN
IRN
IRAQ
IRQ
IRELAND
IRL
ISRAEL
ISR
ITALY
ITA
JAMAICA
JAM
JAPAN
JPN
JORDAN
JOR
KAZAKHSTAN
KAZ
KENYA
KEN
KOREA, REPUBLIC OF
KOR
KUWAIT
KWT
KYRGYZSTAN
KGZ
LAO PEOPLES DEMOCRATIC
LAO
LATVIA
LVA
LEBANON
LBN
LESOTHO
LSO
LIBERIA
LBR
LIBYAN ARAB JAMAHIRIYA
LBY
LIECHTNSTIEN
LIE
LITHUANIA
LTU
LUXEMBOURG
LUX
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
MasterCard Country Codes for FDMS South Only
MACAU
MAC
MALAYSIA
MYS
MALDIVES
MDV
MALI
MLI
MALTA
MLT
MANACO
MCO
MARSHALL ISLANDS
MHL
MARTINIQUE
MTQ
MAURITANIA
MRT
MAURITIUS
MUS
MEXICO
MEX
MICRONESIA
FSM
MOLDOVA
MDA
MONGOLIA
MNG
MONTSERRAT
MSR
MOROCCO
MAR
MOZAMBIQUE
MOZ
MYANMAR
MMR
NAMIBIA
NAM
NAURU
NRU
NEGEL
SEN
NEPAL
NPL
NETHERLANDS
NLD
NETHERLANDS ANTILLES
ANT
NEW CALEDONIA
NCL
NEW ZEALAND
NZL
NICARAGUA
NIC
NIGER
NER
NIGERIA
NGA
NIUE
NIU
NORFOLK ISLAND
NFK
NORTHERN MARIANA ISLAND
MNP
Gateway Developer Guide and Reference
07 February 2013
G
223
G
224
Codes Used by FDMS South Only
MasterCard Country Codes for FDMS South Only
NORWAY
NOR
OMAN
OMN
PAKISTAN
PAK
PALAU
PLW
PANAMA
PAN
PAPUA NEW GUINEA
PNG
PARAGUAY
PRY
PERU
PER
PHILIPPINES
PHI
PITCAIRN ISLAND
PCN
POLAND
POL
PORTUGAL
PRT
PUERTO RICO
PRI
QATAR
QAT
REUNION
REU
ROMANIA
ROM
RUSSIAN FEDERATION
RUS
RWANDA
RWA
SAMOA
WSM
SAN MARINO
SMR
SAN TOME AND PRICIPEL
STP
SAUDI ARABIA
SAU
SEYCHELLES
SYC
SIERRA LEONA
SLE
SINGAPORE
SGP
ST. HELENA
SHN
ST. KITTS-NEVIS-ANGUILLA
KNA
ST. LUCIA
LCA
ST. PIERRE AND MIQUELON
SPM
ST. VINCENT AND THE GRENADINES
VCT
SUDAN
SDN
SURINAME
SUR
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
MasterCard Country Codes for FDMS South Only
SVALBARD AND JAN MAYEN ISLANDS
SJM
SWAZILAND
SWZ
SWEDEN
SWE
SWITZERLAND
CHE
SYRIAN ARAB REPUBLIC
SYR
TAIWAN, PROVIDENCE OF CHINA
TWN
TAJIKISTAN
TJK
TANZANIA, UNITED REPUBLIC
TZA
THAILAND
THA
TOGO
TGO
TOKELAU
TKL
TONGA
TON
TRINIDAD AND TOBAGO
TTO
TUNISIA
TUN
TURKEY
TR
TURKMENISTAN
TM
TURKS AND CAICOS ISLANDS
TC
TUVALU
TUV
U.S. MINOR OUTLYING ISL.
UMI
UGANDA
UGA
UKRAINE
UKR
UNITED ARAB EMIRATES
ARE
UNITED KINGDOM
GBR
UNITED STATES
USA
URUGUAY
URY
UZBEKISTAN
UZB
VANUATU
VUT
VATICAN CITY STATE
VAT
VENEZUELA
VEN
VIETNAM
VNM
VIRGIN ISLANDS BRITISH
VGB
VIRGIN ISLANDS US
VIR
Gateway Developer Guide and Reference
07 February 2013
G
225
G
Codes Used by FDMS South Only
Visa Country Codes
WALLIS AND FUTUNA IS
WLF
WESTERN SAHARA
ESH
YEMEN
YEM
YUGOSLAVIA
YUG
ZAIRE
ZAR
ZAMBIA
ZMB
ZIMBABWE
RHO
Visa Country Codes
226
ALBANIA
AL
ALGERIA
DZ
AMERICAN SAMOA
AS
ANDORRA
AD
ANGOLA
AO
ANGUILLA
AI
ANTARCTICA
AQ
ANTIGUA
AG
APHGANISTAN
AF
ARGENTINA
AR
ARMENIA
AM
ARUBA
AW
AUSTRALIA
AU
AUSTRIA
AT
AZERBAIJAN
AZ
BAHAMAS
BS
BAHRAIN
BH
BANGLADESH
BD
BARBADOS
BB
BELARUS
BY
BELGIUM
BE
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Visa Country Codes
BELIZE
BZ
BENIN
BJ
BERMUDA
BM
BHUTAN
BT
BOLIVIA
BO
BOSNIA AND HERZEGOVINA
BA
BOTSWANA
BW
BOUVET ISLAND
BV
BRAZIL
BR
BRITISH INDIAN OCEAN TERRITORY
IO
BRUNEI
BN
BULGARIA
BG
BURKINA FASO
BF
BURUNDI
BI
CAMBODIA
KH
CANADA
CA
CAPE VERDE
CV
CAYMAN ISLANDS
KY
CENTRAL AFRICAN REPUBLIC
CF
CHAD
TD
CHILE
CL
CHINA
CN
CHRISTMAS ISLAND
CX
CMEROON, UNITED REP.
CM
COLOMBIA
CO
COMOROS
KM
CONGO
CG
COOK ISLANDS
CK
COSTA RICA
CR
COTED’IVOIRE
CI
CROATIA
HR
CYPRUS
CY
Gateway Developer Guide and Reference
07 February 2013
G
227
G
228
Codes Used by FDMS South Only
Visa Country Codes
CZECH REPUBLIC
CZ
DENMARK
DK
DJIBOUTI
DJ
DOMINICA
DM
DOMINICAN REPUBLIC
DO
EAST TIMOR
TP
ECUADOR
EC
EGYPT
EG
EL SALVADOR
SV
EQUATORIAL GUINEA
GQ
ESTONIA
EE
ETHIOPIA
ET
FAEROE ISLANDS
FK
FALKLAND ISLANDS (MALVINAS)
FK
FIJI
FJ
FINLAND
FI
FRANCE
FR
FRENCH GUIANA
GF
FRENCH METROPOLITAN
FX
FRENCH POLYNESIA
PF
FRENCH SOUTHERN TERRITORIES
TF
GABON
GA
GAMBIA
GM
GEORGIA
GE
GERMANY
DE
GHANA
GH
GIBRALTER
GI
GREECE
GR
GREENLAND
GL
GRENADA
GD
GUADALUPE
GP
GUAM
GU
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Visa Country Codes
GUATEMALA
GT
GUINEA
GN
GUINEA-BISSAU
GW
GUYANA
GY
HAITI
HT
HEARD AND MCDONALD ISLANDS
HM
HONDURAS
HN
HONG KONG
HK
HUNGARY
HU
ICELAND
IS
INDIA
IN
INDONESIA
ID
IRAN
IR
IRAQ
IQ
IRELAND
IE
ISRAEL
IL
ITALY
IT
JAMAICA
JM
JAPAN
JP
JORDAN
JO
KAZAKHSTAN
KZ
KENYA
KE
KIRIBATI
KI
KOREA, REPUBLIC OF
KR
KUWAIT
KW
KYRGYZSTAN
KG
LAO PEOPLES DEMOCRATIC
LA
LATVIA
LV
LEBANON
LB
LESOTHO
LS
LIBERIA
LR
LIBYAN ARAB JAMAHIRIYA
LY
Gateway Developer Guide and Reference
07 February 2013
G
229
G
230
Codes Used by FDMS South Only
Visa Country Codes
LIECHTNSTIEN
LI
LITHUANIA
LT
LUXEMBOURG
LU
MACAU
MO
MACEDONIA
MK
MADAGASCAR
MG
MALAWI
MW
MALAYSIA
MY
MALDIVES
MV
MALI
ML
MALTA
MT
MANACO
MC
MARSHALL ISLANDS
MH
MARTINIQUE
MQ
MAURITANIA
MR
MAURITIUS
MU
MAYOTTE
YT
MEXICO
MX
MICRONESIA
FM
MOLDOVA
MD
MONGOLIA
MN
MONTSERRAT
MS
MOROCCO
MA
MOZAMBIQUE
MZ
MYANMAR
MM
NAMIBIA
NA
NAURU
NR
NEPAL
NP
NETHERLANDS
NL
NETHERLANDS ANTILLES
AN
NEW CALDONIA
NC
NEW ZEALAND
NZ
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Visa Country Codes
NICARAGUA
NI
NIGER
NE
NIGERIA
NG
NIUE
NU
NORFOLK ISLAND
NF
NORTHERN MARIANA ISLAND
MP
NORWAY
NO
OMAN
OM
PAKISTAN
PK
PALAU
PW
PANAMA
PA
PAPUA NEW GUINEA
PG
PARAGUAY
PY
PERU
PE
PHILIPPINES
PH
PITCAIRN ISLAND
PN
POLAND
PL
PORTUGUL
PT
PUERTO RICO
PR
QATAR
QA
REUNION
RE
ROMANIA
RO
RUSSIAN FEDERATION
RU
RWANDA
RW
SAMOA
WS
SAN MARINO
SM
SAN TOME AND PRICIPEL
ST
SAUDI ARABIA
SA
SENEGAL
SN
SEYCHELLES
SC
SIERRA LEONA
SL
SINGAPORE
SG
Gateway Developer Guide and Reference
07 February 2013
G
231
G
232
Codes Used by FDMS South Only
Visa Country Codes
ST. HELENA
SH
ST. KITTS-NEVIS-ANGUILLA
KN
ST. LUCIA
LC
ST. PIERRE AND MIQUELON
PM
ST. VINCENT AND THE GRENADINES
VC
SUDAN
SD
SURINAME
SR
SVALBARD AND JAN MAYEN IS
SJ
SWAZILAND
SZ
SWEDEN
SE
SWITZERLAND
CH
SYRIAN ARAB REPUBLIC
SY
TAIWAN, PROVIDENCE OF CHINA
TW
TAJIKISTAN
TJ
TANZANIA, UNITED REPUBLIC
TZ
THAILAND
TH
TOGO
TG
TOKELAU
TK
TONGA
TO
TRINIDAD AND TOBAGO
TT
TUNISIA
TN
TURKEY
TR
TURKMENISTAN
TM
TURKS AND CAICOS ISLANDS
TC
TUVALU
TV
U.S. MINOR OUTLYING ISL.
UM
UGANDA
UG
UKRAINIAN SSR
UA
UNITED ARAB EMIRATES
AE
UNITED KINGDOM
GB
UNITED STATES
US
URUGUAY
UY
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Units of Measure
UZBEKISTAN
UZ
VANUATU
VU
VATICAN CITY STATE
VA
VENEZUELA
VE
VIETNAM
VN
VIRGIN ISLANDS BRITISH
VG
VIRGIN ISLANDS US
VI
WALLIS AND FUTUNA IS
WF
WESTERN SAHARA
EH
YEMEN
YE
YUGOSLAVIA
YU
ZAIRE
ZR
ZAMBIA
ZM
ZIMBABWE
ZW
G
Units of Measure
Acre (4840 yd2)
ACR
Alcoholic strength by mass
ASM
Alcoholic strength by volume
ASV
Ampere*
AMP
Ampere=hour (3,6 kC)*
AMH
Are (100 m2)
ARE
Bar*
BAR
Barrel (petroleum) (158,987 dm3)
BLL
Becquerel*
BQL
Billion EUR
BIL
Billion US
MLD
Board foot
BFT
Brake horse power (245,7 watts)
BHP
British thermal unit (1,055 kilojoules)
BTU
Gateway Developer Guide and Reference
07 February 2013
233
G
Codes Used by FDMS South Only
Units of Measure
Bushel (35,2391 dm3)
BUA
Bushel (36,36874 dm3)
BUI
Candela*
CDL
Carrying capacity in metric tonnes
CCT
Cental GB (45,359237 kg)
CNT
Center, metric (100 kg) (syn.: Hectokilogram)
DTN
Centigram*
CGM
Centilitre*
CLT
Centimetre*
CMT
Cord (3,63 m3)
WCD
Coulomb per kilogram*
CKG
Coulomb*
COU
Cubic centimetre*
CMQ
Cubic decimetre*
DMQ
Cubic foot
FTQ
Cubic inch
INQ
Cubic metre per hour*
MQH
Cubic metre per second*
MQS
Cubic metre*
MTQ
Cubic millimetre*
MMQ
Cubic yard
YDQ
Curie
CUR
Day*
DAY
Decade (ten years)
DEC
Decare
DAA
Decilitre*
DLT
Decimetre*
DMT
Decitonne*
DTN
Degree Celsius
CEL
Degree Fahrenheit
FAH
Degree Kelvin: Kelvin
Displacement tonnage
234
DPT
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Units of Measure
Dozen
DZN
Dozen packs
DZP
Dozen pairs
DZR
Dozen pieces
DCP
Dozen rolls
DRL
Drachm GB (3,887935 g)
DRM
Dram GB (1,771745 g)
DRI
Dram US (3,887935 g)
DRA
Dry Barrel (115,627 dm3)
BLD
Dry gallon (4,404884 dm3)
GLD
Dry pint (0,55061 dm3)
PTD
Dry quart (1,101221 dm3)
QTD
Farad*
FAR
Fluid ounce (28,413 cm3)
OZI
Fluid ounce (29,5735 cm3)
OZA
Foot (0,3048 m)
FOT
Gallon (4,546092 dm3)
GLI
Gigabecquerel*
GBQ
Gigawatt-hour (1 million kW/h)*
GWH
Gill (0,142065 dm3)
GII
Gill (11,8294 cm3)
GIA
Grain GB, US (64,798910 mg)
GRN
Gram of fissile isotopes
GFI
Gram*
GRM
Great gross (12 gross)
GGR
Gross
GRO
Gross (register) ton
GRT
Half year (six months)
SAN
Hectare
HAR
Hectobar*
HBA
Hectogram*
HGM
Hectokilogram*
DTH
Gateway Developer Guide and Reference
07 February 2013
G
235
G
236
Codes Used by FDMS South Only
Units of Measure
Hectolitre of pure alcohol
HPA
Hectolitre*
HLT
Hectometre*
HMT
Hertz*
HTZ
Hour*
HUR
Hundred
CEN
Hundred boxes
BHX
Hundred international units
HIU
Hundred leaves
CLF
Hundred packs
CNP
Hundredweight US (45,3592 kg)
CWA
Inch (25,4 mm)
INH
Joule*
JOU
Kelvin*
KEL
Kilobar*
KBA
Kilogram of caustic potash
KPH
Kilogram of caustic soda
KSH
Kilogram of named substance
KNS
Kilogram of nitrogen
KNI
Kilogram of phosphonic anhydride
KPP
Kilogram of phosphorus pentoxide
KPP
Kilogram of potassium hydroxide
KPH
Kilogram of potassium oxide
KPO
Kilogram of sodium hydroxide
KSH
Kilogram of substance 90 percent dry
KSD
Kilogram per cubic meter*
KMQ
Kilogram per second*
KGS
Kilogram*
KGM
Kilohertz*
KHZ
Kilojoule*
KJO
Kilometre per hour*
KMH
Kilometre*
KMT
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Units of Measure
Kilopascal*
KPA
Kilorgram of uranium
KUR
Kilotonne*
KTN
Kilovar
KVR
Kilovolt*
KVT
Kilovolt-ampere*
KVA
Kilowatt*
KWT
Kilowatt-hour*
KWH
Knot (1 nautical mile per hour)
KNT
Leaf
LEF
Liquid gallon (3,78541 dm3)
GLL
Liquid pint (0,473176 dm3)
PTL
Liquid quart (0,946353 dm3)
QTL
Litre (1 dm3)*
LTR
Litre of pure alcohol
LPA
Long ton GB, US (1,0160469 t)
LTN
(long) hundredweight GB (50,802345 kg)
CWI
Lumen*
LUM
Lux
LUX
Megahertz*
MHZ
Megalitre*
MAL
Megametre*
MAM
Megapascal*
MPA
Megavolt-ampere (1000 KVA)*
MVA
Megawatt*
MAW
Megawatt-hour (100 kW/h)*
MWH
Metre per second squared*
MSK
Metre per second*
MTS
Metre*
MTR
Metric carat (200 mg=2,10-4 kg)
CTM
Metric ton (1000 kg)
TNE
Milliard
MLD
Gateway Developer Guide and Reference
07 February 2013
G
237
G
238
Codes Used by FDMS South Only
Units of Measure
Millibar*
MBR
Millicurie
MCU
Milligram*
MGM
Millilitre*
MLT
Millimetre*
MMT
Million
MIO
Million cubic metres*
HMQ
Million international units
MIU
Minute*
MIN
Month
MON
Nautical mile (1852 m)
NMI
Net (register) ton
NTT
Newton*
NEW
Number
NMB
Number of articles
NAR
Number of bobbons
NBB
Number of cells*
NCL
Number of international units
NIU
Number of packs
NMP
Number of pairs
NMR
Number of parcels
NPL
Number of parts
NPT
Number of rolls
NRL
Ohm*
OHM
Ounce GB, US (28,349523 g)
ONZ
Ounce GB, US (31,103448 g) (syn: Troy ounce)
APZ
Pascal*
PAL
Pennyweight GB, US (1555174 g)
DWT
Piece
PCE
Pint (0,568262 dm3)
PTI
Pound GB, US (0,45359237 kg)
LBR
Proof gallon
PGL
07 February 2013
Gateway Developer Guide and Reference
Codes Used by FDMS South Only
Units of Measure
Quart (1,136523 dm3)
QTI
Quarter (of a year)
QAN
Quarter, GB (12,700586 kg)
QTR
Quintal, metric (100 kg)
DTN
Revolution per minute*
RPM
Revolution per second*
RPS
Score
SCO
scruple, GB (1,2955982 g)
SCR
Second*
SEC
Set
SET
Shipping ton
SHT
Short standard (7200 matches)
SST
Short ton GB, US (0,90718474 t)
STN
Siemens*
SIE
Square centimetre*
CMK
Square decimetre*
DMK
Square foot
FTK
Square inch
INK
Square kilometre*
KMK
Square metre*
MTK
Square mile
MIK
Square millimetre*
MMK
Square yard
YDK
Standard
WSD
standard atmosphere (101325 Pa)
ATM
(statue) mile (1609,344 m)
SMI
Stone GB (6,350293 kg)
STI
Technical atmosphere (98066,5 Pa)
ATT
Ten days
DAD
Ten pairs
TPR
Thousand
MIL
Thousand ampere-hour*
TAH
Gateway Developer Guide and Reference
07 February 2013
G
239
G
240
Codes Used by FDMS South Only
Units of Measure
Thousand board feet (2,36 m3)
MBF
Thousand cubic metres per day*
TQD
Thousand standard brick equivalent
MBE
Ton of steam per hour
TSH
Tonne (1000 kg)*
TNE
Tonne of substance 90 percent dry
TSD
Trillion EUR
TRL
Trillion US
BIL
Troy ounce
APZ
Troy pound, US (373,242 g)
LBT
Volt*
VLT
Watt*
WTT
Watt-hour*
WHR
Weber
WEB
Week
WEE
Yard (0,9144 m)
YRD
Year
ANN
07 February 2013
Gateway Developer Guide and Reference
H
PayPal Acquirer
If PayPal is your acquirer, use the following PayPal specific codes.
Countries and Regions Supported by PayPal
PayPal uses 2-character IS0-3166-1 codes for specifying countries and regions that are
supported in fields and variables.
For a complete list of countries and regions supported by PayPal and their 2-character ISO3166-1 codes, please refer to the PayPal API reference list of Countries and Regions.
PayPal Currency Codes
PayPal uses 3-character ISO-4217 codes for specifying currencies in fields and variables.
Please refer to the Currency Codes section of the PayPal API reference for a complete list of
currencies supported by PayPal.
Gateway Developer Guide and Reference
07 February 2013
241
H
242
PayPal Acquirer
PayPal Currency Codes
07 February 2013
Gateway Developer Guide and Reference
I
Additional Processor Information
Moneris Solutions
The Moneris Solutions processor has the following characteristics:
It supports ecommerce and mail order or telephone order (MOTO) transactions.
It supports the four basic credit card types: American Express, Discover, MasterCard, and
Visa.
To process live transactions, it requires undergoing a certification process. For details, see
the Moneris Receipts Specification available on the PayPal developer website.
Gateway Developer Guide and Reference
07 February 2013
243
Additional Processor Information
Moneris Solutions
244
07 February 2013
Gateway Developer Guide and Reference
J
Payflow Link Migration
If you are currently using the legacy Payflow Link HTML input tag integration and you would
like to use the name-value pair integration, you will need to contact PayPal Merchant
Technical Support to request your account to be upgraded to the new version of Payflow.
Before you request an upgrade, it is important that you understand the differences between the
Payflow Link legacy parameters and the equivalent Payflow parameters. Once you upgrade
your account to the new version, your old legacy integration will still work. However, to take
advantage of the new features we recommend that you update your Payflow Link integration
and use equivalent Payflow Gateway parameters instead of the legacy Payflow Link HTML
input tags.
Migrating from a legacy Payflow Link Integration
The legacy Payflow Link integration is now deprecated. It is recommended that you upgrade
the version of your Payflow Link account which allows you to perform a broader set of
functions. This upgrade allows you to switch from using the legacy Payflow Link HTML input
tag parameters to using Payflow parameters. The table below lists legacy Payflow Link
parameters and their Payflow equivalents.
Payflow Link legacy parameters and the equivalent Payflow parameters
Payflow Link Legacy Parameter
Payflow Parameter
ADDRESS
BILLTOSTREET
ADDRESSTOSHIP
SHIPTOSTREET
AMOUNT
AMT
AVSDATA
AVSADDR and AVSZIP
CARDNUM
ACCT
CITY
BILLTOCITY
CITYTOSHIP
SHIPTOCITY
COUNTRY
BILLTOCOUNTRY
COUNTRYTOSHIP
SHIPTOCOUNTRY
CSC
CVV2
CSCMATCH
CVV2MATCH
DESCRIPTION
N/A
EMAIL
BILLTOEMAIL
Gateway Developer Guide and Reference
07 February 2013
245
J
246
Payflow Link Migration
Migrating from a legacy Payflow Link Integration
Payflow Link Legacy Parameter
Payflow Parameter
EMAILTOSHIP
SHIPTOEMAIL
FAX
BILLTOFAX
FAXTOSHIP
SHIPTOFAX
FIRSTNAME
BILLTOFIRSTNAME
INVOICE
INVNUM
LASTNAME
BILLTOLASTNAME
LOGIN
VENDOR
METHOD
TENDER
NAME
BILLTOFIRSTNAME
BILLTOLASTNAME
NAMETOSHIP
SHIPTOFIRSTNAME
SHIPTOLASTNAME
PHONE
BILLTOPHONENUM
PHONETOSHIP
SHIPTOPHONENUM
SHIPAMOUNT
FREIGHTAMT
STATE
BILLTOSTATE
STATETOSHIP
SHIPTOSTATE
TAX
TAXAMT
TYPE
TRXTYPE
ZIP
BILLTOZIP
ZIPTOSHIP
SHIPTOZIP
07 February 2013
Gateway Developer Guide and Reference
K
Payflow Gateway MagTek
Parameters
MagTek products for both merchants and consumers provide added security to payment
transactions. For merchants, MagTek’s MagneSafe card readers encrypt payment card data
when the card is swiped. For consumers, MagTek has a subscription based service named
Qwick Codes. Consumers can use Qwick Codes instead of their payment card details to
purchase goods and services.
NOT E :
You must have a MagneSafe card reader or the required Qwick Code information to
use the MagTek specific parameters described in this appendix. Please contact
MagTek directly for more information.
MagTek MagneSafe Secure Card Readers and Qwick Codes
Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway
Parameters for Encrypted Card Swipe Transactions
Parameters for MagTek Qwick Code (PCode) Transactions
MagTek Error Codes and Messages
MagTek MagneSafe Secure Card Readers and Qwick Codes
MagneSafe Secure Card Reader Authenticators
MagTek’s MagneSafe™ secure card readers encrypt payment card track data such as the
credit card account number and the expiration date. MagTek's Secure Card Reader
Authenticators (SCRAs) capture data with a single swipe and can deliver dynamic card
authentication, data encryption, tokenization, and device/host authentication to help protect
merchants and their customers from identity theft and card fraud. MagTek’s MagneSafe
SCRAs can also identify counterfeit cards.
What is MagneSafe?
The MagneSafe Security Architecture (MSA) is MagTek’s digital identification and
authentication architecture that can safeguard consumers and their personal data. MSA
leverages strong encryption, secure tokenization, counterfeit detection, tamper recognition,
data relevance and integrity, and dynamic digital transaction signatures to validate and protect
the entire transaction.
The devices suported by MagTek's MagneSafe security and Magensa Services are:
Gateway Developer Guide and Reference
07 February 2013
247
K
Payflow Gateway MagTek Parameters
Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway
USB MSR: Dynamag.
Insert MSR for Kiosks, ATMs, etc.: MagneSafe I-65 for Chip Cards and MagStripe,
PSeries MagneSafe for outdoors, Slim Seal MagneSafe.
Mobile Readers: iDynamo for iOS, Bullet for Android, uDynamo for phones and tablets
with audio jack port.
PINPads: IPAD PINPad available as standard model and also with signature capture
support.
For more information, go to: http://www.magtek.com/V2/products/secure-card-readerauthenticators/index.asp
MagTek Qwick Codes
MagTek offers a subscription based service to consumers named Qwick Codes. Instead of
handing over plastic cards to store clerks or inserting them into unattended terminals like
ATMs or gas pumps that may have been rigged with skimmers to steal card data, consumers
can scan or type a Qwick Code from their smartphone or computer. The Qwick Code token is
used instead to initiate a transaction whereby the merchant or ATM's processor can gather the
actual card data on the back end of the transaction where it can be better secured and shielded
from potential compromise. Qwick Code tokens are also known as Protection Codes or
PCodes.
Passing Encrypted Card Swipe Data and Qwick Codes to the
Payflow Gateway
The Payflow Gateway can process transactions for merchants who already have MagneSafe
card readers or who accept MagTek Qwick Codes. You must have a MagneSafe card reader or
the required Qwick Code information to use the MagTek specific parameters described below.
Please contact MagTek directly for more information on obtaining the required card readers
and codes.
When you pass MagneSafe encrypted card swipe data or a Qwick Code to the Payflow
Gateway, Payflow will communicate directly with MagTek’s Magensa servers to retrieve the
payment card information. Payflow then passes the transaction data onto your merchant bank.
Supported Transaction Types
Encrypted card swipe or Qwick Code (PCode) requests can be used with the following
Payflow transaction types:
248
Authorization (TRXTYPE=A)
Credit (TRXTYPE=C)
07 February 2013
Gateway Developer Guide and Reference
Payflow Gateway MagTek Parameters
Passing Encrypted Card Swipe Data and Qwick Codes to the Payflow Gateway
Delayed Capture (TRXTYPE=D)
Sale (TRXTYPE=S)
Void (TRXTYPE=V)
K
Encrypted Card Swipe Payflow Example
The purpose of this example is to show you how to format a request.You cannot use the values
in this example for testing. You must have a MagneSafe card reader and test credit cards or
live credit cards to send a request to the Payflow Gateway. Please contact MagTek for more
information on obtaining card readers.
Request
This request contains regular Payflow parameters along with required MagTek parameters:
TRXTYPE=A&TENDER=C&VENDOR=MerchantUserID&PARTNER=PayPal&USER=
UserIDIfAvailOrSameAsVendor&PWD=Pwd4Gateway&VERBOSITY=HIGH&CARDTYPE=
1&SWIPEDECRHOST=MAGT&ENCTRACK2=82C69E600FF72FC1755509A76AD049E896A6E
EA64D9BB2F203DF8AAD78265E90F4F8952A9AC03CFC&AMT=11.00&ENCMP=71AB2EE7
A15887C36B8A23FED1CE7E6404D98119E24D15549E9B69AB6ABFB251C4A607D6A718
B494449B506B7555BF8ED5FA4A9E2A6B814B&KSN=9011400B02AA0E00002B&MPSTAT
US=3162209&ENCRYPTIONBLOCKTYPE=1®ISTEREDBY=PayPal&MAGTEKCARDTYPE=
1&DEVICESN=B02AA0E12151
See the Encrypted Card Swipe Transactions - Request Parameters for more information.
Response
If successful, the response will contain the standard Payflow response parameters for your
transaction type:
RESULT=0&PNREF=V24A0A55E168&RESPMSG=Approved&AUTHCODE=098PNI00PN&HOS
TCODE=A&VISACARDLEVEL=12
If you do not pass the required MagTek parameters, you will see: RESULT=7 in the response
along with a MagTek specific error message, such as: MAGTRESPONSE=H178-ENCTRACK2
has incorrect format.
See the Encrypted Card Swipe Transactions - Response Parameters for more information.
Qwick Code (PCode) Payflow Example
The purpose of this example is to show you how to format a request.You cannot use the values
in this example for testing. You must have a MagTek test Qwick Code or live Qwick Codes to
send a request to the Payflow Gateway. Please contact MagTek for more Qwick Code
information.
Request
This request contains regular Payflow parameters along with required MagTek parameters:
Gateway Developer Guide and Reference
07 February 2013
249
K
Payflow Gateway MagTek Parameters
Parameters for Encrypted Card Swipe Transactions
TRXTYPE=A&TENDER=C&VENDOR=MerchantUserID&PARTNER=PayPal&USER=UserIDI
fAvailOrSameAsVendor&PWD=Pwd4Gateway&VERBOSITY=HIGH&AMT=18&SWIPEDECR
HOST=MAGT&PCODE=23456789&MERCHANTID=MerchantID123&MERCHANTNAME=Merch
antName&PAN4=1234&BILLTOLASTNAME=Miller&MAGTEKUSERNAME=MagTekUserNam
e&MAGTEKPWD=MagTekPwd&BILLTOEMAIL=jmiller@anyemailprovider.com&BILLT
OZIP=95131&SHIPTOZIP=94089&AUTHVALUE1=1234&AUTHVALUE2=5678&AUTHVALUE
3=9012
See the Qwick Code (PCode) Transactions - Request Parameters for more information.
Response
If successful, the response will contain the standard Payflow response parameters for your
transaction type:
RESULT=0&PNREF=V24A0A55E19C&RESPMSG=Approved&AUTHCODE=474PNI00PN&HOS
TCODE=A&VISACARDLEVEL=12
If you do not pass the required MagTek parameters, you will see: RESULT=7 in the response
along with a MagTek specific error message, such as: MAGTRESPONSE=H364-MERCHANTID
has incorrect format.
See the Qwick Code (PCode) Transactions - Response Parameters for more information.
Parameters for Encrypted Card Swipe Transactions
Encrypted Card Swipe Transactions - Request Parameters
250
Field
Required
Description
Data Type
ENCMP
Required
Encrypted
MagnePrint
Information returned
by a MagneSafe
device when a card
is swiped.
String
07 February 2013
Length
Gateway Developer Guide and Reference
Payflow Gateway MagTek Parameters
Parameters for Encrypted Card Swipe Transactions
Field
Required
Description
Data Type
Length
ENCRYPTIONBLOCK
TYPE
Required
The code which
indicates what type
of Encryption Block
is used.
1=MagneSafe
V4/V5 compatible
2TDEA-CBC
Encryption, IV=0
Block contains data
only.2=iPad V1
compatible 2TDEACBC Encryption
Block contains
header + data.
Integer
1
ENCTRACK2
Required
Encrypted Track 2
information returned
by a MagneSafe
device when a card
is swiped.
String
KSN
Required
20 character string
returned by a
MagneSafe device
when a card is
swiped.
String
MAGTEKCARDTYPE
Required
The code which
indicates what type
of Card Data Format
is being submitted.
1=Encoding Format
for Financial
Transaction Cards
(ISO 7811).
Integer
MPSTATUS
Required
MagnePrint Status
of Card Swipe. This
is an alpha numeric
string, returned by a
MagneSafe device
when a card is
swiped.
REGISTEREDBY
Required
An alpha numeric
entry between 1 and
20 characters long.
Gateway Developer Guide and Reference
07 February 2013
Alphanumeric [az][A-Z][0-9]
K
20 char
1 to 20 char
251
K
Payflow Gateway MagTek Parameters
Parameters for Encrypted Card Swipe Transactions
Field
Required
Description
Data Type
SWIPEDECRHOST
Required
MAGT is the only
value that is
accepted in the
SWIPEDECRHOST
parameter. If you
pass a different
value you will see
RESULT=7
and MAGTRESPONSE
with an error
message in the
response.
DEVICESN
Optional
The device serial
number.
String
ENCTRACK1
Optional
Encrypted Track 1
information returned
by a MagneSafe
device when a card
is swiped.
String
ENCTRACK3
Optional
Encrypted Track 3
information returned
by a MagneSafe
device when a card
is swiped.
String
Length
Encrypted Card Swipe Transactions - Response Parameters
252
Field
Description
Data Type
Notes
MAGTRESPONSE
This parameter appears in
the response if a data
validation error occurs or
if the MagTek processor
throws an error.
String
See the error codes below
for more information.
07 February 2013
Gateway Developer Guide and Reference
Payflow Gateway MagTek Parameters
Parameters for MagTek Qwick Code (PCode) Transactions
K
Parameters for MagTek Qwick Code (PCode) Transactions
Qwick Code (PCode) Transactions - Request Parameters
Field
Required
Description
Data Type
Length
MERCHANTID
Required
Your Merchant ID
or the Merchant ID
of the merchant
redeeming the
Protection Code.
String
1 to 40 characters
PAN4
Required
The last 4 digits of
the PAN / account
number encoded in
the card.
String
4 characters
PCODE
Required
The generated
Protection Code.
String
8 character
alphanumeric
SWIPEDECRHOST
Required
MAGT is the only
value currently
accepted in the
SWIPEDECRHOST
parameter. .
AUTHVALUE1
Optional
Authentication
Value 1generated
with the PCode.
String
AUTHVALUE2
Optional
Authentication
Value 2 generated
with the PCode.
String
AUTHVALUE3
Optional
Authentication
Value 3 generated
with the PCode.
String
BILLTOEMAIL
Optional
Purchaser’s email
address.
String
BILLTOLASTNAME
Optional
The last name of the
card holder encoded
in the card.
String
BILLT0ZIP
Optional
The billing zipcode.
String
MAGTEKUSERNAME
Optional
MagTek username.
String
MAGTEKPWD
Optional
MagTek password.
String
MERCHANTNAME
Optional
SHIPTOZIP
Optional
Shipping zipcode.
String
Gateway Developer Guide and Reference
07 February 2013
253
K
Payflow Gateway MagTek Parameters
MagTek Error Codes and Messages
Qwick Code (PCode) Transactions - Response Parameters
Field
Description
Data Type
Notes
MAGTRESPONSE
This only appears in the
response if a data
validation error occurs or
if the MagTek processor
throws an error.
String
See the error codes below
for more information.
MagTek Error Codes and Messages
If an error occurs, you will see one of the following error codes in the MAGTRESPONSE
response parameter.
Encrypted Card Swipe Transactions - Input Validation Error Codes
Error Message
Notes
H023 - REGISTEREDBY has incorrect length
H024 - REGISTEREDBY has incorrect format
H176 - ENCTRACK1 has incorrect format
H177 - ENCTRACK1 has incorrect length
H178 - ENCTRACK2 has incorrect format
H179 - ENCTRACK2 has incorrect length
H180 - ENCTRACK3 has incorrect format
H181 - ENCTRACK3 has incorrect length
H182 - ENCMP has incorrect format
H183 - ENCMP has incorrect length
H186 - KSN has incorrect format
H187 - KSN has incorrect length
H188 - MPSTATUS has incorrect format
H189 - MPSTATUS has incorrect length
H206 - Invalid CARDTYPE
Invalid MAGTEKCARDTYPE
H211 - Invalid ENCRYPTIONBLOCKTYPE
H219 - Invalid OUTPUTFORMATCODE
H251 - Invalid DEVICESN
254
07 February 2013
Gateway Developer Guide and Reference
Payflow Gateway MagTek Parameters
MagTek Error Codes and Messages
K
Encrypted Card Swipe Transactions - Other Error Codes
Error Message
Notes
Y001 - No PAN Found in Track2 Data
Y003 - Device is not allowed
MagTek maintains a list of registered Devices.
Y093 - Invalid MagnePrint
Error obtained while Scoring Transaction MagnePrint
against a Reference MagnePrint made up of Zeros.
Y094 - Invalid MagnePrint
“Negative 2 - Invalid Transaction CRC / PAN” Obtained
when Scoring Transaction MagnePrint against a
Reference MagnePrint Made up of Zeros.
Y095 - Error Scoring Card
Y096 - Inactive MagnePrint Reference
This occurs whenever the Card has an inactive
MagnePrint Reference.
Y097 - Replay Prevented
This occurs when the DUKPT KSN and Counter is
replayed.
Y098 - Problem with Reader Data
This occurs if there is a problem while decrypting the
Data..
Qwick Code (PCode) Transactions - Input Validation Error Codes
Error Message
Notes
H330 - PCODE has incorrect length
H331 - PCODE has incorrect format
H336 - EMAIL has incorrect format
BILLTOEMAIL has incorrect format
H337 - EMAIL has incorrect length
BILLTOEMAIL has incorrect length
H348 - BTZIP has incorrect format
BILLTOZIP has incorrect format
H349 - BTZIP has incorrect length
BILLTOZIP has incorrect length
H360 - STZIP has incorrect format
SHIPTOZIP has incorrect format
H361 - STZIP has incorrect length
SHIPTOZIP has incorrect length
H364 - MERCHANTID has incorrect format
H365 - MERCHANTID has incorrect length
H366 - Invalid LASTNAME
Invalid BILLTOLASTNAME
H375 - PAN4 has incorrect length
H376 - PAN4 has incorrect format
H380 - Invalid AUTHVALUE1
Gateway Developer Guide and Reference
07 February 2013
255
K
Payflow Gateway MagTek Parameters
MagTek Error Codes and Messages
Error Message
Notes
H381 - Invalid AUTHVALUE2
H382 - Invalid AUTHVALUE3
H383 - Invalid MERCHANTNAME
H384 - Invalid USERNAME
Invalid MAGTEKUSERNAME
H385 - Invalid PASSWORD
Invalid MAGTEKPWD
Qwick Code (PCode) Transactions - Other Error Codes
Error Message
Notes
P021 - Invalid Protection Code - Not Found.
P022 - Revoked Protection Code.
This Protection Code has already been revoked.
P028 - Expired Protection Code.
P031 - Last 4 of PAN mismatch.
P032 - LASTNAME mismatch.
BILLTOLASTNAME mismatch.
P033 - MERCHANTID is locked.
P034 - Protection Code can no longer be Redeemed.
256
P035 - USERNAME mismatch.
MAGTEKUSERNAME given does not match the one
stored.
P036 - PASSWORD mismatch.
MAGTEKPWD given does not match the one stored.
P037 - EMAIL mismatch.
BILLTOEMAIL given does not match the one stored.
P038 - BTZIP mismatch.
BILLTOZIP given does not match the one stored.
P039 - STZIP mismatch.
SHIPTOZIP given does not match the one stored.
P040 - AUTHVALUE1 mismatch.
AUTHVALUE1 given does not match the one stored.
P041 - AUTHVALUE2 mismatch.
AUTHVALUE2 given does not match the one stored.
P042 - AUTHVALUE3 mismatch.
AUTHVALUE3 given does not match the one stored.
P098 - Problem with Reader Data
This occurs if there is a problem while decrypting the
Data.
07 February 2013
Gateway Developer Guide and Reference
Source Exif Data:
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.6 Linearized : Yes Author : PayPal Inc. Create Date : 2013:02:07 02:21:09Z Modify Date : 2013:02:15 11:53:46+01:00 XMP Toolkit : Adobe XMP Core 4.2.1-c043 52.372728, 2009/01/18-15:56:37 Producer : Acrobat Distiller 9.0.0 (Windows) Creator Tool : FrameMaker 9.0 Metadata Date : 2013:02:15 11:53:46+01:00 Format : application/pdf Title : Payflow Gateway Developer Guide and Reference Creator : PayPal Inc. Document ID : uuid:9a61be3e-2025-439b-aa63-0845e176c83a Instance ID : uuid:a7be2b4d-dc6e-5244-9281-78224cd0c5a8 Page Mode : UseOutlines Page Count : 256EXIF Metadata provided by EXIF.tools