User Guide

April 2012 3
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 1 PayPal Payments Standard Button Manager API Overview . 7
Button Manager Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Generated Button Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Button Hosting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Hosted Button Manipulation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Inventory Management Using Hosted Buttons. . . . . . . . . . . . . . . . . . . . . . . . 11
Inventory Management for Digital Downloads . . . . . . . . . . . . . . . . . . . . . . . . 11
Button Manager API Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Hosted Solution Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Granting Third-Party Permission for APIs . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Chapter 2 Using the Button Manager API With SOAP . . . . . . . . .15
Specifying HTML Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Creating a Button Using SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Tracking Inventory for a Button Using SOAP . . . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 3 Button Manager API Reference . . . . . . . . . . . . . . .19
BMCreateButton API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
BMCreateButton Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
BMCreateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
BMCreateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
BMUpdateButton API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
BMUpdateButton Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
BMUpdateButton Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
BMUpdateButton Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
BMButtonSearch API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
BMButtonSearch Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35