Payflow Pro Developers Guide

Last updated: October 2009

Payflow Pro Developers Guide Document Number: 200010.en_US-200910

2009 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., Socit 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.

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 How to Contact Customer Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 13
Payflow Pro Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Host Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 How Payflow Pro Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

About Payflow Pro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Supported Processing Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Supported Payment Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Payflow Pro Recurring Billing Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 About Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 2

Downloading, Installing, and Activating

. . . . . . . . . . 17

Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Preparing the Payflow Client Application . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Activating Your Payflow Pro Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 3

Simple Payflow Transaction . . . . . . . . . . . . . . . . . 19

Request Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Data Modes for Sending . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Connection Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 User Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Transaction Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Sale Transaction Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Typical Sale Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Formatting Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Payflow Pro Developers Guide

Contents

Chapter 4

Credit Card Transactions . . . . . . . . . . . . . . . . . . 23

Credit Card Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 About Credit Card Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Obtaining an Internet Merchant Account . . . . . . . . . . . . . . . . . . . . . . . . 24 Planning Your Payflow Pro Integration . . . . . . . . . . . . . . . . . . . . . . . . . 24 Complying With the E-commerce Indicator (ECI) . . . . . . . . . . . . . . . . . . . . 25 Handling Credit Card Type Information . . . . . . . . . . . . . . . . . . . . . . . . . 25 Parameters Used in Credit Card Transactions. . . . . . . . . . . . . . . . . . . . . . . . 26 Submitting Sale Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 When To Use a Sale Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Additional Parameters For Sale Transactions . . . . . . . . . . . . . . . . . . . . . . 28 Typical Sale Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . . 29 Submitting Authorization/Delayed Capture Transactions . . . . . . . . . . . . . . . . . . 29 When To Use Authorization/Delayed Capture Transactions . . . . . . . . . . . . . . . 29 Required Authorization Transaction Parameters . . . . . . . . . . . . . . . . . . . . 30 Typical Authorization Transaction Parameter String . . . . . . . . . . . . . . . . . . . 30 Required Delayed Capture Transaction Parameters . . . . . . . . . . . . . . . . . . 30 Delayed Capture Transaction: Capturing Transactions for Lower Amounts . . . . . . . 32 Delayed Capture Transaction: Capturing Transactions for Higher Amounts . . . . . . 32 Delayed Capture Transaction: Error Handling and Retransmittal . . . . . . . . . . . . 32 Submitting Account Verifications With TRXTYPE=A. . . . . . . . . . . . . . . . . . . . . 32 When To Use Account Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Example Account Verification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Submitting Voice Authorization Transactions . . . . . . . . . . . . . . . . . . . . . . . . 33 When to Use a Voice Authorization Transaction. . . . . . . . . . . . . . . . . . . . . 33 Required Voice Authorization Transaction Parameters . . . . . . . . . . . . . . . . . 34 Submitting Credit Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Required Credit Transaction Parameters . . . . . . . . . . . . . . . . . . . . . . . . 34 Credit Transaction Parameter Strings . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Submitting Void Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 When To Use a Void Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Required Void Transaction Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 37 Example Void Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . 37 Submitting Inquiry Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 When To Use an Inquiry Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Required Parameters When Using the PNREF . . . . . . . . . . . . . . . . . . . . . 38 Inquiry Transaction Parameter String Using the PNREF . . . . . . . . . . . . . . . . 38 Required Parameters When Using the CUSTREF . . . . . . . . . . . . . . . . . . . 39 Inquiry Transaction Parameter String Using the CUSTREF . . . . . . . . . . . . . . . 39

Payflow Pro Developers Guide

Contents

Recharging to the Same Credit Card (Reference Transactions). . . . . . . . . . . . . . . 40 When To Use a Reference Transaction . . . . . . . . . . . . . . . . . . . . . . . . . 40 Transaction Types that Can Be Used as the Original Transaction . . . . . . . . . . . 41 Fields Copied From Reference Transactions . . . . . . . . . . . . . . . . . . . . . . 41 Example Reference Transaction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Submitting Card-Present (SWIPE) Transactions. . . . . . . . . . . . . . . . . . . . . . . 42 Supported Processing Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Card-present Transaction Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Submitting Purchasing Card Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Using Address Verification Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Processing Platforms Supporting Address Verification Service . . . . . . . . . . . . . . . 44 Example Address Verification Service Request Parameter List . . . . . . . . . . . . . . . 45 Example Address Verification Service Response . . . . . . . . . . . . . . . . . . . . . . 45 Card Security Code Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Processing Platforms and Credit Cards Supporting Card Security Code . . . . . . . . 46

Chapter 5

Credit Card Testing . . . . . . . . . . . . . . . . . . . . . 49

Testing Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Credit Card Numbers Used for Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Result Values in Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Testing Result Values in Responses. . . . . . . . . . . . . . . . . . . . . . . . . . . 50 RESULT Values Returned Based on Transaction Amount. . . . . . . . . . . . . . . . . . 50 Alternative Methods for Generating Specific RESULT Values . . . . . . . . . . . . . . 51 Testing Address Verification Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Testing Card Security Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Chapter 6

Responses to Transaction Requests . . . . . . . . . . . . 55

Contents of a Response to a Credit Card Transaction Request . . . . . . . . . . . . . . . 55 BALAMT Response Parameter and Stored Value Cards . . . . . . . . . . . . . . . . . . 57 American Express CAPN Stored Value Card Example . . . . . . . . . . . . . . . . . 57 PNREF Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 PNREF Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 RESULT Values and RESPMSG Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 RESULT Values for Transaction Declines or Errors . . . . . . . . . . . . . . . . . . . 58 RESULT Values for Communications Errors . . . . . . . . . . . . . . . . . . . . . . 64

Appendix A Processors Requiring Additional Transaction Parameters . 67

Payflow Pro Developers Guide

Contents

American Express . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 American Express Additional Credit Card Parameters (CAPN) . . . . . . . . . . . . . 68 American Express Additional Credit Card Parameters (Legacy) . . . . . . . . . . . . 73 First Data Merchant Services (FDMS) Nashville . . . . . . . . . . . . . . . . . . . . . . . 76 FDMS Nashville, Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . 76 First Data Merchant Services (FDMS) South . . . . . . . . . . . . . . . . . . . . . . . . 77 FDMS South, Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . 77 First Data Merchant Services (FDMS) North. . . . . . . . . . . . . . . . . . . . . . . . . 77 FDMS North, Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . 77 Merchant e-Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Merchant e-Solutions, Additional Credit Card Parameters . . . . . . . . . . . . . . . 78 Elavon (Formerly Nova) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Elavon, Additional Credit Card Parameters . . . . . . . . . . . . . . . . . . . . . . . 79 Paymentech . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Paymentech Salem (New Hampshire), Additional Credit Card Parameters (CAPN) . . 79 Paymentech, Additional Credit Card Parameters (Legacy) . . . . . . . . . . . . . . . 82 TSYS Acquiring Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 TSYS Acquiring Solutions, Additional Credit Card Parameters (CAPN). . . . . . . . . 83 TSYS Acquiring Solutions, Additional Credit Card Parameters (Legacy) . . . . . . . . 89

Appendix B Performing TeleCheck Electronic Check Transactions . . . 91

TeleCheck Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Required Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Testing TeleCheck Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Example Test Transaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Preparing for TeleCheck Production Transactions . . . . . . . . . . . . . . . . . . . . . . 94 Responses to Telecheck Transactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 HOSTCODE Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Appendix C Submitting Purchasing Card Level 2 and Level 3 Transactions . . . . . . . . . . . . . . . . . . . . . . . . 99

About Purchasing Cards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 About Program Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Accepted BIN Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100 About American Express Purchasing Card Transactions - Phoenix Processor . . . . . . .100 Supported Transaction Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 Avoiding Downgrade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 Submitting Successful Level 3 Transactions . . . . . . . . . . . . . . . . . . . . . .101

Payflow Pro Developers Guide

Contents

Edit Check . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101 Accepted BIN Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102 American Express Phoenix Purchasing Card Transaction Processing . . . . . . . . . . .102 American Express Phoenix Level 2 Parameters (CAPN) . . . . . . . . . . . . . . . .103 American Express Phoenix Level 2 Parameters (Legacy). . . . . . . . . . . . . . . .105 Example American Express Phoenix Level 2 Transaction Parameter String . . . . . .105 American Express Phoenix Level 3 Parameters. . . . . . . . . . . . . . . . . . . . .105 Example American Express Phoenix Level 3 Transaction Parameter String . . . . . .108 First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing.108 First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing . . 110 FDMS North Purchasing Card Line Item Parameters . . . . . . . . . . . . . . . . . . 111 First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing . . 112 FDMS South Line Item Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Example FDMS South Purchasing Card Level 2 and 3 Parameter String . . . . . . . . 114 Example FDMS South Line Item Parameter String . . . . . . . . . . . . . . . . . . . 114 Global Payments - Central Purchasing Card Transaction Processing . . . . . . . . . . . . 115 Global Payments - Central Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . 115 Example Global Payments - Central Level 2 Visa or MasterCard Transaction Parameter String. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Global Payments - East Purchasing Card Transaction Processing . . . . . . . . . . . . . 115 Global Payments - East Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . 116 Example Global Payments - East Level 2 Visa or MasterCard Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Merchant e-Solutions Purchasing Card Transaction Processing . . . . . . . . . . . . . . 116 Merchant e-Solutions Level 2 Parameters. . . . . . . . . . . . . . . . . . . . . . . . 116 Merchant e-Solutions Level 3 MasterCard Parameters . . . . . . . . . . . . . . . . . 117 Merchant e-Solutions Level 3 Visa Parameters . . . . . . . . . . . . . . . . . . . . . 119 Elavon (Formerly Nova) Purchasing Card Transaction Processing . . . . . . . . . . . . .123 Elavon Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123 Elavon Additional Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123 Example Elavon Level 2 Transaction Parameter String . . . . . . . . . . . . . . . . .124 Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing . . . . . .124 Paymentech Salem (New Hampshire) Level 2 Parameters (CAPN) . . . . . . . . . .124 Paymentech Salem (New Hampshire) Level 2 Parameters (Legacy) . . . . . . . . . .126 Paymentech Salem (New Hampshire) Level 3 Purchasing Card Parameters. . . . . .127 Paymentech Tampa Level 2 Purchasing Card Transaction Processing . . . . . . . . . . .130 Paymentech Tampa Level 2 Parameters . . . . . . . . . . . . . . . . . . . . . . . .131 Example Paymentech Tampa Level 2 Visa and MasterCard Transaction Parameter String . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131 TSYS Acquiring Solutions Purchasing Card Transaction Processing . . . . . . . . . . . .131

Payflow Pro Developers Guide

Contents

TSYS Acquiring Solutions Level 2 Parameters . . . . . . . . . . . . . . . . . . . . .131 TSYS Acquiring Solutions Level 3 MasterCard Parameters. . . . . . . . . . . . . . .132 TSYS Acquiring Solutions Level 3 Visa Parameters. . . . . . . . . . . . . . . . . . .134

Appendix D VERBOSITY: Viewing Processor-Specific Transaction Results . . . . . . . . . . . . . . . . . . . . . . . . 139

Supported Verbosity Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .139 Changing the Verbosity Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144 Setting the Verbosity Level on a Per-Transaction Basis . . . . . . . . . . . . . . . . .144 Setting the Default Verbosity Level for All Transactions . . . . . . . . . . . . . . . . .144

Appendix E Additional Reporting Parameters . . . . . . . . . . . . . 145 Appendix F ISO Country Codes . . . . . . . . . . . . . . . . . . . . 147

Appendix G Codes Used by FDMS South Only . . . . . . . . . . . . . 153

MasterCard Country Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153 Visa Country Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157 Units of Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161 FDMS South Currency Codes and Decimal Positions . . . . . . . . . . . . . . . . . . .166

Appendix H XMLPay . . . . . . . . . . . . . . . . . . . . . . . . . . 167

About XMLPay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .167 Payflow Pro XMLPay Developers Guide . . . . . . . . . . . . . . . . . . . . . . . . . .167

Appendix I

Additional Processor Information . . . . . . . . . . . . . 169

Moneris Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171

Payflow Pro Developers Guide

Preface

This guide describes Payflow Pro, a high performance TCP/IP-based Internet payment solution and how to use it to process credit card. Payflow Pro is pre-integrated with leading ecommerce solutions and is also available as a downloadable software development kit (SDK).

Scope
This guide explains how to integrate Payflow Pro into your website or application to process credit card transactions over the Payflow payments gateway. It includes information and special requirements for all supported processors. To process Express Checkout transactions over the Payflow gateway, see the following Payflow guide: Express Checkout for Payflow Pro.

Intended Audience
This guide assumes that its readers: Are experienced web or application developers Have a background in payments services

Related Documentation
For additional Payflow information, See the Payflow documentation set on PayPal Developer Central. Go to https://www.paypal.com/developer and click the Documentation link on the Library tab. For more examples and very current information, see the Payflow developer forums. For additional help, see the Help Center at the following URL: https://www.paypal.com/us/cgibin/helpweb?cmd=help.

How to Contact Customer Support

For problems with transaction processing or your connection to the server, contact Customer Support by opening a ticket on the under Contact Support tab at http://www.paypal.com/mts.

Payflow Pro Developers Guide

Revision History

Revision History
Revision history for Payflow Pro Developers Guide.
TABLE 1.1 Revision history Date October 2009 Description Added COMPANYNAME to reporting parameters. Added new appendix on additional processor informaion. Currently includes Moneris processor information. Added Account Verification as a type of transaction that uses TRXTYPE=A and AMT=0 to verify credit card information. Updated length of PARTNER, USER, and VENDOR to 64 characters. FDMS supports unreferenced credits. Minor corrections for technical accuracy and clarification. Moved coverage of Express Checkout to a separate new document, Express Checkout for Payflow Pro. Removed coverage of the version 3 Payflow SDK, including test and live URLs. Changed Paymentech New Hampshire to Paymentech Salem (New Hampshire) Updated name of Nova processor to Elavon. Corrected format of TSYS ORDERDATE field Added more clarification to description of RESULT value 25 Added more clarification of AMEX CAPN parameters in Appendix A Updated Table 4.1 , Credit card transaction request parameters, to reflect credit card parameter descriptions only and moved the non-credit card parameter descriptions to new tables in applicable sections of the chapter Minor corrections for technical accuracy and clarification
Updated live and test URLs to reflect PayPal only: payflowpro.paypal.com live URL and pilot-payflowpro.paypal.com test URL Added Help Center URL to Preface. Added Paymentech New Hampshire processor specification updates, including: CAPN requirements

June 2009 April 2009 November 2008

June 2008

Support of card security code for American Express and Discover cards Support of Switch/Solo Maestro card Full authorization reversals March 2008
Added PayPal processor responses. Updated RESULT value 0 to include information about PayPal processor success with warning message

February 2008

Removed note that PayPal processor does not support non-referenced credits. It supports them now. Updated test and live host URLs. Added BILLTOCOUNTRY to Paymentech additional parameters. Combined Telecheck transactions content into one appendix.

10

Payflow Pro Developers Guide

Revision History TABLE 1.1 Revision history Date November 2007 Description
Explains how merchant can determine what SDK version they are using. Provides guidelines to merchant to determine if merchant is following American Express CAPN requirements. Explains more about VERBOSITY parameter. Combines appendixes on performing Telecheck transactions with Telecheck responses. Adds BIN ranges. Explains how to eliminate TRANSSTATE 106 results. Updates Index to include an alphabetical listing of all Payflow parameters cited in the guide. Adds new transaction type N.

Includes other minor edits for technical accuracy.

Payflow Pro Developers Guide

11

Revision History

12

Payflow Pro Developers Guide

Introduction

About Payflow Pro

Payflow Pro is a high performance TCP/IP-based internet payment solution that resides on your computer system. You can download it in the following forms from the SDKs and Downloads page on PayPal Developer Central: .NET library Java library HTTPS interface Using the HTTPS interface, you can build your own API by posting directly to the Payflow servers via HTTPS.
N O T E : If

you prefer to have Payflow Pro integration performed for you, you can obtain Payflow Pro pre-integrated with leading e-commerce solutions. For a list of preintegrated solutions, see the Partner Solutions>Shopping Carts page on PayPal Developer Central.

Payflow Pro Documentation

Payflow Pro is described in the Payflow Pro documentation set on PayPal Developer Central. If you are implementing PayPal as a solution into your website, use this guide for general guidelines and guidelines on integrating credit card processing. If you are also implementing PayPal Express Checkout as a payment solution, see the Express Checkout for Payflow Pro guide for integration details.

Host Addresses
Use the following host addresses for the Payflow V4 SDK: For live transactions, use payflowpro.paypal.com For testing purposes, use pilot-payflowpro.paypal.com

How Payflow Pro Works

Payflow Pro uses a client/server architecture to transfer transaction data from you to the processing networks, and then returns the authorization results to you. Payflow Pro can process real-time credit card transactions and other transaction types to most of the financial processing centers in the United States.

Payflow Pro Developers Guide

13

Introduction
Supported Processing Platforms

1. The Payflow client encrypts each transaction request using the latest Secure Sockets Layer (SSL) encryption and establishes a secure link with the Payflow server over the internet. 2. The Payflow server, a multi-threaded processing environment, receives the request and transmits it (over a secure private network) to the appropriate financial processing network for real-time payment authorization. 3. The response (approved/declined, and so on) is received from the financial network and is returned in the same session to the Payflow client. 4. The Payflow client completes each transaction session by transparently sending a transaction receipt to the server before disconnecting the session. The entire process is a real-time synchronous transaction. Once connected, the transaction is immediately processed and the answer returned in about three seconds. Processing transactions through the Payflow service does not affect or define the time periods of authorizations, nor does it influence the approval or denial of a transaction by the issuer. When integrating with Payflow Pro, you need only be concerned with passing all the required data for transaction authorization. For transactions that you want to be settled (close batch), the operation is handled by PayPal.

Supported Processing Platforms

Payflow Pro supports the following processing platforms: PayPal American Express Phoenix American Express Brighton First Data Merchant Services (FDMS) Nashville First Data Merchant Services (FDMS) North First Data Merchant Services (FDMS) South First Data TeleCheck Global Payments Central Global Payments East Merchant e-Solutions Elavon (Formerly Nova) Paymentech Salem (New Hampshire) Paymentech Tampa TSYS Acquiring Solutions (Formerly Vital Processing Services) Moneris Solutions

14

Payflow Pro Developers Guide

Introduction
Supported Payment Types

Supported Payment Types

