Developer's Guide

Table Of Contents

Adaptive Payments Developer Guide August 7, 2012 67

Getting Started

HTTP Headers

For SOAP, you must also include a specific SOAP protocol header (see the SOAP messages

section).

The following is an example of HTTP headers for NVP in Java for a web implementation:

headers.put("X-PAYPAL-SECURITY-USERID", "tok261_biz_api.abc.com");

headers.put("X-PAYPAL-SECURITY-PASSWORD","1244612379");

headers.put("X-PAYPAL-SECURITY-SIGNATURE","lkfg9groingghb4uw5"

headers.put("X-PAYPAL-DEVICE-IPADDRESS", "168.212.226.204");

headers.put("X-PAYPAL-REQUEST-DATA-FORMAT", "NV");

headers.put("X-PAYPAL-RESPONSE-DATA-FORMAT", "NV");

headers.put("X-PAYPAL-APPLICATION-ID", "APP-80W284485P519543T");

NOTE: HTTP headers are case sensitive.

Authentication

Use your PayPal account API credentials to authenticate your application. Your API

credentials include an API username and API password. If you are using 3-token

authentication, you must also specify an API signature. If you are using a certificate, the

certificate is used with the username and password; the signature is not used. To specify API

credentials, include the following HTTP headers in your request message (observing case

sensitivity):

HTTP Headers for Authentication

Specifying JSON, NVP, or XML Data Formats

Use the HTTP header X-PAYPAL-REQUEST-DATA-FORMAT to specify the data format the

request body. You can send messages using JSON, NVP or straight XML.

Use the and X-PAYPAL-RESPONSE-DATA-FORMAT headers to specify the data format for the

response.

Header Description

X-PAYPAL-SECURITY-USERID Your API username

X-PAYPAL-SECURITY-PASSWORD Your API password

X-PAYPAL-SECURITY-SIGNATURE Your API signature, which is required only if you use 3-

token authorization; a certificate does not use a signature

X-PAYPAL-SECURITY-SUBJECT Third-party permission specification, which specifies the

email address or phone number (for mobile) of the party on

whose behalf you are calling the API operation. The subject

must grant you third-party access in their PayPal profile.

NOTE: Resources specified by the API operation, such as a

payment or preapproval identified by a key, must be

owned by the subject granting the third-party

permission.