Payflow Pro – HTTPS Interface Developer’s Guide For Professional Use Only Currently only available in English. A usage Professional Uniquement Disponible en Anglais uniquement pour l’instant.
Payflow Pro – HTTPS Interface Developer’s Guide Document Number: 200038.en_US-200905 © 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.
Contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 This Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Chapter 1 About the HTTPS Interface . . . . . . . . . . . . . . . . . 7 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Moving from the Payflow SDK to the HTTPS interface .
Contents 4 April 2009 HTTPS Interface Developer’s Guide
Preface This Document This document describes the HTTPS interface, which allows you to post transactions directly to the Payflow servers. Use the HTTPS interface for all operating systems and language besides Java and .NET. Revision History Date Description April 2009 Minor updates for technical accuracy. February 2008 Updated test and live URLs. December 2007 Clarification that the related SDKs referred to in this guide are Payflow, not PayPal, SDKs. Update of test and live URLs.
Revision History 6 April 2009 HTTPS Interface Developer’s Guide
1 About the HTTPS Interface This chapter contains the following topics: z Overview z Moving From the Payflow SDK to the HTTPS Interface z Getting Sample Code z Contacting Support Overview The HTTPS interface allows you to post transactions directly to the Payflow servers. N O T E : If you are programming in Java or .NET, you can simplify the implementation by using a Payflow SDK. The Payflow SDKs are based upon this HTTPS interface. Payflow SDK, Version 4 or later for .
About the HTTPS Interface Getting Sample Code When you move to the HTTPS interface, you will have to rewrite these portions of the code. You will need to complete four steps: 1. Write code that creates an HTTPS connection with the Payflow server. 2. Write an HTTPS request to submit your transaction data. 3. Receive the HTTPS reponse and extract the parameters. 4. Add code for error handling, retry logic, and duplicate transaction handling.
2 Reference This chapter contains the following topics: z URLs for Sending Messages z Standard HTTPS Headers z Transaction Message z Common Problems URLs for Sending Messages Use the following URLs for sending transactions to PayPal's Payflow servers: z Production (Live): https://payflowpro.paypal.com z Pilot (Test): https://pilot-payflowpro.paypal.com HTTPS Headers Standard HTTPS Headers HTTPS Header Description Req? Connect State of the connection.
Reference HTTPS Headers PayPal Protocol Headers Protocol Header Description Req? X-VPS-REQUEST-ID A unique identifier for each request, whether the request is a single NVP transaction or an XMLPay 2.0 document with multiple transactions. This identifier is associated with all the transactions in a particular request. You must provide the X-VPS-REQUEST-ID value in the transaction request. The Payflow server uses the X-VPSREQUEST-ID to check for duplicate transaction requests.
Reference Transaction Message Integrator-Provided Headers These headers are extensions to the Payflow HTTPS interface. The extension parameters describe the version of the application and the application’s environment. N O T E : Even though these parameters are not required, it is strongly recommended that you send them. Parameter Description Req? X-VPS-VITINTEGRATION-PRODUCT Identifies the product that is integrated with the Payflow server.
Reference Transaction Message N O T E : The examples below are in NVP format. XMLPay uses the same format as NVP except that the content-type is text/xml and the body of both the request and response contain the XML document. Transaction Request The transaction request consists of a transaction request header and body. Transaction Request Header The following is an example of a transaction request header associated with a message in NVP format: Connect: close Content-Length: ...
Reference Common Problems Transaction Response Body The transaction response body contains the response to the request. The following is an example response body in NVP format: RESULT=0&PNREF=V53A0A30B542&RESPMSG=Approved&AUTHCODE=882PNI& AVSADDR=X&AVSZIP=X&IAVS=X&PREFPSMSG=No Rules Triggered& POSTFPSMSG=No Rules Triggered Common Problems Problem Description Result value 1 User authentication error. Can be caused by: z Invalid login information or IP restrictions on the account.
Reference Common Problems 14 April 2009 HTTPS Interface Developer’s Guide