Payflow Pro supports multiple payment types in a single installation, including: Credit cards PayPal (supported by PayPals 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 II and Level III Automated Clearing House (ACH). For information on performing ACH transactions, contact your PayPal Sales Representative at [email protected]

Payflow Pro Recurring Billing Service

The Recurring Billing Service is a scheduled payment solution that enables you to automatically bill your customers at regular intervalsfor example, a monthly fee of $42 for 36 months with an initial fee of $129. You enroll separately for the Payflow Pro Recurring Billing Service. Using Payflow Pro to define and manage recurring transactions programmatically is described in Payflow Pro Recurring Billing Service Users Guide. You can manage Recurring Billing tasks in PayPal Manager. See the online help for details.

About Security
It is your responsibility to protect your passwords and other confidential data and to implement security safeguards on your website and in your organization, or to ensure that your hosting company or internal web operations team is implementing them on your behalf.
IMPO RTANT: To enable testing of Payflow Pro, PayPal provides sample transaction scripts

that you customize with your Payflow Pro account information and password. Because the password is initially stored in the text of the program, it is vulnerable. Do not use the test scripts in your production environment. To minimize fraud, machine passwords should always be encrypted. You must write a program that encrypts and decrypts your Payflow Pro account password.

Payflow Pro Developers Guide

15

Introduction
About Security

16

Payflow Pro Developers Guide

Downloading, Installing, and Activating

The Payflow Software Development Kit (SDK) is a set of APIs to allow you to integrate Payflow Pro with your application or website.
IMPO RTANT: Full

API documentation is included with each SDK.

S u p p o r t e d P l a tf o r m s
Payflow Pro is available on all major web server platforms in a variety of formats to support your integration requirements. Payflow Pro is available as a .NET or Java library, or you can build your own API by posting directly to the Payflow servers via HTTPS.

Preparing the Payflow Client Application

Unless you are building your own API and using HTTPS to post to the servers, you will need to obtain the Payflow SDK. Follow these steps. 1. Download the Payflow SDK. From the SDKs and Downloads page linked to the Library tab on PayPal Developer Central, download the Payflow SDK appropriate for your platform. 2. Extract the files to a local directory. 3. Configure your firewall. If you have a stateful firewall, enable outbound traffic for SSL (port 443). The firewall keeps state on the connection, and automatically permits the inbound response from PayPal. If you do not have a stateful firewall, enable inbound and outbound traffic for SSL (port 443). Outbound traffic permits the initial request by Payflow Pro, while inbound permits the response from PayPal. 4. Read the Readme.txt file. The Readme.txt file includes integration information and samples that illustrate how to use the Payflow client application in your development environment.

Website Payments Pro Payflow Edition Developers Guide

17

Downloading, Installing, and Activating

Activating Your Payflow Pro Account

Activating Your Payflow Pro Account

When you are ready to activate your Payflow Pro account to begin submitting live transactions, follow these steps: 1. Log in to PayPal Manager at https://manager.paypal.com. 2. Click ActivateYour Account and follow the on-screen instructions. 3. Change the URL within your web or desktop application to point to the live Payflow servers. For details on Payflow server URLs, see Host Addresses on page 13.

18

Website Payments Pro Payflow Edition Developers Guide

Simple Payflow Transaction

All Payflow transactions include a common set of required parameters. Additional parameters are required depending on the transaction type.You can also provide many optional parameters, depending on the results you want returned. For example, you can set the VERBOSITY parameter to return PayPal processor-specific details rather than normalized information if you are looking for this kind of information. VERBOSITY is described in detail in Appendix D, VERBOSITY: Viewing Processor-Specific Transaction Results.

Transaction Requests
Request Contents
A transaction request includes: Connection parameters User parameters Parameters specific to the type of the transaction, such as a sale or an authorization

Data Modes for Sending

You can send parameter data in the transaction request to the Payflow server in either of two modes: Name-value pair XMLPay The examples in this guide are presented in name-value pair format. Name-value pair syntax guidelines are described in PARMLIST Syntax Guidelines on page 20. XMLPay is an XML syntax for payment requests and associated responses in a paymentprocessing network. Instead of using name-value pairs, you can send XML documents to the Payflow server based on the XMLPay 2.0 schema. For details on XMLPay, see XMLPay Developers Guide in the Payflow Pro documentation on Developer Central.

Website Payments Pro Payflow Edition Developers Guide

19

Simple Payflow Transaction

Transaction Requests

Connection Parameters
The connection parameters are described below. Pass them in the format and syntax required by the Payflow SDK and programming language that you are using. See your integration documentation for details.
TABLE 3.1 Connection parameters Parameter HOSTADDRESS HOSTPORT PARMLIST Description (Required) Payflow host name. See Host Addresses on page 13 for details on host addresses. (Required) Use port 443. (Required) List of parameters that specify the payment information for the transaction. The quotation marks at the beginning and end are required. The following is an example: TRXTYPE=S&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=Sup erMerchant&PWD=SuperUserPassword&ACCT=5555555555554444&EXPDATE= 0308&AMT=123.00 The content of the PARMLIST varies by the type of transaction being processed. For example, a Void transaction requires a different set of parameters than a Sale. (Required) Time-out period for the transaction. The minimum recommended time-out value is 30 seconds. The client begins tracking from the time that it sends the transaction request to the server. (Optional) Proxy server address. Use the PROXY parameters for servers behind a firewall. Your network administrator can provide the values. (Optional) Proxy server port. (Optional) Proxy server logon ID. (Optional) Proxy server logon password.

TIMEOUT

PROXYADDRESS PROXYPORT PROXYLOGON PROXYPASSWORD

PARMLIST Syntax Guidelines

Follow these guidelines when creating the PARMLIST: Spaces are allowed in values. Enclose the PARMLIST in quotation marks (). Do not place quotation marks () within the body of the PARMLIST. Separate all name-value pairs in the PARMLIST using an ampersand (&). Set the VERBOSITY transaction parameter to MEDIUM (default is LOW) if you want the response to return more detailed information. For details, see Appendix A, Verbosity: Viewing Processor-Specific Transaction Results.
Using Special Characters in Values

Because the ampersand (&) and equal sign (=) characters have special meanings in the PARMLIST, name-value pairs like the following examples are not valid:
20

Website Payments Pro Payflow Edition Developers Guide

Simple Payflow Transaction

Sale Transaction Example

NAME=Ruff & Johnson COMMENT1=Level=5

To use special characters in the value of a name-value pair, use a length tag. The length tag specifies the exact number of characters and spaces that appear in the value. The following name-value pairs are valid.
NAME[14]=Ruff & Johnson COMMENT1[7]=Level=5
N O T E : Quotation

marks ( ) are not allowed even if you use a length tag.

User Parameters
All Payflow Pro transactions require the user parameters described below.
TABLE 3.2 User parameters Parameter USER Description (Required) If you set up one or more additional users on the account, this value is the ID of the user authorized to process transactions. If, however, you have not set up additional users on the account, USER has the same value as VENDOR. Limitations: Sixty-four alphanumeric, case-sensitive characters. (Required) Your merchant login ID that you created when you registered for the account. Limitations: Sixty-four alphanumeric, case-sensitive characters. (Required) The ID provided to you by the authorized PayPal Reseller who registered you for the Payflow SDK. If you purchased your account directly from PayPal, use PayPal. Limitations: Sixty-four alphanumeric, case-sensitive characters. (Required) The password that you defined while registering for the account. Limitations: Six- to thirty-two alphanumeric, case-sensitive characters.

VENDOR

PARTNER

PWD

Sale Transaction Example

In addition to the connection and user parameters, each transaction type has additional parameter requirements and can include a number of optional parameters as well. The transaction parameters common to all processors are described in detail in Table 4.1 on page 26. To perform a credit card Sale transaction, you are required to pass the following parameters: TRXTYPE - The type of the transaction, such as S for Sale TENDER - The method of payment, such as C for credit card ACCT - The buyers credit card number AMT - The amount of the sale

Website Payments Pro Payflow Edition Developers Guide

21

Simple Payflow Transaction

Formatting Transactions

EXPDATE - The expiration date of the credit card

Typical Sale Transaction

The following is a typical request transaction string for a Sale transaction.
TRXTYPE=S&TENDER=C&USER=SuperMerchant&PWD=SuperUserPassword&PARTNER=PayPal& ACCT=5105105105105100&EXPDATE=1209&AMT=99.06&COMMENT1=Reservation&FIRSTNAME =John&LASTNAME=Jones&STREET=123 Main St.&CITY=San Jose&STATE=CA&ZIP=123451234&BILLTOCOUNTRY=US&CVV2=123&CUSTIP=0.0.0.0

Note that, besides the required Sale transaction parameters, the above string includes other Payflow Pro parameters typically included in a credit card Sale transaction request. When the transaction completes, the Payflow server returns a response string made up of name-value pair response parameters. If the transaction is successful, a RESULT value of 0 is returned. The value of PNREF identifies the transaction in future requests, and RESPMSG is a string indicating whether the transaction was approved. This is an example response to a credit card Sale transaction request:
RESULT=0&PNREF=VXYZ01234567&RESPMSG=APPROVED&AVSADDR=Y&AVSZIP=N&IAVS=Y&CVV2 MATCH=Y

Formatting Transactions
For details on how to format a transaction based on the above information, see the examples and the supporting documentation provided with your SDK.

22

Website Payments Pro Payflow Edition Developers Guide

Credit Card Transactions

This chapter describes how to plan for implementing credit card processing, presents the core set of parameters used by all credit card processors, explains how to submit a transaction for each transaction type supported, and describes other credit card features such as card security.

Credit Card Features

Payflow Pro supports the following transaction types for credit card processing: Sale Authorization (including Account Verification) Voice Authorization Delayed Capture Credit Void Inquiry Payflow Pro also supports the following credit card features: Recharging to the same credit card (also called reference transactions) Securing credit card transactions by means of the Address Verification Service and card security code validation

About Credit Card Processing

Credit card processing occurs in two steps a real-time Authorization and a capture (settlement) of the funds that were authorized. As discussed below, you perform these two steps either as a single transaction or as two transactions, depending on your business model For an Authorization, the server sends the transaction information to a credit card processor who routes the transaction through the financial networks to the cardholders issuing bank. The issuing bank checks whether the card is valid, evaluates whether sufficient credit exists, checks values such as address verification service and card security codes (discussed below), and returns a response: Approved, Declined, Referral, or other response values. You receive the response a few seconds after you submit the transaction to the server. If an Authorization is approved, the bank temporarily reserves the credit for the amount of the transaction to prepare to capture (fulfill) the transaction. The hold on funds typically lasts for about a week.

Payflow Pro Developers Guide

23

Credit Card Transactions

About Credit Card Processing
N O T E : You

cannot remove a hold on funds through the processing networksyou must contact the card issuing bank to lift a hold early.

Capturing a transaction actually transfers the funds to your bank. At least once a day, PayPal gathers all transactions that are flagged to be settled and sends them in a batch file to the processor. The processor then charges the issuing bank and transfers the funds to your bank. It typically takes a few days before the money is actually available in your account, depending on your bank.

Obtaining an Internet Merchant Account

To accept credit cards over the internet, you need a special account called an Internet Merchant Account. Your account provider or merchant (acquiring) bank works with a PayPal-supported credit card processor, such as First Data, TSYS Acquiring Solutions (formerly Vital Processing Services), or Paymentech. To use Payflow Pro to accept live credit cards, you must provide certain details about your account to PayPal during the Go Live part of the enrollment process.
N O T E : An Internet Merchant Account is a different type of merchant account than a merchant

account used for face-to-face (in-person) retail transactions. It has additional risks associated with card-not-present (e-commerce) transactions. You need to obtain an Internet Merchant Account even if you already accept credit cards at your location. To apply for an Internet Merchant Account, contact your merchant (acquiring) bank.

Planning Your Payflow Pro Integration

In designing your Payflow Pro integration, you should evaluate the following: Whether to use a one-step or two-step transaction process. One-step: Submit a Sale transaction, which performs the Authorization and (if successful) then flags the transaction for settlement. Two-step: Perform an Authorization-only transaction and then later perform a Delayed Capture transaction. The Delayed Capture transaction can be for the same amount as the original transaction or for a lower amount. (In the case of a split shipment, you can perform a Delayed Capture transaction for the initial shipment and a reference transaction for the final payment. These transaction types, plus the details of performing a Delayed Capture for an amount higher than the original, are described in Delayed Capture Transaction: Capturing Transactions for Higher Amounts on page 32. According to card association rules, most physical goods merchants should use a two-step process, since settlement should occur when the goods are fulfilled or shipped. A two-step process is also useful if you want to evaluate information in the response, such as whether the issuer verifies the billing address, and so on. Electronic goods merchants, who fulfill the order immediately, can use the one-step process. Check with your Internet Merchant Account provider for suggestions on the best method for you. Whether or how to use risk management tools such as address verification service and card security code. For address verification service, if the data is submitted with the initial transaction, the issuer checks the street address and/or the zip (postal) code against the

24

Payflow Pro Developers Guide

Credit Card Transactions

About Credit Card Processing

billing address on file for the consumer. Address verification service is described on page Using Address Verification Service on page 44. Card security code refers to a 3- or 4-digit number that appears on the back of most credit cards. On American Express, the number appears above and to the right of the embossed card number. Card security code is known by other names, such as CVV2, depending on the type of card. If card security code data is submitted, the issuer can notify you whether the number matches the number assigned to the card. Card security code is described on page Card Security Code Validation on page 46. It may also be possible to implement additional safeguards yourself or to use a fraud service. You might want to discuss risk management with your Internet Merchant Account provider. Store information in your local database or use PayPal Manager reports to manage the data. You may want to store shipping information in your system, or you may prefer to send the information to PayPal with the transaction and report on it later.
N O T E : PayPal

recommends that you do not store credit card numbers. If you must store numbers, encrypt and store them behind properly configured firewalls. You should also consider whether and how to use the merchant-defined fields COMMENT1 and COMMENT2 to help tie reports to your orders/customers or to report on other information about the transaction.

If or how you want to integrate with other systems, such as order fulfillment, customer service, and so on. You may wish to connect these systems directly to Payflow Pro for capturing funds, issuing refunds/credits, and so on. Alternatively, you may prefer to perform these steps manually using PayPal Manager. Either way, PayPal recommends that you monitor transaction activity using PayPal Manager. You may want to discuss, with your Internet Merchant Acquirer, practices that help you to obtain the most advantageous rates.

Complying With the E-commerce Indicator (ECI)

Some processors support a software flag called E-commerce Indicator (ECI) that indicates that the associated transaction is an internet transaction. Payflow Pro complies with ECI basic requirements for all supported processors. If you use the Buyer Authentication Service, then the ECI values reflects the Authentication status. See Payflow Pro Fraud Protection Service Users Guide on Developer Central.

Handling Credit Card Type Information

The Payflow SDK does not check the credit card types that you are accepting. If a customer uses a card type that you are not signed up to accept, the Payflow SDK responds with RESULT value 23, Invalid account number, or the processor returns a message that the customer is not signed up for the card type. For details on RESULT values and response messages, see RESULT Values and RESPMSG Text on page 56. Optionally, you can provide your

Payflow Pro Developers Guide

25

Credit Card Transactions

Parameters Used in Credit Card Transactions

customer with a list of the card types that you accept (in a drop-down list or menu, for example). To accept additional credit card types, you must contact your acquiring bank (the merchant that holds your Internet Merchant Account) and ask them to add the card type to your account. Upon notification from your Acquirer that you can start accepting the card type, you must add the card to your Payflow Pro account through PayPal Manager. See PayPal Manager online help for details.

Parameters Used in Credit Card Transactions

All credit card processors accept the basic parameters described in the table below with one exception: the PayPal processor does not support SWIPE. Some processors require additional parameters described in the following sections: Processors Requiring Additional Transaction Parameters on page 65. Additional Reporting Parameters on page 143
TABLE 4.1 Credit card transaction request parameters Parameter TENDER Description (Required) The method of payment. Values are: A = Automated clearinghouse C = Credit card D = Pinless debit K = Telecheck P = PayPal See the Payflow ACH Payment Service Guide for details on the Automated clearinghouse tender type. (Required) Indicates the type of transaction to perform. Values are: S = Sale transaction C = Credit A = Authorization D = Delayed Capture V = Void F = Voice Authorization I = Inquiry N = Duplicate transaction
N O T E : A type N transaction represents a duplicate transaction (version 4 SDK or

TRXTYPE

HTTPS interface only) with a PNREF the same as the original. It appears only in the PayPal Manager user interface and will never settle.

26

Payflow Pro Developers Guide

Credit Card Transactions

Parameters Used in Credit Card Transactions TABLE 4.1 Credit card transaction request parameters Parameter ACCT Description (Required for credit cards) Credit card or purchase card number. For the Pinless debit TENDER type, ACCT can be the bank account number. Limitations: This value may not contain spaces, non-numeric characters, or dashes. For example, ACCT=5555555555554444 (Required) Expiration date of the credit card. Limitations: mmyy format. For example, 1008 represents November 2008. (Required) Amount (Default: U.S. based currency). Limitations: Specify the exact amount to the cent using a decimal pointuse 34.00, not 34. Do not include comma separatorsuse 1199.95 not 1,199.95. Your processor and/or Internet Merchant Account provider may stipulate a maximum amount. 10 numeric characters plus decimal. (Optional) Merchant-defined value for reporting and auditing purposes. Limitations: 128 alphanumeric characters. (Optional) Merchant-defined value for reporting and auditing purposes. Limitations: 128 alphanumeric characters. (Optional) A code that is printed (not imprinted) on the back of a credit card. Used as partial assurance that the card is in the buyers possession. Limitations: 3 or 4 digits. (Optional) Account holder's first name. Limitations: 30 alphanumeric characters. (Optional but recommended) Account holder's last name. Limitations: 30 alphanumeric characters. (Optional) The cardholders street address (number and street name). The STREET address is verified by the address verification service. Limitations: 30 alphanumeric characters. (Optional) Account holders 5- to 9-digit zip (postal) code. Limitations: Nine characters maximum. Do not use spaces, dashes, or non-numeric characters.

EXPDATE

AMT

COMMENT1

COMMENT2

CVV2

FIRSTNAME

LASTNAME

STREET

ZIP

Payflow Pro Developers Guide

27

Credit Card Transactions

Submitting Sale Transactions TABLE 4.1 Credit card transaction request parameters Parameter SWIPE Description (Required for card-present transactions only) Used to pass the Track 1 or Track 2 data (cards magnetic stripe information) for card-present transactions. Include either Track 1 or Track 2 datanot both. If Track 1 is physically damaged, the point-of-sale (POS) application can send Track 2 data instead. The track data includes the disallowed = (equal sign) character. To enable you to use the data, the SWIPE parameter must include a length tag specifying the number of characters in the track data. For this reason, in addition to passing the track data, the POS application must count the characters in the track data and pass that number. Length tags are described in Using Special Characters in Values on page 20.
N O T E : SWIPE (card-present transactions) are not supported by the PayPal processor..

Limitations: Alphanumeric characters.

Submitting Sale Transactions

The Sale transaction (TRXTYPE=S) charges the specified amount against the account, and marks the transaction for immediate fund transfer during the next settlement period. PayPal submits each merchants transactions for settlement on a daily basis.

When To Use a Sale Transaction

A Sale transaction is best suited to businesses that provide immediate fulfillment for their products or services. If your business does not provide immediate fulfillment, then credit card association rules recommend that you use an Authorization and a Delayed Capture transaction. For details, see Submitting Authorization/Delayed Capture Transactions on page 29. If you need to recharge a credit card and you are not storing the credit card information in your local database, you can perform a new reference transaction based on a Sale transaction.

Additional Parameters For Sale Transactions

To perform a Sale transaction, you are required to pass the following parameters: ACCT AMT EXPDATE
N O T E : The

pinless debit tender type requires essentially the same parameters as a credit card transaction. In addition to the values required by all transactions, you must pass values for the ACCT and AMT parameters. The First Data Merchant Services (FDMS) South processing platform supports Sale and Credit transactions only.

28

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Authorization/Delayed Capture Transactions

Typical Sale Transaction Parameter String

The following is a typical PARMLIST string passed in a Sale transaction.
TRXTYPE=S&TENDER=C&USER=SuperUser&PWD=SuperUserPassword&VENDOR=SuperUser&PA RTNER=PayPal&ACCT=5105105105105100&EXPDATE=1209&CVV2=123&AMT=99.00&FIRSTNAM E=John&LASTNAME=Smith&STREET=123 Main St.&CITY=San Jose&STATE=CA&ZIP=12345&COMMENT1=Reservation&INVNUM=1234567890&PONUM=C12345 &CVV2=567&VERBOSITY=MEDIUM

Note that, besides the required parameters that you pass in a Sale transaction, this string includes other typical parameters. The COMMENT1 (and COMMENT2) fields help to track transaction information. The customers street address (STREET) and zip should be passed to use address verification service. CVV2 is needed for card security code validation. For details on address verification service and card security code, see the following sections: Submitting Card-Present (SWIPE) Transactions on page 42 Card Security Code Validation on page 46

Submitting Authorization/Delayed Capture Transactions

An Authorization (TRXTYPE=A) transaction places a hold on the cardholders open-to-buy limit, lowering the cardholders limit by the amount of the transaction. It does not transfer funds. A Delayed Capture (TRXTYPE=D) transaction is performed after an Authorization to capture the original Authorization amount. The Delayed Capture is scheduled for settlement during the next settlement period. Because Visa and MasterCard regulations prohibit capturing credit card transaction funds until a product or service has shipped to the buyer, most processing networks implement an Authorization transaction followed by a Delayed Capture transaction.

When To Use Authorization/Delayed Capture Transactions

If your business does not provide immediate fulfillment of products or services, you should use this two-stage transaction solution, also known as Delayed Capture processing, because it enables you to capture credit card transaction funds when your are ready to collect them.
N O T E : If you signed up for the PayPal processor with Fraud Protection Services, you must use

delayed capture processing for all sale transactions. If your business provides immediate fulfillment and you are not using the PayPal processor with Fraud Protection Services, you can use a simple Sale transaction instead. For details, see Submitting Sale Transactions on page 28. If you need to recharge a credit card and you are not storing the credit card information in your local database, you can perform a new reference transaction based on a Sale. For details, see Submitting Authorization/Delayed Capture Transactions on page 29.

Payflow Pro Developers Guide

29

Credit Card Transactions

Submitting Authorization/Delayed Capture Transactions
IMPO RTANT: Only

one Delayed Capture transaction is allowed per Authorization transaction.

Required Authorization Transaction Parameters

To perform an Authorization transaction, you are required to pass the following parameters: ACCT AMT EXPDATE

Typical Authorization Transaction Parameter String

A typical parameter string passed in an Authorization transaction is the same as a Sale transaction string. The only difference is that the TRXTYPE value is A in an Authorization.
TRXTYPE=A&TENDER=C&USER=SuperUser&PWD=SuperUserPassword&VENDOR=SuperUser&PA RTNER=PayPal&ACCT=5105105105105100&EXPDATE=1209&CVV2=123&AMT=99.00& FIRSTNAME=John&LASTNAME=Smith&STREET=123 Main St.&CITY=San Jose &STATE=CA&ZIP=12345&COMMENT1=Reservation&INVNUM=1234567890&PONUM=C12345&CVV 2=567&VERBOSITY=MEDIUM

Required Delayed Capture Transaction Parameters

To perform a Delayed Capture transaction, you are required to pass the following parameter: ORIGID
TABLE 4.2 Delayed Capture required parameter Parameter ORIGID Description (Required by some transaction types) ID of the original transaction that is being referenced. This ID is returned by the PNREF parameter and appears as the Transaction ID in PayPal Manager reports. Limitations: 12 case-sensitive alphanumeric characters.

Set ORIGID to the PNREF (Transaction ID in PayPal Manager reports) value returned from the original transaction. In addition, if the amount of the capture differs from the amount of the Authorization, you also must pass a value for AMT.
Fields Copied From the Authorization Transaction into the Delayed Capture Transaction

The following fields are copied from the Authorization transaction into the Delayed Capture transaction (if they exist in the original transaction). If you provide a new value for any of these parameters when submitting the Delayed Capture transaction, then the new value is

30

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Authorization/Delayed Capture Transactions

used. (Exceptions are ACCT, EXPDATE, and SWIPE. These parameters retain their original values.)
TABLE 4.3 Fields copied from Authorization to Delayed Capture transaction ACCT COMMENT2 CUSTIP FIRSTNAME INVNUM SHIPTOFIRSTNAME SHIPTOSTREET SWIPE ZIP AMT COMPANYNAME DUTYAMT MIDDLENAME PONUM SHIPTOMIDDLENAME SHIPTOZIP TAXAMT CITY BILLTOCOUNTRY EMAIL LASTNAME SHIPTOCITY SHIPTOLASTNAME STATE PHONENUM COMMENT1 CUSTCODE EXPDATE FREIGHTAMT SHIPTOCOUNTRY SHIPTOSTATE STREET TAXEXEMPT

To perform the Delayed Capture: 1. Perform the Authorization transaction. The Authorization transaction uses the same parameters as Sale transactions, except that the transaction type is A. The return data for an Authorization transaction is the same as for a Sale transaction. To capture the authorized funds, perform a Delayed Capture transaction that includes the value returned for PNREF, as described in Step 2 below. Example: Authorization-only Transaction
TRXTYPE=A&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=S uperMerchant&ACCT=5555555555554444&EXPDATE=0308&AMT=123.00&COMMENT1=Seco nd purchase&COMMENT2=Low risk customer&INVNUM=123456789&STREET=5199 MAPLE&ZIP=94588

Example:Authorization Response
RESULT=0&PNREF=VXYZ01234567&RESPMSG=APPROVED&AUTHCODE=123456 &AVSADDR=Y&AVSZIP=N

Payflow Pro Developers Guide

31

Credit Card Transactions

Submitting Account Verifications With TRXTYPE=A

2. Perform the Delayed Capture transaction. Set ORIGID to the PNREF value returned in the original Authorization transaction response string. (There is no need to retransmit the credit card or billing address informationit is stored at PayPal.) If the capture succeeds, the amount of the Capture is transferred to the merchants account during the daily settlement process. If the capture does not succeed, the hold on the cardholders open-to-buy is still in effect. Example:Delayed Capture Transaction
TRXTYPE=D&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=.SuperMerchant &USER=SuperMerchant&ORIGID=VXYZ00887892

Example:Delayed Capture Response

RESULT=0&PNREF=VXYZ00895642&AUTHCODE=25TEST&AVSADDR=Y&AVSZIP=N

Delayed Capture Transaction: Capturing Transactions for Lower Amounts

You can perform a Delayed Capture transaction for an amount lower than the original Authorization amount (useful, for example, when you make a partial shipment).

Delayed Capture Transaction: Capturing Transactions for Higher Amounts

You can perform a Delayed Capture transaction for an amount higher than the original Authorization amount. The cardholders open-to-buy could be reduced by the sum of the original Authorization-only amount and the final Delayed Capture amount.

Delayed Capture Transaction: Error Handling and Retransmittal

If an error occurs while processing a Delayed Capture transaction, it is safe to retry the capture with values that allow the Payflow server to successfully process it. Conversely, if a capture for a previous Authorization succeeds, subsequent attempts to capture it again will return an error.

Submitting Account Verifications With TRXTYPE=A

Account Verification, also known as zero dollar Authorization (TRXTYPE=A), verifies credit card information. While Account Verification and normal Authorization transactions are submitted using TRXTYPE=A, Account Verification differs from Authorization in the following ways: The AMT value is always 0. If any other amount is submitted, the transaction as a normal Authorization that places a hold on the cardholders open-to-buy limit. Although the RESULT value returned is 0 (Approved), the RESPMSG value is Verified instead of Approved.

32

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Voice Authorization Transactions

The TRANSSTATE is set to 0 to prevent these types of transactions from being credited, voided, or captured. See VERBOSITY: Viewing Processor-Specific Transaction Results on page 139 for details on TRANSSTATE.
N O T E : RESULT

value 4, Invalid Amount, is returned if the processor does not support Account Verifications.

When To Use Account Verification

Use an Account Verification to validate account numbers and other authentication elements such as CVV2 and AVS. You can also use an Account Verification as a Reference Transaction. See Recharging to the Same Credit Card (Reference Transactions) on page 40.

Example Account Verification

This is an example of account verification: TRXTYPE=A&TENDER=C&USER=SuperUser&PWD=SuperUserPassword&VENDOR=Super User&PARTNER=PayPal&ACCT=4111111111111111&EXPDATE=0712&CVV2=123&AMT= 0.00&CURRENCY=USD&STREET=123 Main St.&ZIP=11232&VERBOSITY=MEDIUM This is the response: RESULT=0&PNREF=V79E1E4610CE&RESPMSG=Verified&AUTHCODE=010101&AVSADDR =Y&AVSZIP=Y&CVV2MATCH=Y&HOSTCODE=00&PROCAVS=Y&PROCCVV2=M&IAVS=N

Submitting Voice Authorization Transactions

A Voice Authorization (TRXTYPE=F) transaction is a transaction that is authorized over the telephone from the processing network.
N O T E : The

PayPal processor does not support Voice Authorization transactions.

When to Use a Voice Authorization Transaction

Some transactions cannot be authorized over the internet (for example, high dollar amounts) and require manual authorization. These transactions generate RESULT value 13 and are called Referral transactions. In these situations, you contact the customer service department of your merchant bank and provide the payment information as requested. If the transaction is approved, the bank provides you with a voice Authorization code (AUTHCODE) for the transaction.. Once a Voice Authorization transaction has been approved, it is treated like a Sale transaction and is settled with no further action on your part.

Payflow Pro Developers Guide

33

Credit Card Transactions

Submitting Credit Transactions

Like Sale transactions, approved Voice Authorization transactions can be voided before settlement occurs.

Required Voice Authorization Transaction Parameters

When sending a Voice Authorization transaction request, you are required to include the AUTHCODE provided by your merchant bank.
TABLE 4.4 Voice Authorization transaction required parameter Parameter AUTHCODE Description (Required for Voice Authorizations only) Returned only for approved Voice Authorization transactions. AUTHCODE is the approval code obtained over the telephone from the processing network. Limitations: Six alphanumeric characters.

The following is an example Voice Authorization transaction request parameter string:

TRXTYPE=F&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P WD=x1y2z3&AUTHCODE=AB34RT56&ACCT=5555555555554444&EXPDATE=0308&AMT=123.00

Submitting Credit Transactions

The Credit transaction (TRXTYPE=C) refunds the specified amount to the cardholder.

Required Credit Transaction Parameters

The required parameter data for a Credit transaction depends on the Allow non-referenced credits security setting for your Payflow Pro account. A non-referenced credit is a Credit transaction that does not use the credit card information from an existing transaction. Credit card information must be supplied. As an example, Sally Smith calls you on the telephone to cancel an order from your business. To refund her money, you credit her credit card by submitting a non-referenced Credit transaction. Guidelines and parameter requirements for Credit transactions differ depending on whether or not non-referenced credits are allowed.
Non-Referenced Credits Not Allowed

When non-referenced credits are not allowed (the setting recommended by PayPal), then Credit transactions are permitted only against existing Sale, Delayed Capture, and Voice Authorization transactions. To submit a Credit transaction when non-referenced credits are not allowed, you must pass the following parameter:

34

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Credit Transactions

ORIGID TABLE 4.5 Credit required parameter Parameter ORIGID Description (Required by some transaction types) ID of the original transaction that is being referenced. This ID is returned by the PNREF parameter and appears as the Transaction ID in PayPal Manager reports. Limitations: 12 case-sensitive alphanumeric characters.

Set the value of ORIGID to the PNREF value returned for the original transaction. (PNREF is displayed as the Transaction ID in PayPal Manager reports.) If you do not specify an amount, then the amount of the original transaction is credited to the cardholder.
Non-Referenced Credits Allowed

When non-referenced credits are allowed, then Credit transactions are permitted in any amount up to the transaction limit for the credit card account that you specify. To submit a Credit transaction when non-referenced credits are allowed, you must pass values for the following parameters:
ACCT EXPDATE AMT
IMPO RTANT: The

default security setting for Payflow Pro accounts is Allow non-referenced credits = No, so sending the ORIGID is the preferred method for performing Credit transactions. Using the ACCT, EXPDATE, or AMT parameters for such accounts leads to RESULT value 117 (failed the security check). For information on setting the security settings, see PayPal Manager online help.

Fields Copied From the Original Transaction into the Credit Transaction

The following fields are copied from the original transaction into the Credit transaction (if they exist in the original transaction). If you provide a new value for any of these parameters when submitting the Credit transaction, then the new value is used. (Exceptions are ACCT, EXPDATE, and SWIPE. These parameters retain their original values).
N O T E : These

fields are not copied for referenced credits: TAXAMT, TAXEXEMPT, DUTYAMT, FREIGHTAMT, and (for American Express only) DESC4.

N O T E : For

processors that use the RECURRING parameter: If the RECURRING parameter was set to Y for the original transaction, then the setting is ignored when forming the Credit transaction.

TABLE 4.6 Fields copied from original to Credit transaction ACCT AMT CITY COMMENT1

Payflow Pro Developers Guide

35

Credit Card Transactions

Submitting Void Transactions TABLE 4.6 Fields copied from original to Credit transaction COMMENT2 CUSTIP MIDDLENAME SHIPTOCITY SHIPTOLASTNAME STATE ZIP COMPANYNAME EMAIL LASTNAME SHIPTOCOUNTRY SHIPTOSTREET STREET BILLTOCOUNTRY EXPDATE INVNUM SHIPTOFIRSTNAME SHIPTOSTATE SWIPE CUSTCODE FIRSTNAME PONUM SHIPTOMIDDLENAME SHIPTOZIP PHONENUM

Credit Transaction Parameter Strings

This is an example Credit transaction string (non-referenced credits not allowed):
TRXTYPE=C&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P WD=x1y2z3&ORIGID=VPNE12564395

This is an example Credit transaction string (non-referenced credits allowed):

TRXTYPE=C&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P WD=x1y2z3&ACCT=5555555555554444&EXPDATE=0308&AMT=123.00

Submitting Void Transactions

The Void transaction (TRXTYPE=V) prevents a transaction from being settled. As part of its internal process, PayPal makes reasonable effort to process authorization reversals for void transactions for debit and credit cards if the processor supports it for a given card type. Because the honoring of authorization reversals is ultimately decided by the bank or issuer, there is no accurate way to determine if an individual bank or issuer has honored an authorization reversal request.
N O T E : For

more information on authorization reversals, see

http://en.wikipedia.org/wiki/Authorization_hold.

When To Use a Void Transaction

Follow these guidelines: You can void Delayed Capture, Sale, Credit, Authorization, and Voice Authorization transactions. You cannot void a Void transaction. You can only use a Void transaction on a transaction that has not yet settled. To refund a customers money for a settled transaction, you must submit a Credit transaction.

36

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Void Transactions

Required Void Transaction Parameters

To submit a Void transaction, you must pass the following parameter: ORIGID
TABLE 4.7 Void required parameter Parameter ORIGID Description (Required by some transaction types) ID of the original transaction that is being referenced. This ID is returned by the PNREF parameter and appears as the Transaction ID in PayPal Manager reports. Limitations: 12 case-sensitive alphanumeric characters.

Set ORIGID to the PNREF (Transaction ID in PayPal Manager reports) value returned for the original transaction.
Fields Copied From the Original Transaction into the Void Transaction

The following fields are copied from the original transaction into the Void transaction (if they exist in the original transaction). If you provide a new value for any of these parameters when submitting the Void transaction, then the new value is used. (Exceptions are ACCT, EXPDATE, and SWIPE. These parameters retain their original values).
N O T E : For

processors that use the RECURRING parameter: If the RECURRING parameter was set to Y for the original transaction, then the setting is ignored when forming the Void transaction.

TABLE 4.8 Fields copied from original Void transaction ACCT COMMENT2 CUSTIP FIRSTNAME INVNUM SHIPTOFIRSTNAME SHIPTOSTREET SWIPE ZIP AMT COMPANYNAME DUTYAMT MIDDLENAME PONUM SHIPTOMIDDLENAME SHIPTOZIP TAXAMT CITY BILLTOCOUNTRY EMAIL LASTNAME SHIPTOCITY SHIPTOLASTNAME STATE PHONENUM COMMENT1 CUSTCODE EXPDATE FREIGHTAMT SHIPTOCOUNTRY SHIPTOSTATE STREET TAXEXEMPT

Example Void Transaction Parameter String

This is an example Void transaction parameter string:

Payflow Pro Developers Guide

37

Credit Card Transactions

Submitting Inquiry Transactions

TRXTYPE=V&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant& PWD=x1y2z3&ORIGID=VPNE12564395

Submitting Inquiry Transactions

An Inquiry transaction (TRXTYPE=I) returns the result and status of a transaction.

When To Use an Inquiry Transaction

You perform an inquiry using a reference to an original transactioneither the PNREF value returned for the original transaction or the CUSTREF value that you specified for the original transaction. While the amount of information returned in an Inquiry transaction depends upon the VERBOSITY setting, Inquiry responses mimic the verbosity level of the original transaction as much as possible. For details on VERBOSITY, see VERBOSITY: Viewing Processor-Specific Transaction Results on page 137.

Required Parameters When Using the PNREF

To submit an Inquiry transaction when using the PNREF, you must pass the following parameter: ORIGID
TABLE 4.9 Inquiry request required parameter when using the PNREF Parameter ORIGID Description (Required by some transaction types) ID of the original transaction that is being referenced. This ID is returned by the PNREF parameter. Limitations: 12 case-sensitive alphanumeric characters.

Set ORIGID to the PNREF (Transaction ID in PayPal Manager reports) value returned for the original transaction.

Inquiry Transaction Parameter String Using the PNREF

This is an example Inquiry transaction parameter string using the ORIGID parameter set to the PNREF value:
TRXTYPE=I&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant &USER=SuperMerchant&PWD=x1y2z3&ORIGID=VPNE12564395

38

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Inquiry Transactions

Required Parameters When Using the CUSTREF

To submit an Inquiry transaction when using the CUSTREF, you must pass the following parameter: CUSTREF Optionally, specify the STARTTIME and ENDTIME parameters. The Inquiry transaction request parameters are described below.
TABLE 4.10 Inquiry transaction request parameters when using the CUSTREF Parameter CUSTREF Description (Required) Merchant-defined identifier for reporting and auditing purposes. For example, you can set CUSTREF to the invoice number. You can use CUSTREF when performing Inquiry transactions. To ensure that you can always access the correct transaction when performing an Inquiry, you must provide a unique CUSTREF when submitting any transaction, including retries. Limitations: 12 alphanumeric characters. (Optional) For Inquiry transactions when using CUSTREF to specify the transaction. ENDTIME specifies the end of the time period during which the transaction specified by the CUSTREF occurred. See STARTTIME. ENDTIME must be less than 30 days after STARTTIME. An inquiry cannot be performed across a date range greater than 30 days. If you set ENDTIME, and not STARTTIME, then STARTTIME is defaulted to 30 days before ENDTIME. If neither STARTTIME nor ENDTIME is specified, then the system searches the last 30 days. Limitations: 14 numeric characters in the format yyyymmddhhmmss. (Optional) For Inquiry transactions when using CUSTREF to specify the transaction. ENDTIME specifies the end of the time period during which the transaction specified by the CUSTREF occurred. See STARTTIME. Limitations: 14 numeric characters.
IMPO RTANT: If

STARTTIME

ENDTIME

there are multiple transactions with a particular CUSTREF value, then the Inquiry transaction returns only the last transaction with the specified CUSTREF. So, to ensure that you can always access the correct transaction, you must use a unique CUSTREF when submitting any transaction, including retries.

Inquiry Transaction Parameter String Using the CUSTREF

This is an example Inquiry transaction parameter string using the CUSTREF:

Payflow Pro Developers Guide

39

Credit Card Transactions

Recharging to the Same Credit Card (Reference Transactions)

TRXTYPE=I&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant&P WD=x1y2z3&CUSTREF=Inv00012345

Recharging to the Same Credit Card (Reference Transactions)

If you need to recharge a credit card and you are not storing the credit card information in your local database, you can perform a reference transaction. A reference transaction takes the existing credit card information that is on file and reuses it.
N O T E : The PNREF returned in the original transaction is valid for use in reference transactions

for a period of 12 months. A PNREF returned by Account Verification also can be used in a reference transaction.

When To Use a Reference Transaction

Say that Joe Smith purchases a holiday gift from your web site store and requests that it be sent by UPS ground service. That evening, Joe becomes concerned that the item might not arrive in time for the holiday. So he calls you to upgrade shipping to second-day air. You obtain his approval for charging an extra $10 for the upgrade. In this situation, you can create a reference transaction based on the original Authorization and charge an additional $10 to Joes credit card without having to ask him again for his credit card information.
IMPO RTANT: As a security measure, reference transactions are disallowed by default. Only

your account administrator can enable reference transactions for your account. If you attempt to perform a reference transaction in an account for which reference transactions are disallowed, RESULT value 117 is returned. See PayPal Manager online help for instructions on setting reference transactions and other security features. Sale and Authorization transactions can make use of a reference transaction as a source of transaction data. PayPal looks up the reference transaction and copies its transaction data into the new Sale or Authorization transaction. With the exception of dollar amount data, which triggers a filter if out of range, reference transactions are not screened by Fraud Protection Services filters.
IMPO RTANT: When PayPal looks up the reference transaction, neither the transaction being

referenced nor any other transaction in the database is changed in any way. That is, a reference transaction is a read-only operationonly the new transaction is populated with data and acted upon. No linkage is maintained between the reference transaction and the new transaction. You can also initiate reference transactions from PayPal Manager. See PayPal Manager online help for details.

40

Payflow Pro Developers Guide

Credit Card Transactions

Recharging to the Same Credit Card (Reference Transactions)

Transaction Types that Can Be Used as the Original Transaction

You can reference the following transaction types to supply data for a new Sale or Authorization transaction: Authorization (To capture the funds for an approved Authorization transaction, be sure to perform a Delayed Capture transactionnot a Reference transaction.) Credit Delayed Capture Sale Voice Authorization (The Voice Authorization code is not copied to the new transaction) Void

Fields Copied From Reference Transactions

The following fields are copied from the reference transaction into the new Sale or Authorization transaction (if they exist in the original transaction). If you provide a value for any of these parameters when submitting the new transaction, then the new value is used.
TABLE 4.11 Fields copied from reference transactions ACCTTYPE ACCT EXPDATE FIRSTNAME MIDDLENAME LASTNAME STREET CITY STATE ZIP BILLTOCOUNTRY SWIPE

Example Reference Transaction

In this example, you authorize an amount of $100 for a shipment and charge $66 for the first partial shipment using a normal Delayed Capture transaction. You charge the $34 for the final part of the shipment using a reference transaction to draw credit card and shipping address information from the initial Authorization transaction. This example procedure creates a reference transaction:

Payflow Pro Developers Guide

41

Credit Card Transactions

Submitting Card-Present (SWIPE) Transactions

1. Submit the initial transaction, such as an Authorization. You use an Authorization transaction for the full amount of the purchase of $100 as shown in this transaction request:
TRXTYPE=A&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=S uperMerchant&ACCT=5555555555554444&EXPDATE=0308&AMT=100.00&INVNUM=123456 789&STREET=5199 MAPLE&ZIP=94588

Note the value of the PNREF in the response:

RESULT=0&PNREF=VXYZ01234567&RESPMSG=APPROVED&AUTHCODE=123456&AVSADDR=Y&A VSZIP=N
N O T E : The

PNREF returned in the original transaction is valid for use in reference transactions for a period of 12 months.

2. Capture the authorized funds for a partial shipment of $66. When you deliver the first $66 worth of product, you use a normal Delayed Capture transaction to collect the $66. Set ORIGID to the value of PNREF in the original Authorization as in this transaction request (See Required Delayed Capture Transaction Parameters on page 30):
TRXTYPE=D&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=S uperMerchant&ORIGID=VXYZ01234567&AMT=66.00

This is the response:

RESULT=0&PNREF=VXYZ01234568&AUTHCODE=25TEST&AVSADDR=Y&AVSZIP=N

3. Submit a new Sale transaction or Authorization/Delayed Capture transaction of $34 for the rest of the shipment. Once you have shipped the remainder of the product, you can collect the remaining $34 in a Sale transaction that uses the initial Authorization as a reference transaction. (This is a Sale transaction because only one Delayed Capture transaction is allowed per Authorization.) This is the Sale transaction request:
TRXTYPE=S&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=S uperMerchant&ORIGID=VXYZ01234567&AMT=34.00

This is the response:

RESULT=0&PNREF=VXYZ01234569&AUTHCODE=25TEST&AVSADDR=Y&AVSZIP=N

Submitting Card-Present (SWIPE) Transactions

Payflow Pro supports card-present transactions (face-to-face purchases).
N O T E : SWIPE (card-present) transactions are not supported by the PayPal processor.

Follow these guidelines to take advantage of the lower card-present transaction rate: Contact your merchant account provider to ensure that they support card-present transactions. Contact PayPal Customer Service to request having your account set up properly for accepting and passing swipe data.

42

Payflow Pro Developers Guide

Credit Card Transactions

Submitting Card-Present (SWIPE) Transactions

If you plan to process card-present as well as card-not-present transactions, set up two separate Payflow Pro accounts. Request that one account be set up for card-present transactions, and use it solely for that purpose. Use the other for card-not-present transactions. Using the wrong account may result in downgrades. A Sale is the preferred method to use for card-present transactions. Consult with your acquiring bank for recommendations on other methods.

Supported Processing Platforms

PayPal is certified to submit card-present transactions for the following processing platforms: American Express Phoenix First Data Merchant Services (FDMS) Nashville First Data Merchant Services (FDMS) North First Data Merchant Services (FDMS) South Global Payments Central Global Payments East Merchant e-Solutions Elavon (Formerly Nova) Paymentech Salem (New Hampshire) Paymentech Tampa TSYS Acquiring Solutions

Card-present Transaction Syntax

Use the SWIPE parameter to pass the Track 1 or Track 2 data (the cards magnetic stripe information). Include either Track 1 or Track 2 datanot both (up to 80 alphanumeric characters). If Track 1 is physically damaged, the POS application can send Track 2 data instead. The track data includes the disallowed = (equal sign) character. To enable you to use the data, the SWIPE parameter must include a length tag specifying the number of characters in the track data. For this reason, in addition to passing the track data, the POS application must count the characters in the track data and pass that number. Length tags are described in Using Special Characters in Values on page 20. The length tag in the following example is [40]. Do not include the ACCT or EXPDATE parameters in card-present transactions, as this data is included in the SWIPE value. This is an example card-present transaction parameter string:
TRXTYPE=S&TENDER=C&PARTNER=PayPal&USER=SuperMerchant&PWD=SuperMerchant&SWI PE[40]=;4912000033330026=15121011000012345678?&AMT=21.00

Payflow Pro Developers Guide

43

Credit Card Transactions

Submitting Purchasing Card Transactions

Submitting Purchasing Card Transactions

A purchasing card (also referred to as a commercial card, corporate card, procurement card or business card) is a credit card that is issued at the request of an employer. It is usually reserved for business-related charges. The card issuer provides specialized reporting for this card type so the employer can monitor the use of the card. There is no method for determining whether a card is a purchase card or a commercial card based on the card number. To obtain the best bank interchange rates for commercial cards, you must pass specific additional transaction information. Commercial card support and parameters vary from processor to processor. SeeSubmitting Purchasing Card Level 2 and Level 3 Transactions on page 97.
N O T E : Purchasing

card transactions are not supported by the PayPal processor.

Using Address Verification Service

To qualify for the lowest bank rate, you must pass address verification service information street address and ZIP (postal) code. Address verification service compares the submitted billing street address and zip code with the values on file at the cardholders bank. The response includes values for AVSADDR and AVSZIP: Y, N, or X for the match status of the customers street address and zip code. Y = match, N = no match, X = cardholders bank does not support address verification service. The address verification service result is for advice only. Banks do not decline transactions based on the address verification service resultthe merchant makes the decision to approve or decline a transaction. Address verification service is supported by most US banks and some international banks.
N O T E : Address

verification service checks only for a street number match, not a street name match, so 123 Main Street returns the same response as 123 Elm Street.

The international address verification service (IAVS) response indicates whether address verification service response is international (Y), USA (N), or cannot be determined (X).

Processing Platforms Supporting Address Verification Service

TABLE 4.12 Processing platforms supporting Address Verification Service Processing Platform American Express Phoenix American Express X Discover Master Card Visa

44

Payflow Pro Developers Guide

Credit Card Transactions

Example Address Verification Service Request Parameter List TABLE 4.12 Processing platforms supporting Address Verification Service Processing Platform American Express Brighton FDMS Nashville FDMS North FDMS South Global Payments Central Global Payments East Merchant e-Solutions Elavon (formerly Nova) Paymentech Salem (New Hampshire) Paymentech Tampa TSYS Acquiring Solutions (formerly Vital Processing Services) American Express X X X X X X X X X X X Discover X X X X X X X X X X Master Card X X X X X X X X X X Visa X X X X X X X X X X

See your processors information in Processors Requiring Additional Transaction Parameters on page 65 for information on their handling of address verification service.

Example Address Verification Service Request Parameter List

This example request include the address verification service request parameters STREET and ZIP:
TRXTYPE=A&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=Supe rMerchant&&ACCT=5555555555554444&EXPDATE=0308&AMT=123.00&STREET=5199 Maple&ZIP=98765

Example Address Verification Service Response

In this example, the address value matches the value in the banks records, but the zip code does not. The AVSZIP response is N.
RESULT=0&PNREF=VXW412345678&RESPMSG=APPROVED&AUTHCODE=123456&AVSADDR=Y&AVSZ IP=N&IAVS=X

Payflow Pro Developers Guide

45

Credit Card Transactions

Card Security Code Validation

Card Security Code Validation

The card security code is a 3- or 4-digit number (not part of the credit card number) that is printed on the credit card. Because the card security code appears only on the card and not on receipts or statements, the card security code provides some assurance that the physical card is in the possession of the buyer. This fraud prevention tool has various names, depending on the payment network. Visa calls it CVV2 and MasterCard calls it CVC2. To ensure that your customers see a consistent name, PayPal recommends use of the term card security code on all end-user materials.
IMPO RTANT: To

comply with credit card association regulations, do not store the CVV2 value.

On most cards, the card security code is printed on the back of the card (usually in the signature field). All or part of the card number appears before the card security code (567 in the example). For American Express, the 4-digit number (1122 in the example) is printed on the front of the card, above and to the right of the embossed account number. Be sure to explain this to your customers.
FIGURE 4.1 Card security code

Processing Platforms and Credit Cards Supporting Card Security Code

N O T E : You

need to contact American Express to be set up to accept their CID card security code.

TABLE 4.13 Processing platforms supporting card security code Processing Platform American Express Phoenix American Express Brighton FDMS Nashville FDMS North American Express X X X X Discover X X Master Card X X Visa X X

46

Payflow Pro Developers Guide

Credit Card Transactions

Card Security Code Validation TABLE 4.13 Processing platforms supporting card security code Processing Platform FDMS South Global Payments Central Global Payments East Merchant e-Solutions Elavon (formerly Nova) Paymentech Salem (New Hampshire) Paymentech Tampa TSYS Acquiring Solutions (formerly Vital Processing Services) American Express X X X X X X X X Discover X X X X X X X X Master Card X X X X X X X X Visa X X X X X X X X

Payflow Pro Developers Guide

47

Credit Card Transactions

Card Security Code Validation

48

Payflow Pro Developers Guide

Credit Card Testing

To test your application, direct all transactions to the host address for testing. For details, see Host Addresses on page 13. Transactions directed to this URL are processed through PayPals simulated payment network, enabling you to test the configuration and operation of your application or storefront no money changes hands. (You must activate your account and configure your application for live transactions before accepting real orders.)

Testing Guidelines
The following are testing guidelines: While testing, use only the credit card numbers listed in this chapter. Other numbers produce an error. Expiration Date must be a valid date in the future (use the mmyy format). To view the credit card processor that you have selected for testing, see Account Info > Processor Info in PayPal Manager.

Credit Card Numbers Used for Testing

Use the following credit card numbers for testing. Any other card number produces a general failure.
TABLE 5.1 Test credit card numbers American Express American Express American Express Corporate Diners Club Diners Club Discover Discover JCB JCB MasterCard 378282246310005 371449635398431 378734493671000 30569309025904 38520000023237 6011111111111117 6011000990139424 3530111333300000 3566002020360505 5555555555554444

Payflow Pro Developers Guide

49

Credit Card Testing

Result Values in Responses TABLE 5.1 Test credit card numbers MasterCard Visa Visa Visa 5105105105105100 4111111111111111 4012888888881881 4222222222222
N O T E : Even though this number has a different character count than the

other test numbers, it is the correct and functional number.

Result Values in Responses

This section describes the result value responses that you receive.

Testing Result Values in Responses

You can use the amount of the transaction to generate a particular result value. The table below lists the general guidelines for specifying amounts to submit in requests.
TABLE 5.2 Results generated by the amount submitted Amount $0 $1000 $1001 $2000 Result RESULT value 0 (Approved) Certain amounts in this range will return specific PayPal results, and can be generated by adding $1000 to that RESULT value. For example, for RESULT value 13 (Referral), submit the amount 1013. If the amount is in this range but does not correspond to a PayPal result supported by this testing mechanism, RESULT value 12 (Declined) is returned RESULT value 12 (Declined)

$2001+

RESULT Values Returned Based on Transaction Amount

This table lists the RESULT values that you can generate using the amount of the transaction. To generate a specific code, submit an amount of 1000 plus the code number (for example, submit an amount of 1013 for a result code of 13).
TABLE 5.3 Result values supporting the amount control Processing Platform American Express Phoenix American Express Brighton RESULT Values Available for Testing 0, 12, 13, 104, 1000

50

Payflow Pro Developers Guide

Credit Card Testing

RESULT Values Returned Based on Transaction Amount TABLE 5.3 Result values supporting the amount control Processing Platform Elavon (Formerly Nova) First Data Merchant Services Nashville First Data Merchant Services North First Data Merchant Services South Global Payments Central Global Payments East Paymentech Salem (New Hampshire) Paymentech Tampa TSYS Acquiring Solutions (Formerly Vital Processing Services) RESULT Values Available for Testing 0, 12, 13, 104 0, 12, 13, 104 0, 4, 5, 12, 13, 23, 24,114, 1000 0, 12, 13, 104 0, 4, 5, 8, 12, 13, 23, 24, 104, 111, 114, 1000 0, 4, 5, 12, 13, 23, 24, 30, 100, 104, 114, 1000 0, 12, 13, 104 0, 3, 4, 5, 12, 13, 23, 24, 1000 0, 4, 12, 13, 23, 104, 114, 1000

Alternative Methods for Generating Specific RESULT Values

The table below shows another method for obtaining RESULT values. Non-zero RESULT values from processors are not returned by the servers, and therefore cannot be simulated using the amount. In some cases, you may get certain results using the RESULT value plus 1000 even though this table suggests another means of obtaining the RESULT value.
TABLE 5.4 Obtaining RESULT value RESULT 0 Definition Approved How to test using Payflow Pro Use an AMOUNT of $1000 or less For all Processors except Global Payments Central (MAPP) and FDI Credit (C) and Force (F) transactions will always be approved regardless of dollar amount or card number Use an invalid PWD Use an invalid TENDER, such as G Use an invalid TRXTYPE, such as G Use an invalid AMOUNT, such as 1 Use the AMOUNT 1005 - Applies only to the following processors: Global Payments East and Central, and American Express Submit a Delayed Capture transaction with no ORIGID Use the AMOUNT 1012 or an AMOUNT of 2001 or more Use the AMOUNT 1013

1 2 3 4 5 7 12 13

User authentication failed Invalid tender Invalid transaction type Invalid amount Invalid merchant information Field format error Declined Referral

Payflow Pro Developers Guide

51

Credit Card Testing

RESULT Values Returned Based on Transaction Amount TABLE 5.4 Obtaining RESULT value RESULT 19 22 23 24 25 Definition Original transaction ID not found Invalid ABA number Invalid account number Invalid expiration date Transaction type not mapped to this host (Processor) Invalid XML document Duplicate Transaction Insufficient funds available General error Invalid transaction returned from host (Processor) Time-out value too small Error reading response from host (Processor) Timeout waiting for processor response Credit error Void error Capture error Failed AVS check How to test using Payflow Pro Submit a Delayed Capture transaction with an invalid ORIGID Applies only to ACH transactions submit an invalid ABA number (8 digits) Submit an invalid account number, for example, 000000000000000 Submit an invalid expiration date, for example, 0298 Submit a transaction for a card or tender you are not currently set up to accept, for example, a Diners card if you arent set up to accept Diners Pass a bad XML document (XMLPay users only) Use the AMOUNT 1030 - Only applies to Global Payments East and Central processors Use the AMOUNT 1050 - Only applies to Paymentech Use the AMOUNT 1099 - Only applies to Global Payments East Use the AMOUNT 1100. Only applies to Global Payments East and Central Set timeout value to 1 Use the AMOUNT 1103 Use the AMOUNT 1104 Attempt to credit an authorization Attempt to void a captured authorization Capture an Authorization transaction twice or attempt to capture a transaction that is not an Authorization transaction You cannot generate this RESULT value by submitting an amount of 1112, but must submit a value for Address Verification Servicethat will fail In production, this error occurs only if your account is configured by PayPal customer service to use the AVS Deny feature Applies to ACH transactions only Use the AMOUNT 1114. Only applies to TSYS Acquiring Solutions, Merchant e-Solutions, and Global Payments East and Central processors

29 30 50 99 100 101 103 104 105 108 111 112

113 114

Cannot exceed sales cap CVV2 Mismatch

52

Payflow Pro Developers Guide

Credit Card Testing

Testing Address Verification Service TABLE 5.4 Obtaining RESULT value RESULT 1000 Definition Generic Host (Processor) Error How to test using Payflow Pro Use the AMOUNT 2000 - Does not apply to Elavon (formerly Nova), American Express, or Global Payments East processors

Testing Address Verification Service

The Payflow testing server simulates Address Verification Service by returning a value for AVSADDR based on the first three characters of the submitted value for STREET. The testing server returns a value for AVSZIP based on the submitted ZIP value as shown in the table. If STREET starts with 667 or higher or begins with a non-numeric character, then the simulator returns AVSADDR=X, AVSZIP=X.
TABLE 5.5 Testing AVSADDR Submitted Value for STREET 000-333 334-666 667 or higher or begins with a non-numeric character TABLE 5.6 Testing AVSZIP Submitted Value for ZIP 00000-50000 50001-99999 Any value (if street address is 667 or higher or begins with a non-numeric character) Example ZIP Value 00382 94303 STREET=79232 Maple, ZIP=20304 AVSZIP Result Y N X Example STREET Value 24285 Elm 49354 Main 79232 Maple AVSADDR Result Y N X

Testing Card Security Code

If you submit a value for the card security code, the cardholders bank returns a Yes / No / Not Supported (Y / N / X) response on whether the value matches the number on file at the bank. Card security code is described in Card Security Code Validation on page 46.
N O T E : Some processors will decline (RESULT value 12) a transaction if the card security code

does not match without returning a CVV2MATCH value. Test the results and check with your processor to determine whether they support card security code checking.

Payflow Pro Developers Guide

53

Credit Card Testing

Testing Address Verification Service

For the testing server, the first three characters of the CVV2 value determine the CVV2MATCH result, as shown here.
TABLE 5.7 Testing CVV2MATCH CVV2 Value 000 001-300 301-600 601 or higher CVV2MATCH Value Y Y N X

54

Payflow Pro Developers Guide

Responses to Transaction Requests

When a transaction finishes, the Payflow server returns a response string made up of namevalue pairs. This is an example response string. RESULT=0&PNREF=EFHP0D426A53&RESPMSG=APPROVED&AUTHCODE=25TEST&AVSADDR =Y&AVSZIP=N&CVV2MATCH=Y

Contents of a Response to a Credit Card Transaction Request

The table below describes values that can be returned in response strings
TABLE 6.8 Transaction response values Field PNREF Description Payflow Transaction ID, a unique number that identifies the transaction. Character length and limitations: 12 alphanumeric characters Unique transaction ID of the payment. Character length and limitations: 17-character string The outcome of the attempted transaction. RESULT=0 means the transaction was approved.
N O T E : For Account Verification transactions, RESULT=0 with

PPREF

RESULT

RESPMSG=Verified means a zero dollar authorization has been successfully performed. Any other value for RESULT indicates a decline or error. Character length and limitations: variable length, numeric CVV2MATCH Result of the card security code (CVV2) check. The issuing bank may decline the transaction if there is a mismatch. In other cases, the transaction may be approved despite a mismatch. Character length and limitations: 1 alpha character (Y, N, X, or no response) The response message returned with the transaction result. Exact wording varies. Sometimes a colon appears after the initial RESPMSG followed by more detailed information.
N O T E : For Account Verification transactions, RESULT=0 with

RESPMSG

RESPMSG=Verified means a zero dollar authorization has been successfully performed. Character length and limitations: variable, alphanumeric characters

Website Payments Pro Payflow Edition Developers Guide

55

Responses to Transaction Requests

Contents of a Response to a Credit Card Transaction Request TABLE 6.8 Transaction response values Field AUTHCODE Description Returned for Sale, Authorization, and Voice Authorization credit card transactions. AUTHCODE is the approval code obtained over the telephone from the processing network. AUTHCODE is required when submitting a Force (F) transaction. Character length and limitations: 6 alphanumeric characters Address Verification Service address response returned if you are using Address Verification Service. Address Verification Service address responses are for advice only. This process does not affect the outcome of the authorization. Character length and limitations: 1 alpha character (Y, N, X, or no response) Address Verification Service address response returned if you are using Address Verification Service. Address Verification Service address responses are for advice only. This process does not affect the outcome of the authorization. Character length and limitations: 1 alpha character (Y, N, X, or no response) International Address Verification Service address responses may be returned if you are using Address Verification Service. IAVS responses are for advice only. This value does not affect the outcome of the transaction. Indicates whether Address Verification Service response is international (Y), US (N), or cannot be determined (X). Client version 3.06 or later is required. Character length and limitations: 1 alpha character (Y, N, X, or no response) Address Verification Service response from the processor when you use Address Verification Service and send a VERBOSITY request parameter value of MEDIUM. Character length and limitations: 1 character CVV2 response from the processor when you send a VERBOSITY request parameter value of MEDIUM. Character length and limitations: 1 character Value used for tracking this Direct Payment transaction. Character length and limitations: 13 alphanumeric characters Unique transaction ID returned when VERBOSITY=MEDIUM or VERBOSITY=HIGH for tracking American Express CAPN transactions.
N O T E : American Express CAPN transactions only: used by merchants

AVSADDR

AVSZIP

IAVS

PROCAVS

PROCCVV2

CORRELATIONID

AMEXID

who authorize transactions through the payflow gateway but settle through a third-party solution. Character length and limitations: 15 numeric characters

56

Website Payments Pro Payflow Edition Developers Guide

Responses to Transaction Requests

BALAMT Response Parameter and Stored Value Cards TABLE 6.8 Transaction response values Field AMEXPOSDATA Description Value returned when VERBOSITY=MEDIUM or VERBOSITY=HIGH.. Character length and limitations: 12 alphanumeic characters

BALAMT Response Parameter and Stored Value Cards

BALAMT is a parameter that may be returned by transactions meeting Card Acceptance Processing Network (CAPN) requirements when that transaction involves a stored value card. Stored value cards typically are offered as gift cards, allowing the user to spend any amount up to the balance remaining on the card. BALAMT returns the balance on the card provided that the card is active and is not compromised. If the card is used to purchase merchandise exceeding the card balance, American Express declines the transaction and returns the card balance in BALAMT. For details on American Express CAPN request transaction parameters, see Appendix C, Submitting Purchasing Card Level 2 and Level 3 Transactions.

American Express CAPN Stored Value Card Example

The Authorization request is for a purchase of 123.00.
TRXTYPE=A&TENDER=C&PWD=x1y2z3&PARTNER=PayPal&VENDOR=SuperMerchant&USER=Supe rMerchant&ACCT=5555555555554444&EXPDATE=0308&AMT=123.00&STREET=5199 MAPLE&ZIP=94588

Because the response returns a BALAMT of 99.00, the Authorization is declined.

RESULT=12&PNREF=VXYZ01234567&RESPMSG=DECLINED&BALANCE=99.00&AVSADDR=Y&AVSZI P=N

PNREF Value
The PNREF is a unique transaction identification number issued by PayPal that identifies the transaction for billing, reporting, and transaction data purposes. The PNREF value appears in the Transaction ID column in PayPal Manager reports. The PNREF value is used as the ORIGID value (original transaction ID) in Delayed Capture transactions (TRXTYPE=D), Credits (TRXTYPE=C), Inquiries (TRXTYPE=I), and Voids (TRXTYPE=V). The PNREF value is used as the ORIGID value (original transaction ID) value in reference transactions for Authorization (TRXTYPE=A) and Sale (TRXTYPE=S).
N O T E : The

PNREF is also referred to as the Transaction ID in PayPal Manager.

Website Payments Pro Payflow Edition Developers Guide

57

Responses to Transaction Requests

RESULT Values and RESPMSG Text

PNREF Format
The PNREF is a 12-character string of printable characters, for example: VADE0B248932 ACRAF23DB3C4
N O T E : Printable

characters also include symbols other than letters and numbers such as the question mark (?). A PNREF typically contains letters and numbers only.

The PNREF in a transaction response tells you that your transaction is connecting to PayPal.

RESULT Values and RESPMSG Text

The RESULT parameter and value is the first name-value pair returned in the response string. The value of RESULT indicates the overall status of the transaction attempt: A value of 0 (zero) indicates that no errors occurred and the transaction was approved.
N O T E : For Account

Verification transactions, RESULT=0 with RESPMSG=Verified means a zero dollar authorization has been successfully performed.

A value less than 0 indicates that a communication error occurred. In this case, no transaction is attempted. A value greater than 0 indicates a decline or error. The response message (RESPMSG) provides a brief description for decline or error results.

RESULT Values for Transaction Declines or Errors

For non-zero RESULT values, the response string includes a RESPMSG name-value pair. The exact wording of the RESPMSG (shown in bold) may vary. Sometimes a colon appears after the initial RESPMSG followed by more detailed information.
TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 0 RESPMSG and Explanation Approved
N O T E : PayPal processor: Warning information may be returned that may be useful

to the request applicaton. See the PayPal API documentation on the PayPal website for information on corrective actions.

58

Website Payments Pro Payflow Edition Developers Guide

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 1 RESPMSG and Explanation User authentication failed. Error is caused by one or more of the following: Login information is incorrect. Verify that USER, VENDOR, PARTNER, and PASSWORD have been entered correctly. VENDOR is your merchant ID and USER is the same as VENDOR unless you created a Payflow Pro user. All fields are case sensitive. Invalid Processor information entered. Contact merchant bank to verify. "Allowed IP Address" security feature implemented. The transaction is coming from an unknown IP address. See PayPal Manager online help for details on how to use Manager to update the allowed IP addresses. You are using a test (not active) account to submit a transaction to the live PayPal servers. Change the host address from the test server URL to the live server URL Invalid tender type. Your merchant bank account does not support the following credit card type that was submitted. Invalid transaction type. Transaction type is not appropriate for this transaction. For example, you cannot credit an authorization-only transaction Invalid amount format. Use the format: #####.## Do not include currency symbols or commas. Invalid merchant information. Processor does not recognize your merchant account information. Contact your bank account acquirer to resolve this problem. Invalid or unsupported currency code Field format error. Invalid information entered. See RESPMSG Not a transaction server Too many parameters or invalid stream Too many line items Client time-out waiting for response Declined. Check the credit card number, expiration date, and transaction information to make sure they were entered correctly. If this does not resolve the problem, have the customer call their card issuing bank to resolve. Referral. Transaction cannot be approved electronically but can be approved with a verbal authorization. Contact your merchant bank to obtain an authorization and submit a manual Voice Authorization transaction. Original transaction ID not found. The transaction ID you entered for this transaction is not valid. See RESPMSG Cannot find the customer reference number Invalid ABA number

2 3 4 5 6 7 8 9 10 11 12

13

19 20 22

Website Payments Pro Payflow Edition Developers Guide

59

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 23 24 25 RESPMSG and Explanation Invalid account number. Check credit card number and re-submit. Invalid expiration date. Check and re-submit. Invalid Host Mapping. You are trying to process a tender type such as Discover Card, but you are not set up with your merchant bank to accept this card type. You are trying to process a tender type such as Discover Card, but you are not set up with your merchant bank to accept this card type. You are trying to process an Express Checkout transaction when your account is not set up to do so. Contact your account holder to have Express Checkout added to your account. Invalid vendor account. Login information is incorrect. Verify that USER, VENDOR, PARTNER, and PASSWORD have been entered correctly. VENDOR is your merchant ID and USER is the same as VENDOR unless you created a Payflow Pro user. All fields are case sensitive. Insufficient partner permissions Insufficient user permissions Invalid XML document. This could be caused by an unrecognized XML tag or a bad XML format that cannot be parsed by the system. Duplicate transaction Error in adding the recurring profile Error in modifying the recurring profile Error in canceling the recurring profile Error in forcing the recurring profile Error in reactivating the recurring profile OLTP Transaction failed Invalid recurring profile ID Insufficient funds available in account Exceeds per transaction limit General error. See RESPMSG. Transaction type not supported by host Time-out value too small Processor not available Error reading response from host

26

27 28 29 30 31 32 33 34 35 36 37 50 51 99 100 101 102 103

60

Website Payments Pro Payflow Edition Developers Guide

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 104 105 RESPMSG and Explanation Timeout waiting for processor response. Try your transaction again. Credit error. Make sure you have not already credited this transaction, or that this transaction ID is for a creditable transaction. (For example, you cannot credit an authorization.) Host not available Duplicate suppression time-out Void error. See RESPMSG. Make sure the transaction ID entered has not already been voided. If not, then look at the Transaction Detail screen for this transaction to see if it has settled. (The Batch field is set to a number greater than zero if the transaction has been settled). If the transaction has already settled, your only recourse is a reversal (credit a payment or submit a payment for a credit) Time-out waiting for host response Referenced auth (against order) Error Capture error. Either an attempt to capture a transaction that is not an authorization transaction type, or an attempt to capture an authorization transaction that has already been captured. Failed AVS check. Address and ZIP code do not match. An authorization may still exist on the cardholders account. Merchant sale total will exceed the sales cap with current transaction. ACH transactions only. Card Security Code (CSC) Mismatch. An authorization may still exist on the cardholders account. System busy, try again later VPS Internal error. Failed to lock terminal number Failed merchant rule check. One or more of the following three failures occurred: An attempt was made to submit a transaction that failed to meet the security settings specified on the PayPal Manager Security Settings page. If the transaction exceeded the Maximum Amount security setting, then no values are returned for AVS or CSC. AVS validation failed. The AVS return value should appear in the RESPMSG. CSC validation failed. The CSC return value should appear in the RESPMSG Invalid keywords found in string fields Attempt to reference a failed transaction Not enabled for feature

106 107 108

109 110 111

112 113 114 115 116 117

118 120 121

Website Payments Pro Payflow Edition Developers Guide

61

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 122 125 126 RESPMSG and Explanation Merchant sale total will exceed the credit cap with current transaction. ACH transactions only. Fraud Protection Services Filter Declined by filters Fraud Protection Services Filter Flagged for review by filters
I M P O R T A N T : RESULT value 126 indicates that a transaction triggered a fraud

filter. This is not an error, but a notice that the transaction is in a review status. The transaction has been authorized but requires you to review and to manually accept the transaction before it will be allowed to settle. RESULT value 126 is intended to give you an idea of the kind of transaction that is considered suspicious to enable you to evaluate whether you can benefit from using the Fraud Protection Services. To eliminate RESULT 126, turn the filters off. For more information, see the fraud documentation for your payments solution. 127 128 132 133 150 151 200 201 600 601 1000 1001 1002 1003 1004 1011 1012 Fraud Protection Services Filter Not processed by filters Fraud Protection Services Filter Declined by merchant after being flagged for review by filters Card has not been submitted for update Data mismatch in HTTP retry request Issuing bank timed out Issuing bank unavailable Reauth error Order error Cybercash Batch Error Cybercash Query Error Generic host error. This is a generic message returned by your credit card processor. The RESPMSG will contain more information describing the error. Buyer Authentication Service unavailable Buyer Authentication Service Transaction timeout Buyer Authentication Service Invalid client version Buyer Authentication Service Invalid timeout value Buyer Authentication Service unavailable Buyer Authentication Service unavailable

62

Website Payments Pro Payflow Edition Developers Guide

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 1013 1014 1016 RESPMSG and Explanation Buyer Authentication Service unavailable Buyer Authentication Service Merchant is not enrolled for Buyer Authentication Service (3-D Secure) Buyer Authentication Service 3-D Secure error response received. Instead of receiving a PARes response to a Validate Authentication transaction, an error response was received. Buyer Authentication Service 3-D Secure error response is invalid. An error response is received and the response is not well formed for a Validate Authentication transaction. Buyer Authentication Service Invalid card type Buyer Authentication Service Invalid or missing currency code Buyer Authentication Service merchant status for 3D secure is invalid Buyer Authentication Service Validate Authentication failed: missing or invalid PARES Buyer Authentication Service Validate Authentication failed: PARES format is invalid Buyer Authentication Service Validate Authentication failed: Cannot find successful Verify Enrollment Buyer Authentication Service Validate Authentication failed: Signature validation failed for PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid amount in PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid acquirer in PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid Merchant ID in PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid card number in PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid currency code in PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid XID in PARES Buyer Authentication Service Validate Authentication failed: Mismatched or invalid order date in PARES

1017

1021 1022 1023 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051

Website Payments Pro Payflow Edition Developers Guide

63

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.9 Payflow Transaction RESULT Values and RESPMSG Text RESULT 1052 RESPMSG and Explanation Buyer Authentication Service Validate Authentication failed: This PARES was already validated for a previous Validate Authentication transaction

RESULT Values for Communications Errors

A RESULT value less than zero indicates that a communication error occurred. In this case, no transaction is attempted. A value of -1 or -2 usually indicates a configuration error caused by an incorrect URL or by configuration issues with your firewall. A value of -1 or -2 can also be possible if the PayPal servers are unavailable, or an incorrect server/socket pair has been specified. A value of -1 can also result when there are internet connectivity errors. Contact customer support regarding any other errors. For information on firewall configuration, see Chapter 2, Downloading, Installing, and Activating. Details of the response message may vary slightly from that shown in the table, depending on your SDK integration.
TABLE 6.10 Communications RESULT values RESULT -1 -2 -5 -6 -7 -8 -9 -10 -11 -12 -13 -14 -15 -20 Description Failed to connect to host Failed to resolve hostname Failed to initialize SSL context Parameter list format error: & in name Parameter list format error: invalid [ ] name length clause SSL failed to connect to host SSL read failed SSL write failed Proxy authorization failed Timeout waiting for response Select failure Too many connections Failed to set socket options Proxy read failed

64

Website Payments Pro Payflow Edition Developers Guide

Responses to Transaction Requests

RESULT Values and RESPMSG Text TABLE 6.10 Communications RESULT values RESULT -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -40 -41 -99 -100 -103 -104 -105 -106 -107 -108 -109 -111 -113 Description Proxy write failed Failed to initialize SSL certificate Host address not specified Invalid transaction type Failed to create a socket Failed to initialize socket layer Parameter list format error: invalid [ ] name length clause Parameter list format error: name Failed to initialize SSL connection Invalid timeout value The certificate chain did not validate, no local certificate found The certificate chain did not validate, common name did not match URL Unexpected Request ID found in request Required Request ID not found in request Out of memory Parameter list cannot be empty Context initialization failed Unexpected transaction state Invalid name value pair request Invalid response format This XMLPay version is not supported The server certificate chain did not validate Unable to do logging The following error occurred while initializing from message file: <Details of the error message> Unable to round and truncate the currency value simultaneously

Website Payments Pro Payflow Edition Developers Guide

65

Responses to Transaction Requests

RESULT Values and RESPMSG Text

66

Website Payments Pro Payflow Edition Developers Guide

Processors Requiring Additional Transaction Parameters

This appendix lists both required and optional parameters supplementary to the common parameter set.
In this Appendix

American Express on page 67 First Data Merchant Services (FDMS) Nashville on page 76 First Data Merchant Services (FDMS) South on page 77 First Data Merchant Services (FDMS) North on page 77 Elavon (Formerly Nova) on page 79 Paymentech on page 79 TSYS Acquiring Solutions on page 83

American Express
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, American Express accepts the parameters described in this section. Parameters to meet American Express Card Acceptance and Processing Network (CAPN) requirements are described in Table A.1. American Express (legacy) platform parameters are described in Table A.2.

Payflow Pro Developers Guide

67

Processors Requiring Additional Transaction Parameters

American Express

American Express Additional Credit Card Parameters (CAPN)

N O T E : You should start coding to the CAPN parameters if you want to be able to impact what

appears on AMEX statements and reports. With a few exceptions, most merchants in the United States follow CAPN requirements; international merchants do not. If you are not sure whether you should make the coding changes, contact Customer Service. See How to Contact Customer Support on page 9 for contact information. American Express Phoenix accepts the following parameters to meet CAPN requirements.
TABLE A.1 Parameter American Express CAPN parameters Description Required Type Length

Retail Transaction Advice Addendum Parameters (for SWIPE transactions) L_DESCn L_AMTn Description of this line-item (n is a line item number from 1 to 6) Amount of this line-item (n is a line item number from 1 to 6) 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 Quantity of this line-item (n is a line item number from 1 to 6) No No Alphanumeric Numeric 19 12

L_QTYn

No

Numeric

Internet Transaction Data Parameters EMAIL PHONENUM PHONETYPE Account holders email address Account holders telephone number Telephone company provided ANI information identifier digits indicating the telephone call type Examples: cellular (61-63), payphone (27) Name of the server that the account holder is connected to Example: PHX.QW.AOL.COM No No No Alphanumeric String Alphanumeric Alphanumeric and special characters Alphanumeric and special characters 60 20 2

CUSTHOSTNAME

No

60

CUSTBROWSER

Account holders HTTP browser type Example: MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~W INDOWS~95)

No

60

68

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

American Express TABLE A.1 Parameter CUSTIP American Express CAPN parameters (Continued) Description Account holders IP address Required No Type Alphanumeric and special characters Alphanumeric Length 15

SHIPTOCOUNTRY

Numeric country code of ship-to country Example: USA: 840 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 Merchant product SKU

No

SHIPMETHOD

No

Alphanumeric

SKU AVS Parameters STREET ZIP

No

Alphanumeric

15

Account holders street address (number and street name) Account holders 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Account holders telephone number. The formats are xxx-xxx-xxxx (US numbers) +xxxxxxxxxxx (international numbers) First name in the shipping address Last name in the shipping address Shipping street address Numeric country code Example: USA: 840

No No

Alphanumeric String

30 9

PHONENUM

No

String

20

SHIPTOFIRSTNAME SHIPTOLASTNAME SHIPTOSTREET SHIPTOCOUNTRY

No No No No

Alphanumeric Alphanumeric Alphanumeric Alphanumeric

30 30 30 3

Payflow Pro Developers Guide

69

Processors Requiring Additional Transaction Parameters

American Express TABLE A.1 Parameter SHIPTOZIP American Express CAPN parameters (Continued) Description Shipping 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Shipping telephone number Identifies the transaction as recurring. This value does not activate PayPals Recurring Billing Service APIs. 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 PayPals 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 Managers Virtual Terminal. 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. Required No Type Alphanumeric String Alphanumeric Y or N Length 9

SHIPTOPHONENUM RECURRING

No No

10 1

Location Transaction Advice Addendum Parameters MERCHANTNAME MERCHANTSTREET MERCHANTCITY MERCHANTSTATE MERCHANTCOUNTRYCO DE Name of merchant Merchants street address (number and street name) Merchants city Merchants state Merchants numeric country code Example: USA: 840 Merchants 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 No No No No No Alphanumeric 3 Alphanumeric 30

MERCHANTZIP

No

Alphanumeric

Transaction Advice Detail Parameters

70

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

American Express TABLE A.1 Parameter ADDLAMTn American Express CAPN parameters (Continued) Description Detail of a charge where n is a value from 1 - 5 Use for additional breakdown of the 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) Examples: tip=3.00, convenience charge=2.00 A 3-digit code indicating the type of the corresponding charge detail, where n is a value from 1 - 5 Required No Type Numeric Length 12

