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.
Gateway Developer Guide and Reference07 February 201311
Content
1207 February 2013Gateway Developer Guide and Reference
Scope
Preface
This guide describes the data parameters for the Gateway payments solutions.
This guide is a reference to the payment card data parameters available for submitting in
transaction requests over the Gateway to multiple supported processors. It also covers the
resulting response data parameters and errors.
The guide describes the requirements of an ever growing list of processing platforms. It
organizes parameters into a core set of request parameters supported by all processors,
additional parameters unique to individual processors, and purchasing card parameters
specialized to monitor credit card use in businesses. It also provides a section on response
parameters and error codes (PNREF values that are not 0).
Although this guide provides guidance on getting started with the SDK, setting up credit card
processing, and testing your integration, its broad scope does not lend to use as a tutorial on
integration. Refer to the
PayPal Developer website and the Payflow Gateway SDK for detailed
working examples and use cases.
Related Documentation
For additional information on the Gateway payments solutions:
See PayPal Manager at:
https://manager.paypal.com/
For more information on Payflow documentation, examples, and very current information,
see the PayPal developer site at the following URL:
https://www.x.com/developers/paypal
Intended Audience
This guide provides Gateway payments solutions to readers who:
Are web or application developers
Have a background in payments services
Gateway Developer Guide and Reference07 February 201313
Preface
Intended Audience
Who Should Use This Document
This comprehensive developer guide includes integration information for multiple Gateway
solutions. Legacy Payflow Link features are not included in this guide. For legacy Payflow
Link features refer to the
explained in this guide are not necessarily available to every Gateway customer. This section
will help you determine whether you should use this document and which sections of the
document are relevant to you.
To view the Gateway solutions available to you, login to PayPal Manager at
https://manager.paypal.com/. PayPal Manager displays your Gateway Services in the Service
Summary box.
Payflow Link
Payflow Link customers can choose PayPal or another merchant bank to process their
transactions via the Payflow Gateway.
A) Legacy Payflow Link users will see the following in the Service Summary box in PayPal
Manager:
Payflow Link
Payflow Link User’s Guide. Additionally, all the Gateway features
If you are a legacy Payflow Link user, do not use this guide; instead, use the
User’s Guide.
Payflow Link
B) New Payflow Link users will see the following in the Service Summary box in PayPal
Manager:
Hosted Checkout Pages & Payflow SDK/API (Limited Access). (If PayPal Payments
Advanced is also listed, then you are not a Payflow Link customer).
1407 February 2013Gateway Developer Guide and Reference
Preface
Intended Audience
New Payflow Link users who are using the Secure Token or the API should use this guide.
However, new Payflow Link users who are using the legacy Payflow Link input tag
integration should use the
Limited API Access means you can perform all API functions except for Sales and
Authorization transactions. For Sales and Authorization type transactions you must use the
Hosted Checkout Pages.
Payflow Pro
Payflow Link User’s Guide instead.
Payflow Pro customers can choose PayPal or another merchant bank to process their
transactions via the Gateway.
A) Legacy Payflow Pro users will see the following in the Service Summary box in PayPal
Manager:
Payflow Pro
Legacy Payflow Pro users should use this guide; however, these users can only use the API
integration and do not have the Hosted Checkout Pages service. If you are a legacy
Payflow Pro user, you should skip the chapter on Hosted Checkout Pages - “Configuring
Hosted Checkout Pages” on page 37.
B) New Payflow Pro users can take advantage of all of the Gateway features including
Hosted Checkout Pages. These users will see the following in the Service Summary box in
PayPal Manager:
Gateway Developer Guide and Reference07 February 201315
Preface
Intended Audience
PayPal Payments Advanced
Transactions submitted by PayPal Payments Advanced customers are processed through
the Gateway with PayPal acting as the merchant bank. PayPal Payments Advanced users
will see the following in the Service Summary box in PayPal Manager:
Limited API Access means you can perform all API functions except for Sales and
Authorization transactions. For Sales and Authorization type transactions you must use
Hosted Checkout Pages.
PayPal Payments Pro
Transactions submitted by PayPal Payments Pro customers are processed through the
Gateway with PayPal acting as the merchant bank. PayPal Payments Pro users can use all
of the Gateway features supported by PayPal. These users will see the following in the
Service Summary box in PayPal Manager:
PayPal Payments Pro with Hosted Checkout Pages & Payflow SDK/API (Full Access)
1607 February 2013Gateway Developer Guide and Reference
Preface
Revision History
Revision History
Revision History for the Gateway Developer Guide and Reference:
DateDescription
28 Jan 2013Added a new Appendix on Payflow Header Parameters.
Added information about duplicate parameters in the
Name-Value Parameter Syntax Guidelines.
In the Hosted Pages Chapter, added the Passing Other
Data to Your Server Using Post or Silent Post section,
and clarified that Silent Posts are returned for both
approved and declined transactions.
Updated the Payflow Link legacy parameters and the
equivalent Payflow parameters parameter table.
Removed legacy Payflow Link parameters with
identical Payflow equivalents.
Updated the description of the BILLTOSTATE and
SHIPTOSTATE parameters in the Core Credit Card
Parameters table.
Added a note to the introduction of the Submitting
Credit Card Transactions chapter.
Revised the introduction to the Payflow SDK chapter.
Updated some of the external links in the guide.
Corrected the format of the ORDERDATE parameter in
TSYS Acquiring Solutions Level 3 Visa Extended Data.
28 Dec 2012Updated the description of the Driver’s Licencse - DL
field in Required TeleCheck Parameters.
11 Dec 2012Added info on forcing the Cancel URL with layout
template C to Configuring Hosted Pages Using PayPal
Manager.
Added Secure Token error codes to Secure Token Errors
and to RESULT Values and RESPMSG Text.
04 Oct 2012Added a new section on Hosted Pages and Mobile
Browsers and updated the Configuring Hosted
Checkout Pages chapter.
Added a new section: Supported Languages.
Added a new section: Using the PARMLIST Parameter.
Added information to the Host URL Addresses section.
29 Aug 2012Added the Payflow Gateway MagTek Parameters
Appendix.
31 July 2012Added a list of Setup Params and Customize Params.
These parameters override PayPal Manager settings for
Hosted Pages.
Gateway Developer Guide and Reference07 February 201317
Preface
Revision History
DateDescription
Briefly explained the differences between Submitting
Credit Transactions and Submitting Void Transactions.
Updated the parameters in the Payflow Link legacy
parameters and the equivalent Payflow parameters
table.
Added DATE_TO_SETTLE to Credit Card Transaction
Responses parameters table.
Added a note to the About Credit Card Processing
section.
23 July 2012Added the Bill Me Later feature to the Gateway Product
Details section.
16 July 2012Updated required value for BILLTOCITY,
BILLTOSTATE & BILLTOCOUNTRY in PayPal Credit
Card Transaction Request Parameters table.
June 2012Who Should Use This Document section added to the
Preface.
Integrating the Secure Token Without the Hosted
Checkout Pages: Transparent Redirect section:
corrected value of SILENTTRAN to “True”
Silent Posts section added to Hosted Checkout Pages
chapter.
ISO Country Codes: removed the legacy paramater
CORPCOUNTRY
May 2012Added new sections to the Testing Transactions
Added a description for response parameters
HOSTCODE, RESPTEXT, PROCCARDSECURE,
ADDLMSGS and an explanation on how to use these
parameters to obtain the processor’s raw response codes
and response messages.
Changed Litle parameters from STREET2,STREET3 to
BILLTOSTREET2, BILLTOSTREET3
Corrected description of MERCHSVC parameter for
FDMS North, Heartland, Litle, Merchant e-Solutions,
Paymentech Salem
Updated examples and removed legacy parameters to
include:FIRSTNAME, LASTNAME, STREET, CITY, STATE, ZIP, COUNTRY
Preface
Revision History
Updated processor and entity names:
Vantiv, previously known as Fifth Third Processing
Solutions
PayPal Australia, previously known as First Data
Australia
January 2012Added new processors:
First Third International
Heartland Payment Systems
Planet Payment
SecureNet
TeleCheck
World Pa y
Added new transaction types:
TRXTYPE=L can be used to upload credit card data,
easing PCI compliance. You can store the resulting
PNREF locally for use in performing reference
transactions.
Gateway Developer Guide and Reference07 February 201319
Gateway Developer Guide and Reference07 February 201321
Preface
Revision History
2207 February 2013Gateway Developer Guide and Reference
Introducing the Gateway
1
Checkout Solutions
The Gateway provides checkout solutions for novice and advanced use. It provides merchants
with a rich set of options to handle payment transactions.
“About the Gateway Checkout Solutions” on page 23
“About the Gateway Transaction Flow” on page 25
“About Security” on page 26
“Processing Platforms Supporting Card-Present Transactions” on page 28
“Supported Payment Types” on page 29
“Recurring Billing Service” on page 30
About the Gateway Checkout Solutions
Gateway checkout consists of the following four solutions:
Payflow Link
Payflow Pro
PayPal Payments Advanced
PayPal Payments Pro
Summary of the Gateway Checkout Solutions
Below is a basic comparison of the Gateway checkout solutions:
Payflow Link uses hosted checkout pages to send transactions to a supported processor.
Merchants can use the Payflow SDK APIs to perform all transactions except authorization
and sale transactions. By using hosted pages with a secure token, the merchant adheres to
compliance rules for handling customer data in a secure way: data is stored on PayPal so
that it is not exposed to compromise.
Payflow Pro can send transactions to a number of different supported processors,
requirements for which are described in this documentation. Merchants select a supported
processor and obtain an acquiring bank. Typically merchants integrate with, and have full
access to, the Payflow SDK or use HTTPS to send transactions to the processor. Using
hosted pages is an option.
PayPal Payments Advanced uses web pages hosted by PayPal (also known as hosted
checkout pages) to send transactions to the PayPal processor. With PayPal Payments
Advanced, PayPal is the acquiring bank. By using hosted checkout pages with a secure
Gateway Developer Guide and Reference07 February 201323
Introducing the Gateway Checkout Solutions
1
About the Gateway Checkout Solutions
token, the merchant adheres to compliance rules for handling customer data in a secure
way: data is stored on PayPal so that it is not exposed to compromise.
Like PayPal Payments Advanced, PayPal Payments Pro sends transactions to the PayPal
processor and PayPal is the acquiring bank. Using hosted checkout pages is an option.
Typically merchants integrate with the Payflow SDK or use HTTPS to send transactions to
the PayPal processor.
NOTE: PayPal strongly recommends that all users of Gateway checkout solutions take
advantage of the secure token and the hosted checkout pages. Doing so provides
automatic compliance with processing card industry (PCI) standards for protecting
cardholder data.
Gateway Product Details
The table below compares how the Gateway checkout solutions support payment processing
features.
PayPal Payments Advanced
Feature
Hosted checkout page (including an
iFrame version)
PayPal paymentsIncludedOptional
Bill Me Later payments
(Available to US merchants only on
Hosted checkout pages.)
PayPal branding on full page templatesYesOptional
Transparent RedirectNoYes
Supports PayPal as a processor and an
acquirer
Credit and debit cardsYesYes
Level 2 and Level 3 purchase cardsYesYes
TeleCheck (guaranteed electronic
checks)
ACH (electronic checks)NoYes
Virtual Terminal support, including
card-present data passage
Payflow Link
Ye sYe s
IncludedOptional
Ye sYe s
NoYes
Ye sYe s
PayPal Payments Pro
Payflow Pro
Virtual Terminal Payflow Link onlyYes
API Limited access (no authorization
or sale)
2407 February 2013Gateway Developer Guide and Reference
Full access
Introducing the Gateway Checkout Solutions
About the Gateway Transaction Flow
1
PayPal Payments Advanced
Feature
Reference transactions (Tokenization)YesYes
Secure token to preset hosted checkout
page
Reporting APIsYesYes
Desktop integrationYesYes
Recurring billingYesYes
Basic fraud protectionYesYes
Advanced fraud protectionYesYes
Partner/channel distribution support
(Partner Manager, registration, XML
registration) resale and referral
Payflow Link
Ye sYe s
Ye sYe s
About the Gateway Transaction Flow
PayPal Payments Pro
Payflow Pro
The traditional transaction flow is as follows. Numbers correspond to numbers in the figure.
1. At your website, the customer clicks Buy to purchase merchandise.
2. You send the transaction request to the Gateway server.
3. The Gateway sends the transaction to the payment processing network.
4. Your processor sends the response back to the Gateway server and processes the
transaction (obtains the payment from the customer bank and deposits it in the merchant
bank).
5. The Gateway server returns the response to your website.
6. Your website displays the result to the customer.
You can use the core transaction parameters supported by all Gateway processors described in
this dcumentation to send transaction data to your processor. In addition:
Gateway Developer Guide and Reference07 February 201325
Introducing the Gateway Checkout Solutions
1
About Security
Each Gateway processor may support various additional parameters beyond the core set
that you can send in transaction requests.
Your processor may also support purchasing cards (credit cards employers issue for
business-related charges). Purchasing card Level 2 and Level 3 parameters provide
specialized reporting so an employer can monitor card use. The parameter information may
appear on the customer’s statement or describe line items in greater detail. Be sure to check
for your processor’s Level 2 and 3 parameters in this documentation.
The sections in this documentation describing the above parameters alphabetically organize
parameters by processor name.
About Security
It is your responsibility to adhere to PCI compliance standards to protect personal information
and implement security safeguards on your website when processing payment card
transactions.
Gateway solutions make available a secure token and hosted checkout pages to help you meet
PCI compliance. Hosted pages are optional to PayPal Payments Pro and Payflow Pro users. If
you do not use a secure token or hosted pages, you must provide your own means of meeting
compliance requirements.
NOTE: PayPal Payments Advanced and Payflow Link merchants are required to use hosted
pages.
Secure Token
The secure token stores request transaction data on the Gateway server. It eliminates the need
to resend the parameter data for display in a hosted checkout page where the data might be
subject to compromise.
Hosted Checkout Pages
The Gateway enables the use of hosted checkout pages, which help you achieve PCI
compliance. The hosted checkout pages enable you to pass transaction data securely to the
server and to collect credit card acceptance data.
NOTE: You are required to use hosted pages with PayPal Payments Advanced and Payflow
Link.
The following figure shows the transaction flow when using hosted pages and a secure token.
2607 February 2013Gateway Developer Guide and Reference
Introducing the Gateway Checkout Solutions
Numbers in the figure correspond to the numbered comments below:
About Security
1
1. The customer clicks Buy to purchase merchandise on your website.
2. You request a secure token by passing a token ID to the Gateway server.
3. The Gateway server returns the secure token and your token ID to your website.
4. You submit the secure token and token ID in an HTTP post to pages hosted on the Gateway
server and redirect the customer’s browser to the hosted pages.
5. The Gateway server uses the secure token to retrieve the amount and other transaction data.
The customer submits their credit card number, expiration date, and other sensitive data
directly to the host pages rather than to your website, easing your PCI compliance
requirements.
6. The Gateway processes the payment through the payment processing network.
7. The Gateway server transparently returns the customer to the location on your website that
you specified in the request to obtain a secure token. You display the results to the
customer on your website.
NOTE: If you do not get a response from the Gateway server, submit an Inquiry transaction,
passing in the secure token to see if the transaction has completed. For details, see
“Submitting Inquiry Transactions” on page 69.
PCI Compliance Without Hosted Pages: Transparent Redirect
PayPal Payments Pro and Payflow Pro merchants who want PCI compliance while
maintaining full control over designing and hosting checkout pages on their website can use
Transparent Redirect. Transparent Redirect posts payment details silently to the Gateway
server, so this sensitive information never goes through the merchant’s website.
Gateway Developer Guide and Reference07 February 201327
Implementing Transparent Redirect is very similar to implementing hosted pages. It differs
only in the steps shown in boldface below:
1. The customer clicks Buy to purchase merchandise on your website.
2. You request a secure token by passing a secure token ID to the Gateway server. In the
request, you pass the name-value pair, SILENTTRAN=TRUE. This name-value pair
prevents the hosted pages from displaying.
3. The Gateway server returns the secure token and your token ID to your website.
4. You display the credit card fields to the customer in a checkout page on your website.
5. The customer enters their credit card number, expiration date, and other sensitive
data into the credit card fields and clicks Submit. The browser posts the payment data
directly to the Gateway server, avoiding your website and easing your PCI
compliance requirements.
NOTE: To ensure that the post goes from the browser directly to PayPal and not back to
your website, you should add scripting.
6. The Gateway processes the payment through the payment processing network.
7. The Gateway server transparently sends the customer to the location on your website that
you specified in the request to obtain a secure token. You display the results to the
customer on your website.
The following processing platforms support card-present transactions.
American Express
American Express APAC
Elavon
First Data Merchant Services (FDMS) Nashville
First Data Merchant Services (FDMS) North
First Data Merchant Services (FDMS) South
Global Payments Central
Global Payments East
Heartland Payment Systems
Litle
Merchant e-Solutions
2807 February 2013Gateway Developer Guide and Reference
Moneris Solutions
Paymentech Salem
Paymentech Tampa
PayPal
SecureNet
TeleCheck
TSYS Acquiring Solutions
Va nt iv
World Pa y
Supported Payment Types
Introducing the Gateway Checkout Solutions
Supported Payment Types
1
Credit cards
PayPal (supported by PayPal’s Express Checkout product)
Pinless debit cards
Electronic checks
Check cards
Purchasing cards (also referred to as commercial cards, corporate cards, procurement cards, or business cards)
Level 2 and Level 3
Automated Clearing House (ACH). For information on performing ACH transactions, contact your PayPal Sales
Representative.
Supported Languages
The Payflow Gateway only supports customer input and API parameter values that are in
regular ASCII (English language) characters. Payflow does not support extended ASCII
characters or any other character sets other than regular ASCII at this time. Additionally, the
Payflow hosted checkout pages and PayPal manager account settings pages are available in
English only. For information on a similar PayPal product that offers multi-lingual support, see
Website Payments Pro Hosted Solution.
Gateway Developer Guide and Reference07 February 201329
Introducing the Gateway Checkout Solutions
1
Recurring Billing Service
Recurring Billing Service
The Recurring Billing Service is a scheduled payment solution that enables you to
automatically bill your customers at regular intervals—for example, you can bill your
customers a monthly fee of $42 for 36 months with an initial fee of $129.
You enroll separately for the Recurring Billing Service. You can learn about the Recurring
Billing Service in the
this service, this user guide will show you how to define and manage recurring transactions
programmatically. You can also manage Recurring Billing tasks in
Payflow Pro – Recurring Billing Service User’s Guide. If you already have
Fraud Protection Service
Fraud Protection Services can help you significantly reduce the cost of fraud and the resulting
damage to your business. This service uses Fraud Protection filters to help protect you from
fraudsters using stolen or false credit card information. These filters identify potentially
fraudulent activity and let you decide whether to accept or reject the suspicious transaction.
Fraud Protection Service can also minimize the risk of hacking your customer database by
enabling you to place powerful constraints on access to and use of your PayPal Manager and
Payflow Gateway accounts.
PayPal Manager.
You enroll separately for the Fraud Protection Service. You can learn more about Fraud
Protection Service in the
this service, this user guide will show you how to setup Fraud Protection filters. You can also
manage some aspects of your Fraud Protection Service in
Payflow Pro Fraud Protection Services User’s Guide. If you already have
PayPal Manager.
3007 February 2013Gateway Developer Guide and Reference
Loading...
+ 226 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.