User's Guide

PayPal Permissions Service May 2012 3
Contents
What’s New?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Release 89 Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 1 About the PayPal Permissions Service . . . . . . . . . . .11
Permissions Service Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Permission Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Permissions API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 2 Using the Permissions Service . . . . . . . . . . . . . . .17
Obtaining Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Generating Signatures for the Authentication Header . . . . . . . . . . . . . . . . . . . . 20
Granting Permission to Access Account Holder Information. . . . . . . . . . . . . . . . . 22
Chapter 3 RequestPermissions API Operation . . . . . . . . . . . . .25
RequestPermissionsRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
RequestPermissions Request Fields . . . . . . . . . . . . . . . . . . . . . . . . . . 26
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
RequestPermissionsResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . 27
RequestPermissions Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . 27
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
RequestPermission Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Chapter 4 GetAccessToken API Operation . . . . . . . . . . . . . . .33
GetAccessTokenRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33