ADDLAMTTYPEn

No

Alphanumeric

Airline Passenger Data Parameters AIR-DEPARTUREDATE AIR-PASSENGERNAME Departure date in the format YYYYMMDD. Name of the passenger in the following format with fields separated by a space: surname firstname middleinitial title Airport code of the originating airport. For a list of airport codes, see http://www.worldairport-codes.com/alphabetical/airportcode/a.html.
N O T E : Present day airport codes are three

No No

Alphanumeric Alphanumeric Alphanumeric

8 60

AIR-ORIGIN

No

characters in length. The five character length is designed to allow for future expansion. AIR-DESTINATION 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.worldairport-codes.com/alphabetical/airportcode/a.html.
N O T E : Present day airport codes are three

No

Alphanumeric

characters in length. The five character length is designed to allow for future expansion.

Payflow Pro Developers Guide

71

Processors Requiring Additional Transaction Parameters

American Express TABLE A.1 Parameter AIRNUMBEROFCITIES American Express CAPN parameters (Continued) Description 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. 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.worldairport-codes.com/alphabetical/airportcode/a.html.
N O T E : Present day airport codes are three

Required No

Type Numeric

Length

AIR-ROUTINGCITYn

No

Alphanumeric

characters in length. The five character length is designed to allow for future expansion. AIR-CARRIERn 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_codes-All. List discounts associated with the travel. Number of passengers on this trip. No Alphanumeric 5

