(c) PCI Pal 2020. The content on this page is subject to the Disclaimer Section (found on the Introduction page)
PayFlow Pro (PayPal) Payment Gateway
This page details the inputs, secure inputs and outputs available for the PayFlow Pro (PayPal) Payment Gateway, how to complete each field, and an external link to the PayFlowPro integration documentation.
PCI Pal must check any payment gateway integrations prior to going live. The documentation disclaimer (which applies throughout this guide) should be read before commencing any configuration of payment gateways.
Inputs
Input Fields
Required
Character Limits/Required Input
Description
user
Y
64 char
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.
vendor
Y
64 char
Your merchant login ID that you created when you registered for the account
orderDate
Y
7 char
Order date. For example, July 28, 2003 is 072803. Format: mmddyy (with no slashes or dashes)
password
Y
32 char
The password that you defined while registering for the account.
trxType
Y
1
Type of transaction that should be processed. Allowed transaction types: Sale (S), Void (V), Inquiry (I).
amount
Y
Money
The amount of the sale, including two decimal places and without a comma separator
invnum
N
9 char
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.
ponum
Y
17 char
Purchase order number
comment1
N
128 char
User-defined value for reporting and auditing purposes (PayPal parameter only)
comment2
N
128 char
User-defined value for reporting and auditing purposes (PayPal parameter only)
verbosity
N
LOW, MEDIUM or HIGH
Defines the amount of detail that is returned in the response
billingFirstName
N
30 char
First name for the card holder
billingLastName
N
30 char
Last name for the card holder
billingStreet
N
30 char
Card holder’s street address
billingStreet2
N
30 char
Card holder’s street address, line 2
billlingCity
N
30 char
Card holder’s city
billingState
N
9 char
Shipping state US = 2 letter state code; outside US, use full name
billingZip
N
9 char
Billing postal code (called zip
code in the USA)
billingCountry
N
4 char
Cardholder’s billing country code
shippingFirstName
N
30 char
First name in the shipping address
shippingLastName
N
30 char
Last name in the shipping address
shippingStreet
N
30 char
Shipping street address
shippingCity
N
30 char
Shipping city
shippingState
N
10 char
Shipping state
US = 2 letter state code; outside US, use full name
shippingZip
N
9 char
Shipping postal code (called zip code in the USA)
shippingCountry
N
3 num
Numeric country code of ship-to country (ISO 3166-1 numeric) Example: USA: 840
recurring
N
Y or N
Identifies the transaction as recurring. This value does not activate PayPal’s 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.
orderId
Y
30 char
Identifier for the order
email
N
60 char
Account holder’s email address
origId
N
12 char
(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.
Secure Inputs
Input Fields
Required
Character Limits/Required Input
Description
cardNumber
Yes
19 chars
Secure input of the card number
expiryDate
Yes
4 chars
Secure input of the card expiry in MMYY format
cv2
Yes
3 or 4 chars
Secure input of the card CVV, either three or four digits long depending on the card
Outputs
Output Fields
Description
AMTOUT
The amount of the transaction, as sent in the request
ACCT
Masked card number, as sent in the request
PNREF
Transaction reference returned by PayPal
AMEXID
Unique transaction ID returned when VERBOSITY=HIGH for tracking American Express CAPN transactions on non-PayPal processors.
result
The outcome of the attempted transaction. RESULT=0 means the transaction was approved.
EXPDATE
The card expiry date, as sent in the request
RESPMSG
A descriptive message associated with decline or error RESULTs
AUTHCODE
Returned for sale, authorization, and voice authorization credit card transactions. AUTHCODE is the approval code obtained over the telephone from the processing network.
CARDTYPE
The credit card type. Returned as an inquiry response when you send a VERBOSITY request parameter value of HIGH.
Is one of the following values for currently used cards:
0 = Visa
1 = MasterCard
2 = Discover
3 = American Express
4 = Diner's Club
5 = JCB
9 = Maestro (Switch)
HOSTCODE
The raw response code returned by the processor. This field is not normalized and is returned when VERBOSITY is set to HIGH.
PROCCVV2
CVV match code as per the processor
RESPTEXT
The raw text returned by the processor for the transaction
CVV2MATCH
Result of the card security code (CVV2) check from PayPal only. The issuing bank may decline the transaction if there is a mismatch. In other cases, the transaction may be approved despite a mismatch.
Y= Match
N= No Match
X= One of the following: (Not processed, Service not supported, Unavailable, No response, or Invalid data was p passed).
PREFPSMSG
Preprocessing Fraud Protection Services messages. These apply to all filters except: AVS Failure, Card Security Code Failure, and Custom Filters.
TRANSTIME
Time of the transaction. The following is an example response in the format returned:
TRANSTIME=2010-08-11 22:53:18
POSTFPSMSG
Postprocessing Fraud Protection Services messages. These apply to the following filters only: AVS Failure, Card Security Code Failure, and Custom Filters.
BILLTOZIP
Billing address - ZIP (postal) code
BILLTOCITY
Billing address - City
BILLTOSTATE
Billing address - state/province
BILLTOSTREET
Billing address - street address
BILLTOCOUNTRY
Billing address - Country
BILLTOSTREET2
Billing address – Street address line 2
BILLTOLASTNAME
Billing address – customer last name
BILLTOFIRSTNAME
Billing address – customer first name
VISACARDLEVEL
Card product level indicator returned by VISA. The possible 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
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
As this field is 2 characters long, any single character response will be followed by a space.
Further information can be found by viewing the integration documentation:
