Gateway Developer Guide and Reference
Total Page:16
File Type:pdf, Size:1020Kb
Gateway Developer Guide and Reference PayPal Payments Advanced PayPal Payments Pro Payflow Pro Payflow Link Last updated: April 2012 Gateway Developer Guide and Reference Document Number: 200045.en_US-201204 © 2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other trademarks and brands are the property of their respective owners. The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc. Copyright © PayPal. All rights reserved. PayPal (Europe) S.à r.l. et Cie., S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard Royal, L-2449, Luxembourg, R.C.S. Luxembourg B 118 349. Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it does not require the approval of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully. Notice of non-liability: PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express, implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice. Content Preface . 11 Scope . 11 Intended Audience . 11 Related Documentation . 11 Revision History . 12 Chapter 1 Introducing the Gateway Checkout Solutions . .15 About the Gateway Checkout Solutions . 15 Summary of the Gateway Checkout Solutions . 15 Gateway Product Details . 16 About the Gateway Transaction Flow . 17 About Security . 18 Secure Token . 18 Hosted Checkout Pages . 18 PCI Compliance Without Hosted Pages: Transparent Redirect . 19 Processing Platforms Supporting Card-Present Transactions . 20 Supported Payment Types . 21 Recurring Billing Service . 21 Chapter 2 Secure Token . .23 About the Secure Token . 23 Integrating the Secure Token With the Hosted Checkout Pages . 23 Integrating the Secure Token Without the Hosted Checkout Pages: Transparent Redirect . 24 Posting To the Hosted Checkout Page . 25 Chapter 3 Configuring Hosted Checkout Pages . .27 Configuring Hosted Checkout Pages Using PayPal Manager . 27 Setup. 28 Customize . 31 Using a Secure Token and Dynamically Passing Form Post Variables . 33 Gateway Developer Guide and Reference April 2012 3 Content Chapter 4 Payflow SDK . .35 Preparing the Payflow Pro Client Application . 35 Activating Your Payflow Pro Account . 36 Host Addresses . 36 Chapter 5 Sending a Simple Transaction to the Server . .37 About Name-Value Pairs . 37 Using Special Characters In Values . 37 Name-Value Parameter Syntax Guidelines . 38 Do Not URL Encode Name-Value Parameter Data . 38 Payflow Connection Parameters . 38 User Parameter Data . 39 Sale Transaction Example . 40 Typical Sale Transaction. 40 Formatting Payflow Pro Transactions . 40 Chapter 6 Submitting Credit Card Transactions . .41 Credit Card Features. 41 About Credit Card Processing . 42 Obtaining an Internet Merchant Account. 43 Planning Your Gateway Integration . 43 Complying With E-commerce Indicator . 44 Handling Credit Card Type Information . 44 Core Credit Card Parameters . 45 Submitting Sale Transactions . 48 When To Use a Sale Transaction . 49 Additional Parameters For Sale Transactions . 49 Typical Sale Transaction Parameter String . 49 Submitting Authorization/Delayed Capture Transactions . 50 When to Use Authorization/Delayed Capture Transactions . 50 Required Authorization Transaction Parameters . 50 Typical Authorization Transaction Parameter String . 51 Submitting Partial Authorizations . 51 When To Use Partial Authorizations . 51 Required Partial Authorization Parameters . 52 Example Partial Authorization . 52 Submitting Account Verifications . 53 4 April 2012 Gateway Developer Guide and Reference Content When To Use Account Verifications . 53 Required Account Verification Parameters . 53 Example Account Verification String . 53 Submitting Voice Authorization Transactions . 54 When To Use a Voice Authorization Transaction . 54 Required Voice Authorization Transaction Parameters . 54 Submitting Credit Transactions . 55 Required Credit Transaction Parameters . 55 Submitting Void Transactions . 57 When To Use a Void Transaction . 57 Required Void Transaction Parameters . 57 Fields Copied From the Original Transaction Into the Void Transaction. 57 Example Void Transaction Parameter String . 58 Submitting Inquiry Transactions . 58 When To Use an Inquiry Transaction . 58 Required Parameters When Using the PNREF . 58 Inquiry Transaction Parameter String Using the PNREF . 59 Required Parameters When Using the CUSTREF . 59 Inquiry Transaction Parameter String Using the CUSTREF . 60 Required Parameters When Using the Secure Token . 60 Inquiry Parameter String Using the Secure Token. 61 Submitting Reference Transactions (Tokenization) . 61 When To Use a Reference Transaction . 61 Transaction Types That Can Be Used As the Original Transaction . 62 Fields Copied From Reference Transactions . 62 Example Reference Transaction. 63 Storing Credit Card Data on the Gateway Server . 64 Submitting Card Present (SWIPE) Transactions. 65 Processing Platforms Supporting Card-Present Transactions. 65 Card Present Transaction Syntax . 66 Submitting Purchasing Card Transactions . 66 Submitting Balance Inquiry Transactions . 66 Processing Platforms Supporting Balance Inquiry Transactions . 67 Required Balance Inquiry Parameters. 67 Example Balance Inquiry Transaction String . 67 Submitting Soft Merchant Information . 68 About Soft Merchant Information . 68 Ways to Send Soft Merchant Information . 68 Using Address Verification Service . 69 Gateway Developer Guide and Reference April 2012 5 Content Processing Platforms Supporting Address Verification Service . 70 Example Address Verification Service Parameter String . 70 Card Security Code Validation . 71 Processing Platforms Supporting Card Security Code . 72 Chapter 7 Testing Transactions . .73 Setting Up The Payflow Pro Testing Environment . 73 Testing Guidelines . 73 Processors Other Than PayPal . ..