AIR-FAREBASIS AIRNUMBEROFPASSENGER S AIR-ISETICKET

No No

Alphanumeric Numeric

24

If this is an electronic ticket. The values are: Y = yes N = no Code assigned to the travel reservation before the ticket was purchased.

No

Alphanumeric Alphanumeric

AIRRESERVATIONCODE

No

15

72

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

American Express TABLE A.1 Parameter Other FIRSTNAME Account holder's first and last name. Note: 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). Account holder's last name. 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. Order date For example, July 28, 2003 is 072803. Format: mmddyy (with no slashes or dashes) 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: 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. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction No Alphanumeric 13 American Express CAPN parameters (Continued) Description Required Type Length

LASTNAME INVNUM

No No

Alphanumeric Alphanumeric

13 9

ORDERDATE

No

Numeric

ORDERDATETIME

No

19

SWIPE

No

Alphanumeric

80

American Express Additional Credit Card Parameters (Legacy)

In addition to the parameters in Table 4.1 , Credit card transaction request parameters, American Express Phoenix accepts the following legacy parameters.
N O T E : Merchants

in the United States follow the CAPN requirements and use the parameters described in Table A.1; international merchants do not and instead use the legacy

Payflow Pro Developers Guide

73

Processors Requiring Additional Transaction Parameters

American Express

parameters described in Table A.2. There are a few exceptions. If you are not sure, contact Customer Service. See How to Contact Customer Support on page 9 for contact information.
TABLE A.2 Parameter DESC American Express legacy parameters Required No Type Alphanumeric Length Brighton 40 Other American Express platforms 23 40 40 40 40 13

Description Describes the transaction.

DESC1 DESC2 DESC3 DESC4 FIRSTNAME

Describes the transaction. Describes the transaction. Describes the transaction. Describes the transaction. Account holder's first and last name. Note: 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). Account holder's last name. 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. Specifies an order date. For example, July 28, 2003 is 072803. Format: mmddyy (with no slashes or dashes)

No No No No No

Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric

LASTNAME INVNUM

No No

Alphanumeric Alphanumeric

13 9

ORDERDATE

No

Numeric

74

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

American Express TABLE A.2 Parameter ORDERDATETIME American Express legacy parameters (Continued) Required No Type Length 19

Description Specifies an 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: 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 Identifies the transaction as recurring. This value does not activate PayPals Recurring Billing Service APIs. 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 PayPals 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 Managers 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. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction.

RECURRING

No

Alphanumeric Y or N

SWIPE

No

Alphanumeric

80

Payflow Pro Developers Guide

75

Processors Requiring Additional Transaction Parameters

First Data Merchant Services (FDMS) Nashville

First Data Merchant Services (FDMS) Nashville

FDMS Nashville, Additional Credit Card Parameters
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, FDMS Nashville accepts the following parameters:
TABLE A.3 Parameter INVNUM FDMS Nashville additional parameters Required No Type Alphanumeric Length 9

Description 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. Identifies the transaction as recurring. This value does not activate PayPals 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 PayPals 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 Managers 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. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction.

RECURRING

No

Alphanumeric Y or N

SWIPE

No

Alphanumeric

80

76

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

First Data Merchant Services (FDMS) South

First Data Merchant Services (FDMS) South

FDMS South, Additional Credit Card Parameters
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, FDMS South accepts the following parameters:
TABLE A.4 Parameter SWIPE FDMS South additional parameters Required No Type Alphanumeric Length 80

Description Allows Track 1 and Track 2 data to be passed to enable a card-present transaction.

First Data Merchant Services (FDMS) North

FDMS North, Additional Credit Card Parameters
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, FDMS North (also known as FDMS CardNet) accepts the parameters in Table A.5.
TABLE A.5 Parameter DESC FDMS North additional parameters Description Use the DESC* parameters to pass in your DBA name and other data describing the transaction. This information will be displayed in the end users statement. 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. Defaults to CITY (where the merchant outlet is located) for retail and to PHONENUM for non-retail. For example, 800 111-1111. Use uppercase characters. The first three positions must be numeric. Required No Type Alphanumeric Length 25

MERCHSVC

No

Alphanumeric

13

Payflow Pro Developers Guide

77

Processors Requiring Additional Transaction Parameters

Merchant e-Solutions

Merchant e-Solutions
Merchant e-Solutions, Additional Credit Card Parameters
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, Merchant e-Solutions accepts the following parameters:
TABLE A.6 Parameter INVNUM TSYS Acquiring Solutionsa additional parameters Required No Type Alphanumeric Length 9

Description 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. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction. Identifies the transaction as recurring. This value does not activate PayPals Recurring Billing Service APIs. 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 PayPals 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 Managers Virtual Terminal 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.

SWIPE RECURRING

No No

Alphanumeric Alphanumeric Y or N

80 1

a. Formerly Vital Processing Services

78

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

Elavon (Formerly Nova)

Elavon (Formerly Nova)

Elavon, Additional Credit Card Parameters
In addition to the parameters in Table 4.1 , Credit card transaction request parameters,Elavon accepts the following parameter:
TABLE A.7 Parameter RECURRING Elavon additional parameters Required No Type Alphanumeric Y or N Length 1

Description Identifies the transaction as recurring. This value does not activate PayPals 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 PayPals 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 Managers 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.

Paymentech
Paymentech Salem (New Hampshire), Additional Credit Card Parameters (CAPN)
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, Paymentech Salem (New Hampshire) accepts the parameters in Table A.8 to meet CAPN requirements.
TABLE A.8 Parameter Additional Paymentech parameters to meet CAPN requirements Description Required Type Length

Internet Transaction Data Parameters EMAIL Account holders email address No Alphanumeric 60

Payflow Pro Developers Guide

79

Processors Requiring Additional Transaction Parameters

Paymentech TABLE A.8 Parameter PHONENUM PHONETYPE

Additional Paymentech parameters to meet CAPN Description Account holders telephone number Telephone company provided ANI information identifier digits indicating the telephone call type Examples: cellular (61-63), payphone (27) Name of the server that the account holder is connected to Example: PHX.QW.AOL.COM Required No No Type String Alphanumeric Alphanumeric and special character s Alphanumeric and special character s Alphanumeric and special character s Alphanumeric Length 20 2

CUSTHOSTNAME

No

60

CUSTBROWSER

Account holders HTTP browser type Example: MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~WI NDOWS~95)

No

60

CUSTIP

Account holders IP address

No

15

SHIPTOCOUNTRY

Numeric country code of ship-to country Example: USA: 840 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 Merchant product SKU

No

SHIPMETHOD

No

Alphanumeric

SKU AVS Parameters STREET

No

Alphanumeric

15

Account holders street address (number and street name)

No

Alphanumeric

30

80

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

Paymentech TABLE A.8 Parameter ZIP

Additional Paymentech parameters to meet CAPN Description Account holders 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Account holders telephone number. The formats are xxx-xxx-xxxx (US numbers) +xxxxxxxxxxx (international numbers) First name in the shipping address Last name in the shipping address Shipping street address Numeric country code Example: USA: 840 Shipping 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Shipping telephone number Identifies the transaction as recurring. This value does not activate the PayPal 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 PayPals 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 Managers Virtual Terminal. 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. Required No Type String Length 9

PHONENUM

No

String

20

SHIPTOFIRSTNAME SHIPTOLASTNAME SHIPTOSTREET SHIPTOCOUNTRY

No No No No

Alphanumeric Alphanumeric Alphanumeric Alphanumeric

30 30 30 3

SHIPTOZIP

No

Alphanumeric String Alphanumeric Y or N

SHIPTOPHONENUM RECURRING

No No

10 1

Payflow Pro Developers Guide

81

Processors Requiring Additional Transaction Parameters

Paymentech

Paymentech, Additional Credit Card Parameters (Legacy)

In addition to the parameters in Table 4.1 , Credit card transaction request parameters, Paymentech accepts the following legacy parameters. For best AVS results, pass the city and state parameters in the parameter list.
TABLE A.9 Parameter CITY BILLTOCOUNTRY INVNUM Additional Paymentech parameters (legacy) Description Cardholders billing city. Cardholders billing country code 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. Merchant descriptor. For example, ABCCMPY*FALLCATALOG Merchant telephone number. For example, 603-555-1212 Cardholders billing state. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction. Identifies the transaction as recurring. This value does not activate PayPals Recurring Billing Service APIs. 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 PayPals 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 Managers 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. Required No Yes No Type Alpha Numeric Alphanumeric Length 20 3 9

MERCHDESCR

No No No No No

Alphanumeric Alphanumeric Alpha Alphanumeric Alphanumeric Y or N

22 13 2 80 1

MERCHSVC

STATE SWIPE RECURRING

82

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.9 Parameter RECURRINGTYPE Additional Paymentech parameters (legacy)(Continued) Description (Paymentech Tampa only) Type of transaction occurrence. The values are: F = First occurrence S = Subsequent occurrence (default) Required No Type Alpha Length 1

TSYS Acquiring Solutions

TSYS Acquiring Solutions, Additional Credit Card Parameters (CAPN)
In addition to the parameters in Table 4.1 , Credit card transaction request parameters, TSYS Acquiring Solutions accepts the following parameters to meet CAPN requirements.
TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements Parameter Description Required Type Length

Retail Transaction Advice Addendum Parameters (for SWIPE transactions) L_DESCn L_AMTn Description of this line-item (n is a line item number from 1 to 6) Amount of this line-item (n is a line item number from 1 to 6) 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 Quantity of this line-item (n is a line item number from 1 to 6) No No Alphanumeric Numeric 19 12

L_QTYn

No

Numeric

Internet Transaction Data Parameters EMAIL PHONENUM PHONETYPE Account holders email address Account holders telephone number Telephone company provided ANI information identifier digits indicating the telephone call type Examples: cellular (61-63), payphone (27) No No No Alphanumeric String Alphanumeric 60 20 2

Payflow Pro Developers Guide

83

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements (Continued) Parameter CUSTHOSTNAME Description Name of the server that the account holder is connected to Example: PHX.QW.AOL.COM Required No Type Alphanumeric and special characters Alphanumeric and special characters Alphanumeric and special characters Alphanumeric Length 60

CUSTBROWSER

Account holders HTTP browser type Example: MOZILLA/4.0~(COMPATIBLE;~MSIE~5.0;~W INDOWS~95) Account holders IP address

No

60

CUSTIP

No

15

SHIPTOCOUNTRY

Numeric country code of ship-to country Example: USA: 840 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 Merchant product SKU

No

SHIPMETHOD

No

Alphanumeric

SKU AVS Parameters STREET ZIP

No

Alphanumeric

15

Account holders street address (number and street name) Account holders 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Account holders telephone number. The formats are xxx-xxx-xxxx (US numbers) +xxxxxxxxxxx (international numbers)

No No

Alphanumeric String

30 9

PHONENUM

No

String

20

84

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements (Continued) Parameter SHIPTOFIRSTNAME SHIPTOLASTNAME SHIPTOSTREET SHIPTOCOUNTRY Description First name in the shipping address Last name in the shipping address Shipping street address Numeric country code Example: USA: 840 Shipping 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Shipping telephone number Identifies the transaction as recurring. This value does not activate PayPals Recurring Billing Service APIs. 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 PayPals 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 Managers Virtual Terminal. 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. Required No No No No Type Alphanumeric Alphanumeric Alphanumeric Alphanumeric Length 30 30 30 3

SHIPTOZIP

No

Alphanumeric String Alphanumeric Y or N

SHIPTOPHONENUM RECURRING

No No

10 1

Location Transaction Advice Addendum Parameters MERCHANTNAME MERCHANTSTREET MERCHANTCITY MERCHANTSTATE Name of merchant Merchants street address (number and street name) Merchants city Merchants state No No No No Alphanumeric 30

Payflow Pro Developers Guide

85

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements (Continued) Parameter MERCHANTCOUNTRYCO DE Description Merchants numeric country code Example: USA: 840 Merchants 5- to 9-digit ZIP (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737 Required No Type Alphanumeric Length 3

MERCHANTZIP

No

Alphanumeric

Transaction Advice Detail Parameters ADDLAMTn Detail of a charge where n is a value from 1 - 5 Use for additional breakdown of the 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) Examples: tip=3.00, convenience charge=2.00 A 3-digit code indicating the type of the corresponding charge detail, where n is a value from 1 - 5 No Numeric 12

ADDLAMTTYPEn

No

Alphanumeric

Airline Passenger Data Parameters AIR-DEPARTUREDATE AIR-PASSENGERNAME Departure date in the format YYYYMMDD. Name of the passenger in the following format with fields separated by a space: surname firstname middleinitial title Airport code of the originating airport. For a list of airport codes, see http://www.worldairport-codes.com/alphabetical/airportcode/a.html.
N O T E : Present day airport codes are three

No No

Alphanumeric Alphanumeric Alphanumeric

8 60

AIR-ORIGIN

No

characters in length. The five character length is designed to allow for future expansion.

86

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements (Continued) Parameter AIR-DESTINATION Description 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.worldairport-codes.com/alphabetical/airportcode/a.html.
N O T E : Present day airport codes are three

Required No

Type Alphanumeric

Length 5

characters in length. The five character length is designed to allow for future expansion. AIRNUMBEROFCITIES 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. 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.worldairport-codes.com/alphabetical/airportcode/a.html.
N O T E : Present day airport codes are three

No

Numeric

AIR-ROUTINGCITYn

No

Alphanumeric

characters in length. The five character length is designed to allow for future expansion.

Payflow Pro Developers Guide

