User Guide

Invoicing Service API Examples

HTTP Headers

18 May 2012 Invoicing Service API Guide

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.

For SOAP messages, refer to the next section.

HTTP Headers for JSON, NVP, and XML Data Formats

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.

Header Description

X-PAYPAL-REQUEST-DATA-FORMAT The payload format for the request.

Allowable values are:

 NV – Name-value pairs

 XML – Extensible markup language

 JSON – JavaScript object notation

X-PAYPAL-RESPONSE-DATA-FORMAT The payload format for the response.

Allowable values are:

 NV – Name-value pairs

 XML – Extensible markup language

 JSON – JavaScript object notation