Paypal Invoicing 2012 User Guide API Developer
Invoicing - 2012 - Service API Guide PP_InvoicingAPI_2012 Free User Guide for PayPal Software, Manual
2015-07-27
: Paypal Paypal-Invoicing-2012-User-Guide-777953 paypal-invoicing-2012-user-guide-777953 paypal pdf
Open the PDF directly: View PDF 
.
Page Count: 122
| Download | |
| Open PDF In Browser | View PDF |
Invoicing Service API
Guide
Last updated: May 2012
Invoicing Service API Guide
Document Number: 10128.en_US-201205
© 2011-2012 PayPal, Inc. All rights reserved. PayPal is a registered trademark of PayPal, Inc. The PayPal logo is a trademark of PayPal, Inc. Other
trademarks and brands are the property of their respective owners.
The information in this document belongs to PayPal, Inc. It may not be used, reproduced or disclosed without the written approval of PayPal, Inc.
Copyright © PayPal. All rights reserved. PayPal S.à r.l. et Cie, S.C.A., Société en Commandite par Actions. Registered office: 22-24 Boulevard Royal, L2449, Luxembourg, R.C.S. Luxembourg B 118 349
Consumer advisory: The PayPal™ payment service is regarded as a stored value facility under Singapore law. As such, it does not require the approval
of the Monetary Authority of Singapore. You are advised to read the terms and conditions carefully.
Notice of non-liability:
PayPal, Inc. is providing the information in this document to you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express,
implied or statutory) with respect to the information contained herein. PayPal, Inc. assumes no liability for damages (whether direct or indirect), caused
by errors or omissions, or resulting from the use of this document or the information contained in this document or resulting from the application or use
of the product or service described herein. PayPal, Inc. reserves the right to make changes to any information herein without further notice.
Contents
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Documentation Feedback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Chapter 1
Introduction to the Invoicing Service API . . . . . . . . . . 11
Sending Invoices on Behalf of a Merchant. . . . . . . . . . . . . . . . . . . . . . . . . . 13
Invoicing Service API Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Creating and Sending Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Managing Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
IPN Variables for Invoicing API Operations . . . . . . . . . . . . . . . . . . . . . . . . . 14
Invoice Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Canceled Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Chapter 2
Invoicing Service API Examples . . . . . . . . . . . . . . . 17
HTTP Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Specifying JSON, NVP, or XML Data Formats. . . . . . . . . . . . . . . . . . . . . . 18
SOAP Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Specifying Application and Device Information . . . . . . . . . . . . . . . . . . . . . 19
Creating an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Sending an Invoice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Creating and Sending an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Updating an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Obtaining Invoice Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Canceling an Invoice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Searching for Invoices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Chapter 3
CreateInvoice API Operation . . . . . . . . . . . . . . . . 25
CreateInvoiceRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
CreateInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
BusinessInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Invoicing Service API Guide
May 2012
3
Contents
BaseAddress Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
InvoiceItemListType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
CreateInvoiceResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
CreateInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
CreateInvoice API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Chapter 4
SendInvoice API Operation . . . . . . . . . . . . . . . . . 37
SendInvoiceRequest Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
SendInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SendInvoiceResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
SendInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Send Invoice API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Chapter 5
CreateAndSendInvoice API Operation . . . . . . . . . . . . 43
CreateAndSendInvoiceRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . 43
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
CreateAndSendInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . 46
InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
BusinessInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
BaseAddress Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
InvoiceItemListType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
CreateAndSendInvoiceResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . 50
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
CreateAndSendInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . 51
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
4
May 2012
Invoicing Service API Guide
Contents
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
CreateAndSendInvoice API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Chapter 6
UpdateInvoice API Operation . . . . . . . . . . . . . . . . 55
UpdateInvoiceRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
UpdateInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
BusinessInfoType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
InvoiceItemType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
UpdateInvoiceResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
UpdateInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
UpdateInvoice API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Chapter 7
GetInvoiceDetails API Operation . . . . . . . . . . . . . . 67
GetInvoiceDetailsRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
GetInvoiceDetailsRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
GetInvoiceDetailsResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
GetInvoiceDetailsResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
InvoiceType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
InvoiceDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
PaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
PayPalPaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
OtherPaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Invoicing Service API Guide
May 2012
5
Contents
GetInvoiceDetails API Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Chapter 8
CancelInvoice API Operation . . . . . . . . . . . . . . . . 81
CancelInvoiceRequest Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
CancelInvoiceRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
CancelInvoiceResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
CancelInvoiceResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
CancelInvoice API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Chapter 9
SearchInvoices API Operation
. . . . . . . . . . . . . . . 87
SearchInvoicesRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
SearchInvoicesRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
SearchParametersType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
DateRangeType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
SearchInvoicesResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
SearchInvoicesResponse Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
InvoiceSummaryListType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
InvoiceSummaryType Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
SearchInvoices API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Chapter 10
MarkInvoiceAsPaid API Operation
. . . . . . . . . . . . . 97
MarkInvoiceAsPaidRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
MarkInvoiceAsPaidRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
OtherPaymentDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
MarkInvoiceAsPaidResponse Message . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
6
May 2012
Invoicing Service API Guide
Contents
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
MarkInvoiceAsPaidResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . . .100
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
MarkInvoiceAsPaid API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
Chapter 11
MarkInvoiceAsUnpaid API Operation . . . . . . . . . . . 105
MarkInvoiceAsUnpaidRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . .105
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
MarkInvoiceAsUnpaidRequest Fields . . . . . . . . . . . . . . . . . . . . . . . . . .106
MarkInvoiceAsUnpaidResponse Message. . . . . . . . . . . . . . . . . . . . . . . . . .106
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106
MarkInvoiceAsUnpaidResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . .107
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .108
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
MarkInvoiceAsUnpaid API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Chapter 12
MarkInvoiceAsRefunded API Operation . . . . . . . . . . 111
MarkInvoiceAsRefundedRequest Message . . . . . . . . . . . . . . . . . . . . . . . . . 111
RequestEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
MarkInvoiceAsRefundedRequest Fields. . . . . . . . . . . . . . . . . . . . . . . . . 111
OtherRefundDetailsType Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
MarkInvoiceAsRefundedResponse Message . . . . . . . . . . . . . . . . . . . . . . . . 112
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
MarkInvoiceAsRefundedResponse Fields . . . . . . . . . . . . . . . . . . . . . . . . 113
PPFault Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
FaultMessage Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
ErrorData Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
ResponseEnvelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
MarkInvoiceAsRefunded API Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Invoicing Service API Guide
May 2012
7
Contents
8
May 2012
Invoicing Service API Guide
Preface
You can use the Invoicing Service API to create, send, and manage invoices using PayPal.
Documentation Feedback
Help us improve this guide by sending feedback to:
documentationfeedback@paypal.com
Invoicing Service API Guide
May 2012
9
Documentation Feedback
10
May 2012
Invoicing Service API Guide
1
Introduction to the Invoicing
Service API
PayPal enables you to create and manage invoices. When you send an invoice, PayPal emails
the receipient and allows him or her to pay with PayPal.
The following diagram shows the basic execution flow for creating and sending an invoice:
The circled numbers indicate actions that you take as well as actions taken by PayPal and your
customer:
1. Specify the contents of the invoice in the CreateInvoice request and send the request to
the https://svcs.paypal.com/Invoice/CreateInvoice endpoint.
2. Examine the response and verify that the ACK field contains SUCCESS.
3. Using the invoice ID in the response, create a SendInvoice request and send it to the
https://svcs.paypal.com/Invoice/SendInvoice endpoint.
4. Examine the response and verify that the ACK field contains SUCCESS.
NOT E :
Invoicing Service API Guide
You can combine the creation and transmission of an invoice in the same request,
which is CreateAndSend. After you create the request, send it to the
https://svcs.paypal.com/Invoice/CreateAndSendInvoice endpoint.
May 2012
11
1
Introduction to the Invoicing Service API
5. If the SendInvoice request was successful, PayPal sends an invoice by email to the payer
whose email you specified in the CreateInvoice or CreateAndSendInvoice request.
6. When your customer clicks Pay Invoice in the email, the customer’s browser is redirected
to PayPal and the customer is prompted to log in.
7. The customer can then pay on PayPal.
The contents of an invoice depend on what you specify in the CreateInvoice, or
CreateAndSend requests. Following is an example invoice:
12
May 2012
Invoicing Service API Guide
Introduction to the Invoicing Service API
Sending Invoices on Behalf of a Merchant
1
Sending Invoices on Behalf of a Merchant
You can send invoices on behalf of a merchant if you have permission to do so. There is no
difference in how you set up your request for CreateInvoice or
CreateAndSendInvoice, except that you specify the merchant’s email address instead of
your own in the request, and you include an additional header that indicates you have the
permission of the third party to send invoices on their behalf.
The merchant grants you permission using their PayPal profile, or you request permission
using the Permissions Service API. For more information about this API, see PayPal
Permissions Service at PayPal Permissions Service.
Invoicing Service API Operations
The operations in the Invoicing Service API enable you to create and send invoices to your
customers, as well manage existing invoices, which may or may not have been sent.
NOT E :
Although you do not need to register your application with PayPal, you must have a
valid app ID to use the Invoicing Service API. If you have an existing app ID, you can
reuse it. See x.com to obtain an app ID.
Creating and Sending Invoices
API Operation
Description
CreateInvoice
Creates a new invoice.
SendInvoice
Sends an invoice to a customer.
CreateAndSendInvoice
Creates and sends an invoice, which is equivalent to the combination
of the CreateInvoice operation followed by the SendInvoice
operation.
Managing Invoices
API Operation
Description
UpdateInvoice
Updates an invoice.
GetInvoiceDetails
Obtains the contents of an invoice.
CancelInvoice
Cancels an invoice.
SearchInvoices
Searches for invoices based on specified criteria.
MarkInvoiceAsPaid
Marks an invoice as having been paid.
Invoicing Service API Guide
May 2012
13
1
Introduction to the Invoicing Service API
IPN Variables for Invoicing API Operations
API Operation
Description
MarkInvoiceAsUnpaid
Marks an invoice as unpaid.
MarkInvoiceAsRefunded
Marks an invoice as having been refunded.
IPN Variables for Invoicing API Operations
PayPal sends IPN messages for invoice payments and canceled invoices. For more
information about IPN, see the Instant Payment Notification Guide:
https://cms.paypal.com/cms_content/US/en_US/files/developer/IPNGuide.pdf.
Invoice Payments
mc_gross: 37.12
protection_eligibility: Eligible
address_status: confirmed
payer_id: ABF644D44GSPJ
address_street: 5656 South Market Street
payment_date: 15:57:39 Sep 12, 2011 PDT
payment_status: Completed
invoice_id: INV2-VMYW-LQKA-QBGC-6YDE
charset: windows-1252
address_zip: 95131
first_name: Nick
mc_fee: 1.38
address_country_code: US
address_name: Selling Fruits
notify_version: 3.4
payer_status: verified
business: jbui-us-business1@paypal.com
address_country: United States
address_city: San Jose
verify_sign: AFcWxV21C7fd0v3bYYYRCpSSRl31A23x28hwIQCThw2nNi2s8MlV2o10
payer_email: jbui-us-personal1@paypal.com
txn_id: 68H067535A2789915
payment_type: instant
last_name: Ronald
address_state: CA
14
May 2012
Invoicing Service API Guide
Introduction to the Invoicing Service API
IPN Variables for Invoicing API Operations
1
receiver_email: jbui-us-business1@paypal.com
payment_fee: 1.38
receiver_id: 9N3VVZS28ELHL
txn_type: invoice_payment
mc_currency: USD
residence_country: US
transaction_subject: Send the Reminder Soon.
invoice_number: 0151
payment_gross: 37.12
ipn_track_id: ogo4fwr-n.J7dGNgDiJzqg
Canceled Invoices
merchant_business_name: Fruits Packaging Inc.
merchant_first_name: Joan
notify_version: 3.4
txn_type: invoice_payer_cancel
invoice_number: 0021
charset: windows-1252
payer_email: jbui-us-personal1@paypal.com
payer_last_name: Bond
merchant_last_name: Joan
payer_first_name: Henry
merchant_email: jbui-us-business1@paypal.com
verify_sign: AiPC9BjkCyDFQXbSkoZcgqH3hpacAAV9zVNI.GLTI1sLOHpeeWp3oMQZ
invoice_id: INV2-UHWN-STXM-65B7-PT4R
ipn_track_id: 2eKZJ-cZftAHzSWbsS7qjQ
Invoicing Service API Guide
May 2012
15
1
16
Introduction to the Invoicing Service API
IPN Variables for Invoicing API Operations
May 2012
Invoicing Service API Guide
2
Invoicing Service API Examples
You can use the Invoicing Service API to create, send, update, cancel, or obtain details of
invoices for yourself or third-party merchants. You can also search invoices, and mark them as
paid, unpaid, or refunded.
HTTP Headers
Each request message includes HTTP headers specifying authentication, the application ID,
the device ID or IP address, and the payload format or protocol (SOAP).
Adaptive Payments supports request bodies with JSON, NVP, and XML data formats for
REST implementations. You can specify different formats for the request and response, such
as sending the request in JSON and requesting an XML response.
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");
NOT E :
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):
Invoicing Service API Guide
May 2012
17
2
Invoicing Service API Examples
HTTP Headers
HTTP Headers for Authentication
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 3token 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.
N O TE :
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.
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
18
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
May 2012
Invoicing Service API Guide
Invoicing Service API Examples
HTTP Headers
2
SOAP Messages
To use Adaptive Payments with SOAP, include the HTTP headers for authentication as
described in the section Authentication and the application ID as described in the next section.
In addition, include the X-PAYPAL-MESSAGE-PROTOCOL header with a SOAP11 value.
The following is a header example for an Adaptive Payments API call for a SOAP message:
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-MESSAGE-PROTOCOL", "SOAP11");
headers.put("X-PAYPAL-APPLICATION-ID","APP-80W284485P519543T");
Below are the service name, port type, binding and location for SOAP as defined in the
Adaptive Payments WSDL.
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Author : PayPal, Inc. Create Date : 2012:05:18 15:25:36Z Modify Date : 2012:05:18 15:49:25-07:00 XMP Toolkit : Adobe XMP Core 5.2-c001 63.139439, 2010/09/27-13:37:26 Format : application/pdf Title : PayPal Invoicing API Developer Guide Creator : PayPal, Inc. Creator Tool : FrameMaker 9.0 Metadata Date : 2012:05:18 15:49:25-07:00 Producer : Acrobat Distiller 10.1.3 (Windows) Document ID : uuid:bc5d22b4-99f3-4ea0-9f00-8c69c1c819f5 Instance ID : uuid:62e92948-ae75-42ce-891a-b66c2ac4e0e9 Page Mode : UseOutlines Page Count : 122EXIF Metadata provided by EXIF.tools