87

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements (Continued) Parameter AIR-CARRIERn Description 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_codes-All. List discounts associated with the travel. Number of passengers on this trip. Required No Type Alphanumeric Length 5

AIR-FAREBASIS AIRNUMBEROFPASSENGER S AIR-ISETICKET

No No

Alphanumeric Numeric

24

If this is an electronic ticket. The values are: Y = yes N = no Code assigned to the travel reservation before the ticket was purchased.

No

Alphanumeric Alphanumeric

AIRRESERVATIONCODE Other FIRSTNAME

No

15

Account holder's first and last name. Note: 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). Account holder's last name. 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. Order date For example, July 28, 2003 is 072803. Format: mmddyy (with no slashes or dashes)

No

Alphanumeric

13

LASTNAME INVNUM

No No

Alphanumeric Alphanumeric

13 9

ORDERDATE

No

Numeric

88

Payflow Pro Developers Guide

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.10 Additional TSYS Acquiring Solutions parameters to meet CAPN requirements (Continued) Parameter ORDERDATETIME Description 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: 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. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction Required No Type Length 19

SWIPE

No

Alphanumeric

80

TSYS Acquiring Solutions, Additional Credit Card Parameters (Legacy)

In addition to the parameters in Table 4.1 , Credit card transaction request parameters, TSYS Acquiring Solutions accepts the following legacy parameters:
TABLE A.11 TSYS Acquiring Solutions additional parameters (legacy) Parameter INVNUM Description 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. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction. Required No Type Alphanumeric Length 9

SWIPE

No

Alphanumeric

80

Payflow Pro Developers Guide

89

Processors Requiring Additional Transaction Parameters

TSYS Acquiring Solutions TABLE A.11 TSYS Acquiring Solutions additional parameters (legacy)(Continued) Parameter RECURRING Description Identifies the transaction as recurring. This value does not activate PayPals 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 PayPals 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 Managers Virtual Terminal 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. Required No Type Alphanumeric Y or N Length 1

90

Payflow Pro Developers Guide

Performing TeleCheck Electronic Check Transactions

This chapter describes Telecheck (electronic check) transaction processing and testing.
N O T E : TeleCheck

transactions are not supported on the PayPal processor.

Paypal offers electronic check acceptance through TeleCheck. Before processing electronic check transactions, merchants must obtain an account through TeleCheck (www.telecheck.com). For information on: Performing credit card transactions, skip this chapter and see Credit Card Transactions on page 23. Performing ACH transactions, contact your PayPal Sales Representative at
[email protected]

TeleCheck Parameters
Parameters used for processing electronic checks through TeleCheck are described in Table B.1. Required and optional parameters are noted.
N O T E : Appendix

E, Additional Reporting Parameters, provides a list of parameters that you can pass for reporting purposes.

Required Parameters
As a summary of Table B.1, the following parameters are required for every electronic check transaction:
TRXTYPE TENDER CHKTYPE PARTNER VENDOR USER PWD AMT CITY DL or SS CHKNUM EMAIL MICR NAME STATE

Payflow Pro Developers Guide

91

Performing TeleCheck Electronic Check Transactions

TeleCheck Parameters

STREET ZIP TABLE B.1 Parameter AMT

TeleCheck Parameters Required Yes Type Numeric US Dollars only. Alpha Alphanumeric Alphanumeric Numeric Alpha Length 7

Description 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. Account holders city User-defined value for reporting and auditing purposes. User-defined value for reporting and auditing purposes. Account holders next unused (available) check number Check type: P: personal (default) or C: company If CHKTYPE=P, then a value for either DL or SS must be passed as an identifier. If CHKTYPE=C, then the Federal Tax ID must be passed as the SS value. Drivers license number. If CHKTYPE=P, a value for either DL or SS must be passed as an identifier. Format: XXnnnnnnnn XX = State Code nnnnnnnn = DL Number Account holders date of birth. Format: mmddyyyy. For example, July 28, 1965 is represented as 07281965. Account holders e-mail address Check invoice number Magnetic Ink Check Reader. This is the entire line of numbers at the bottom of all checks. It includes the transit number, account number, and check number. Account holders name as it appears on the check

CITY COMMENT1 COMMENT2 CHKNUM CHKTYPE

Yes No No Yes Yes

20 128 128 7

DL

Yes

Alphanumeric

33

DOB

No

Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric

EMAIL INVNUM MICR

Yes No Yes

40 9 35

NAME

Yes

30

92

Payflow Pro Developers Guide

Performing TeleCheck Electronic Check Transactions

Testing TeleCheck Transactions TABLE B.1 Parameter PARTNER TeleCheck Parameters (Continued) Required Yes Type Alphanumeric Length 64

Description The authorized PayPal Reseller that registered you for the Payflow service provided you with a Partner ID. If you registered yourself, use PayPal. This parameter is case-sensitive. Account holders telephone number Case-sensitive 6- to 32-character password that you created while registering for the account. Account holders social security number. If CHKTYPE=P, a value for either DL or SS must be passed as an identifier. If CHKTYPE=C, the Federal Tax ID must be passed as the SS value. Account holders state Account holders street address Tender type (method of payment). Use only the value K (electronic check). Type of transaction that should be processed. Allowed transaction types: Sale (S), Void (V), Inquiry (I). Case-sensitive login ID for the Payflow Pro account that you created while registering for the account. In the future, each account will allow multiple users. This parameter will specify the user. Case-sensitive Vendor ID that you created while registering for the account. Account holders 5- to 9-digit postal code (called ZIP code in the USA). Do not use spaces, dashes, or non-numeric characters.

PHONENUM PWD SS

No Yes No

Numeric Alphanumeric Alphanumeric

20 32 35

STATE STREET TENDER TRXTYPE USER

Yes Yes Yes Yes Yes

Alpha Alphanumeric Alpha Alpha Alphanumeric

2 30 1 1 64

VENDOR ZIP

Yes Yes

Alphanumeric Alpha

64 9

Testing TeleCheck Transactions

PayPal provides a test server to support testing and configuration. For information on the test server URL, see Host Addresses on page 13.

Example Test Transaction

TRXTYPE=S&TENDER=K&CHKTYPE=P&PARTNER=<your Partner Name (typically PayPal>&VENDOR=<your Merchant Login Name>&USER=<your Merchant Login

Payflow Pro Developers Guide

93

Performing TeleCheck Electronic Check Transactions

Preparing for TeleCheck Production Transactions

Name>&PWD=<your Payflow password>& AMT=42.00&STREET=1234 Main&CITY=Buffalo&DL=CA123456&CHKNUM=1001&EMAIL=<y our e-mail address>&MICR=<Use a MICR value from Table B.2>&NAME=Sally&STATE=CA&ZIP=95050 TABLE B.2 MICR 1234567804390850001001 1234567804390850011001 1234567804390850021001 1234567804390850031001 1234567804390850041001 1234567804390850051001 1234567804390850071001 MICR values for testing HOSTCODE 000800 000801 000802 000803 000804 000805 000807 TeleCheck Result Check Approved ECA Check Approved No ECA Check Approved ECA, No Guarantee Check Approved No ECA, No Guarantee Check Decline Negative Data Check Decline Scoring Check Failed

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 [email protected]. 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 Addresses on page 13.

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

94

Payflow Pro Developers Guide

Performing TeleCheck Electronic Check Transactions

HOSTCODE Values

Telecheck transaction response values are described in Table B.3.

TABLE B.3 Field RESULT Transaction responses common to all tender types Type Numeric Length Variable

Description The outcome of the attempted transaction. A result of 0 (zero) indicates the transaction was approved. Any other number indicates a decline or error. RESULT values are described in RESULT Values and RESPMSG Text on page 58. PayPal Reference ID, a unique number that identifies the transaction. PNREF is described in HOSTCODE Values on page 95. TeleChecks response code representing the results of the transaction authorization attempt. These values are described in HOSTCODE Values on page 95. A descriptive message associated with decline or error RESULTs. Response messages are described in Chapter , Responses to Transaction Requests.

PNREF HOSTCODE

Alphanumeric Numeric

12 6

RESPMSG

Alphanumeric

Variable

HOSTCODE Values
The HOSTCODE reflects the TeleCheck server result. The following tables describe the HOSTCODE values. TeleCheck requires that you display certain verbiage to the purchaser based on the returned HOSTCODE valuecheck with TeleCheck for details.
N O T E : Many of these codes will not be encountered under normal operating conditionsthey

are included as a troubleshooting aid. In the tables, the Frequency column indicates the likelihood that you will encounter the code.
TABLE B.4 Code 000500 000501 000502 000504 000505 000800 000801 000802 000803 Response Sale Approved Sale Time-out Test Card ANI Sale Approved PB Sale Approved Sale Approved Sale Approved Sale Approved Sale Approved Sale Approved HOSTCODE values Description Sale Approved by credit card network Sale transaction time-out in credit card network Test card sale approved (never billed) 900/Telco sale approved Private billing sale approved Direct Check Sale/ECA approved Direct Check Sale approved (no ECA) Direct Check Sale/ECA approved no guarantee Direct Check Sale approved no ECA no guarantee Frequency Common Common Common ANI bill only PB only Direct Check Direct Check Direct Check Direct Check

Payflow Pro Developers Guide

95

Performing TeleCheck Electronic Check Transactions

HOSTCODE Values

TABLE B.5 Code 000300 000301 000804 000805 000807 Response Sale Declined Sale Rejected

Sale Declined HOSTCODE values Description Sale declined by credit card network Sale does not meet risk standards Direct Check Sale declined negative data Direct Check Sale Decline Scoring Direct Check Sale Inquiry Approved HOSTCODE values Description Preauthorization approved. AVS matches if provided. No response from credit card network for preauth. Preauthorization approved, AVS timed out Private billing approved. Previous positive history. Test Card Preauthorization approved, AVS match 900/TELCO billing approved Frequency Common Common AVS only PB only Common Common AVS only ANI bill only Frequency Common Common Direct Check Direct Check Direct Check

Check Declined Check Declined Check Failure TABLE B.6

Code 000400 000401 000402 000403 000410 000420 000421 000503

Response OTB Approved No Response AVS Time-out PB Approved Positive Record Test card Approved OTB/AVS Approval ANI Bill approved TABLE B.7

General Failure HOSTCODE values Description General host based failure Invalid for one or more fields in transaction TeleCheck received an unknown response Frequency Rare Common Rare

Code 000100 000101 999999

Response General Failure Invalid Value Unknown Response

TABLE B.8 Code 000200 000201 Response

Inquiry Declined HOSTCODE values Description Declined by credit card or Telco network (LIDB) Mismatch on PIN stored in TeleCheck database Frequency Common Not Used

Preauth Declined PIN Mismatch

96

Payflow Pro Developers Guide

Performing TeleCheck Electronic Check Transactions

HOSTCODE Values TABLE B.8 Code 000210 Response Negative Card Record

Inquiry Declined HOSTCODE values Description Temporary and permanent blocks. Prior OTB decline, sale decline or CS block Transaction falls below minimum scoring standards. Most frequently used for risk scoring declines, where a transaction falls below minimum standards. ANI previously blocked by CS Card with chargeback history ANI with chargeback history Card has exceeded usage limits ANI has excessive number of cards ANI has exceeded usage limits Card has been used from excessive ANI OTB decline and AVS mismatch OTB approved and AVS mismatch OTB decline and AVS match Temporary Risk referral, AVS necessary Card does not meet minimum bank restrictions Private billing risk referral, AVS necessary Frequency Common

000215 000220 000225 000230 000240 000250 000260 000270 000271 000272 000280 000281 000282
a. This

Negative ANI Record Chargeback Card Chargeback ANI Exceed card profilea Too many Cards
a

Common Common Common Uncommon Uncommon Uncommon Uncommon AVS OTB only AVS OTB only AVS OTB only Common Not Used PB Only

Exceed ANI profilea Too Many Phonesa OTB/AVS Decline OTB/AVS Decline OTB/AVS Decline Risk Referral Card Not Qualified PB Risk Referral

data is included in risk scoring decisions and a response of 210 has higher precedence.

Payflow Pro Developers Guide

97

Performing TeleCheck Electronic Check Transactions

HOSTCODE Values

98

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 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.

About Purchasing Cards

Purchasing Cards are used in the procurement process to eliminate paper-based order systems and associated costs, to improve control and accountability through itemized statements, to foster better risk controls through spending limits and buying from approved vendors, to reduce administrative overhead because employees are empowered to make small purchases, and to enable enterprises to negotiate better contract pricing and discounts with suppliers through the use of vendor detail reports. To promote acceptance and usage of Purchasing Card programs, card issuers have established incentive rates for merchants. These rates are available for merchants who comply at either Level 2 or Level 3 (described in the next section). Transactions that comply at Level 1 qualify as normal credit card transactions.
N O T E : Card

issuing institutions perform strict data verification on the enhanced data that is submitted with Level 2 or Level 3 transactions. Issuers may charge stiff penalties if 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. Table C.1 describes the transaction levels that are recognized.
TABLE C.1 Level Level 1 Transaction levels Description 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.

Payflow Pro Developers Guide

99

Submitting Purchasing Card Level 2 and Level 3 Transactions

About American Express Purchasing Card Transactions - Phoenix Processor TABLE C.1 Level Level 2

Transaction levels Description 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 merchants 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. 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 3

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 determination of whether a card is a purchasing card is left to the processor (for example, TSYS Acquiring Solutions1). In other cases, the Payflow payments gateway makes the determination based on the BIN range (for example, FDMS South and American Express). BIN ranges accepted for American Express Level 2 and Level 3 transactions are listed on page 102.

About American Express Purchasing Card Transactions Phoenix Processor

The information in this section applies to transactions processed by the American Express Phoenix Processor, 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.

1. Formerly Vital Processing Services

100

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

About American Express Purchasing Card Transactions - Phoenix Processor

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 Payflow payments gateway decides whether a transaction meets Level 3 requirements during authorization. Level 3 data is passed to the American Express Phoenix processor only during settlement.

Avoiding Downgrade
If a transaction uses the purchasing card BIN range (see Accepted BIN Ranges on page 100) and contains a line item but does not include all mandatory Level 3 parameters, then 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 MEDIUM or HIGH, a message like the following is returned in the ADDLMSGS field:
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 Appendix D, VERBOSITY: Viewing Processor-Specific Transaction Results.

Submitting Successful Level 3 Transactions

If a transaction uses the purchasing card BIN range, contains all mandatory Level 3 fields, and has at least one line item (with all mandatory line item fields), the Payflow payments gateway flags it as Level 3.

Edit Check
PayPal performs an edit check on the transactions 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 Tax Amount Total Freight Amount Total amount for the transaction, AMT TAXAMT FREIGHTAMT, or, if not present, the summation of L_FREIGHTAMTn for all line items

Payflow Pro Developers Guide

101

Submitting Purchasing Card Level 2 and Level 3 Transactions

American Express Phoenix Purchasing Card Transaction Processing

Total Handling Amount Total Line Item Amount

HANDLINGAMT, or, if not present, the summation of L_HANDLINGAMTn for all line items 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)

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 Phoenix Purchasing Card Transaction Processing

The American Express Phoenix platform supports Level 2 transaction data. The parameters to meet card acceptance and processor network (CAPN) requirements are described in Table C.2. Level 2 parameters supported for legacy applications are described in Table C.3.
N O T E : Most

merchants in the United States follow CAPN requirements; international merchants do not.There are a few exceptions. If you are not sure, contact Customer Service. See How to Contact Customer Support on page 9 for contact information.

102

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

American Express Phoenix Purchasing Card Transaction Processing

American Express Phoenix Level 2 Parameters (CAPN)

TABLE C.2 Parameter American Express Phoenix CAPN Level 2 parameters Required Type Length

Description

CPC Level 2 Transaction Advice Addendum Parameters PONUM SHIPTOZIP Purchase order number 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 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 Description of this line item; if not provided, DESC1 (if present) is used 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 Quantity of this line item Description of this line item; if not provided, DESC2 (if present) is used 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) Quantity of this line item Description of this line item; if not provided, DESC3 (if present) is used 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) Quantity of this line item Yes Yes Alphanumeric Alphanumeric 17 15

TAXAMT

No

Numeric

12

L_DESC1 L_AMT1

No No

Alphanumeric Numeric

140 12

L_QTY1 L_DESC2 L_AMT2

No No No

Numeric Alphanumeric Numeric

3 40 12

L_QTY2 L_DESC3 L_AMT3

No No No

Numeric Alphanumeric Numeric

3 40 12

L_QTY3

No

Numeric

Payflow Pro Developers Guide

103

Submitting Purchasing Card Level 2 and Level 3 Transactions

American Express Phoenix Purchasing Card Transaction Processing TABLE C.2 Parameter L_DESC4 L_AMT4 American Express Phoenix CAPN Level 2 parameters (Continued) Required No No Type Alphanumeric Numeric Length 40 12

Description Description of this line item; if not provided, DESC4 (if present) is used 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) Quantity of this line item

L_QTY4

No

Numeric

Location Transaction Advice Addendum Parameters MERCHANTNAME MERCHANTSTREET MERCHANTCITY MERCHANTSTATE Name of merchant Merchants street address (number and street name) Merchants city Merchants state No No No No No Alphanumeric Alphanumeric 38 38 21 3 3

MERCHANTCOUNTRY Merchants numeric country code CODE Example: USA: 840 MERCHANTZIP Merchants 5- to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737

No

Alphanumeric

15

Transaction Advice Detail Parameters ADDLAMTn Detail of a charge (n is the line item number, a value from 1 - 5); use for additional breakdown of the charge 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 A 3-digit code indicating the type of the corresponding charge detail (n is the line item number, a value from 1 - 5) No Numeric 12

ADDLAMTTYPEn

No

Alphanumeric

104

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

American Express Phoenix Purchasing Card Transaction Processing

American Express Phoenix Level 2 Parameters (Legacy)

TABLE C.3 Parameter PONUM SHIPTOZIP American Express Phoenix Legacy Level 2 parameters Required Yes Yes Type Alphanumeric Alphanumeric Length 17 16

Description Purchase order number 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 Freeform description Freeform description Freeform description Freeform description

DESC1 DESC2 DESC3 DESC4

No No No No

Alphanumeric Alphanumeric Alphanumeric Alphanumeric

40 40 40 40

Example American Express Phoenix Level 2 Transaction Parameter String

TRXTYPE=S&ACCT=372449635311003&AMT=20.06&CITY=Mountain View&DESC1=desc1&DESC2=desc2&DESC3=desc3&DESC4=FRT10.00&EXPDATE=1209&NAME=C ardholder Name&PARTNER=PayPal&PONUM=12345&PWD=pwd&SHIPTOZIP=94045&STATE=CA&STREET=123 Main St.&TENDER=C&USER=user&ZIP=123451234

American Express Phoenix Level 3 Parameters

The American Express Phoenix platform supports Level 3 transaction data. PayPal provides the Merchant Registration data values: Supplier Name, Supplier City, Supplier State, Supplier

Payflow Pro Developers Guide

105

Submitting Purchasing Card Level 2 and Level 3 Transactions

American Express Phoenix Purchasing Card Transaction Processing

Postal code, Merchant No, and Federal Tax ID. The merchant provides the values listed in Table C.4.
TABLE C.4 AMEX Name (per American Express Specification) Supplier Reference Number Authorization Code Mandatory / Optional American Express Phoenix Level 3 Parameters XMLPayRequest parameter (See Payflow Pro XMLPay Developers Guide for detailed instructions.) Invoice.InvNum

Pay Flow SDK parameter INVNUM Defaults to PNREF if not present. AUTHCODE (Passed transparently for delayed capture. Use only with voice authorized force capture transactions) REQNAME PONUM SHIPTOZIP 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 INVOICEDATE Defaults to Transaction Date if not present.

Format (min/max, type) 1/9, AN

ForceCapture.Authcode

Requester Name Cardmember Reference No Ship to ZIP

M M M

ExtData REQNAME BillTo.PONum ShipTo.Address.ZIP

1/40, AN 1/17, AN 5/6, AN

Invoice Date

Invoice.Date

YYYYMM DD, string

106

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

American Express Phoenix Purchasing Card Transaction Processing TABLE C.4 Mandatory / Optional AMEX Name (per American Express Specification) Total Transaction Amount American Express Phoenix Level 3 Parameters (Continued) XMLPayRequest parameter (See Payflow Pro XMLPay Developers Guide for detailed instructions.) Invoice.TotalAmt

Pay Flow SDK parameter AMT 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).
N O T E : American Express Phoenix

Format (min/max, type) 1/8 NUM

Level 3 processing requires that this parameter have a maximum field length of 8 for Level 3 processing. Total Tax Amount M TAXAMT 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). DESC Defaults to NO FREIGHTAMT HANDLINGAMT L_QTYn L_UOMn L_COSTn L_DESCn L_CATALOGNUMn L_COSTCENTERNUMn L_PRODCODEn Invoice.TaxAmt 1/6 NUM

Charge Description Total Freight Amt Total Handling Amt Quantity Invoiced Unit of Measure Unit Price Item Description Supplier Catalog No Cost Center No Supplier Stock Keeping Unit Number Universal Product Code Item Tax Amount

O O O M M M M M M O

Invoice.Description Invoice.FreightAmt Invoice.HandlingAmt Item.Quantity Item.UnitOfMeasurement Item.UnitPrice Item.Description Item.CatalogNumber Item.CostCenterNumber Item.SKU

1/40, AN 1/15, AN 1/15, AN 1/10, NUM 2/2, AN 1/15, NUM 1/80, AN 1/20, AN 1/30, AN 1/30, AN

O O

L_UPCn L_TAXAMTn

Item.UPC Item.TaxAmt

1/30, AN 1/6, NUM

Payflow Pro Developers Guide

107

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing TABLE C.4 Mandatory / Optional AMEX Name (per American Express Specification) Freight Amount Handling Amount Tracking Number Drop-off Address1 Drop-off City Drop-off State Drop-off ZIP Drop-off Country UNSPSC Code American Express Phoenix Level 3 Parameters (Continued) XMLPayRequest parameter (See Payflow Pro XMLPay Developers Guide for detailed instructions.) Item.FreightAmt Item.HandlingAmt Item.TrackingNumber Item.PickUp.Address.Street Item.PickUp.Address.City Item.PickUp.Address.State Item.PickUp.Address.ZIP Item.PickUp.Address.Country Item.UNSPSCCode

Pay Flow SDK parameter L_FREIGHTAMTn L_HANDLINGAMTn L_TRACKINGNUMn L_PICKUPSTREETn L_PICKUPCITYn L_PICKUPSTATEn L_PICKUPZIPn L_PICKUPCOUNTRYn L_UNSPSCCODEn

Format (min/max, type) 1/15, NUM 1/15, NUM 1/30, AN 1/40, AN 2/30, AN 2/2, AN 3/15, AN 2/3, AN 1/30, AN

O O O O O O O O O

Example American Express Phoenix Level 3 Transaction Parameter String

TRXTYPE=S&TENDER=C&partner=partner&PWD=test&USER=test&ACCT=378734493671000&EXPDATE=12 13&AMT=5.00&COMMENT1=PCARD Test&COMMENT2=Testing&ZIP=940151234&STREET=123 Lincoln WAY&CVV2=052&SHIPTOCOUNTRY=USA&CUSTCODE=12345&FREIGHTAMT=1.00&ORDERDATE=021700&HANDLI NGAMT=1.00&PONUM=1234567890123456789012345&SHIPFROMZIP=940151234&SHIPTOZIP=940151234& TAXAMT=1.00&TAXEXEMPT=N&L_UPC1=PN&L_QTY1=1&L_DESC1=Test 123&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_COST2=1.00&L_PRODCODE2=1234&L_COSTCENTERNUM2=55&L_T AXAMT2=1.00&REQNAME=Robert&SHIPTOZIP=543210&INVNUM=123456789&VERBOSITY=2

First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing
N O T E : FDMS

Nashville supports Level 2 transaction processing only.

108

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services (FDMS) Nashville Purchasing Card Transaction Processing

The following parameters are recommended to obtain the best rates for purchasing card transactions with FDMS Nashville.
TABLE C.5 Parameter COMMCARD FDMS commercial card parameters Required No (defaults to U - Unknown) Type Alphanumeric Length 1

Description One-character value representing type of purchasing card account number sent. P Purchase Card C Corporate Card B Business Card U Unknown (default) N None 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). 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).. Purchase order number.

DUTYAMT

No

Currency

10

FREIGHTAMT

No

Currency

10

PONUM

No (but provides best rate when used) No (but provides best rate when used) No (but provides best rate when used)

Alphanumeric Numeric

25

SHIPTOZIP

Ship to postal code (called zip code in the USA).

TAXAMT

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).. Is the customer tax exempt? Y or N

Currency

10

TAXEXEMPT

No

Alpha

Payflow Pro Developers Guide

109

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing

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:
TABLE C.6 Parameter SHIPTOCOUNTRY FDMS North purchasing card parameters Description Destination country code. Visa and MasterCard are different. Refer to country code tables. (See Appendix F, ISO Country Codes) Discount amount on total sale 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) See FDMS South Currency Codes and Decimal Positions on page 166. 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). See FDMS South Currency Codes and Decimal Positions on page 166. Purchase order number / merchant-related data. Required No Type Alpha Length 4

DISCOUNT DUTYAMT

No No

Currency Currency

10 10

FREIGHTAMT

No

Currency

10

PONUM

No (but provides best rate when used) No (but provides best rate when used) No (but provides best rate when used)

Alphanumeric

25

SHIPFROMZIP

The postal code (called zip code in the USA) from which shipping occurs.

Numeric

SHIPTOZIP

Ship to postal code (called zip code in the USA).

Numeric

110

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services (FDMS) North Purchasing Card Transaction Processing TABLE C.6 Parameter TAXAMT FDMS North purchasing card parameters (Continued) Description 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). See FDMS South Currency Codes and Decimal Positions on page 166. Required No (but provides best rate when used) Type Currency Length 10

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 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. In addition, the SHIPFROMZIP parameter is required for Level 3 transactions.
TABLE C.7 Parameter L_QTYn L_COMMCODEn L_DESCn FDMS North line item parameters Required Yes No No No No No No Yes No Type Numeric Alphanumeric Alphanumeric Alpha Currency Alphanumeric Currency Currency Currency Length 10 12 35 3 10 12 10 10 10

Description Quantity (whole units only). Item commodity code. Item description. Item unit of measure. See Units of Measure on page 161. Cost per item, excluding tax. Supplier specific product code. Discount per line item. Total line item amount including tax and discount. + for debit, - for credits. Line item tax amount.

L_UOMn L_COSTn L_UPCn

L_DISCOUNTn L_AMTn L_TAXAMTn

Payflow Pro Developers Guide

111

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing

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.
TABLE C.8 Parameter CITY SHIPTOCOUNTRY FDMS South Level 2 and Level 3 purchasing card parameters Description Cardholders city. Destination Country Code. Visa and MasterCard are different. Refer to Country Code tables. (See Appendix F, ISO Country Codes) Customer code/customer reference ID. Discount amount on total sale. 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). See FDMS South Currency Codes and Decimal Positions on page 166. Cardholders first name. 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)). See FDMS South Currency Codes and Decimal Positions on page 166. Merchant invoice number. This reference number (PNREFgenerated by PayPal) is used for authorizations and settlements. The acquirer decides if this information will appear on the merchants bank reconciliation statement. Cardholders last name. Order date. Format is mmddyy with no slashes or dashes. For example, July 28, 2003 is 072803. Required No No Type Alpha Alpha Length 13 4

CUSTCODE DISCOUNT DUTYAMT

No No No

Alphanumeric Currency Currency

17 10 10

FIRSTNAME FREIGHTAMT

No No

Alpha Currency

15 10

INVNUM

No

Alphanumeric

LASTNAME ORDERDATE

No No

Alpha Numeric

15 6

112

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing TABLE C.8 Parameter ORDERTIME FDMS South Level 2 and Level 3 purchasing card parameters (Continued) Description Order time and date. Format is either YYYY-MMDD 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. Purchase order number / merchant-related data. Required No Type Alphanum eric Length 19

PONUM

No (but provides best rate when used) No (but provides best rate when used) No (but provides best rate when used) No No No (but provides best rate when used)

Alphanumeric

25

SHIPFROMZIP

The postal code (called zip code in the USA) from which shipping occurs.

Numeric

SHIPTOZIP

Ship to postal code (called zip code in the USA).

Numeric

STATE SWIPE TAXAMT

Cardholders state. Allows Track 1 and Track 2 data to be passed to enable a card-present transaction. 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). See FDMS South Currency Codes and Decimal Positions on page 166. Is the customer tax exempt? Y or N

