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 i n this document t o you “AS-IS” with all faults. PayPal, Inc. makes no warranties of any kind (whether express,
implied or statutory) with respect to the information co ntained 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 f rom 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 Messag e . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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/Cr eateInvoice 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/SendInv oice endpoint.
4. Examine the response and verify that the ACK field contains SUCCESS.
NOTE: 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/CreateA ndSendInvoice endpoint.
Invoicing Service API Guide May 2012 11
Introduction to the Invoicing Service API
1
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
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.
1
NOTE: 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
Introduction to the Invoicing Service API
1
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: Eligib le
address_status: confirmed
payer_id: ABF644D44GSPJ
address_street: 5656 South Mar ket Street
payment_date: 15:57:39 Sep 12, 2011 PDT
payment_status: Completed
invoice_id: INV2-VMYW-LQKA-QBGC-6 YDE
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@pa ypal.com
address_country: United States
address_city: San Jose
verify_sign: AFcWxV21C7fd0v3bY YYRCpSSRl31A23x28h wIQCThw2nNi2s8MlV2o10
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
receiver_email: jbui-us-busine ss1@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.J7dGNgDiJ zqg
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-busine ss1@paypal.com
verify_sign: AiPC9BjkCyDFQXbSk oZcgqH3hpacAAV9zVN I.GLTI1sLOHpeeWp3oMQZ
invoice_id: INV2-UHWN-STXM-65B7-P T4R
ipn_track_id: 2eKZJ-cZftAHzSWbsS7 qjQ
Introduction to the Invoicing Service API
IPN Variables for Invoicing API Operations
1
Invoicing Service API Guide May 2012 15
Introduction to the Invoicing Service API
1
IPN Variables for Invoicing API Operations
16 May 2012 Invoicing Service API Guide
Invoicing Service API Examples
2
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","124461 2379");
headers.put("X-PAYPAL-SECURITY -SIGNATURE","lkfg9 groingghb4uw5"
headers.put("X-PAYPAL-DEVICE-I PADDRESS", "168.212.226. 204");
headers.put("X-PAYPAL-REQUEST- DATA-FORMAT", "NV" );
headers.put("X-PAYPAL-RESPONSE -DATA-FORMAT", "NV ");
headers.put("X-PAYPAL-APPLICAT ION-ID", "APP-80W2 84485P519543T");
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):
Invoicing Service API Guide May 2012 17
Invoicing Service API Examples
2
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 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 b y 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-FORM AT 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-REQUEST-DATA-FORMAT The payload format for the request.
Allowable values are:
NV – Name-value pairs
XML – Extensible markup language
JSO N – 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
JSO N – JavaScript object notation
18 May 2012 Invoicing Service API Guide
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","124461 2379");
headers.put("X-PAYPAL-SECURITY -SIGNATURE","lkfg9 groingghb4uw5"
headers.put("X-PAYPAL-DEVICE-I PADDRESS", "168.212.226. 204");
headers.put("X-PAYPAL-MESSAGE- PROTOCOL", "SOAP11");
headers.put("X-PAYPAL-APPLICAT ION-ID","APP-80W28 4485P519543T");
Below are the service name, port type, binding and location for SOAP as defined in the
Adaptive Payments WSDL.
<wsdl:service name="AdaptivePayme nts">
<wsdl:port name="AdaptivePayme ntsSOAP11_http"
<binding="services:AdaptivePay mentsSOAP11Binding ">
<soap:address location="https://s vcs.paypal.com/Adapti vePayments" />
Invoicing Service API Examples
HTTP Headers
2
Specifying Application and Device Information
You also must identify the application. Y o u can op tion all y identify other information
associated with the client and the API version:
HTTP Headers for Application and Device identification
Header Description
X-PAYPAL-APPLICATION-ID (Required) Your application’s identification, which is issued
by PayPal.
NOTE: Check X.com for which application ID m ust be
defined for working in the sandbox.
X-PAYPAL-DEVICE-ID (Optional) Client’s device ID, such as a mobile device’s
IMEI number or a web browser cookie.
X-PAYPAL-DEVICE-IPADDRESS (Required) Client’s IP address.
X-PAYPAL-SERVICE-VERSION (Optional) The version of an API operation to use. By
default, PayPal executes a request with the current version
of an API operation.
NOTE: PayPal recommends not specifying a version unless
it is absolutely required.
Invoicing Service API Guide May 2012 19
Invoicing Service API Examples
2
Creating an Invoice
Creating an Invoice
This example shows how to create an invoice using CreateInvoice.
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Your_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Your_API_passwor d"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Your_API_signat ure"
-H "X-PAYPAL-REQUEST-DATA-FORM AT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://svcs.sandbox.paypal.co m/Invoice/CreateInvoi ce
-d
"requestEnvelope.errorLanguage =en_US
&invoice.merchantEmail=merchan t%40domain.com
&invoice.payerEmail=jbui-us-bu siness2%40paypal.c om
&invoice.currencyCode=USD
&invoice.itemList.item(0).name =Banana+Leaf+--+00 1
&invoice.itemList.item(0).desc ription=Banana+Lea f
&invoice.itemList.item(0).quan tity=1
&invoice.itemList.item(0).unit Price=1
&invoice.itemList.item(0).taxN ame=Tax1
&invoice.itemList.item(0).taxR ate=10.25
&invoice.paymentTerms=Net10
&invoice.logoUrl=https%3A%2F%2 Fwww.example.com%2 FYour_logo.jpg"
Sending an Invoice
This example shows how to send an invoice using SendInvoice. The invoice ID, which is in
the response to CreateInvoice, identifies the invoice to send.
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Y our_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Y our_API_password"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Y our_API_signature"
-H "X-PAYPAL-REQUEST-DATA-FORM AT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://svcs.sandbox.paypal.co m/Invoice/SendInvo ice
-d
"requestEnvelope.errorLanguage =en_US
&invoiceID=INV2-RVY9-UWTW-64HZ -BR9W"
20 May 2012 Invoicing Service API Guide
Creating and Sending an Invoice
This example shows how to create and send an invoice using CreateAndSendInvoice. It is
equivalent to creating an invoice and sending it.
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Y our_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Y our_API_password"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Y our_API_signature"
-H "X-PAYPAL-REQUEST-DATA-FORM AT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://svcs.sandbox.paypal.co m/Invoice/CreateAndSe ndInvoice
-d
"requestEnvelope.errorLanguage =en_US
&invoice.merchantEmail=merchan t%40domain.com
&invoice.payerEmail=jbui-us-bu siness2%40paypal.c om
&invoice.currencyCode=USD
&invoice.itemList.item(0).name =Banana+Leaf+--+00 1
&invoice.itemList.item(0).desc ription=Banana+Lea f
&invoice.itemList.item(0).quan tity=1
&invoice.itemList.item(0).unit Price=1
&invoice.itemList.item(0).taxN ame=Tax1
&invoice.itemList.item(0).taxR ate=10.25
&invoice.paymentTerms=Net10
&invoice.logoUrl=https%3A%2F%2 Fwww.example.com%2 FYour_logo.jpg"
Invoicing Service API Examples
Creating and Sending an Invoice
2
Updating an Invoice
This example shows how to send an invoice using UpdateInvoice. If the invoice has not
been sent, the invoice continues to be a draft; otherwise, the invoice is resent.
NOTE: When updating an invoice, in addition to the updated fields, you must also provide all
of the original fields used to create the invoice.
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Y our_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Y our_API_password"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Y our_API_signature"
-H "X-PAYPAL-REQUEST-DATA-FORM AT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://sandbox.svcs.paypal.co m/Invoice/UpdateInvoi ce
-d
"requestEnvelope.errorLanguage =en_US
&invoice.merchantEmail=merchan t%40domain.com
Invoicing Service API Guide May 2012 21
Invoicing Service API Examples
2
Obtaining Invoice Details
&invoice.payerEmail=jbui-us-bu siness2%40paypal.c om
&invoice.currencyCode=USD
&invoice.itemList.item(0).name =Banana+Leaf+--+00 1
&invoice.itemList.item(0).desc ription=Banana+Lea f
&invoice.itemList.item(0).quan tity=3
&invoice.itemList.item(0).unit Price=1
&invoice.itemList.item(0).taxN ame=Tax1
&invoice.itemList.item(0).taxR ate=10.25
&invoice.paymentTerms=Net10
&invoice.logoUrl=https%3A%2F%2 Fwww.example.com%2 FYour_logo.jpg"
Obtaining Invoice Details
This example shows how to obtain invoice details using GetInvoiceDetails.
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Y our_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Y our_API_password"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Y our_API_signature"
-H "X-PAYPAL-REQUEST-DATA-FORM AT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://svcs.sandbox.paypal.co m/Invoice/GetInvoi ceDetails
-d
"requestEnvelope.detailLevel=R eturnAll
&requestEnvelope.errorLanguage =en_US
&invoiceID=INV2-RVY9-UWTW-64HZ -BR9W"
Canceling an Invoice
This example shows how to cancel an invoice using CancelInvoice. PayPal can notifiy the
payer that the message has been canceled.
22 May 2012 Invoicing Service API Guide
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Y our_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Y our_API_password"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Y our_API_signature"
-H "X-PAYPAL-REQUEST-DA TA-FOR MAT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://sandbox.svcs.paypal.co m/Invoice/CancelInvoi ce
-d
"requestEnvelope.errorLanguage =en_US
&invoiceID=INV2-RVY9-UWTW-64HZ -BR9W"
&subject=Cancel+it
¬eForPayer=Cancel+it+now
&sendCopyToMerchant=true"
Searching for Invoices
Invoicing Service API Examples
Searching for Invoices
2
This example shows how to create and send an invoice using CreateAndSendInvoi ce. You
must have created the original invoice either for yourself or on behalf of another merchant.
PayPal can return a maximum of 100 invoices per page. In this example, only the first 10
invoices that you created using the Invoicing Service API for the jb-us-
seller1@paypal.com account are returned:
curl -s --insecure
-H "X-PAYPAL-SECURITY-USERID: Y our_API_username"
-H "X-PAYPAL-SECURITY-PASSWORD : Y our_API_password"
-H "X-PAYPAL-SECURITY-SIGNATUR E: Y our_API_signature"
-H "X-PAYPAL-REQUEST-DATA-FORM AT: NV"
-H "X-PAYPAL-RESPONSE-DATA-FOR MAT: NV"
-H "X-PAYPAL-APPLICATION-ID: Your_AppID"
https://svcs.sandbox.paypal.co m/Invoice/SearchIn voices
-d
"requestEnvelope.errorLanguage =en_US
&merchantEmail=jb-us-seller1%4 0paypal.com
¶meters.origin=API
¶meters.email=jb-us-seller 1%40paypal.com
&page=1
&pageSize=10"
Invoicing Service API Guide May 2012 23
Invoicing Service API Examples
2
Searching for Invoices
24 May 2012 Invoicing Service API Guide
CreateInvoice API Operation
3
Use the CreateInvoice API operation to create a new invoice. The call includes merchant,
payer, and API caller information, in addition to invoice detail. The response to the call
contains an invoice ID and URL.
CreateInvoiceRequest Message
Use the CreateInvoiceRequest message to create a new invoice. The merchant issuing the
invoice, and the partner, if any, making the call, must have a PayPal account in good standing.
Invoicing Service API Guide May 2012 25
CreateInvoice API Operation
3
CreateInvoiceRequest Message
26 May 2012 Invoicing Service API Guide
CreateInvoice API Operation
CreateInvoiceRequest Message
3
Invoicing Service API Guide May 2012 27
CreateInvoice API Operation
3
CreateInvoiceRequest Message
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
CreateInvoiceRequest Fields
Field Description
invoice inv:InvoiceType
(Required) Merchant, payer, and invoice information.
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
InvoiceType Fields
Field Description
merchantEmail xs:string
(Required) Merchant email address.
payerEmail xs:string
(Required) Payer email address.
number xs:string
(Optional) Unique identifier for the invoice.
merchantInfo inv:BusinessInfoTy pe
Company contact information of the merchant company sending the invoi ce.
itemList inv:InvoiceItemListType
(Required) List of items included in this invoice.
currencyCode xs:string
(Required) Currency used for all invoice item amounts and totals.
invoiceDate xs:dateTime
(Optional) Date on which the invoice is enabled.
28 May 2012 Invoicing Service API Guide
Field Description
dueDate xs:dateTime
(Optional) Date on which the invoice payment is due.
paymentTerms inv:PaymentTermsTy pe
(Required) Terms by which the invoice payment is due. It is one of the
following values:
Du eOnReceipt – Payment is due when the payer receives the invoice.
Du eOnDateSpecified – Payment is due on the date specified in the
invoice.
Ne t10 – Payment is due 10 days from the invoice date.
Ne t15 – Payment is due 15 days from the invoice date.
Ne t30 – Payment is due 30 days from the invoice date.
Ne t45 – Payment is due 45 days from the invoice date.
discountPercent xs:decimal
(Optional) Discount percent applied to the invoice.
discountAmount xs:decimal
(Optional) Discount amount applied to the invoice, if any. If
discountPercent is provided, discountAmoun t is ignored.
CreateInvoice API Operation
CreateInvoiceRequest Message
3
terms xs:string
(Optional) General terms for the invoice.
note xs:string
(Optional) Note to the payer company.
merchantMemo xs:string
(Optional) Memo for bookkeeping that is private to the merchant.
billingInfo inv:BusinessInfoTy pe
(Optional) Billing information for the payer.
shippingInfo inv:BusinessInfoTy pe
(Optional) Shipping information for the payer.
shippingAmount xs:decimal
(Optional) Cost of shipping.
shippingTaxName xs:string
(Optional) Name of the applicable tax on shipping cost.
shippingTaxRate xs:decimal
(Optional) Rate of the applicable tax on shipping cost.
logoURL xs:string
(Optional) Complete URL to an external image used as the logo, if any.
ReferrerCode xs:string
(Optional) Build Notification (BN) code for tracking transactions with a
particular partner..
Invoicing Service API Guide May 2012 29
CreateInvoice API Operation
3
CreateInvoiceRequest Message
Field Description
customAmountLabel xs:string
customAmountValue xs:decimal
BusinessInfoType Fields
Field Description
firstName xs:string
lastName xs:string
Label used to display custom amount value. If a value is entered for
customAmountLabel, then customAmountValu e cannot be empty.
Value of custom amount.If a value is entered for customAmountValue, then
customAmountLabel cannot be empty.
(Optional) First name of the company contact.
(Optional) Last name of the company contact.
businessName xs:string
(Optional) Company business name.
phone xs:string
(Optional) Phone number for contacting the company.
fax xs:string
(Optional) Fax number used by the company.
website xs:string
(Optional) Website us ed by the company.
customValue xs:string
(Optional) Custom value to be displayed in the contact information details..
address common:BaseAddress
(Optional) Street address of the company.
BaseAddress Fields
Field Description
city xs:string
(Required) City of the address.
countryCode xs:string
(Required) Country code of the address.
30 May 2012 Invoicing Service API Guide
Field Description
line1 xs:string
(Required) First line of the address.
line2 xs:string
(Optional) Second line of the street address.
postalCode xs:string
(Optional) Postal code of the address.
state xs:string
(Optional) State for the address.
type xs:string
(Optional) Type of address.
InvoiceItemListType Fields
CreateInvoice API Operation
CreateInvoiceRequest Message
3
Field Description
item inv:InvoiceItemType
(Required) Invoice item.
InvoiceItemType Fields
Field Description
name xs:string
(Required) SKU or name of the item.
Character length and limitations: 30 characters maximum
description xs:string,
(Optional) Item description.
date xs:dateTime
(Optional) Date on which the product or service was provided.
quantity xs:decimal
(Required) Item count. Valid values are 0 to 10.000.
unitPrice xs:decimal
(Required) Price of the item, in the currency specified by the invoice.
taxName xs:string
(Optional) Name of the applicable tax.
taxRate xs:decimal
(Optional) Rate of the applicable tax.
Invoicing Service API Guide May 2012 31
CreateInvoice API Operation
3
CreateInvoiceResponse Message
CreateInvoiceResponse Message
The CreateInvoiceResponse message contains information returned in response to a
CreateInvoiceRequest message. The response contains an invoice ID and the URL to the
invoice on the PayPal system.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
32 May 2012 Invoicing Service API Guide
CreateInvoiceResponse Fields
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoiceId xs:string
ID of the created invoice.
invoiceNumber xs:string
Invoice number of the created invoice.
invoiceURL xs:string
URL location where merchants view the invoice details.
totalAmount xs:long
The total amount of the invoice.
CreateInvoice API Operation
PPFault Message
3
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
Invoicing Service API Guide May 2012 33
CreateInvoice API Operation
3
PPFault Message
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
parameter common:ErrorParameter
Represents contextual information about the error.
34 May 2012 Invoicing Service API Guide
Field Description
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
CreateInvoice API Operation
PPFault Message
3
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Invoicing Service API Guide May 2012 35
CreateInvoice API Operation
3
CreateInvoice API Errors
CreateInvoice API Errors
Code Message Additional Information
520002 Internal error.
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
570045 The number of items exceeds this allowed limit.
570046 The due date occurs before the invoice date.
570047 The invoice date is earlier than todays date.
570048 A tax name can only be associated with one unique tax rate on a
single invoice; the following tax name is associated to different
rates on this invoice.
570049 The total amount for the invoice cannot be negative.
570050 The merchant’s PayPal account cannot be the same as the
payer’s account; merchant and payer email addresses presently
link to the same account.
570051 Invoice cannot have more than 10 different taxes.
570054 Invalid token.
570058 Invalid token.
570059 Invoice number is too long.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
580045 Merchant does not have a PayPal account associated with this
email address.
580046 An invoice already exists for the merchant with this invoice
number.
36 May 2012 Invoicing Service API Guide
SendInvoice API Operation
4
Use the SendInvoice API operation to send an invoice to a pa yer , and no tify the payer of the
pending invoice.
SendInvoiceRequest Message
Use the SendInvoiceRequest message to send an invoice to a payer, and notify the payer
of the pending invoice.
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
Invoicing Service API Guide May 2012 37
SendInvoice API Operation
4
SendInvoiceResponse Message
SendInvoiceRequest Fields
The table below lists the fields for the SendInvoiceRequest message.
Field Description
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
invoiceID xs:string
(Required) ID of the invoice to send.
SendInvoiceResponse Message
The SendInvoiceResponse message contains information returned in response to a
SendInvoiceRequest message. It indicates whether the invoice was sent successfully.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
38 May 2012 Invoicing Service API Guide
Field Description
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
SendInvoiceResponse Fields
SendInvoice API Operation
SendInvoiceResponse Message
4
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoiceID xs:string
ID of the invoice being sent.
invoiceURL xs:string
Location where merchants view the invoice details.
Invoicing Service API Guide May 2012 39
SendInvoice API Operation
4
PPFault Message
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
40 May 2012 Invoicing Service API Guide
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
SendInvoice API Operation
PPFault Message
4
parameter common:ErrorParameter
Represents contextual information about the error.
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
Invoicing Service API Guide May 2012 41
SendInvoice API Operation
4
Send Invoice API Errors
Field Description
correlationId xs:string
timestamp xs:datetime
Send Invoice API Errors
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Code Message Additional Information
520002 Internal error.
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
550026 Partner did not create the invoice but attempted to access or
modify it; a merchant’s invoice can be accessed or modified only
by the partner who created it.
550027 Merchant cannot access or modify an invoice they did not create;
an invoice can only be accessed or modified by the party who
created it.
570052 You cannot send this invoice because it has already been paid.
570053 You cannot send this invoice because it has already been
canceled.
570058 Invalid token.
570064 An invoice that has already been sent cannot be sent again.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
580047 Invoice does not exist.
42 May 2012 Invoicing Service API Guide
CreateAndSendInvoice API
5
Operation
Use the CreateAndSendInvoice API operation to create and send an invoice.
CreateAndSendInvoiceRequest Message
Use the CreateAndSendInvoiceRequest message to create and send a new invoice. The
requester should authenticate the caller and verify that the merchant requesting the invoice has
an existing PayPal account in good standing. Once the invoice is created, PayPal sends it to the
specified payer, who is notified of the pending invoice.
Invoicing Service API Guide May 2012 43
CreateAndSendInvoice API Operation
5
CreateAndSendInvoiceRequest Message
44 May 2012 Invoicing Service API Guide
CreateAndSendInvoice API Operation
CreateAndSendInvoiceRequest Message
5
Invoicing Service API Guide May 2012 45
CreateAndSendInvoice API Operation
5
CreateAndSendInvoiceRequest Message
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
CreateAndSendInvoiceRequest Fields
Field Description
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
invoice inv:InvoiceType
(Required) Merchant, payer, and invoice information.
InvoiceType Fields
Field Description
merchantEmail xs:string
(Required) Merchant email address.
payerEmail xs:string
(Required) Payer email address.
number xs:string
(Optional) Unique identifier for the invoice.
merchantInfo inv:BusinessInfoTy pe
Company contact information of the merchant company sending the invoi ce.
itemList inv:InvoiceItemListType
(Required) List of items included in this invoice.
currencyCode xs:string
(Required) Currency used for all invoice item amounts and totals.
invoiceDate xs:dateTime
(Optional) Date on which the invoice is enabled.
46 May 2012 Invoicing Service API Guide
Field Description
dueDate xs:dateTime
(Optional) Date on which the invoice payment is due.
paymentTerms inv:PaymentTermsTy pe
(Required) Terms by which the invoice payment is due. It is one of the
following values:
Du eOnReceipt – Payment is due when the payer receives the invoice.
Du eOnDateSpecified – Payment is due on the date specified in the
invoice.
Ne t10 – Payment is due 10 days from the invoice date.
Ne t15 – Payment is due 15 days from the invoice date.
Ne t30 – Payment is due 30 days from the invoice date.
Ne t45 – Payment is due 45 days from the invoice date.
discountPercent xs:decimal
(Optional) Discount percent applied to the invoice.
discountAmount xs:decimal
(Optional) Discount amount applied to the invoice, if any. If
discountPercent is provided, discountAmoun t is ignored.
CreateAndSendInvoice API Operation
CreateAndSendInvoiceRequest Message
5
terms xs:string
(Optional) General terms for the invoice.
note xs:string
(Optional) Note to the payer company.
merchantMemo xs:string
(Optional) Memo for bookkeeping that is private to the merchant.
billingInfo inv:BusinessInfoTy pe
(Optional) Billing information for the payer.
shippingInfo inv:BusinessInfoTy pe
(Optional) Shipping information for the payer.
shippingAmount xs:decimal
(Optional) Cost of shipping.
shippingTaxName xs:string
(Optional) Name of the applicable tax on shipping cost.
shippingTaxRate xs:decimal
(Optional) Rate of the applicable tax on shipping cost.
logoURL xs:string
(Optional) Complete URL to an external image used as the logo, if any.
ReferrerCode xs:string
(Optional) Build Notification (BN) code for tracking transactions with a
particular partner..
Invoicing Service API Guide May 2012 47
CreateAndSendInvoice API Operation
5
CreateAndSendInvoiceRequest Message
Field Description
customAmountLabel xs:string
customAmountValue xs:decimal
BusinessInfoType Fields
Field Description
firstName xs:string
lastName xs:string
Label used to display custom amount value. If a value is entered for
customAmountLabel, then customAmountValu e cannot be empty.
Value of custom amount.If a value is entered for customAmountValue, then
customAmountLabel cannot be empty.
(Optional) First name of the company contact.
(Optional) Last name of the company contact.
businessName xs:string
(Optional) Company business name.
phone xs:string
(Optional) Phone number for contacting the company.
fax xs:string
(Optional) Fax number used by the company.
website xs:string
(Optional) Website us ed by the company.
customValue xs:string
(Optional) Custom value to be displayed in the contact information details..
address common:BaseAddress
(Optional) Street address of the company.
BaseAddress Fields
Field Description
city xs:string
(Required) City of the address.
countryCode xs:string
(Required) Country code of the address.
48 May 2012 Invoicing Service API Guide
Field Description
line1 xs:string
(Required) First line of the address.
line2 xs:string
(Optional) Second line of the street address.
postalCode xs:string
(Optional) Postal code of the address.
state xs:string
(Optional) State for the address.
type xs:string
(Optional) Type of address.
InvoiceItemListType Fields
CreateAndSendInvoice API Operation
CreateAndSendInvoiceRequest Message
5
Field Description
item inv:InvoiceItemType
(Required) Invoice item.
InvoiceItemType Fields
Field Description
name xs:string
(Required) SKU or name of the item.
Character length and limitations: 30 characters maximum
description xs:string,
(Optional) Item description.
date xs:dateTime
(Optional) Date on which the product or service was provided.
quantity xs:decimal
(Required) Item count. Valid values are 0 to 10.000.
unitPrice xs:decimal
(Required) Price of the item, in the currency specified by the invoice.
taxName xs:string
(Optional) Name of the applicable tax.
taxRate xs:decimal
(Optional) Rate of the applicable tax.
Invoicing Service API Guide May 2012 49
CreateAndSendInvoice API Operation
5
CreateAndSendInvoiceResponse Message
CreateAndSendInvoiceResponse Message
The CreateAnd SendInvoiceResponse message contains information returned in response
to a CreateAndSendInvoiceRequest message. The response contains an invoice ID and
the URL to the invoice on the PayPal system, and indicates whether the invoice was sent
successfully.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
50 May 2012 Invoicing Service API Guide
CreateAndSendInvoiceResponse Fields
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoiceID xs:string
ID of the created invoice.
invoiceNumber xs:string
Number of the created invoice.
invoiceURL xs:string
URL location where merchants view the invoice details.
totalAmount xs:long
The total amount of the invoice.
CreateAndSendInvoice API Operation
PPFault Message
5
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
Invoicing Service API Guide May 2012 51
CreateAndSendInvoice API Operation
5
PPFault Message
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
parameter common:ErrorParameter
Represents contextual information about the error.
52 May 2012 Invoicing Service API Guide
Field Description
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
CreateAndSendInvoice API Operation
CreateAndSendInvoice API Errors
5
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
CreateAndSendInvoice API Errors
Code Message Additional Information
520002 Internal error.
Invoicing Service API Guide May 2012 53
CreateAndSendInvoice API Operation
5
CreateAndSendInvoice API Errors
Code Message Additional Information
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
570045 The number of items exceeds this allowed limit.
570046 The due date occurs before the invoice date.
570047 The invoice date is earlier than todays date.
570048 A tax name can only be associated with one unique tax rate on a
single invoice; the following tax name is associated to different
rates on this invoice.
570049 The total amount for the invoice cannot be negative.
570050 The merchant’s PayPal account cannot be the same as the
payer’s account; merchant and payer email addresses presently
link to the same account.
570051 Invoice cannot have more than 10 different taxes.
570054 Invalid token.
570058 Invalid token.
570059 Invoice number is too long.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
580045 Merchant does not have a PayPal account associated with this
email address.
580046 An invoice already exists for the merchant with this invoice
number.
54 May 2012 Invoicing Service API Guide
UpdateInvoice API Operation
6
Use the UpdateInvoice API operation to update an invoice.
UpdateInvoiceRequest Message
Use the UpdateInvoiceRequest message to update an invoice.
Invoicing Service API Guide May 2012 55
UpdateInvoice API Operation
6
UpdateInvoiceRequest Message
56 May 2012 Invoicing Service API Guide
UpdateInvoice API Operation
UpdateInvoiceRequest Message
6
Invoicing Service API Guide May 2012 57
UpdateInvoice API Operation
6
UpdateInvoiceRequest Message
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
UpdateInvoiceRequest Fields
Field Description
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
invoiceID xs:string
(Required) ID of the invoice to update.
invoice inv:InvoiceType
(Required) Merchant, payer, and invoice information.
InvoiceType Fields
Field Description
merchantEmail xs:string
(Required) Merchant email address.
payerEmail xs:string
(Required) Payer email address.
number xs:string
(Optional) Unique identifier for the invoice.
merchantInfo inv:BusinessInfoTy pe
Company contact information of the merchant company sending the invoi ce.
itemList inv:InvoiceItemListType
(Required) List of items included in this invoice.
currencyCode xs:string
(Required) Currency used for all invoice item amounts and totals.
58 May 2012 Invoicing Service API Guide
Field Description
invoiceDate xs:dateTime
(Optional) Date on which the invoice is enabled.
dueDate xs:dateTime
(Optional) Date on which the invoice payment is due.
paymentTerms inv:PaymentTermsTy pe
(Required) Terms by which the invoice payment is due. It is one of the
following values:
Du eOnReceipt – Payment is due when the payer receives the invoice.
Du eOnDateSpecified – Payment is due on the date specified in the
invoice.
Ne t10 – Payment is due 10 days from the invoice date.
Ne t15 – Payment is due 15 days from the invoice date.
Ne t30 – Payment is due 30 days from the invoice date.
Ne t45 – Payment is due 45 days from the invoice date.
discountPercent xs:decimal
(Optional) Discount percent applied to the invoice.
UpdateInvoice API Operation
UpdateInvoiceRequest Message
6
discountAmount xs:decimal
(Optional) Discount amount applied to the invoice, if any. If
discountPercent is provided, discountAmoun t is ignored.
terms xs:string
(Optional) General terms for the invoice.
note xs:string
(Optional) Note to the payer company.
merchantMemo xs:string
(Optional) Memo for bookkeeping that is private to the merchant.
billingInfo inv:BusinessInfoTy pe
(Optional) Billing information for the payer.
shippingInfo inv:BusinessInfoTy pe
(Optional) Shipping information for the payer.
shippingAmount xs:decimal
(Optional) Cost of shipping.
shippingTaxName xs:string
(Optional) Name of the applicable tax on shipping cost.
shippingTaxRate xs:decimal
(Optional) Rate of the applicable tax on shipping cost.
logoURL xs:string
(Optional) Complete URL to an external image used as the logo, if any.
Invoicing Service API Guide May 2012 59
UpdateInvoice API Operation
6
UpdateInvoiceRequest Message
Field Description
ReferrerCode xs:string
customAmountLabel xs:string
customAmountValue xs:decimal
BusinessInfoType Fields
Field Description
firstName xs:string
(Optional) Build Notification (BN) code for tracking transactions with a
particular partner..
Label used to display custom amount value. If a value is entered for
customAmountLabel, then customAmountValu e cannot be empty.
Value of custom amount.If a value is entered for customAmountValue, then
customAmountLabel cannot be empty.
(Optional) First name of the company contact.
lastName xs:string
(Optional) Last name of the company contact.
businessName xs:string
(Optional) Company business name.
phone xs:string
(Optional) Phone number for contacting the company.
fax xs:string
(Optional) Fax number used by the company.
website xs:string
(Optional) Website us ed by the company.
customValue xs:string
(Optional) Custom value to be displayed in the contact information details..
address common:BaseAddress
(Optional) Street address of the company.
InvoiceItemType Fields
Field Description
item inv:InvoiceItemType
(Required) Invoice item.
60 May 2012 Invoicing Service API Guide
InvoiceItemType Fields
Field Description
name xs:string
(Required) SKU or name of the item.
Character length and limitations: 30 characters maximum
description xs:string,
(Optional) Item description.
date xs:dateTime
(Optional) Date on which the product or service was provided.
quantity xs:decimal
(Required) Item count. Valid values are 0 to 10.000.
unitPrice xs:decimal
(Required) Price of the item, in the currency specified by the invoice.
taxName xs:string
(Optional) Name of the applicable tax.
UpdateInvoice API Operation
UpdateInvoiceResponse Message
6
taxRate xs:decimal
(Optional) Rate of the applicable tax.
UpdateInvoiceResponse Message
The UpdateInvoiceResponse message contains information returned in response to an
UpdateInvoiceRequest message.
Invoicing Service API Guide May 2012 61
UpdateInvoice API Operation
6
UpdateInvoiceResponse Message
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
however, there is a warning message.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
UpdateInvoiceResponse Fields
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoiceId xs:string
ID of the updated invoice.
invoiceNumber xs:string
Invoice number of the updated invoice.
invoiceURL xs:string
URL location where merchants view the updated invoice details.
totalAmount xs:long
The total amount of the invoice.
62 May 2012 Invoicing Service API Guide
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
UpdateInvoice API Operation
PPFault Message
6
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
Invoicing Service API Guide May 2012 63
UpdateInvoice API Operation
6
PPFault Message
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
parameter common:ErrorParameter
Represents contextual information about the error.
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
64 May 2012 Invoicing Service API Guide
Field Description
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
UpdateInvoice API Errors
UpdateInvoice API Operation
UpdateInvoice API Errors
6
Code Message Additional Information
520002 Internal error.
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
550026 Partner did not create the invoice but attempted to access or
modify it; a merchant’s invoice can be accessed or modified only
by the partner who created it.
550027 Merchant cannot access or modify an invoice they did not create;
an invoice can only be accessed or modified by the party who
created it.
570045 The number of items exceeds this allowed limit.
570046 The due date occurs before the invoice date.
570047 The invoice date is earlier than todays date.
570048 A tax name can only be associated with one unique tax rate on a
single invoice; the following tax name is associated to different
rates on this invoice.
570049 The total amount for the invoice cannot be negative.
570050 The merchant’s PayPal account cannot be the same as the
payer’s account; merchant and payer email addresses presently
link to the same account.
570051 Invoice cannot have more than 10 different taxes.
Invoicing Service API Guide May 2012 65
UpdateInvoice API Operation
6
UpdateInvoice API Errors
Code Message Additional Information
570058 Invalid token.
570059 Invoice number is too long.
570060 The status of the invoice is such that it can no longer be updated.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
580046 An invoice already exists for the merchant with this invoice
number.
580047 Invoice does not exist.
66 May 2012 Invoicing Service API Guide
GetInvoiceDetails API Operation
7
Use the GetInvoiceDetails API operation to get detailed information about an invoice.
GetInvoiceDetailsRequest Message
Use the GetInvoiceDetailsRequest message to get detailed information about an
invoice.
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
Invoicing Service API Guide May 2012 67
GetInvoiceDetails API Operation
7
GetInvoiceDetailsResponse Message
GetInvoiceDetailsRequest Fields
Field Description
invoiceID xs:string
(Required) ID of the invoice to retrieve.
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
GetInvoiceDetailsResponse Message
68 May 2012 Invoicing Service API Guide
GetInvoiceDetails API Operation
GetInvoiceDetailsResponse Message
7
Invoicing Service API Guide May 2012 69
GetInvoiceDetails API Operation
7
GetInvoiceDetailsResponse Message
70 May 2012 Invoicing Service API Guide
GetInvoiceDetails API Operation
GetInvoiceDetailsResponse Message
7
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Invoicing Service API Guide May 2012 71
GetInvoiceDetails API Operation
7
GetInvoiceDetailsResponse Message
Field Description
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
GetInvoiceDetailsResponse Fields
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoice xs:string
ID of the created invoice.
invoiceDetails inv:InvoiceDetailsType
Details about the invoice status and state change dates.
paymentDetails inv:PaymentDetailsType
Payment details about the invoice.
refundDetails inv:PaymentRefundDetailsType
The requested invoice refund details.
invoiceURL xs:string
URL location where merchants view the invoice details.
InvoiceType Fields
Field Description
merchantEmail xs:string
Merchant email address.
payerEmail xs:string
Payer email address.
number xs:string
Unique identifier for the invoice.
merchantInfo inv:BusinessInfoTy pe
Company contact information of the merchant company sending the invoi ce.
72 May 2012 Invoicing Service API Guide
Field Description
itemList inv:InvoiceItemListType
List of items included in this invoice.
currencyCode xs:string
Currency used for all invoice item amounts and totals.
invoiceDate xs:dateTime
Date on which the invoice is enabled.
dueDate xs:dateTime
Date on which the invoice payment is due.
paymentTerms inv:PaymentTermsTy pe
Terms by which the invoice payment is due. It is one of the following values:
Du eOnReceipt – Payment is due when the payer receives the invoice.
Du eOnDateSpecified – Payment is due on the date specified in the
invoice.
Ne t10 – Payment is due 10 days from the invoice date.
Ne t15 – Payment is due 15 days from the invoice date.
Ne t30 – Payment is due 30 days from the invoice date.
Ne t45 – Payment is due 45 days from the invoice date.
GetInvoiceDetails API Operation
GetInvoiceDetailsResponse Message
7
discountPercent xs:decimal
Discount percent applied to the invoice.
discountAmount xs:decimal
Discount amount applied to the invoice, if any. If discountPerc ent is
provided, discountAmount is ignored.
terms xs:string
General terms for the invoice.
note xs:string
Note to the payer company.
merchantMemo xs:string
Memo for bookkeeping that is private to the merchant.
billingInfo inv:BusinessInfoTy pe
Billing information for the payer.
shippingInfo inv:BusinessInfoTy pe
Shipping information for the payer.
shippingAmount xs:decimal
Cost of shipping.
shippingTaxName xs:string
Name of the applicable tax on shipping cost.
Invoicing Service API Guide May 2012 73
GetInvoiceDetails API Operation
7
GetInvoiceDetailsResponse Message
Field Description
shippingTaxRate xs:decimal
Rate of the applicable tax on shipping cost.
logoURL xs:string
External image URL of the invoice logo, if any.
referrerCode xs:string
Build Notification (BN) code for tracking transactions with a particular
partner.
InvoiceDetailsType Fields
Field Description
status inv:StatusType
Status of the invoice.
totalAmount xs:decimal
Total amount of the invoice (cost of items, shipping, and tax, less any
discount). The invoicing system sets this field and ignores any changes made
by API callers.
origin inv:OriginType
Indicates whether the invoice was created by the website or an API call.
createdDate xs:dateTime
Date when the invoice was created.
createdBy xs:string
Account that created the invoice.
canceledDate xs:dateTime
Date when the invoice was canceled, if canceled.
canceledByActor xs:ActorType
Actor who canceled the invoice.
canceledBy xs:string
Account that canceled the invoice.
lastUpdatedDate xs:dateTime
Date when the invoice was last updated.
lastUpdatedBy xs:string
Account that last edited the invoice.
firstSentDate xs:dateTime
Date when the invoice was first sent.
74 May 2012 Invoicing Service API Guide
Field Description
lastSentDate xs:dateTime
Date when the invoice was last sent.
lastSentBy xs:string
Account that last sent the invoice.
paidDate xs:dateTime
Date when the invoice was paid, if paid.
PaymentDetailsType Fields
Field Description
viaPayPal xs:boolean
Returns True if the invoice was paid by PayPal.
paypalPayment inv:PayPalPaymentDetailsType
PayPal payment details about the invoice.
GetInvoiceDetails API Operation
GetInvoiceDetailsResponse Message
7
otherPayment inv:OtherPaymentDe tailsType
Offline payment details about the invoice.
PayPalPaymentDetailsType Fields
Field Description
transactionID xs:string
Transaction ID of the PayPal payment.
date xs:dateTime
Date when the invoice was paid.
Invoicing Service API Guide May 2012 75
GetInvoiceDetails API Operation
7
PPFault Message
OtherPaymentDetailsType Fields
Field Description
method inv:PaymentMethodsType
(Optional) Method that can be used to mark an invoice as paid when the payer
pays offline. It is one of the following values:
Ba nkTransfer – Payment is made by a bank transfer.
Ca sh – Payment is made in cash.
Ch eck – Payment is made by check.
Cr editCard – Payment is made by a credit card.
De bitCard – Payment is made by a debit card.
Ot her – Payment is made by a method not specified in this list.
Pa yPal – Payment is made by PayPal.
Wi reTransfer – Payment is made by a wire transfer.
note xs:string
(Optional) Optional note associated with the payment.
date xs:dateTime
(Required) Date when the invoice was paid.
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
76 May 2012 Invoicing Service API Guide
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
GetInvoiceDetails API Operation
PPFault Message
7
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
parameter common:ErrorParameter
Represents contextual information about the error.
Invoicing Service API Guide May 2012 77
GetInvoiceDetails API Operation
7
GetInvoiceDetails API Errors
Field Description
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
GetInvoiceDetails API Errors
Code Message Additional Information
520002 Internal error.
78 May 2012 Invoicing Service API Guide
GetInvoiceDetails API Operation
GetInvoiceDetails API Errors
Code Message Additional Information
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
550026 Partner did not create the invoice but attempted to access or
modify it; a merchant’s invoice can be accessed or modified only
by the partner who created it.
550027 Merchant cannot access or modify an invoice they did not create;
an invoice can only be accessed or modified by the party who
created it.
570058 Invalid token.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
580047 Invoice does not exist.
7
Invoicing Service API Guide May 2012 79
GetInvoiceDetails API Operation
7
GetInvoiceDetails API Errors
80 May 2012 Invoicing Service API Guide
CancelInvoice API Operation
8
Use the CancelInvoice API operation to cancel an invoice.
CancelInvoiceRequest Message
Use the CancelInvoiceRequest message to cancel an invoice.
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
Invoicing Service API Guide May 2012 81
CancelInvoice API Operation
8
CancelInvoiceResponse Message
CancelInvoiceRequest Fields
Field Description
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
invoiceID xs:string
(Optional) ID of the invoice.
subject xs:string
(Optional) Subject of the cancelation notification.
noteForPayer xs:string
(Optional) Note to send payer within the cancelation notification.
sendCopyToMerchant xs:boolean
(Optional) Indicates whether to send a copy of the cancelation notification to
the merchant. It is one of the following values:
fa lse – Do not send a copy of the cancelation notification to the merchant
(default).
tr ue – Send a copy of the cancelation notification to the merchant.
CancelInvoiceResponse Message
Use the CancelInvoiceResponse message to cancel an invoice.
82 May 2012 Invoicing Service API Guide
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
CancelInvoice API Operation
CancelInvoiceResponse Message
8
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
CancelInvoiceResponse Fields
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoiceID xs:string
ID of the canceled invoice.
invoiceNumber xs:string
Number of the canceled invoice.
invoiceURL xs:string
URL location where merchants view the invoice details.
Invoicing Service API Guide May 2012 83
CancelInvoice API Operation
8
PPFault Message
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
84 May 2012 Invoicing Service API Guide
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
CancelInvoice API Operation
PPFault Message
8
parameter common:ErrorParameter
Represents contextual information about the error.
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
Invoicing Service API Guide May 2012 85
CancelInvoice API Operation
8
CancelInvoice API Errors
Field Description
correlationId xs:string
timestamp xs:datetime
CancelInvoice API Errors
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Code Message Additional Information
520002 Internal error.
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
550026 Partner did not create the invoice but attempted to access or
modify it; a merchant’s invoice can be accessed or modified only
by the partner who created it.
550027 Merchant cannot access or modify an invoice they did not create;
an invoice can only be accessed or modified by the party who
created it.
570058 Invalid token.
570061 Invoice cannot be canceled since it has already been paid.
570062 The invoice has already been canceled.
570063 A draft invoice cannot be canceled.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
580047 Invoice does not exist.
86 May 2012 Invoicing Service API Guide
SearchInvoices API Operation
9
Use the SearchInvoice API operation to search an invoice.
SearchInvoicesRequest Message
Use the SearchInvoiceRequest message to search an invoice.
Invoicing Service API Guide May 2012 87
SearchInvoices API Operation
9
SearchInvoicesRequest Message
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
SearchInvoicesRequest Fields
Field Description
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
merchantEmail xs:string
(Required) Email address of invoice creator.
parameters inv:SearchParamete rsType
(Required) Parameters constraining the search.
88 May 2012 Invoicing Service API Guide
Field Description
page xs:integer
(Required) Page number of result set, starting with 1.
pageSize xs:integer
(Required) Number of results per page, between 1 and 100.
SearchParametersType Fields
Field Description
email xs:string
(Optional) Email search string.
recipientName xs:string
(Optional) Recipient search string.
businessName xs:string
(Optional) Company search string.
SearchInvoices API Operation
SearchInvoicesRequest Message
9
invoiceNumber xs:integer
(Optional) Invoice number search string.
status inv:statusType
(Optional) Invoice status search.
lowerAmount xs:decimal
(Optional) Invoice amount search. It specifies the smallest amount to be
returned. If you pass a value for this field, you must also pass a
currencyCode value.
upperAmount xs:decimal
(Optional) Invoice amount search. It specifies the largest amount to be
returned. If you pass a value for this field, you must also pass a
currencyCode value.
currencyCode xs:string
(Optional) Currency used for lower and upper amounts. It is required when
you specify lowerAmount or upperAmount.
memo xs:string
(Optional) Invoice memo search string.
origin inv:originType
(Optional) Indicates whether the invoice was created by the website or by an
API call. It is one of the following values:
We b – The invoice was created on paypal.com.
AP I – The invoice was created by an Invoicing Service API call.
Invoicing Service API Guide May 2012 89
SearchInvoices API Operation
9
SearchInvoicesResponse Message
Field Description
invoiceDate inv:dateRangeType
(Optional) Invoice date range filter.
dueDate inv:dateRangeType
(Optional) Invoice due date range filter.
paymentDate inv:dateRangeType
(Optional) Invoice payment date range filter.
creationDate inv:dateRangeType
(Optional) Invoice creation date range filter.
DateRangeType Fields
Field Description
startDate xs:dateTime
(Optional) Start of the date range.
endDate xs:dateTime
(Optional) End of the date range.
SearchInvoicesResponse Message
The SearchInvoicesResponse message contains information returned in response to a
SearchInvoicesRequest message.
90 May 2012 Invoicing Service API Guide
SearchInvoices API Operation
SearchInvoicesResponse Message
9
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
Invoicing Service API Guide May 2012 91
SearchInvoices API Operation
9
SearchInvoicesResponse Message
Field Description
correlationId xs:string
timestamp xs:datetime
SearchInvoicesResponse Fields
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
count xs:integer
Number of invoices that matched the request.
invoiceList inv:invoiceSummary List
Page of invoice summaries that matched the list.
page xs:string
URL location where the merchant views invoice details.
hasNextPage xs:boolean
True if another page of invoice summary results exists.
hasPreviousPage xs:boolean
True if a previous page of the invoice summary results exists.
InvoiceSummaryListType Fields
Field Description
invoice inv:InvoiceSummaryType
Summary of invoice contents.
92 May 2012 Invoicing Service API Guide
InvoiceSummaryType Fields
Field Description
invoiceID xs:string
ID of the invoice.
merchantEmail xs:string
Merchant email address.
payerEmail xs:string
Payer email address.
number xs:string
Unique identifier for the invoice.
billingBusinessName xs:string
Company contact information of the merchant company sending the invoi ce.
billingFirstName xs:string
First name of the business information.
SearchInvoices API Operation
SearchInvoicesResponse Message
9
billingLastName xs:string
shippingBusinessName xs:string
Business name of the shipping information.
shippingFirstName xs:string
First name of the shipping information.
shippingLastName xs:string
Last name of the shipping information.
totalAmount xs:decimal
Total amount of the invoice.
currencyCode xs:string
Currency used for all invoice item amounts and totals.
invoiceDate xs:dateTime
Date on which the invoice is enabled.
dueDate xs:dateTime
Date on which the invoice payment is due.
status xs:statusType
Status of the invoice.
referrerCode xs:string
Build Notification (BN) code for tracking transactions with a particular
partner.
origin inv:originType
Indicates whether the invoice was created by the website or by an API call.
Invoicing Service API Guide May 2012 93
SearchInvoices API Operation
9
PPFault Message
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
FaultMessage Fields
Field Description
error common:ErrorData
Detailed error information.
responseEnvelope common:ResponseEnvelope
Common response information, including a timestamp and the response
acknowledgement status.
94 May 2012 Invoicing Service API Guide
ErrorData Fields
Field Description
category common:ErrorCategory
The location where the error occurred.
Possible values are:
Sy stem – The system encountered errors; try again
Ap plication – The application encountered errors; try again
Re quest – The request was incorrect
domain xs:string
The domain to which this service belongs.
errorId xs:long
A 6-digit number that uniquely identifies a particular error.
exceptionID This field is not used.
message xs:string
A description of the error.
SearchInvoices API Operation
PPFault Message
9
parameter common:ErrorParameter
Represents contextual information about the error.
severity common:ErrorSeverity
The severity of the error encountered.
Possible values are:
Er ror – Processing of the request was interrupted
Wa rning – Processing of the request was completed
subdomain This field is not used.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
Invoicing Service API Guide May 2012 95
SearchInvoices API Operation
9
SearchInvoices API Errors
Field Description
correlationId xs:string
timestamp xs:datetime
SearchInvoices API Errors
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Code Message Additional Information
520002 Internal error.
520005 Authentication failed. API credentials are incorrect.
520009 Account is restricted.
570058 Invalid token.
580022 This error code corresponds to validation error messages that
deal with errors of supplied parameters.
96 May 2012 Invoicing Service API Guide
MarkInvoiceAsPaid API Operation
10
Use the MarkInvoiceAsPaid API operation to mark an invoice as paid.
MarkInvoiceAsPaidRequest Message
Use the MarkInvoiceAsPaidRequest message to mark an invoice as paid.
RequestEnvelope Fields
Field Description
detailLevel common:DetailLevel Code
(Optional) Level of detail required by the client application for components. It
is one of the following values:
Re turnAll – This value provides the maximum level of detail (default).
Invoicing Service API Guide May 2012 97
10
MarkInvoiceAsPaid API Operation
MarkInvoiceAsPaidRequest Message
Field Description
errorLanguage xs:string
(Required) RFC 3066 language in which error messages are returned; by
default it is en_US, which is the only language currently supported.
MarkInvoiceAsPaidRequest Fields
Field Description
invoiceID xs:string
(Required) ID of the invoice to mark as paid.
payment inv:OtherPaymentDetailsType
(Required) Details of the payment made against this type.
requestEnvelope common:requestEnve lope
(Required) Information common to each API operation, such as the language
in which an error message is returned.
OtherPaymentDetailsType Fields
Field Description
method inv:PaymentMethodsType
(Optional) Method that can be used to mark an invoice as paid when the payer
pays offline. It is one of the following values:
Ba nkTransfer – Payment is made by a bank transfer.
Ca sh – Payment is made in cash.
Ch eck – Payment is made by check.
Cr editCard – Payment is made by a credit card.
De bitCard – Payment is made by a debit card.
Ot her – Payment is made by a method not specified in this list.
Pa yPal – Payment is made by PayPal.
Wi reTransfer – Payment is made by a wire transfer.
note xs:string
(Optional) Optional note associated with the payment.
date xs:dateTime
(Required) Date when the invoice was paid.
98 May 2012 Invoicing Service API Guide
MarkInvoiceAsPaid API Operation
MarkInvoiceAsPaidResponse Message
MarkInvoiceAsPaidResponse Message
The MarkInvoiceAsPaidResponse message marks an invoice as paid.
ResponseEnvelope Fields
Field Description
ack common:AckCode
Acknowledgement code. It is one of the following values:
Su ccess – The operation completed successfully.
Fa ilure – The operation failed.
Su ccessWithWarning – The operation completed successfully;
however, there is a warning message.
Fa ilureWithWarning – The operation failed with a warning message.
10
build xs:string
Build number. It is used only by PayPal Merchant Technical Support.
correlationId xs:string
Correlation identifier. It is a 13-character, alphanumeric stri ng (for exam ple,
db87c705a910e) that is used only by PayPal Merchant Technical Support.
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
timestamp xs:datetime
Date on which the response was sent, for example:
2012-04-02T22:33:35.774-07:00
NOTE: You must log and store this data for every response you receive.
PayPal Technical Support uses the information to assist with reported
issues.
Invoicing Service API Guide May 2012 99
10
MarkInvoiceAsPaid API Operation
PPFault Message
MarkInvoiceAsPaidResponse Fields
Field Description
responseEnvelope common:ResponseEnv elope
Common response information, including a timestamp and the response
acknowledgement status.
invoiceID xs:string
ID of the invoice marked as paid.
invoiceNumber xs:string
Number of the invoice marked as paid.
invoiceURL xs:string
URL location where merchants view the invoice details.
PPFault Message
The PPFaultMessage returns ErrorData and the ResponseE nvelope information to
your application if an error occurs.
100 May 2012 Invoicing Service API Guide
Loading...