Developer's Guide

Adaptive Payments Developer Guide August 7, 2012 7
Contents
PhoneNumberType Response Fields . . . . . . . . . . . . . . . . . . . . . . . . . .145
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
GetPaymentOptions Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .149
Chapter 7 SetPaymentOptions API Operation . . . . . . . . . . . . 151
SetPaymentsOptionsRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . .151
SetPaymentOptionsRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . .152
DisplayOptions Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
InitiatingEntity Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
Institution Customer Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
SenderOptions Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
ReceiverOptions Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
InvoiceData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
InvoiceItem Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155
ReceiverIdentifier Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
PhoneNumberType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
SetPaymentOptionsResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . . .157
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
SetPaymentOptions Examples Using NVP and CURL . . . . . . . . . . . . . . . . . . .160
SetPaymentOptions Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161
Chapter 8 Preapproval API Operation . . . . . . . . . . . . . . . . 163
Preapproval Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163
Preapproval Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163
Additional Notes About the PreApproval API Operation. . . . . . . . . . . . . . . . .164
PreapprovalRequest Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164
PreapprovalRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .165
ClientDetails Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169
RequestEnvelope Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170