Alpha Alphanumeric Currency

2 80 10

TAXEXEMPT

No

Alpha

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

Payflow Pro Developers Guide

113

Submitting Purchasing Card Level 2 and Level 3 Transactions

First Data Merchant Services South (FDMS) Purchasing Card Transaction Processing

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.
TABLE C.9 Parameter L_QTYn L_COMMCODEn L_DESCn FDMS South purchasing card line item parameters Required Yes No No No No No No Yes No Type Numeric Alphanumeric Alphanumeric Alpha Currency Alphanumeric Currency Currency Currency Length 10 12 35 3 10 12 10 10 10

Description Quantity (whole units only). Item commodity code. Item description. Item unit of measure. See Units of Measure on page 161. Cost per item, excluding tax. Supplier-specific product code. Discount per line item. Total line item amount including tax and discount. + for debit, - for credits. Line item tax amount.

L_UOMn L_COSTn L_PRODCODEn

L_DISCOUNTn L_AMTn L_TAXAMTn

Example FDMS South Purchasing Card Level 2 and 3 Parameter String

TRXTYPE=S&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant& PWD=x1y2z3&STATE=CA&FIRSTNAME=John&LASTNAME=Smith&CITY=Redwood&SHIPTOCOUNTR Y=USA&CUSTCODE=12345&DISCOUNT=.25&DUTYAMT=34.00&FREIGHTAMT=12.00&INVNUM=123 456789&ORDERDATE=021700&PONUM=1234567890123456789012345&SHIPFROMZIP=9401512 34&SHIPTOZIP=94065&TAXAMT=1.00&TAXEXEMPT=Y

Example FDMS South Line Item Parameter String

TRXTYPE=S&TENDER=C&PARTNER=PayPal&VENDOR=SuperMerchant&USER=SuperMerchant& PWD=x1y2z3&STATE=CA&FIRSTNAME=John&LASTNAME=Smith&CITY=Redwood&SHIPTOCOUNTR Y=USA&CUSTCODE=12345&DISCOUNT=.25&DUTYAMT=34.00&FREIGHTAMT=12.00&INVNUM=123 456789&ORDERDATE=021700&PONUM=1234567890123456789012345&SHIPFROMZIP=9401512 34&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_DISCOUNT1=.25&&L_AMT1=.75&L_TAX AMT1=0

114

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Global Payments - Central Purchasing Card Transaction Processing

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

Both Level 2 parameters in Table C.10 are required to get the discount rate. You must pass the following parameters.
TABLE C.10 Global Payments - Central Level 2 parameters Data Items Customer Code Sales Tax Mandatory / Optional M M Payflow Parameter CUSTCODE TAXAMT 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. Format (min/max, type) 1/16, Char NUM

Example Global Payments - Central Level 2 Visa or MasterCard Transaction Parameter String
TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&CITY=Mountain View&COMMENT1=L2 Testing&EXPDATE=1209&NAME=Cardholder Name&PARTNER=PayPal&PWD=pwd&STATE=CA&STREET=123 Main St.&TENDER=C&USER=user&ZIP=94043&CUSTCODE=123456&TAXAMT=1.34

Global Payments - East Purchasing Card Transaction Processing

Global Payments - East (NDCE) supports Level 2 parameters for American Express, MasterCard, and Visa.

Payflow Pro Developers Guide

115

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing

Global Payments - East Level 2 Parameters

Both Level 2 parameters listed in Table C.11 are required to get the discount rate. You must pass these parameters in Authorization and Sale transactions.
TABLE C.11 Global Payments - East Level 2 parameters Data Items Customer Code Sales Tax Payflow Parameter CUSTCODE TAXAMT 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. Required Yes Yes Type char numeric Length (min/ max) 1/16

Example Global Payments - East Level 2 Visa or MasterCard Transaction Parameter String
TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&CITY=Mountain View&COMMENT1=L2 Testing&EXPDATE=1209&NAME=Cardholder Name&PARTNER=PayPal&PWD=pwd&STATE=CA&STREET=123 Main St.&TENDER=C&USER=user&ZIP=94043&CUSTCODE=123456&TAXAMT=1.34

Global Payments - Central (MAPP) supports Level 2 for MasterCard, and Visa Sale, Credit, and Delayed Capture transactions.

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 or not the credit card in the transaction is a commercial card. Based in the commercial card indicator, PayPal will format the Level 2 information in the settlement request.

116

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing

Merchant e-Solutions Level 2 Transaction Data

Level 2 values marked as mandatory in Table C.12 are required to get the discount rate.
TABLE C.12 Merchant e-Solutions Level 2 parameters Merchant eSolutions Name Cust Ref ID Tax Amount Mandatory / Optional M M Format (min/max, type) 1/17, AN NUM

Payflow Parameter PONUM TAXAMT 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). TAXEXEMPT, Y or N

Tax Amount Identifier

1, A

Example Merchant e-Solutions Level 2 Visa Transaction Parameter String TRXTYPE=S&ACCT=4111111111111111&AMT=20.02&CITY=Mountain View&COMMENT1=L2 Testing&EXPDATE=1209&INVNUM=661254585&NAME=CardHolder Name&PARTNER=PayPal&PWD=pwd&STATE=CA&STREET=123 Main St.&TAXAMT=1.01&TAXEXEMPT=N&TENDER=C&USER=user&ZIP=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 mandatory are required for Level 3 transactions. Level 3 transactions that do not include the mandatory Level 2 values are rejected.
IMPO RTANT: The values required for Level 3 status vary by bank, so contact your bank for

details.

Payflow Pro Developers Guide

117

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing

Merchant e-Solutions Level 2 MasterCard Parameters Required for Level 3 Transactions TABLE C.13 Merchant e-Solutions Level 2 MasterCard parameters for Level 3 line item transactions Merchant e-Solutions Name Purchase Identifier Tax Amt Mandatory / Optional M M Length, Data Type 25, AN NUM

Payflow Parameter PONUM Value of TransID is sent if no value is provided. TAXAMT 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). LOCALTAXAMT TAXEXEMPT, Y or N NATIONALTAXAMT You may omit this parameter if there is no such tax. INVNUM Value of PNREF is sent if no value is provided.

Lcl Tax Lcl Tax Incl Flag National Tax Amt Purch Ord #/Cust Ref ID

O O O M

12, NUM 1, AN 12, NUM 9, AN

Merchant e-Solutions Level 3 MasterCard Extended Data

The parameters listed in Table C.14 apply to Level 3 MasterCard transactions as extended data.
TABLE C.14 Merchant e-Solutions Level 3 MasterCard Extended Data Merchant e-Solutions Name Freight Amt Duty Amt Dest Postal / ZIP Code Mandatory / Optional O O M Payflow Parameter FREIGHTAMT DUTYAMT SHIPTOZIP The zip code of the address to which the goods are shipped. SHIPFROMZIP The postal code (called zip code in the USA) from which shipping occurs. SHIPTOCOUNTRY ALTTAXAMT Length, Data Type 12, NUM 12, NUM 10, AN

Ship from Postal / ZIP Code Dest Country Code Alt Tax Amt

10, AN

O O

4, AN 9, NUM

118

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing

Merchant e-Solutions Level 3 MasterCard Line item Detail Records TABLE C.15 Merchant e-Solutions Level 3 MasterCard line item detail record Merchant e-Solutions Name Mandatory / Optional Payflow Parameter Length, Data Type

N O T 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<n>) and unit price (L_COST<n>) fields. Item Descriptor Product Code Quantity Unit of Measure/Code Tax Rate Applied Tax Type Applied Tax Amount Discount Amount M O M M O O O O L_DESCn L_UPCn L_QTYn L_UOMn L_TAXRATEn L_TAXTYPEn L_TAXAMTn L_DISCOUNTn 35, AN 12, AN 12, NUM 12, AN 4, NUM 4, AN 12, NUM 12, NUM

Example Merchant e-Solutions Level 3 MasterCard Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000 0005&EXPDATE=0406&AMT=1.00&STREET=5199 JOHNSON&ZIP=94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.00&NATIO NALTAXAMT=1.00&COMMCODE=22222&VATAXAMT=1.00&VATAXPERCENT=10&TAXEXEMPT=Y&DIS COUNT=1.00&FREIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&S HIPTOCOUNTRY=840&ORDERDATE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 description&L_UPC1=CBA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.00&L _TAXAMT1=1.00&L_TAXRATE1=1.00&L_DISCOUNT1=1.00&L_AMT1=1.00&L_TAXTYPE1=TT3

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 mandatory are required for Level 3 transactions. Level 3 transactions that do not include the mandatory Level 2 values are rejected.
IMPO RTANT: The values required for Level 3 status vary by bank, so contact your bank for

details.

Payflow Pro Developers Guide

119

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing

Merchant e-Solutions Level 2 Visa Parameters Required for Level 3 Transactions TABLE C.16 Merchant e-Solutions Level 2 Visa parameters for Level 3 line item transactions Merchant eSolutions Name Purchase Identifier Tax Amount Mandatory / Optional M M Length, Data Type 25, AN NUM

Payflow Parameter PONUM Value of TransID is sent if no value is provided. TAXAMT 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). LOCALTAXAMT TAXEXEMPT, Y or N.

Lcl Tax Lcl Tax Incl Flag National Tax Amt Purch Ord #/Cust Ref ID

12, NUM 1, AN 12, NUM 9, AN

O M

NATIONALTAXAMT INVNUM Value of TransID is sent if no value is provided.

Merchant e-Solutions Level 3 Visa Extended Data

The parameters listed in Table C.17 apply to Level 3 Visa transactions as extended data.
TABLE C.17 Merchant e-Solutions Level 3 Visa extended data Merchant eSolutions Name Summary Commodity Code Discount Amt Freight Amt Duty Amt Order Date Mandatory / Optional M O M O O Payflow Parameter COMMCODE Commodity code identifier for the business. DISCOUNT FREIGHTAMT DUTYAMT ORDERDATE Format is mmddyy with no slashes or dashes. For example, July 28, 2003 is 072803 SHIPTOZIP The zip code of the address to which the goods are shipped. Length, Data Type 4, AN 12, NUM 12, NUM 12, NUM 6, NUM

Dest Postal / ZIP Code

10, AN

120

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing TABLE C.17 Merchant e-Solutions Level 3 Visa extended data (Continued) Merchant eSolutions Name Ship from Postal / ZIP Code Dest Country Code VAT Registration Number Unique VAT Inv Ref # Mandatory / Optional M Payflow Parameter SHIPFROMZIP The postal code (called zip code in the USA) from which shipping occurs. SHIPTOCOUNTRY VATREGNUM Can be part of the registration data or passed with each transaction. INVNUM Can be part of the registration data or passed with each transaction. CUSTVATREGNUM VATTAXAMT VATTAXPERCENT Length, Data Type 10, AN

O M

4, AN 20, AN

9, AN

Cust VAT Registr # VAT/Tax Amt (Freight/Ship) VAT/Tax Rate (Freight/Ship)

M O O

13, AN 12, NUM 4, NUM

Payflow Pro Developers Guide

121

Submitting Purchasing Card Level 2 and Level 3 Transactions

Merchant e-Solutions Purchasing Card Transaction Processing

Merchant e-Solutions Level 3 Visa Line item Detail Records TABLE C.18 Merchant e-Solutions Level 3 Visa line item detail record Merchant e-Solutions Name Mandatory / Optional Payflow Parameter Length, Data Type

N O T 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<n>) and unit price (L_COST<n>) fields. Item Commodity Code Item Descriptor Product Code Quantity Unit of Measure/Code Unit Cost VAT/Tax Amount VAT/Tax Rate Discount Per Line Item Line-item Total O M M M M M O O M O L_COMMCODEn L_DESCn L_UPCn L_QTYn L_UOMn L_COSTn L_TAXAMTn L_TAXRATEn L_DISCOUNTn L_AMTn 12, AN 35, AN 12, AN 12, NUM 12, AN 12, NUM 12, NUM 4, NUM 12, NUM 12, NUM

Example Merchant e-Solutions Level 3 Visa Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111 1111&EXPDATE=0406&AMT=1.00&STREET=5199 JOHNSON&TAXAMT=106&ZIP=94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT =1.01&NATIONALTAXAMT=1.02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXE XEMPT=N&DISCOUNT=.50&FREIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZ IP=44444&SHIPTOCOUNTRY=840&ORDERDATE=020725&L_COMMCODE1=123456789ABC&L_DESC 1=Line item 1 description&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

122

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Elavon (Formerly Nova) Purchasing Card Transaction Processing

Elavon (Formerly Nova) Purchasing Card Transaction Processing

Elavon supports Level 2 for Visa or MasterCard Sale, Credit, or Delayed Capture transactions.

Elavon Level 2 Parameters

Both Level 2 parameters listed in Table C.19 are required to get the discount rate. You must pass these parameters in Authorization and Sale transactions.
TABLE C.19 Elavon Level 2 parameters Mandatory / Optional M M Format (min/max, type) 1/16, char NUM

Data Items Customer Code Sales Tax

Payflow Parameter CUSTCODE Value of {ServerID}{TransID} is sent if no value is provided. TAXAMT Value of 0 (zero) is sent if no value is provided. 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).

Elavon Additional Parameters

The following parameters are recommended to obtain the best rates for purchasing card transactions with Elavon:
TABLE C.20 Elavon additional parameters Parameter COMMCARD Description One-character value representing the type of commercial card. P Purchase Card C Corporate Card B Business Card U Unknown (default) N None Purchase Order Number. Required No (defaults to U - Unknown) Type AN Length 1

PONUM

No (when used provides best rate)

AN

25

Payflow Pro Developers Guide

123

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing TABLE C.20 Elavon additional parameters (Continued) Parameter TAXAMT Description 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). Required No (when used provides best rate) Type Currency Length 10

Example Elavon Level 2 Transaction Parameter String

TRXTYPE=S&ACCT=5105105105105100&AMT=20.10&CITY=Mountain View&COMMENT1=L2 Testing&EXPDATE=1209&NAME=Cardholder Name&PARTNER=PayPal&PWD=pwd&STATE=CA&STREET=123 Main St.&TENDER=C&USER=user&ZIP=94043&CUSTCODE=123456&TAXAMT=1.34

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing

Paymentech Salem (New Hampshire) Level 2 Parameters (CAPN)
The Paymentech Salem (New Hampshire) platform supports Level 2 parameters for American Express, MasterCard, Visa, and Switch/Solo Maestro. The parameters to meet card acceptance and processor network (CAPN) requirements are described in Table C.21. Level 2 parameters supported for legacy applications are described in Table C.22.
N O T E : Most

merchants in the United States follow CAPN requirements; international merchants do not.There are a few exceptions. If you are not sure, contact Customer Service. See How to Contact Customer Support on page 9 for contact information.

TABLE C.21 Paymentech Salem (New Hampshire) CAPN Level 2 parameters Parameter Description Required Type Length

CPC Level 2 Transaction Advice Addendum Parameters PONUM SHIPTOZIP TAXAMT Purchase order number Ship-to postal code (called zip code in the USA) 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) Yes Yes No Alphanumeric Alphanumeric Numeric 17 15 12

124

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing TABLE C.21 Paymentech Salem (New Hampshire) CAPN Level 2 parameters Parameter L_DESC1 L_AMT1 Description Description of this line item; if not provided, DESC1 (if present) is used 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) Quantity of this line item Description of this line item; if not provided, DESC2 (if present) is used 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)) Quantity of this line item Description of this line item; if not provided, DESC3 (if present) is used 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)) Quantity of this line item Description of this line item; if not provided, DESC4 (if present) is used 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) Quantity of this line item Required No No Type Alphanumeric Numeric Length 140 12

L_QTY1 L_DESC2 L_AMT2

No No No

Numeric Alphanumeric Numeric

3 40 12

L_QTY2 L_DESC3 L_AMT3

No No No

Numeric Alphanumeric Numeric

3 40 12

L_QTY3 L_DESC4 L_AMT4

No No No

Numeric Alphanumeric Numeric

3 40 12

L_QTY4

No

Numeric

Location Transaction Advice Addendum Parameters MERCHANTNAME MERCHANTSTREET MERCHANTCITY MERCHANTSTATE Name of merchant Merchants street address (number and street name) Merchants city Merchants state No No No No Alphanumeric 38 38 21 3

Payflow Pro Developers Guide

125

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing TABLE C.21 Paymentech Salem (New Hampshire) CAPN Level 2 parameters Parameter Description Required No Type Alphanumeric Length 3

MERCHANTCOUNTRY Merchants numeric country code CODE Example: USA: 840 MERCHANTZIP Merchants 5- to 9-digit zip (postal) code excluding spaces, dashes, and non-numeric characters Example: 951121737

No

Alphanumeric

15

Transaction Advice Detail Parameters ADDLAMTn Detail of a charge (n is the line item number, a value from 1 - 5); use for additional breakdown of the charge 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 A 3-digit code indicating the type of the corresponding charge detail (n is the line item number, a value from 1 - 5) No Numeric 12

ADDLAMTTYPEn

No

Alphanumeric

Paymentech Salem (New Hampshire) Level 2 Parameters (Legacy)

Paymentech Salem (New Hampshire) supports Level 2 parameters for American Express, MasterCard, Visa, and Switch/Solo Maestro. Both Level 2 parameters listed in Table C.22 are required to get the discount rate.
TABLE C.22 Paymentech Salem (New Hampshire) Level 2 legacy parameters Paymentech Data Items Customer Ref No Sales Tax Mandatory / Optional M M Format (min/max, type) 1/17, char NUM

Payflow Parameter PONUM TAXAMT Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56) To qualify for Level 2 discounts, this value must not be all zeros or blank spaces.

126

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing

Example Paymentech Salem (New Hampshire) Level 2 Visa and MasterCard Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&PWD=Password&USER=User&ACCT=548018000000 0024&EXPDATE=1203&AMT=1.00&COMMENT1=0508&NAME=Robert&STREET=1600&ZIP=94065& CVV2=426&PONUM=ABCDEFGHIJ&TAXAMT=1.00 TRXTYPE=S&TENDER=C&PARTNER=Partner&PWD=Password&USER=User&ACCT=427533001234 5626&EXPDATE=1203&AMT=1.00&COMMENT1=0508&STREET=1600&ZIP=94065&CVV2=426&PON UM=ABCDEFGHIJ&TAXAMT=1.00 Example American Express Level 2 Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&PWD=Password&USER=User&ACCT=378734493671 000&EXPDATE=1203&AMT=1.00&COMMENT1=0508&NAME=Robert&STREET=1600&ZIP=94065&D ESC=Descriptor&DESC1=Descriptor1&DESC2=Descriptor2&DESC3=Descriptor3&DESC4= Descriptor4

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 are required for Level 3 transactions. Level 3 transactions that do not include the Level 2 values are rejected.
Paymentech Salem (New Hampshire) Level 2 Parameters Required for Level 3 Transactions

Both Level 2 parameters listed in Table C.23 are required to get the discount rate.
TABLE C.23 Paymentech Salem (New Hampshire) Level 2 parameters Paymentech Data Items Customer Ref No Sales Tax Mandatory / Optional M M Format (min/max, type) 1/17, char NUM

Payflow Parameter PONUM TAXAMT Must include a decimal and be exact to the cent (42.00, not 42) and exclude comma separators (1234.56 not 1,234.56). To qualify for Level 2 discounts, this value must not be all zeros or blank spaces.

Payflow Pro Developers Guide

127

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing

Paymentech Salem (New Hampshire) Level 3 MasterCard Parameters TABLE C.24 Paymentech Salem (New Hampshire) Level 3 MasterCard order and line item parameters Paymentech MasterCard data item Order Freight Amt Duty Amt Destination ZIP Destination Country Ship from ZIP Discount Amount Alternate Tax ID Alternate Tax Amt Line Item Record #1 Description Product Code Quantity Unit of measure Tax Amt Tax Rate Line Item Record #2 Line-item Total Discount Amt Tax Type Applied O O O L_AMTn L_DISCOUNTn L_TAXTYPEn NUM NUM M O M M O O L_DESCn L_PRODCODEn L_QTYn L_UOMn TAXAMTn TAXPERCENTAGEn NUM NUM M M M M M M M M FREIGHTAMT DUTYAMT SHIPTOZIP SHIPTOCOUNTRY SHIPPEDFROMZIP DISCOUNT ALTERNATETAXID ALTERNATETAXAMT NUM NUM NUM NUM Mandatory / Optional Payflow Parameter Format (min/max, type)

128

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Salem (New Hampshire) Purchasing Card Transaction Processing

Paymentech Salem (New Hampshire) Level 3 Visa Parameters

Level 3 transactions should include at least one line item.

TABLE C.25 Paymentech Salem (New Hampshire) Level 3 Visa order and line item parameters Paymentech Visa data item Order Freight Amt Duty Amt Destination ZIP Destination Country Ship from ZIP Discount Amount VAT/Tax Amt VAT/Tax Rate Line Item Record #1 Description Product Code Quantity Unit of measure Tax Amt Tax Rate Line Item Record #2 Line-item Total Discount Amt Item commodity code Unit cost M M M M L_AMTn L_DISCOUNTn L_UPCn L_COSTn NUM NUM NUM M M M M O O L_DESCn L_PRODCODEn L_QTYn L_UOMn L_TAXAMTn L_TAXRATEn NUM NUM M M M M M M M M FREIGHTAMT DUTYAMT SHIPTOZIP SHIPTOCOUNTRY SHIPPEDFROMZIP DISCOUNT TAXAMT TAXPERCENTAGE NUM NUM NUM NUM Mandatory / Optional Payflow Parameter Format (min/max, type)

Payflow Pro Developers Guide

129

Submitting Purchasing Card Level 2 and Level 3 Transactions

Paymentech Tampa Level 2 Purchasing Card Transaction Processing

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=1203&AMT=1.00&COMMENT1=0508&NAME=Robert&STREET=1600&ZIP=94065& CVV2=426&PONUM=ABCDEFGHIJ&TAXAMT=1.00&FREIGHTAMT=2.00&DUTYAMT=3.00&SHIPTOZI P=94543&SHIPTOCOUNTRY=840&SHIPFROMZIP=94509&ALTERNATETAXID=10&ALTERNATETAXA MT=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=1203&AMT=1.00&COMMENT1=0508&NAME=Robert&STREET=1600&ZIP=94065& CVV2=426&PONUM=ABCDEFGHIJ&TAXAMT=1.00&FREIGHTAMT=2.00&DUTYAMT=3.00&SHIPTOZI P=94543&SHIPTOCOUNTRY=840&SHIPFROMZIP=94509&DISCOUNT=4.00&VATAXAMT=5.00&VAT AXPERCENT=10&L_DESC1=TSYS Acquiring Solutions Pcard&L_UPC1=1&L_UOM1=2&L_QTY 1=3&L_TAXAMT1=4&L_TAXRATE1=5&L_AMT1=6&L_DISCOUNT1=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.

130

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

Pa ymentech Tampa Level 2 Parameters

TABLE C.26 Paymentech Tampa Level 2 parameters Paymentech Data Items Customer Ref No Sales Tax Mandatory / Optional M M Format (min/max, type) 1/17, char NUM

Payflow Parameter PONUM TAXAMT 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. TAXEXEMPT, Y or N Contact your acquiring bank to determine if your transactions are tax exempt. SHIPTOZIP (called zip code in the USA).

Tax Exempt

Ship to ZIP Code

1/16

Example Paymentech Tampa Level 2 Visa and MasterCard Transaction Parameter String
TRXTYPE=S&TENDER=C&PWD=PWD&USER=USER&PARTNER=PARTNER&ACCT=4275330012345675&EXPDATE=0 209&AMT=12.59&VERBOSITY=1&STREET=123 main street&ZIP=49801&CVV2=248&TAXAMT=1.22&PONUM=AB12345678&SHIPTOZIP=98765&TAXEXEMPT=N

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 or not the credit card in the transaction is a commercial card. Based in the commercial card indicator, PayPal will format the Level 2 information in the settlement request.

Payflow Pro Developers Guide

131

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

Level 2 parameters marked as mandatory in Table C.27 are required to get the discount rate.
TABLE C.27 TSYS Acquiring Solutions Level 2 parameters Mandatory / Optional M M Format (min/max, type) 1/17, AN NUM

Name Cust Ref ID Tax Amount

Payflow Parameter PONUM TAXAMT 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). TAXEXEMPT, Y or N

Tax Amount Identifier

1, A

Example TSYS Acquiring Solutions Level 2 Visa Transaction Parameter String TRXTYPE=S&ACCT=4111111111111111&AMT=20.02&CITY=Mountain View&COMMENT1=L2 Testing&EXPDATE=1209&INVNUM=661254585&NAME=CardHolder Name&PARTNER=PayPal&PWD=pwd&STATE=CA&STREET=123 Main St.&TAXAMT=1.01&TAXEXEMPT=N&TENDER=C&USER=user&ZIP=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 mandatory are required for Level 3 transactions. Level 3 transactions that do not include the mandatory Level 2 values are rejected.
IMPO RTANT: The values required for Level 3 status vary by bank, so contact your bank for

details.

132

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

TSYS Acquiring Solutions Level 2 MasterCard Parameters Required for Level 3 Line Item Transactions TABLE C.28 TSYS Acquiring Solutions Level 2 MasterCard transaction data for line item transactions Name Purchase Identifier Tax Amt Mandatory / Optional M M Payflow Parameter PONUM Value of TransID is sent if no value is provided. TAXAMT 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). LOCALTAXAMT TAXEXEMPT, Y or N NATIONALTAXAMT You may omit this parameter if there is no such tax. INVNUM Value of PNREF is sent if no value is provided. Length, Data Type 25, AN NUM

Lcl Tax Lcl Tax Incl Flag National Tax Amt Purch Ord #/Cust Ref ID

O O O M

12, NUM 1, AN 12, NUM 9, AN

TSYS Acquiring Solutions Level 3 MasterCard Extended Data

The parameters listed in Table C.29 apply to Level 3 MasterCard transactions as extended data.
TABLE C.29 TSYS Acquiring Solutions Level 3 MasterCard Extended Data Name Freight Amt Duty Amt Dest Postal / ZIP Code Mandatory / Optional O O M Payflow Parameter FREIGHTAMT DUTYAMT SHIPTOZIP The zip code of the address to which the goods are shipped. SHIPFROMZIP The postal code (called zip code in the USA) from which shipping occurs. SHIPTOCOUNTRY ALTTAXAMT Length, Data Type 12, NUM 12, NUM 10, AN

Ship from Postal / ZIP Code Dest Country Code Alt Tax Amt

10, AN

O O

4, AN 9, NUM

Payflow Pro Developers Guide

133

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

TSYS Acquiring Solutions Level 3 MasterCard Line item Detail Records TABLE C.30 TSYS Acquiring Solutions Level 3 MasterCard line item detail record Name Mandatory / Optional Payflow Parameter Length, Data Type

N O T 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<n>) and unit price (L_COST<n>) fields. Item Descriptor Product Code Quantity Unit of Measure/Code Tax Rate Applied Tax Type Applied Tax Amount Discount Amount M O M M O O O O L_DESCn L_UPCn L_QTYn L_UOMn L_TAXRATEn L_TAXTYPEn L_TAXAMTn L_DISCOUNTn 35, AN 12, AN 12, NUM 12, AN 4, NUM 4, AN 12, NUM 12, NUM

Example TSYS Acquiring Solutions Level 3 MasterCard Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=552500000000 0005&EXPDATE=0406&AMT=1.00&STREET=5199 JOHNSON&ZIP=94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT=1.00&NATIO NALTAXAMT=1.00&COMMCODE=22222&VATAXAMT=1.00&VATAXPERCENT=10&TAXEXEMPT=Y&DIS COUNT=1.00&FREIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZIP=44444&S HIPTOCOUNTRY=840&ORDERDATE=020725&L_COMMCODE1=123456789ABC&L_DESC1=Line item 1 description&L_UPC1=CBA987654321&L_QTY1=1&L_UOM1=123456789012&L_COST1=1.00&L _TAXAMT1=1.00&L_TAXRATE1=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 mandatory are required for Level 3 transactions. Level 3 transactions that do not include the mandatory Level 2 values are rejected.
IMPO RTANT: The values required for Level 3 status vary by bank, so contact your bank for

details.

134

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

TSYS Acquiring Solutions Level 2 Visa Parameters for Level 3 Line Item Transactions TABLE C.31 TSYS Acquiring Solutions Level 2 Visa transaction data for line item transactions Name Purchase Identifier Tax Amount Mandatory / Optional M M Payflow Parameter PONUM Value of TransID is sent if no value is provided. TAXAMT 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). LOCALTAXAMT TAXEXEMPT, Y or N O M NATIONALTAXAMT INVNUM Value of TransID is sent if no value is provided. Length, Data Type 25, AN NUM

