Pay Pall Wpsbuttonmgrapinvp

  • View
    24

  • Download
    2

Embed Size (px)

Text of Pay Pall Wpsbuttonmgrapinvp

Website Payments Standard Button Manager API (NVP)

For Professional Use Only Currently only available in English. A usage Professional Uniquement Disponible en Anglais uniquement pour linstant.

Last updated: May, 2010

Button Manager NVP API Document Number: 10089.en_US-201005

2010 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. PayPal (Europe) Ltd. is authorised and regulated by the Financial Services Authority in the United Kingdom as an electronic money institution. PayPal FSA Register Number: 226056. 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.

Preface

This document describes the Button Manager API for NVP.

Intended AudienceThis document is intended for merchants and developers implementing Website Payment Standard buttons using an API.

Revision HistoryRevision history for Website Payments Standard Button Manager API (NVP).TABLE P.1 Revision History Date 05/10/10 02/03/10 01/11/10 06/03/09 03/31/09 Description Added information about installment plans, automatic billing, and subscribe buttons. Added error code. Added download key information and updated for version 61.0. Added HTML Variable appendix and updated for version 57.0. Initial draft.

Button Manager NVP API

May, 2010

3

Revision History

4

May, 2010

Button Manager NVP API

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 1

Website Payments Standard Button Manager API Overview 7

Button Manager Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Generated Button Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Button Hosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Hosted Button Manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Inventory Management Using Hosted Buttons. . . . . . . . . . . . . . . . . . . . . . . . 10 Inventory Management for Digital Downloads . . . . . . . . . . . . . . . . . . . . . . . . 11 Button Manager API Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Granting Third-Party Permission for APIs . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Chapter 2

Using the Button Manager API With NVP . . . . . . . . . . 15

Specifying HTML Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Creating a Button Using NVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Offering Multiple Payment Option Subscriptions Using NVP . . . . . . . . . . . . . . . . 17 Offering Installment Plans Using NVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Offering Automatic Billing Using NVP . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Tracking Inventory for Menu Items Using NVP . . . . . . . . . . . . . . . . . . . . . . . 20

Chapter 3

Button Manager API Reference . . . . . . . . . . . . . . . 23BMCreateButton Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 BMCreateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 BMCreateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

BMCreateButton API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

BMUpdateButton API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 BMUpdateButton Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 BMUpdateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 BMUpdateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Button Manager NVP API

May, 2010

5

Contents

BMButtonSearch API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 BMButtonSearch Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 BMButtonSearch Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 BMButtonSearch Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 BMGetButtonDetails API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 BMGetButtonDetails Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 BMGetButtonDetails Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 BMGetButtonDetails Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 BMManageButtonStatus API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 BMManageButtonStatus Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 BMManageButtonStatus Response . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 BMManageButtonStatus Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 BMSetInventory API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 BMSetInventory Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 BMSetInventory Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 BMSetInventory Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 BMGetInventory API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 BMGetInventory Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 BMGetInventory Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 BMGetInventory Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Chapter A

HTML Variables for Website Payments Standard . . . . . . 49

Technical HTML Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 HTML Variables for Individual Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 HTML Variables for Payment Transactions . . . . . . . . . . . . . . . . . . . . . . . . . 56 HTML Variables for Shopping Carts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 HTML Variables for Subscribe Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 HTML Variables for Displaying PayPal Checkout Pages . . . . . . . . . . . . . . . . . . 63 HTML Variables for Prepopulating PayPal Checkout Pages. . . . . . . . . . . . . . . . . 66

6

May, 2010

Button Manager NVP API

1

Website Payments Standard Button Manager API OverviewThe Website Payments Standard Button Manager API lets you programatically create, manage, edit, and delete Website Payment Standard buttons, which are the same kind of buttons that you can create from the PayPal Profile. Hosted buttons created by this API reside on PayPal and can use all features, including inventory management; however, you can use this API to create code for non-hosted Website Payment Standard buttons as well. Button Manager Introduction Generated Button Code Button Hosting Hosted Button Manipulation Inventory Management Using Hosted Buttons Inventory Management for Digital Downloads Button Manager API Summary Granting Third-Party Permission for APIs

Button Manager IntroductionYou should consider creating and managing your buttons with the Button Manager API when you are creating more than just a few Website Payment Standard buttons or when you manage buttons for others; for example, if you provide a shopping cart for merchants. The Button Manager API enables you to manage Website Payment Standard buttons programatically in the same way that you can manage them on PayPal from the My Saved Buttons page of your Profile.NOT E :

You can access your My Saved Buttons page on PayPal by choosing My Saved Buttons from the Profiles Selling Preferences column. If no buttons have been created, the menu item is Create New Button.

You can use the API to create these Website Payment Standard buttons: Buy Now Add to Cart and View Cart Donate Buy Gift Certificate Subscribe and Unsubscribe Installment Plan

Button Manager NVP API

May, 2010

7

Website Payments Standard Button Manager API OverviewGenerated Button Code

Automatic Billing The following buttons are some of those that you can create using the Button Manager API:

Generated Button CodeWhen you create a button, PayPal responds by generating code that you can paste into your web page or document. The generated code includes: HTML code for including the button in web pages URL link code for adding buttons to email and documents that support linksNOT E :

Not all merchants in every country can use all the buttons that can be created. For example, German merchants cannot use Subscribe buttons even though they can be created through the API. If yo