Lcl Tax Lcl Tax Incl Flag National Tax Amt Purch Ord #/Cust Ref ID

12, NUM 1, AN 12, NUM 9, AN

TSYS Acquiring Solutions Level 3 Visa Extended Data

The parameters listed in Table C.32 apply to Level 3 Visa transactions as extended data.
TABLE C.32 TSYS Acquiring Solutions Level 3 Visa extended data Name Summary Commodity Code Discount Amt Freight Amt Duty Amt Order Date Mandatory / Optional M O M O O Payflow Parameter COMMCODE Commodity code identifier for the business. DISCOUNT FREIGHTAMT DUTYAMT ORDERDATE Format is yymmdd with no slashes or dashes. For example, November 28, 2008 is 081128 SHIPTOZIP The zip code of the address to which the goods are shipped. Length, Data Type 4, AN 12, NUM 12, NUM 12, NUM 6, NUM

Dest Postal / ZIP Code

10, AN

Payflow Pro Developers Guide

135

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing TABLE C.32 TSYS Acquiring Solutions Level 3 Visa extended data (Continued) Name Ship from Postal / ZIP Code Dest Country Code VAT Registration Number Unique VAT Inv Ref # Mandatory / Optional M Payflow Parameter SHIPFROMZIP The postal code (called zip code in the USA) from which shipping occurs. SHIPTOCOUNTRY VATREGNUM Can be part of the registration data or passed with each transaction. INVNUM Can be part of the registration data or passed with each transaction. CUSTVATREGNUM VATTAXAMT VATTAXPERCENT Length, Data Type 10, AN

O M

4, AN 20, AN

9, AN

Cust VAT Registr # VAT/Tax Amt (Freight/Ship) VAT/Tax Rate (Freight/Ship)

M O O

13, AN 12, NUM 4, NUM

136

Payflow Pro Developers Guide

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

TSYS Acquiring Solutions Level 3 Visa Line item Detail Records TABLE C.33 TSYS Acquiring Solutions Level 3 Visa line item detail record Name Mandatory / Optional Payflow Parameter Length, Data Type

N O T 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<n>) and unit price (L_COST<n>) fields. Item Commodity Code Item Descriptor Product Code Quantity Unit of Measure/Code Unit Cost VAT/Tax Amount VAT/Tax Rate Discount Per Line Item Line-item Total O M M M M M O O M O L_COMMCODEn L_DESCn L_UPCn L_QTYn L_UOMn L_COSTn L_TAXAMTn L_TAXRATEn L_DISCOUNTn L_AMTn 12, AN 35, AN 12, AN 12, NUM 12, AN 12, NUM 12, NUM 4, NUM 12, NUM 12, NUM

Example TSYS Acquiring Solutions Level 3 Visa Transaction Parameter String TRXTYPE=S&TENDER=C&PARTNER=Partner&USER=User&PWD=Password&ACCT=411111111111 1111&EXPDATE=0406&AMT=1.00&STREET=5199 JOHNSON&TAXAMT=106&ZIP=94588&ALTTAXAMT=1.00&CUSTVATREGNUM=11111&LOCALTAXAMT =1.01&NATIONALTAXAMT=1.02&COMMCODE=22222&VATAXAMT=1.03&VATAXPERCENT=55&TAXE XEMPT=N&DISCOUNT=.50&FREIGHTAMT=1.00&DUTYAMT=1.00&SHIPTOZIP=33333&SHIPFROMZ IP=44444&SHIPTOCOUNTRY=840&ORDERDATE=081125&L_COMMCODE1=123456789ABC&L_DESC 1=Line item 1 description&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

Payflow Pro Developers Guide

137

Submitting Purchasing Card Level 2 and Level 3 Transactions

TSYS Acquiring Solutions Purchasing Card Transaction Processing

138

Payflow Pro Developers Guide

D
TABLE D.1 Parameter VERBOSITY

VERBOSITY: Viewing ProcessorSpecific Transaction Results

Transaction results (especially values for declines and error conditions) returned by each PayPal-supported processor vary in detail level and in format. The Payflow VERBOSITY parameter described below enables you to control the kind and level of information you want returned.
VERBOSITY parameter Description (Optional) Enables you to obtain additional processor information for a transaction. Values are LOW or MEDIUM. LOW is the default settingnormalized values MEDIUM returns the processors raw response values VERBOSITY is also part of an Inquiry transaction. For more information, see Submitting Inquiry Transactions on page 38.

By default, VERBOSITY is set to LOW.. A LOW setting causes PayPal to normalize the transaction result values. Normalizing the values limits them to a standardized set of values and simplifies the process of integrating the Payflow SDK. By setting VERBOSITY to MEDIUM, you can view the processors raw response values. This setting is more verbose than the LOW setting in that it returns more detailed, processorspecific information.

Supported Verbosity Settings

The following VERBOSITY settings are supported for PayPal-supported processors. Contact your processor or bank for definitions of the returned values. LOW: This is the default setting for PayPal accounts. The following values are returned: {RESULT, PNREF, RESPMSG, AUTHCODE, AVSADDR, AVSZIP, CVV2MATCH, IAVS, CARDSECURE} MEDIUM: All of the values returned for a LOW setting, plus the following values:
N O T E : For information on interpreting the responses returned by the processor for the MEDIUM

VERBOSITY setting, contact your processor directly.

Payflow Pro Developers Guide

139

VERBOSITY: Viewing Processor-Specific Transaction Results

Supported Verbosity Settings

TABLE D.2 Field Name HOSTCODE RESPTEXT

Processor responses Type Char Char Length 7 17 Description Response code returned by the processor. This value is not normalized by PayPal. Text corresponding to the response code returned by the processor. This text is not normalized by PayPal. Address Verification Service response from the processor CVV2 (buyer authentication) response from the processor VPAS/SPA response from the processor Additional error message that indicates that the merchant used a feature that is disabled

PROCAVS PROCCVV2 PROCCARDSECURE ADDLMSGS

Char Char Char char

1 1 1 Up to 1048 characters. Typically 50 characters.

140

Payflow Pro Developers Guide

VERBOSITY: Viewing Processor-Specific Transaction Results

Supported Verbosity Settings TABLE D.2 Field Name TRANSSTATE Processor responses(Continued) Type Integer Length 10 Description State of the transaction. The values are: 0 = Account Verification (no settlement involved) 1 = General error state 3 = Authorization approved 6 = Settlement pending (transaction is scheduled to be settled) 7 =Settlement in progress (transaction involved in a currently ongoing settlement) 8 = Settled successfully 9 = Authorization captured (once an authorization type transaction is captured, its TRANSSSTATE becomes 9) 10 =Capture failed (an error occurred while trying to capture an authorization because the transaction was already captured) 11 = Failed to settle (transactions fail settlement usually because of problems with the merchants processor or because the card type is not set up with the merchants processor) 12 - Unsettled transaction because of incorrect account information 14 = For various reasons, the batch containing this transaction failed settlement 15 = Settlement incomplete due to a charge back 16 = Merchant ACH settlement failed; (need to manually collect it) 106 = Unknown Status Transaction - Transactions not settled 206 = Transactions on hold pending customer intervention Value available only before settlement has started

DATE_TO_SETTLE

Date format YYYY-MM-DD HH:MM:SS Integer Date format YYYY-MM-DD HH:MM:SS

19

BATCHID SETTLE_DATE

10 19

Value available only after settlement has assigned a Batch ID Value available only after settlement has completed

Payflow Pro Developers Guide

141

VERBOSITY: Viewing Processor-Specific Transaction Results

Supported Verbosity Settings TABLE D.2 Field Name AMEXID Processor responses(Continued) Type Numeric Length 15 Description American Express transactions meeting CAPN requirements:
N O T E : Used only by merchants who authorize

transactions through the payflow gateway but settle through a third-party solution. AMEXPOSDATA Alphanumeric 12 American Express transactions meeting CAPN requirements:
N O T E : Used only by merchants who authorize

transactions through the payflow gateway but settle through a third-party solution.

142

Payflow Pro Developers Guide

VERBOSITY: Viewing Processor-Specific Transaction Results

Supported Verbosity Settings TABLE D.2 Field Name VISACARDLEVEL Processor responses(Continued) Type Alphanumeric Length 2 Description Card product level indicator returned by VISA. The values are: A = Visa Traditional B = Visa Traditional Rewards C = Visa Signature D = Visa Infinite E = Reserved F = Reserved G = Visa Business Card H = Visa Check Card I = Visa Commerce J = Reserved K = Visa Corporate Card L = Reserved M = MasterCard/EuroCard and Diners* N = Reserved O = Reserved P = Reserved Q = Private Label R = Proprietary Card S = Visa Purchasing Card T = Reserved/Interlink U = Visa TravelMoney W -Z = Reserved 0 - 9 = Reserved G1 = Visa Signature Business G2= Visa Business Check Card J1 = Visa General Prepaid J2 = Visa Prepaid Gift Card J3 = Visa Prepaid Healthcare J4 = Visa Prepaid Commercial K1 = Visa GSA Corporate T&E Q1 = Private Label Prepaid S1 = Visa Purchasing with Fleet S2 = Visa GSA Purchasing S3 = Visa GSA Purchasing with Fleet V1 = Reserved DI = Discover* AX = American Express*
N O T E : Because length is 2, single character values

are followed by a space.

Payflow Pro Developers Guide

143

VERBOSITY: Viewing Processor-Specific Transaction Results

Changing the Verbosity Setting

Table D.3 shows the increments that are possible on basic TRANSSTATE values.
TABLE D.3 Increment +100 TRANSSTATE increments

Meaning If no client acknowledgment (ACK) is received for the transaction, the original TRANSSTATE value is incremented by 100. For example, if the original TRANSSTATE is 6, it is incremented to 106. Transactions in this range do not settle. For transactions in TRANSSTATE 106, use Auto Resettle in PayPal Managers Virtual Terminal to submit them for settlement or void them using a manual Void. If the host process never receives an ACK from the transaction broker (or backend payment server) for the transaction, the original TRANSSTATE value is incremented by 200. For example, if the original TRANSSTATE is 6, it is incremented to 206. Transactions in this range are basically in limbo and will not be settled. If a Void transaction is run (through the API, PayPal Virtual Terminal, or by PayPal Customer Service) against a successful Authorization or Sale transaction, the original TRANSSTATE is incremented by 1000. For example, if the original TRANSSTATE is 6, it is incremented to 1006.

+200

+1000

Changing the Verbosity Setting

Setting the Verbosity Level on a Per-Transaction Basis
To specify a setting for Verbosity that differs from your accounts current setting, include the VERBOSITY=<value> name-value pair in the transaction request, where <value> is LOW or MEDIUM.

Setting the Default Verbosity Level for All Transactions

Contact Customer Service to set your accounts VERBOSITY setting to LOW or MEDIUM for all transaction requests. For details, see How to Contact Customer Support on page 9.

144

Payflow Pro Developers Guide

Additional Reporting Parameters

This appendix lists parameters whose values can appear in PayPal Manager reports. For example, the Shipping and Billing report displays these values. Some of the following parameters may also have other purposes. The STREET and ZIP parameters, for instance, are also used for Address Verification Service.
N O T E : For

regular credit card transactions, reporting parameters are normally not passed to the processor. See Appendix A, Processors Requiring Additional Transaction Parameters, to learn which fields are sent to your processor.
Additional reporting parameters Description Cardholders billing city User-defined value for reporting and auditing purposes (PayPal parameter only) User-defined value for reporting and auditing purposes (PayPal parameter only) Cardholders billing country code Cardholders company Customer code Duty amount Cardholders email address Cardholders first name Freight amount Cardholders last name Required No No Type Alpha Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Max Length 20 128

TABLE E.1 Parameter CITY COMMENT1

COMMENT2

No

128

BILLTOCOUNTRY COMPANYNAME CUSTCODE DUTYAMT EMAIL FIRSTNAME FREIGHTAMT LASTNAME

No No No No No No No No

4 30 30 10 64 15 10 15

Payflow Pro Developers Guide

145

Additional Reporting Parameters

TABLE E.1 Parameter NAME PONUM SHIPTOCITY

Additional reporting parameters Description Cardholders name Purchase order number Shipping city First name in the shipping address Last name in the shipping address Shipping state US = 2 letter state code; outside US, use full name Shipping street address Shipping postal code (called zip code in the USA) Cardholders billing state code Cardholders billing street address (used for Address Verification Service and reporting) Tax amount Account holders 5-to-9-digit postal code (called zip in the USA). Do not use spaces, dashes, or non-numeric characters. The postal code is verified by Address Verification Service. Required No No No No No No Type Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Alphanumeric Max Length 15 15 30 30 30 10

SHIPTOFIRSTNAME SHIPTOLASTNAME SHIPTOSTATE

SHIPTOSTREET SHIPTOZIP STATE STREET

No No No No

Alphanumeric Alphanumeric Alphanumeric Alphanumeric Currency Numeric

30 9 2 30

TAXAMT ZIP

No No

10 9

146

Payflow Pro Developers Guide

F
TABLE F.1 Country Name Afghanistan Albania Algeria American Samoa Andorra Angola Anguilla Antarctica

ISO Country Codes

The following International Standards Organization (ISO) country codes are used when filling the order fields BILLTOCOUNTRY, SHIPTOCOUNTRY, and CORPCOUNTRY: ISO country codes Code 4 8 12 16 20 24 660 10 28 32 51 533 36 40 31 44 48 108 116 120 124 132 136 140 Country Name Bangladesh Barbados Belarus Belgium Belize Benin Bermuda Bhutan Bolivia Bosnia-Herzegovina Botswana Bouvet Island Brazil British Indian Ocean Territory Brunei Darussalam Bulgaria Burkina Faso Dominican Republic East Timor Ecuador Egypt El Salvador Equatorial Guinea Eritrea Code 50 52 112 56 84 204 60 64 68 70 72 74 76 86 96 100 854 214 626 218 818 222 226 232

Antigua and Barbuda Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Burundi Cambodia Cameroon Canada Cape Verde Cayman Islands Central African Republic

Payflow Pro Developers Guide

147

ISO Country Codes

TABLE F.1

ISO country codes Code 148 152 156 162 166 170 174 178 184 188 384 191 192 196 203 208 262 212 304 308 312 316 320 324 624 328 332 334 Country Name Estonia Ethiopia Falkland Islands (Malvinas) Faroe Islands Fiji Finland France France, Metropolitan French Guiana French Polynesia French Southern Territories Gabon Gambia Georgia Germany Ghana Gibraltar Greece Jordan Kazakhstan Kenya Kiribati Korea, Democratic Peoples Republic of (formerly North Korea) Korea, Republic of (formerly South Korea) Kuwait Kyrgyzstan Lao Peoples Democratic Republic (formerly Laos) Latvia Code 233 231 238 234 242 246 250 249 254 258 260 266 270 268 276 288 292 300 400 398 404 296 408 410 414 417 418 428

Country Name Chad Chile China Christmas Island Cocos (Keeling) Islands Colombia Comoros Congo Cook Islands Costa Rica Cote Divoire (Ivory Coast) Croatia (local name: Hrvatska) Cuba Cyprus Czech Republic Denmark Djibouti Dominica Greenland Grenada Guadeloupe Guam Guatemala Guinea Guinea-Bissau Guyana Haiti Heard and McDonald Islands

148

Payflow Pro Developers Guide

ISO Country Codes

TABLE F.1

ISO country codes Code 340 344 348 352 356 360 364 368 372 376 380 388 392 466 470 584 474 478 480 175 484 583 498 492 496 500 504 508 104 Country Name Lebanon Lesotho Liberia Libyan Arab Jamahiriya (formerly Libya) Liechtenstein Lithuania Luxembourg Macau Macedonia, the Former Yugoslav Republic of Madagascar Malawi Malaysia Maldives Niue Norfolk Island Northern Mariana Islands Norway Oman Pakistan Palau Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico Code 422 426 430 434 438 440 442 446 807 450 454 458 462 570 574 580 578 512 586 585 591 598 600 604 608 612 616 620 630

Country Name Honduras Hong Kong Hungary Iceland India Indonesia Iran (Islamic Republic of) Iraq Ireland Israel Italy Jamaica Japan Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia, Federated States of Moldova, Republic of Monaco Mongolia Montserrat Morocco Mozambique Myanmar (formerly Burma)

Payflow Pro Developers Guide

149

ISO Country Codes

TABLE F.1

ISO country codes Code 516 520 524 528 530 540 554 558 562 566 678 682 686 690 694 702 703 705 90 706 710 239 724 144 654 666 736 740 744 Country Name Qatar Reunion Romania Russian Federation Rwanda Saint Kitts and Nevis Saint Lucia Saint Vincent and the Grenadines Samoa San Marino Tajikistan Tanzania, United Republic of Thailand Togo Tokelau Tonga Trinidad and Tobago Tunisia Turkey Turkmenistan Turks and Caicos Islands Tuvalu Uganda Ukraine United Arab Emirates United Kingdom United States United States Minor Outlying Islands Uruguay Code 634 638 642 643 646 659 662 670 882 674 762 834 764 768 772 776 780 788 792 795 796 798 800 804 784 826 840 581 858

Country Name Namibia Nauru Nepal Netherlands Netherlands Antilles New Caledonia New Zealand Nicaragua Niger Nigeria Sao Tome and Principe Saudi Arabia Senegal Seychelles Sierra Leona Singapore Slovakia (Slovak Republic) Slovenia Solomon Islands Somalia South Africa South Georgia and the South Sandwich Islands Spain Sri Lanka St. Helena St. Pierre and Miquelon Sudan Suriname Svalbard and Jan Mayen Islands

150

Payflow Pro Developers Guide

ISO Country Codes

TABLE F.1

ISO country codes Code 748 752 756 760 158 92 850 876 92 850 732 Country Name Uzbekistan Vanuatu Vatican City State Venezuela Viet Nam Western Samoa Yemen Yugoslavia Zaire Zambia Zimbabwe Code 860 548 336 862 704 882 887 891 180 894 716

Country Name Swaziland Sweden Switzerland Syrian Arab Republic (formerly Syria) Taiwan, Province of China Virgin Islands (British) Virgin Islands (U.S.) Wallis and Futuna Islands Virgin Islands (British) Virgin Islands (U.S.) Western Sahara

Payflow Pro Developers Guide

151

ISO Country Codes

152

Payflow Pro Developers Guide

G
TABLE G.1 ALBANIA ALGERIA

Codes Used by FDMS South Only

Codes used by FDMS South only are Country Codes, Units of Measure, and Currency Codes.

MasterCard Country Codes

MasterCard country codes ALB DZA ASM AND AGO AIA ATA ATG LAO AFG ARG ARN ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL

AMERICAN SAMOA ANDORRA ANGOLA ANGUILLA ANTARCTICA ANTIGUA AO PEOPLES DEMOCRATIC APHGANISTAN ARGENTINA ARMENIA ARUBA AUSTRALIA AUSTRIA AZERBAIJAN BAHAMAS BAHRAIN BANGLADESH BARBADOS BELARUS BELGIUM

Payflow Pro Developers Guide

153

Codes Used by FDMS South Only

MasterCard Country Codes TABLE G.1 BELIZE BENIN BERMUDA BHUTAN BOLIVIA BOSNIA AND HERZIGOVINA BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI BULGARIA BURKINA FASO BURUNDI CAMBODIA CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHAD CHILE CHINA CHRISTMAS ISLAND CMEROON, UNITED REP. COCOS (KEELING) ISLAND COLOMBIA COMOROS CONGO COOK ISLANDS COSTA RICA TABLE G.1

MasterCard country codes BLZ BEN BMU BTN BOL BIH BWA BVT BRA IOT BRN BGR BFA BDI KHM CAN CPV CYM CAF TCD CHL CHN CXR CMR CCK COL COM GOG COK CRI

MasterCard country codes CIV HRV CYP CZE DNK DJI DMA DOM SLV GNQ EST ETH FRO FLK FJI FIN FRA GUF PYF ATF GAB GMB GEO DDR DEU GHA GIB GRC GRL GRD GLP

COTED'IVOIRE CROATIA CYPRUS CZECH REPUBLIC DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC EL SALVADOR EQUATORIAL GUINEA ESTONIA ETHIOPIA FAEROE ISLANDS FALKLAND ISLANDS (MALVINAS) FIJI FINLAND FRANCE FRENCH GUIANA FRENCH POLYNESIA FRENCH SOUTHERN TERRITORY GABON GAMBIA GEORGIA GERMAN DEMOCRATIC REP GERMANY GHANA GIBRALTER GRECE GREENLAND GRENADA GUADALUPE

154

Payflow Pro Developers Guide

Codes Used by FDMS South Only

MasterCard Country Codes TABLE G.1 GUAM GUATEMALA GUINEA GUINEA-BISSAU GUYANA HAITI HEARD & MCDONALDS ISLAND HONDURAS HONG KONG HUNGARY ICELAND INDIA INDONESIA IRAN IRAQ IRELAND ISRAEL ITALY JAMAICA JAPAN JORDAN KAZAKHSTAN KENYA KOREA, REPUBLIC OF KUWAIT KYRGYZSTAN LATVIA LEBANON LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA TABLE G.1

MasterCard country codes GUM GTM GIN GNB GUY HTI HMD HND HKG HUN ISL IND IDN IRN IRQ IRL ISR ITA JAM JPN JOR KAZ KEN KOR KWT KGZ LVA LBN LSO LBR LBY

MasterCard country codes LIE LTU LUX MAC MYS MDV MLI MLT MCO MHL MTQ MRT MUS MEX FSM MDA MNG MSR MAR MOZ MMR NAM NRU SEN NPL NLD ANT NCL NZL NIC NER

LIECHTNSTIEN LITHUANIA LUXEMBOURG MACAU MALAYSIA MALDIVES MALI MALTA MANACO MARSHALL ISLANDS MATINIQUE MAURITANIA MAURITIUS MEXICO MICRONESIA MOLDOVA MONGOLIA MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR NAMIBIA NAURU NEGEL NEPAL NETHERLANDS NETHERLANDS ANTILLES NEW CALDONIA NEW ZEALAND NICARAGUA NIGER

Payflow Pro Developers Guide

155

Codes Used by FDMS South Only

MasterCard Country Codes TABLE G.1 NIGERIA NIUE NORFOLK ISLAND NORTHERN MARIANA ISLAND NORWAY OMAN PAKISTAN PALAU PANAMA PAPAU NEW GUINEA PARAGUAY PERU PHILIPPINES PITCAIRN ISLAND POLAND PORTUGUL PUERTO RICO QATAR REUNION ROMANIA RUSSIAN FERERATION RWANDA SAMOA SAN MARINO SAN TOME AND PRICIPEL SAUDI ARABIA SEYCHELLES SIERRA LEONE SINGAPORE ST. HELENA ST. KITTS-NEVIS-ANGUILLA TABLE G.1 ST. LUCIA ST. PIERRE AND MIQUELON ST. VINCENT AND THE GRENADINES SUDAN SURINAM SVALBARD & JAN MAYEN IS. SWAZILAND SWEDEN SWITZERLAND SYRIAN ARAB REPUBLIC TAIWAN, PROVIDENCE OF CHINA TAJIKISTAN TANZANIA, UNITED REPUBLIC THAILAND TOGO TOKELAU TONGA TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS & CAICOS ISLANDS TUVALU U.S. MINOR OUTLYING ISL. UGANDA UKRAINIAN SSR UNITED ARAB EMIRATES UNITED KINGDOM UNITED STATES URAGUAY

MasterCard country codes NGA NIU NFK MNP NOR OMN PAK PLW PAN PNG PRY PER PHI PCN POL PRT PRI QAT REU ROM RUS RWA WSM SMR STP SAU SYC SLE SGP SHN KNA

MasterCard country codes LCA SPM VCT SDN SUR SJM SWZ SWE CHE SYR TWN TJK TZA THA TGO TKL TON TTO TUN TR TM TC TUV UMI UGA UKR ARE GBR USA URY

156

Payflow Pro Developers Guide

Codes Used by FDMS South Only

Visa Country Codes TABLE G.1

MasterCard country codes UZB VUT VAT VEN VNM VGB VIR WLF ESH YEM YUG ZAR ZMB RHO

UZBEKISTAN VANUATU VATICAN CITY STATE VENEZUELA VIETNAM VIRGIN ISLANDS BRITISH VIRGIN ISLANDS US WALLIS AND FUTUNA IS WESTERN SAHARA YEMEN YUGOSLAVIA ZAIRE ZAMBIA ZIMBABWE

Visa Country Codes

TABLE G.2 TABLE G.2 ALBANIA ALGERIA AMERICAN SAMOA ANDORRA ANGOLA ANGUILLA ANTARCTICA ANTIGUA APHGANISTAN ARGENTINA ARMENIA Visa country codes AL DZ AS AD AO AI AQ AG AF AR AM ARUBA AUSTRALIA AUSTRIA AZERBAIJAN BAHAMAS BAHRAIN BANGLADESH BARBADOS BELARUS BELGIUM BELIZE BENIN BERMUDA Visa country codes AW AU AT AZ BS BH BD BB BY BE BZ BJ BM

Payflow Pro Developers Guide

157

Codes Used by FDMS South Only

Visa Country Codes TABLE G.2 BHUTAN BOLIVIA BOSNIA AND HERZIGOVINA BOTSWANA BOUVET ISLAND BRAZIL BRITISH INDIAN OCEAN TERRITORY BRUNEI BULGARIA BURKINA FASO BURUNDI CAMBODIA CANADA CAPE VERDE CAYMAN ISLANDS CENTRAL AFRICAN REPUBLIC CHACOS (KEELING) ISLAND CHAD CHILE CHINA CHRISTMAS ISLAND CMEROON, UNITED REP. COLUMBIA COMOROS CONGO COOK ISLANDS COSTA RICA COTED'IVOIRE CROATIA CYPRUS TABLE G.2 BT BO BA BW BV BR IO BN BG BF BI KH CA CV KY CF CC TD CL CN CX CM CO KM CG CK CR CI HR CY

Visa country codes

Visa country codes CZ DK DJ DM DO TP EC EG SV GQ ER EE ET FO FK FJ FI FR GF FX PF TF GA GM GE DE GH GI GR GL GD

CZECH REPUBLIC DENMARK DJIBOUTI DOMINICA DOMINICAN REPUBLIC EAST TIMOR ECUADOR EGYPT EL SALVADOR EQUATORIAL GUINEA ERITREA ESTONIA ETHIOPIA FAEROE ISLANDS FALKLAND ISLANDS FIJI FINLAND FRANCE FRENCH GUIANA FRENCH METROPOLITAN FRENCH POLYNESIA FRENCH SOUTHERN TERRITORY GABON GAMBIA GEORGIA GERMANY GHANA GIBRALTER GRECE GREENLAND GRENADA

158

Payflow Pro Developers Guide

Codes Used by FDMS South Only

Visa Country Codes TABLE G.2 TABLE G.2 GP GU GT GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IL IT JM JP JO KZ KE KI KR KW KG LA LV LB LESOTHO LIBERIA LIBYAN ARAB JAMAHIRIYA LIECHTNSTIEN LITHUANIA LUXEMBOURG MACAU MACEDONIA MADAGASCAR MALAWI MALAYSIA MALDIVES MALI MALTA MANACO MARSHALL ISLANDS MATINIQUE MAURITANIA MAURITIUS MAYOTTE MEXICO MICRONESIA MOLDOVA MONGOLIA MONTSERRAT MOROCCO MOZAMBIQUE MYANMAR NAMIBIA NAURU NEPAL

Visa country codes

Visa country codes LS LR LY LI LT LU MO MK MG MW MY MV ML MT MC MH MQ MR MU YT MX FM MD MN MS MA MZ MM NA NR NP

GUADALUPE GUAM GUATEMALA GUINEA GUINEA-BISSAU GUYANA HAITI HEARD & MCDONALDS ISLAND HONDURAS HONG KONG HUNGARY ICELAND INDIA INDONESIA IRAN IRAQ IRELAND ISRAEL ITALY JAMAICA JAPAN JORDAN KAZAKHSTAN KENYA KIRIBATI KOREA, REPUBLIC OF KUWAIT KYRGYZSTAN LAO PEOPLES DEMOCRATIC LATVIA LEBANON

Payflow Pro Developers Guide

159

Codes Used by FDMS South Only

Visa Country Codes TABLE G.2 TABLE G.2 NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PA PG PY PE PH PN PL PT PR QA RE RO RU RW WS SM ST

Visa country codes

Visa country codes SA SN SC SL SG SH KN LC PM VC SD SR SJ SZ SE CH SY TW TJ TZ TH TG TK TO TT TN TR TM TC TV

NETHERLANDS NETHERLANDS ANTILLES NEW CALDONIA NEW ZEALAND NICARAGUA NIGER NIGERIA NIUE NORFOLK ISLAND NORTHERN MARIANA ISLAND NORWAY OMAN PAKISTAN PALAU PANAMA PAPAU NEW GUINEA PARAGUAY PERU PHILIPPINES PITCAIRN ISLAND POLAND PORTUGUL PUERTO RICO QATAR REUNION ROMANIA RUSSIAN FERERATION RWANDA SAMOA SAN MARINO SAN TOME AND PRICIPEL

SAUDI ARABIA SENEGAL SEYCHELLES SIERRA LEONE SINGAPORE ST. HELENA ST. KITTS-NEVIS-ANGUILLA ST. LUCIA ST. PIERRE AND MIQUELON ST. VINCENT AND THE GRENADINES SUDAN SURINAM SVALBARD & JAN MAYEN IS. SWAZILAND SWEDEN SWITZERLAND SYRIAN ARAB REPUBLIC TAIWAN, PROVIDENCE OF CHINA TAJIKISTAN TANZANIA, UNITED REPUBLIC THAILAND TOGO TOKELAU TONGA TRINIDAD AND TOBAGO TUNISIA TURKEY TURKMENISTAN TURKS & CAICOS ISLANDS TUVALU

160

Payflow Pro Developers Guide

Codes Used by FDMS South Only

Units of Measure TABLE G.2

Visa country codes UM UG UA AE GB US UY UZ VU VA VE VN VG VI WF EH YE YU ZR ZM ZW

U.S. MINOR OUTLYING ISL. UGANDA UKRAINIAN SSR UNITED ARAB EMIRATES UNITED KINGDOM UNITED STATES URAGUAY UZBEKISTAN VANUATU VATICAN CITY STATE VENEZUELA VIETNAM VIRGIN ISLANDS BRITISH VIRGIN ISLANDS US WALLIS AND FUTUNA IS WESTERN SAHARA YEMEN YUGOSLAVIA ZAIRE ZAMBIA ZIMBABWE

Units of Measure
TABLE G.3 TABLE G.3 Units of measure ACR ASM ASV AMP Units of measure AMH ARE BAR BLL BQL BIL Ampere=hour (3,6 kC)* Are (100 m2) Bar* Barrel (petroleum) (158,987 dm3) Becquerel* Billion EUR

Acre (4840 yd2) Alcoholic strength by mass Alcoholic strength by volume Ampere*

Payflow Pro Developers Guide

161

Codes Used by FDMS South Only

Units of Measure TABLE G.3 Billion US Board foot Brake horse power (245,7 watts) British thermal unit (1,055 kilojoules) Bushel (35,2391 dm3) Bushel (36,36874 dm3) Candela* Carrying capacity in metric tonnes Cental GB (45,359237 kg) Center, metric (100 kg) (syn.: Hectokilogram) Centigram* Centilitre* Centimetre* Cord (3,63 m3) Coulomb per kilogram* Coulomb* Cubic centimetre* Cubic decimetre* Cubic foot Cubic inch Cubic metre per hour* Cubic metre per second* Cubic metre* Cubic millimetre* Cubic yard Curie Day* Decade (ten years) Decare Decilitre* TABLE G.3 MLD BFT BHP BTU BUA BUI CDL CCT CNT DTN CGM CLT CMT WCD CKG COU CMQ DMQ FTQ INQ MQH MQS MTQ MMQ YDQ CUR DAY DEC DAA DLT Decimetre* Decitonne* Degree Celsius Degree Fahrenheit Degree Kelvin: Kelvin Displacement tonnage Dozen Dozen packs Dozen pairs Dozen pieces Dozen rolls Drachm GB (3,887935 g) Dram GB (1,771745 g) Dram US (3,887935 g) Dry Barrel (115,627 dm3) Dry gallon (4,404884 dm3) Dry pint (0,55061 dm3) Dry quart (1,101221 dm3) Farad* Fluid ounce (28,413 cm3) Fluid ounce (29,5735 cm3) Foot (0,3048 m) Gallon (4,546092 dm3) Gigabecquerel* Gigawatt-hour (1 million kW/h)* Gill (0,142065 dm3) Gill (11,8294 cm3) Grain GB, US (64,798910 mg) Gram of fissile isotopes Gram* Great gross (12 gross) DPT DZN DZP DZR DCP DRL DRM DRI DRA BLD GLD PTD QTD FAR OZI OZA FOT GLI GBQ GWH GII GIA GRN GFI GRM GGR

Units of measure

Units of measure DMT DTN CEL FAH

162

Payflow Pro Developers Guide

Codes Used by FDMS South Only

Units of Measure TABLE G.3 Gross Gross (register) ton Half year (six months) Hectare Hectobar* Hectogram* Hectokilogram* Hectolitre of pure alcohol Hectolitre* Hectometre* Hertz* Hour* Hundred Hundred boxes Hundred international units Hundred leaves Hundred packs Hundredweight US (45,3592 kg) Inch (25,4 mm) Joule* Kelvin* Kilobar* Kilogram of caustic potash Kilogram of caustic soda Kilogram of named substance Kilogram of nitrogen Kilogram of phosphonic anhydride Kilogram of phosphorus pentoxide Kilogram of potassium hydroxide Kilogram of potassium oxide TABLE G.3 GRO GRT SAN HAR HBA HGM DTH HPA HLT HMT HTZ HUR CEN BHX HIU CLF CNP CWA INH JOU KEL KBA KPH KSH KNS KNI KPP KPP KPH KPO

Units of measure

Units of measure KSH KSD KMQ KGS KGM KHZ KJO KMH KMT KPA KUR KTN KVR KVT KVA KWT KWH KNT LEF GLL PTL QTL LTR LPA LTN CWI LUM LUX MHZ MAL

Kilogram of sodium hydroxide Kilogram of substance 90 percent dry Kilogram per cubic meter* Kilogram per second* Kilogram* Kilohertz* Kilojoule* Kilometre per hour* Kilometre* Kilopascal* Kilorgram of uranium Kilotonne* Kilovar Kilovolt* Kilovolt-ampere* Kilowatt* Kilowatt-hour* Knot (1 nautical mile per hour) Leaf Liquid gallon (3,78541 dm3) Liquid pint (0,473176 dm3) Liquid quart (0,946353 dm3) Litre (1 dm3)* Litre of pure alcohol Long ton GB, US (1,0160469 t) (long) hundredweight GB (50,802345 kg) Lumen* Lux Megahertz* Megalitre*

Payflow Pro Developers Guide

163

Codes Used by FDMS South Only

Units of Measure TABLE G.3 Megametre* Megapascal* Megavolt-ampere (1000 KVA)* Megawatt* Megawatt-hour (100 kW/h)* Metre per second squared* Metre per second* Metre* Metric carat (200 mg=2,10-4 kg) Metric ton (1000 kg) Milliard Millibar* Millicurie Milligram* Millilitre* Millimetre* Million Million cubic metres* Million international units Minute* Month Nautical mile (1852 m) Net (register) ton Newton* Number Number of articles Number of bobbons Number of cells* Number of international units Number of packs Number of pairs TABLE G.3 MAM MPA MVA MAW MWH MSK MTS MTR CTM TNE MLD MBR MCU MGM MLT MMT MIO HMQ MIU MIN MON NMI NTT NEW NMB NAR NBB NCL NIU NMP NMR

Units of measure

Units of measure NPL NPT NRL OHM ONZ APZ PAL DWT PCE PTI LBR PGL QTI QAN QTR DTN RPM RPS SCO SCR SEC SET SHT SST STN SIE CMK DMK FTK INK

Number of parcels Number of parts Number of rolls Ohm* Ounce GB, US (28,349523 g) Ounce GB, US (31,103448 g) (syn: Troy ounce) Pascal* Pennyweight GB, US (1555174 g) Piece Pint (0,568262 dm3) Pound GB, US (0,45359237 kg) Proof gallon Quart (1,136523 dm3) Quarter (of a year) Quarter, GB (12,700586 kg) Quintal, metric (100 kg) Revolution per minute* Revolution per second* Score scruple, GB (1,2955982 g) Second* Set Shipping ton Short standard (7200 matches) Short ton GB, US (0,90718474 t) Siemens* Square centimetre* Square decimetre* Square foot Square inch

164

Payflow Pro Developers Guide

Codes Used by FDMS South Only

Units of Measure TABLE G.3

Units of measure KMK MTK MIK MMK YDK WSD ATM SMI STI ATT DAD TPR MIL TAH MBF TQD MBE TSH TNE TSD TRL BIL APZ LBT VLT WTT WHR WEB WEE YRD ANN

Square kilometre* Square metre* Square mile Square millimetre* Square yard Standard standard atmosphere (101325 Pa) (statue) mile (1609,344 m) Stone GB (6,350293 kg) Technical atmosphere (98066,5 Pa) Ten days Ten pairs Thousand Thousand ampere-hour* Thousand board feet (2,36 m3) Thousand cubic metres per day* Thousand standard brick equivalent Ton of steam per hour Tonne (1000 kg)* Tonne of substance 90 percent dry Trillion EUR Trillion US Troy ounce Troy pound, US (373,242 g) Volt* Watt* Watt-hour* Weber Week Yard (0,9144 m) Year

Payflow Pro Developers Guide

165

Codes Used by FDMS South Only

FDMS South Currency Codes and Decimal Positions

FDMS South Currency Codes and Decimal Positions

TABLE G.4 TABLE G.4 FDMS South currency codes Currency Name Currency Name Argentine Peso Australian Dollar Austrian Schilling Belgian Franc Canadian Dollar Chilean Peso Czech Koruna Danish Krone Dominican Peso Markka French Franc Deutsche Mark Drachma Hong Kong Dollar Indian Rupee Irish Punt Shekel Italian Lira Yen Won Luxembourg Franc Mexican Duevo Peso Netherlands Guilder New Zealand Dollar Norwegian Frone Philippine Peso Currency Code 32 36 40 56 124 152 203 208 214 246 250 280 300 344 356 372 376 380 392 410 442 484 528 554 578 608 Decimal Positions 2 2 2 0 2 2 2 2 2 2 2 2 0 2 2 2 2 0 0 0 0 2 2 2 2 2 Portuguese Escudo Rand Spanish Peseta Swedish Krona Swiss Franc Thailand Baht Pound Sterling Russian Ruble U.S Dollar Bolivar New Taiwan Dollar Euro Polish New Zloty Brazilian Real FDMS South currency codes Currency Code 620 710 724 752 756 764 826 810 840 862 901 978 985 986 Decimal Positions 0 2 0 2 2 2 2 2 2 2 2 2 2 2

166

Payflow Pro Developers Guide

XMLPay

About XMLPay
XMLPay specifies an XML syntax for payment requests and associated responses in a payment-processing network. Instead of using name/value pairs, the Payflow SDK allows the use of XML documents based on XMLPay 2.0 schema. The typical user of XMLPay is an internet merchant or merchant aggregator who wants to dispatch credit card, corporate purchase card, Automated Clearinghouse (ACH), or other payment requests to a financial processing network. Using the data type definitions specified by XMLPay, such a user creates a client payment request and dispatches it in the same fashion as using name/value pairs to an associated XMLPay-compliant server component. Responses are also formatted in XML and convey the results of the payment requests to the client.

Payflow Pro XMLPay Developers Guide

Payflow Pro XMLPay Developers Guide defines an XML syntax for payment transaction requests, responses, and receipts in a payment processing network. You may obtain a copy of this document via the PayPal Manager Documentation page.
N O T E : For specific examples of how to submit XML documents using the Payflow client API,

see the Payflow SDK Download package.

Payflow Pro Developers Guide

167

XMLPay
Payflow Pro XMLPay Developers Guide

168

Payflow Pro Developers Guide

Additional Processor Information

This appendix provides 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 Payflow Pro page on Developer Central.

Payflow Pro Developers Guide

169

Additional Processor Information

Moneris Solutions

170

Payflow Pro Developers Guide

Index
A
Account Verification 23, 32 ADDLMSGS 101 address verification service 44 ALTERNATETAXAMT parameter 128 ALTERNATETAXID parameter 128 ALTTAXAMT parameter 118, 133 American Express 67 American Express CAPN 68, 83, 102, 124 AMT 101 AMT parameter 27, 107 APIs documentation 17 downloading 17 application testing 49 AUTHCODE parameter 34, 106 CUSTREF parameter 39 CUSTVATREGNUM parameter 121, 136 CVV2 parameterPayflow parameters CVV2 27

D
DESC parameter 74, 107 DESC1 parameter 74, 105 DESC2 parameter 74, 105 DESC3 parameter 74, 105 DESC4 parameter 74, 105 developer forums 9 DISCOUNT parameter 110, 112, 120, 128, 129, 135 DL parameter 92 DOB parameter 92 documentation API 17 downgraded transactions 101 downloading APIs 17 duplicate transactions 26 DUTYAMT parameter 109, 110, 112, 118, 120, 129, 133, 135

B
BALAMT 57 BALAMT parameter 57 Bank Identification Numbers. See 100 BIN 101

E
Elavon (Formerly Nova) 79 electronic check transaction required parameters 91 ENDTIME parameter 39 EXPDATE parameter 27

C
CAPN 68, 83, 102, 124 card acceptance and processing network (CAPN) 102, 124 certification 169 CHKNUM parameter 92 CITY parameter 82, 112 close batch see settlement operation COMMCARD parameter 109 COMMCODE parameter 120, 135 COMMENT1 parameter 27 COMMENT2 parameter 27 credit card verification 23, 32 credit transaction type 34 CUSTCODE parameter 112, 116

F
FDMS CardNet 77 FDMS North 77, 110 FDMS South 77, 112 firewalls. configuring 17 FIRSTNAME parameter 27, 73, 74, 88, 112 FREIGHTAMT 101 FREIGHTAMT parameter 107, 109, 110, 112, 118, 120, 128, 129, 133, 135

Index

H
HANDLINGAMT parameter 107 HOSTCODE parameter 95

I
inquiry transaction type 38 INVNUM parameter 73, 74, 76, 78, 82, 88, 89, 106, 112, 118, 121, 133, 136 INVOICEDATE parameter 106

L
L_AMTn parameter 111, 114, 122, 128, 129, 137 L_CATALOGNUMn parameter 107 L_COMMCODEn parameter 111, 114, 122, 137 L_COSTCENTERNUMn parameter 107 L_COSTn parameter 107, 111, 114, 122, 129 L_COSTn parameterPayflow parameters L_COSTn 137 L_DESCn parameter 107, 111, 114, 119, 122, 128, 129, 134, 137 L_DISCOUNTn 137 L_DISCOUNTn parameter 111, 114, 119, 122, 128, 129, 134, 137 L_FREIGHTAMTn 101 L_FREIGHTAMTn parameter 108 L_HANDLINGAMTn parameter 108 L_PICKUPCITYn parameter 108 L_PICKUPCOUNTRYn parameter 108 L_PICKUPSTATEn parameter 108 L_PICKUPSTREETn parameter 108 L_PICKUPZIPn parameter 108 L_PRODCODEn parameter 107, 114, 128, 129 L_QTYn 137 L_QTYn parameter 107, 111, 114, 119, 122, 128, 129, 134, 137 L_TAXAMTn parameter 107, 111, 114, 119, 122, 129, 134, 137 L_TAXRATEn parameter 119, 122, 129, 134, 137 L_TAXTYPEn parameter 119, 128, 134 L_TRACKINGNUMn parameter 108 L_UNSPSCCODEn parameter 108 L_UOMn parameter 107, 111, 114, 119, 122, 128, 129, 134, 137 L_UPCn parameter 107, 111, 119, 122, 129, 134, 137 LASTNAME parameter 27, 73, 74, 88, 112

length tags 21 Level 2 parameters American Express Phoenix (CAPN) 103 American Express Phoenix (legacy) 105 Elavon (Formerly Nova) 123 Global Payments - East 116 Global Payments Central 115 Merchant e-Solutions 116 Paymentech Salem (New Hampshire) 124, 126 Paymentech Tampa 131 Level 3 MasterCard transactions TSYS Acquiring Solutions 117 Level 3 parameters Merchant e-Solutions 119 Paymentech Salem (New Hampshire) 127, 128, 129 TSYS Acquiring Solutions 132, 134 Level 3 transactions American Express Brighton 108 American Express Phoenix 105, 111 Level 3 Visa transactions, TSYS Acquiring Solutions 119 levels, transaction parameters 99 Line item parameters First Data Merchant Services North 111 Line item paramters First Data Merchant Services South 113 live transactions 18 live transactions host address 13 LOCALTAXAMT parameter 118, 120, 133, 135 Logging Transaction Information 97

M
MERCHDESCR parameter 82 MERCHSVC parameter 77, 82 MICR parameter 92 Moneris Solutions 14, 169 MOTO 169

N
NATIONALTAXAMT parameter 118, 120, 133, 135 Nova. See Elavon. 79, 123

O
operation

172

Payflow Pro Developers Guide

Index

testing 49 ORDERDATE parameter 73, 74, 88, 112, 120, 135 ORDERDATETIME parameter 73, 75, 89 ORDERTIME parameter 113 ORIGID parameter 30, 35, 37, 38

P
parameters required for electronic check 91 PARTNER parameter 21 Payflow parameters ACCT 21, 28, 30, 31, 35, 37, 41, 43 ACCTTYPE 41 ADDLAMTn 71, 86, 104, 126 ADDLAMTTYPEn 71, 86, 104, 126 ADDLMSGS 101, 140 ALTERNATETAXAMT 128 ALTERNATETAXID 128 ALTTAXAMT 118, 133 AMEXID 142 AMEXPOSDATA 142 AMT 21, 27, 28, 30, 31, 35, 37, 91, 92, 101, 107 AUTHCODE 33, 34, 106 AVSADDR 53 AVSZIP 53 BALAMT 57 BATCHID 141 BILLTOCOUNTRY 31, 36, 37, 41, 82, 145 CHKNUM 91, 92 CHKTYPE 91, 92 CITY 31, 35, 37, 41, 82, 91, 92, 112, 145 COMMCARD 109 COMMCODE 120, 135 COMMENT1 27, 31, 35, 37, 92, 145 COMMENT2 27, 31, 36, 37, 92, 145 COMPANYNAME 31, 36, 37, 145 CUSTBROWSER 68, 80, 84 CUSTCODE 31, 36, 37, 112, 115, 116, 145 CUSTHOSTNAME 68, 80, 84 CUSTIP 31, 36, 37, 69, 80, 84 CUSTREF 39 CUSTVATREGNUM 121, 136 CVV2 54 CVV2MATCH 53 DATE_TO_SETTLE 141 DESC 74, 107

DESC1 74, 105 DESC2 74, 105 DESC3 74, 105 DESC4 35, 74, 105 DISCOUNT 110, 112, 120, 128, 129, 135 DL 91, 92 DOB 92 DUTYAMT 31, 35, 37, 109, 110, 112, 118, 120, 129, 133, 135, 145 EMAIL 31, 36, 37, 68, 79, 83, 91, 92, 145 ENDTIME 39 EXPDATE 22, 27, 28, 30, 31, 35, 36, 37, 41, 43 FIRSTNAME 27, 31, 36, 37, 41, 73, 74, 88, 112, 145 FREIGHTAMT 31, 35, 37, 101, 107, 109, 110, 112, 118, 120, 128, 129, 133, 135, 145 HANDLINGAMT 102, 107 HOSTADDRESS 20 HOSTCODE 95, 140 HOSTPORT 20 INVNUM 31, 36, 37, 73, 74, 76, 78, 82, 88, 89, 92, 106, 112, 118, 120, 121, 133, 136 INVOICEDATE 106 L_AMT1 103, 125 L_AMT2 103, 125 L_AMT3 103, 125 L_AMT4 104, 125 L_AMTn 68, 83, 111, 114, 122, 128, 129, 137 L_CATALOGNUMn 107 L_COMMCODEn 111, 114, 122, 137 L_COSTCENTERNUMn 107 L_COSTn 102, 107, 111, 114, 122, 129 L_DESC1 103, 125 L_DESC2 103, 125 L_DESC3 103, 125 L_DESC4 104, 125 L_DESCn 68, 83, 107, 111, 114, 119, 122, 128, 129, 134, 137 L_DISCOUNTn 111, 114, 119, 122, 128, 129, 134 L_FREIGHTAMTn 101, 108 L_HANDLINGAMTn 102, 108 L_PICKUPCITYn 108 L_PICKUPCOUNTRYn 108 L_PICKUPSTATEn 108 L_PICKUPSTREETn 108 L_PICKUPZIPn 108 L_PRODCODEn 107, 114, 128, 129 L_QTY1 103, 125

Payflow Pro Developers Guide

173

Index

L_QTY2 103, 125 L_QTY3 103, 125 L_QTY4 104, 125 L_QTYn 68, 83, 102, 107, 111, 114, 119, 122, 128, 129, 134 L_TAXAMTn 107, 111, 114, 119, 122, 129, 134, 137 L_TAXRATEn 119, 122, 129, 134, 137 L_TAXTYPEn 119, 128, 134 L_TRACKINGNUMn 108 L_UNSPSCCODEn 108 L_UOMn 107, 114, 119, 122, 128, 129, 134, 137 L_UPCn 107, 111, 119, 122, 129, 134, 137 LASTNAME 27, 31, 36, 37, 41, 73, 74, 88, 112, 145 LOCALTAXAMT 118, 120, 133, 135 MERCHANTCITY 70, 85, 104, 125 MERCHANTCOUNTRYCODE 70, 86, 104, 126 MERCHANTNAME 70, 85, 104, 125 MERCHANTSTATE 70, 85, 104, 125 MERCHANTSTREET 70, 85, 104, 125 MERCHANTZIP 70, 86, 104, 126 MERCHDESCR 82 MERCHSVC 77, 82 MICR 91, 92 MIDDLENAME 31, 36, 37, 41 NAME 91, 92, 146 NATIONALTAXAMT 118, 120, 133, 135 ORDERDATE 73, 74, 88, 112, 120, 135 ORDERDATETIME 73, 75, 89 ORDERTIME 113 ORIGID 30, 35, 37, 38, 57 PARMLIST 20 PARTNER 21, 91, 93 PHONENUM 31, 36, 37, 68, 69, 80, 81, 83, 84, 93 PHONETYPE 68, 80, 83 PNREF 30, 35, 37, 38, 57, 95 PONUM 31, 36, 37, 103, 105, 106, 109, 110, 113, 117, 118, 120, 124, 126, 131, 132, 133, 135, 146 PROCAVS 140 PROCCARDSECURE 140 PROCCVV2 140 PROXYADDRESS 20 PROXYLOGON 20 PROXYPASSWORD 20 PROXYPORT 20 PWD 21, 91, 93 RECURRING 35, 37, 70, 75, 76, 78, 81, 82, 85, 90

RECURRINGTYPE 83 REQNAME 106 RESPMSG 58, 95 RESPTEXT 140 RESULT 58, 64, 95 SETTLE_DATE 141 SHIPFROMZIP 110, 113, 118, 121, 133, 136 SHIPMETHOD 69, 80, 84 SHIPPEDFROMZIP 128, 129 SHIPTOCITY 31, 36, 37, 146 SHIPTOCOUNTRY 31, 36, 37, 69, 80, 81, 84, 85, 110, 112, 118, 121, 129, 133, 136 SHIPTOFIRSTNAME 31, 36, 37, 69, 81, 85, 146 SHIPTOLASTNAME 31, 36, 37, 69, 81, 85, 146 SHIPTOMIDDLENAME 31, 36, 37 SHIPTOPHONENUM 70, 81, 85 SHIPTOSTATE 31, 36, 37, 146 SHIPTOSTREET 31, 36, 37, 69, 81, 85, 146 SHIPTOZIP 31, 36, 37, 70, 81, 85, 103, 105, 106, 109, 110, 118, 120, 124, 129, 131, 133, 135, 146 SKU 69, 80, 84 SS 91, 93 STARTTIME 39 STATE 31, 36, 37, 41, 82, 91, 93, 113, 146 STREET 27, 31, 36, 37, 41, 45, 53, 69, 80, 84, 92, 93, 146 SWIPE 28, 31, 36, 37, 41, 42, 43, 73, 75, 76, 78, 82, 89, 113 TAXAMT 31, 35, 37, 101, 103, 107, 109, 111, 113, 115, 116, 117, 118, 120, 124, 126, 129, 131, 132, 133, 135, 146 TAXAMTn 128 TAXEXEMPT 31, 35, 37, 109, 113, 117, 118, 120, 131, 132, 133, 135 TAXPERCENTAGE 129 TAXPERCENTAGEn 128 TENDER 26, 91, 93 TIMEOUT 20 TRANSSTATE 141 TRXTYPE 26, 28, 29, 33, 34, 36, 57, 91, 93 USER 21, 91, 93 VATREGNUM 121, 136 VATTAXAMT 121, 136 VATTAXPERCENT 121, 136 VENDOR 21, 91, 93 VERBOSITY 19, 20, 101, 139

174

Payflow Pro Developers Guide

Index

ZIP 24, 27, 31, 36, 37, 41, 44, 45, 53, 69, 81, 84, 92, 93, 146 payflowpro.paypal.com 13 payment types 15 PayPal Developer Central 9 PHONENUM parameter 69, 81, 84, 93 pilot-payflowpro.paypal.com 13 PINless debit 26 pinless debit 15, 26, 27, 28 PNREF format of value 58 PNREF parameter 95 PNREF value 57 PONUM parameter 103, 105, 106, 109, 110, 113, 117, 118, 120, 124, 126, 131, 132, 133, 135 Purchasing card transactions American Express Phoenix 100 First Data Merchant Services Nashville 108 First Data Merchant Services North 110 First Data Merchant Services South 112 Global Payments - Central 115 Global Payments East 115 Merchant e-Solutions 116 Nova 123 Paymentech Salem (New Hampshire) 124 Paymentech Tampa 130 TSYS Acquiring Solutions 131 purchasing cards about 99 BIN ranges 100 PWD parameter 21

settlement operation 14 SHIPFROMZIP parameter 110, 113, 118, 121, 133, 136 SHIPPEDFROMZIP parameter 128, 129 SHIPTOCOUNTRY parameter 110, 112, 118, 121, 128, 129, 133, 136 SHIPTOFIRSTNAME parameter 69, 81, 85 SHIPTOLASTNAME parameter 69, 81, 85 SHIPTOSTREET parameter 69, 81, 85 SHIPTOZIP parameter 70, 81, 85, 103, 105, 106, 109, 110, 113, 118, 120, 124, 129, 131, 133, 135 Software Development Kit 9 SS parameter 93 SSL 17 SSL, see Secure Sockets Layer STARTTIME parameter 39 STATE parameter 82, 113 Stored Value 57 storefront testing 49 STREET parameter 27, 69, 80, 84, 93 SWIPE 68, 83 SWIPE parameter 28, 73, 75, 76, 78, 82, 89, 113

T
TAXAMT 101 TAXAMT parameter 107, 109, 111, 113, 116, 117, 118, 120, 126, 129, 131, 132, 133, 135 TAXAMTn parameter 128 TAXEXEMPT parameter 109, 113, 117, 118, 120, 131, 132, 133, 135 TAXPERCENTAGE parameter 129 TAXPERCENTAGEn parameter 128 TENDER parameter 26 testing operation 49 testing transactions host address 13 transaction types supporded for Level 3 procdessing 101 transaction levels described 99 transaction response PNREF parameter 57 RESPMSG parameter 58 RESULT parameter 58 transactions credit 34 inquiry 38

R
RECURRING parameter 70, 75, 76, 78, 81, 82, 85, 90 REQNAME parameter 106 required parameters electronic check 91 RESPMSG parameter 95 RESPMSG value 58 RESULT parameter 95 RESULT value 58

S
sale transaction type 28 Secure Sockets Layer 14

Payflow Pro Developers Guide

175

Index

sale 28 void 36 TRXTYPE parameter 26 TSYS Acquiring Solutions 83 type N transactions 26

U
USER parameter 21

V
VATREGNUM parameter 121, 136 VATTAXAMT parameter 121, 136 VATTAXPERCENT parameter 121, 136 VENDOR parameter 21 VERBOSITY 101 VERBOSITY parameter 139 void transaction type 36

Z
zero dollar Authorization 23, 32 ZIP parameter 27, 69, 81, 84

176

Payflow Pro Developers Guide