Home

PayPal Invoicing - 2012 User Guide

1. Searching for Invoices This example shows how to create and send an invoice using CreateAndSendInvoice 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 Your API username H X PAYPAL SECURITY PASSWORD Your API password H X PAYPAL SECURITY SIGNATURE Your API signature H X PAYPAL REQUEST DATA FORMAT NV H X PAYPAL RESPONSE DATA FORMAT NV H X PAYPAL APPLICATION ID Your AppiD https svcs sandbox paypal com Invoice SearchInvoices d requestEnvelope errorLanguage en_US amp merchantEmail jb us seller1 40paypal com amp parameters origin API amp parameters email jb us seller1 40paypal com amp page 1 amp pageSize 10 Invoicing Service API Guide May 2012 23 Le Invoicing Service API Examples Searching for Invoices 24 May 2012 Invoicing Service API Guide Createlnvoice API Operation 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 Createl
2. 75 OtherPaymentDetails Type Fields 76 PPFault Message s2 24 4 Dans ee eo dle Faite Ee ee A RE ARR dre 76 FaultMessage Fields 77 ErrorData Fields sc ce ee 2 442 Lana ha a M Rae Ba ee ae 77 ResponseEnvelope Fields 78 Invoicing Service API Guide May 2012 5 FR Contents GetinvoiceDetails API Errors Chapter 8 Cancelinvoice API Operation CancellnvoiceRequest Message RequestEnvelope Fields CancellnvoiceRequest Fields CancellnvoiceResponse Message ResponseEnvelope Fields CancellnvoiceResponse Fields PPFault Message FaultMessage Fields ErrorData Fields ResponseEnvelope Fields Cancellnvoice API Errors Chapter 9 Searchinvoices API Operation SearchinvoicesRequest Message RequestEnvelope Fields SearchInvoicesRequest Fields SearchParametersType Fields DateRangeType Fields SearchinvoicesResponse Message ResponseEnvelope Fields SearchinvoicesResponse Fields InvoiceSummaryListType Fields
3. 106 MarkinvoiceAsUnpaidResponse Fields 107 PPFault Message sioi 8 bi ee mn As ee ae a tn D Ha he dun 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 OtherRefundDetails Type 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 2 o dou ne 8 ele due we we 117 Index 2 19 Invoicing Service API Guide May 2012 7 Na Contents 8 May 2012 Invoicing Servic
4. InvoiceSummary Type Fields PPFault Message FaultMessage Fields ErrorData Fields ResponseEnvelope Fields Searchinvoices API Errors Chapter 10 MarkinvoiceAsPaid API Operation MarkinvoiceAsPaidRequest Message RequestEnvelope Fields MarkInvoiceAsPaidRequest Fields OtherPaymentDetails Type Fields MarkinvoiceAsPaidResponse Message 6 May 2012 Invoicing Service API Guide Contents E ResponseEnvelope Fields 99 MarkinvoiceAsPaidResponse Fields 100 PPFault Message s 24 4 44 ua aan sua da ga md die 484 be RUE eu a 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
5. 58 UpdatelnvoiceRequest Fields 58 Invoice Type Fields 58 BusinessinfoType Fields ee ek ke 60 InvoiceltemType Fields 60 InvoiceltemType Fields 61 UpdatelnvoiceResponse Message 61 ResponseEnvelope Fields 62 UpdatelnvoiceResponse Fields 62 PPFault Message 63 FaultMessage Fields 63 ErrorData Fields 64 ResponseEnvelope Fields 64 Updatelnvoice API Errors 65 Chapter 7 GetinvoiceDetails API Operation 67 GetinvoiceDetailsRequest Message 67 RequestEnvelope Fields 67 GetinvoiceDetailsRequest Fields 68 GetlnvoiceDetailsResponse Message 68 ResponseEnvelope Fields 71 GetinvoiceDetailsResponse Fields 72 Invoice Type Fields ee 72 InvoiceDetails Type Fields 74 PaymentDetailsType Fields 75 PayPalPaymentDetails Type Fields
6. Invoicing Service API Guide May 2012 Updatelnvoice API Operation CEN UpdatelnvoiceRequest Message ES BusinessInfoType E firstName wl string Ef lastName wl string Ef businessName 0 1 string fe phone wl string Ef fax wl string Ef website wl string fe customValue wl string Ef address 1 BaseAddress Fany ES InvoiceltemListType E PaymentTermsType E ReferrerCode E InvoiceltemType e name 1 1 string e description 0 1 string e date 0 1 dateTime e quantity 1 1 decimal e unitPrice 1 1 decimal e taxName 0 1 string e taxRate 0 1 decimal 7 any 0 E BaseAddress e line1 1 1 string e line2 0 1 string e city 1 1 string e state 0 1 string postalCode 0 1 string e countryCode 1 1 string e type 0 1 string FE any 0 57 58 Updatelnvoice API Operation UpdatelnvoiceRequest Message RequestEnvelope Fields Field Description detailLevel common DetailLevelCod Optional Level of detail required by the client application for components It is one of the following values e ReturnAll 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 UpdatelnvoiceRequest Fields Field Description requestEnvelope common
7. 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 ERID Your API username ECURITY PASSWORD Your API password ECURITY SIGNATURE Your API signature T curl s insecure H X PAYPAL SECURITY US H X PAYPAL S H X PAYPAL S H X PAYPAL REQUEST DATA FORMAT NV H X PAYPAL RESPONSE DATA FORMAT NV H X PAYPAL APPLICATION ID Your AppiD d requestEnvelop amp invoice merchantl Invoicing Service API Guide https sandbox svcs paypal com Invoice UpdateInvoice rrorLanguage en_US Emai1 merchant 40domain com May 2012 21 22 Invoicing Service API Examples Obtaining Invoice Details invoice itemi List invoice payerEmail jbui us business2 40paypal com invoice currencyCode USD invoice itemi List invoice item List invoice itemi List invoice itemi List item 0 name Banana Leaf 001 item 0 description BananatLeaf item 0 quantity 3 item 0 unitPrice 1 item 0 taxName Taxl invoice itemi List item 0 taxRate 10 25 ROM M M M mm SM M S KS invoice paymentTerms Net10 invoice l
8. e requestEnvelope 1 1 RequestEnvelope e merchantEmail 1 1 string e parameters 1 1 SearchParametersType page 1 1 integer e pageSize 1 1 integer e recipientName 0 1 string e businessName 0 1 string e invoiceNumber 0 1 string e status 0 StatusType e lower mount 0 1 decimal e upper mount 0 1 decimal e currencyCode 0 1 string e memo 0 1 string e origin 0 1 OriginType e invoiceDate 0 1 DateRangeType e dueDate 0 1 DateRangeType e paymentDate 0 1 DateRangeType e creationDate 0 1 DateRangeType RE any 0 Invoicing Service API Guide May 2012 87 88 Searchinvoices API Operation SearchinvoicesRequest Message e e e e e e e fe SearchParametersType email recipientName businessName invoiceNumber status lowerAmount upperAmount currencyCode memo origin invoiceDate dueDate paymentDate creationDate any 0 0 0 0 0 0 0 0 0 0 0 E StatusType 1 string E OriginType dk 1 string 1 string DateRangeType 1 string e startDate 0 1 dateTime e endDate 0 1 dateTime StatusType decimal decimal string string OriginType DateRangeType DateRangeType DateRangeType DateRangeType RequestEnvelope Fields Field detailLevel errorLanguage Description common DetailLevelCod
9. Optional Level of detail required by the client application for components It is one of the following values e ReturnAl1 This value provides the maximum level of detail default 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 requestEnvelope 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 SearchParametersType Required Parameters constraining the search May 2012 Invoicing Service API Guide SearchInvoices API Operation EEN SearchinvoicesRequest Message Field Description page xs integer Required Page number of result set starting with 1 pageSize xs integer Required Number of results per page between 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 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
10. requestEnvelop Required Information common to each API operation such as the language in which an error message is returned invoiceID xs string Required 1D 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 merchant Info inv BusinessInfoType Company contact information of the merchant company sending the invoice itemList inv InvoiceItemListType Required List of items included in this invoice currencyCode xs string Required Currency used for all invoice item amounts and totals May 2012 Invoicing Service API Guide Updatelnvoice API Operation ERE UpdatelnvoiceRequest Message Field Description invoiceDate dueDate paymentTerms discountPercent discountAmount terms note merchantMemo billingInfo shippingInfo shippingAmount shippingTaxName shippingTaxRate logoURL xs dateTime Optional Date on which the invoice is enabled xs dateTime Optional Date on which the invoice payment is due inv PaymentTermsType Required Terms by which the invoice payment is due It is one of the following values e DueOnReceipt Payment is due when the payer receives the invoice e DueOnDa
11. terms response field 73 timestamp response field 32 35 39 42 50 53 62 65 72 78 83 86 92 96 99 102 107 110 113 116 totalAmount response field 74 93 type response field 31 49 U unitPrice request field 31 49 61 upperA mount request field 89 Invoicing Service API Guide May 2012 121 122 May 2012 Invoicing Service API Guide
12. 0 1 decimal re logoUrl 0 1 string Ef referrerCode 0 1 ReferrerCode FE any 0 Ef InvoiceDetailsType Ef status 1 1 StatusType Ef totalAmount 0 1 decimal Ef origin 1 1 OriginType Ef createdDate 1 1 dateTime createdBy 0 1 string canceledDate 0 1 dateTime canceledByActor 0 1 ActorType canceledBy 0 1 string lastUpdatedDate 0 1 dateTime lastUpdatedBy 0 1 string firstSentDate 0 1 dateTime lastSentDate 0 1 dateTime 6 lastSentBy 0 1 string e paidDate 0 1 dateTime Ej any 0 E PaymentDetailsType Ef viaPayPal 1 1 boolean Ef paypalPayment 0 1 PayPalPaymentDetailsType Ef otherPayment 0 1 OtherPaymentDetailsType Fl any 0 Invoicing Service API Guide May 2012 69 70 GetinvoiceDetails API Operation GetInvoiceDetailsResponse Message Ef merchantEmail Ef payerEmail Ef number Ef merchantInfo Ef itemList Ef currencyCode e invoiceDate Gi dueDate Gi paymentTerms Gi discountPercent Gi discount mount E terms Gi note Gi merchantMemo Ef billingInfo Gi shippingInfo E shipping mount Ef shippingTaxName Gi shippingTaxRate Ef logoUrl Ef referrerCode Fl any 1 1 1 1 0 0 1 1 1 1 1 1 0 0 1 1 1 1 1 1 ET ET ET 1 1 ET 1 0 0 0 0 1 1 1 Ef InvoiceType string string string Business
13. 1 1 OriginType Ef referrerCode 0 1 ReferrerCode TE any 0 ResponseEnvelope Fields Field Description ack common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning 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 ES Searchinvoices API Operation SearchinvoicesResponse Message Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 SearchinvoicesResponse Fields Field Description responseEnvelop common ResponseEnvelop Common response information including a timestamp and the response a
14. 104 May 2012 Invoicing Service API Guide MarkinvoiceAsUnpaid API Operation Use the MarkInvoiceAsUnpaid API operation to mark an invoice as unpaid MarkinvoiceAsUnpaidRequest Message Use the MarkInvoiceAsUnpaidRequest message to mark an invoice as unpaid MarkInvoiceAsUnpaidRequest E MarkinvoiceAsUnpaidRequest e requestEnvelope 1 1 RequestEnvelope Ef invoicelD 1 1 string ET TT e requestEnvelope 1 1 RequestEnvelope detailLevel 0 1 DetailLevelCode Ef invoicelD 1 1 string se e errorlanguage 1 1 string RE any 0 e RequestEnvelope Fields Field Description detailLevel common DetailLevelCode Optional Level of detail required by the client application for components It is one of the following values e ReturnAll 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 105 al MarkInvoiceAsUnpaid API Operation MarkInvoiceAsUnpaidResponse Message MarkInvoiceAsUnpaidRequest Fields Field Description invoicelD xs string Required 1D of the invoice to mark as unpaid requestEnvelope common requestEnvelop Required Information common to each API operation such as the language in which an error message is returned MarkInvoiceAsUn
15. It is a 13 character alphanumeric string for example 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 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 Createlnvoice API Operation EN PPFault Message CreatelnvoiceResponse Fields Field Description responseEnvelope common ResponseEnvelope Common response information including a timestamp and the response acknowledgement status invoiceld 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 PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvel ope information to your application if an error occurs FaultMessage E ResponseEnvelope e responseEnvelope 1 1 ResponseEnvelope e timestamp 1 1 dateTime e error 0 ErrorData e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string fe any 0 ErrorDa
16. Payer email address number xs string Optional Unique identifier for the invoice merchant Info inv BusinessInfoType Company contact information of the merchant company sending the invoice 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 Createlnvoice API Operation EN CreatelnvoiceRequest Message Field Description dueDate paymentTerms discountPercent discountAmount terms note merchantMemo billingInfo shippingInfo shippingAmount shippingTaxName shippingTaxRate logoURL ReferrerCode xs dateTime Optional Date on which the invoice payment is due inv PaymentTermsType Required Terms by which the invoice payment is due It is one of the following values e DueOnReceipt Payment is due when the payer receives the invoice e DueOnDateSpecified Payment is due on the date specified in the invoice Net 10 Payment is due 10 days from the invoice date Net 15 Payment is due 15 days from the invoice date Net 30 Payment is due 30 days from the invoice date Net 45 Payment is due 45 days from the invoice date xs decimal Optional Discount percent applied to the invoice xs decimal Optional Discount amount applie
17. try again e Application The application encountered errors try again e Request The request was incorrect xs string The domain to which this service belongs xs long A 6 digit number that uniquely identifies a particular error This field is not used xs string A description of the error common ErrorParameter Represents contextual information about the error Invoicing Service API Guide May 2012 101 MarkinvoiceAsPaid API Operation MarkInvoiceAsPaid API Errors Field Description severity common ErrorSeverity The severity of the error encountered Possible values are e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example db87c705a910e that is used only by PayPal Merchant Technical Support NOTE You must log and store this
18. 0 1 boolean CancelInvoiceRequest le RequestEnvelope requestEnvelope 1 1 RequestEnvelope e detaillevel 0 1 DetaillevelCode invoicelD 0 1 string ses e errorLanguage 1 1 string subject 0 1 string FE any o noteForPayer 0 string sendCopyToMerchant 0 1 boolean RequestEnvelope Fields Field Description detailLevel common DetailLevelCode Optional Level of detail required by the client application for components It is one of the following values e ReturnAl1 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 La Cancellnvoice API Operation Cancellnvoice Response Message CancellnvoiceRequest Fields Field Description requestEnvelope common requestEnvelope Required Information common to each API operation such as the language in which an error message is returned invoicelD 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 e f
19. 40 ErrorData Fields 2 2 o een ed 41 ResponseEnvelope Fields 41 Send Invoice API Errors 42 Chapter 5 CreateAndSendinvoice API Operation 43 CreateAndSendinvoiceRequest Message 43 RequestEnvelope Fields 46 CreateAndSendinvoiceRequest Fields 46 Invoice Type Fields 46 BusinessinfoType Fields 2 48 BaseAddress Fields 48 InvoiceltemListType Fields 49 InvoiceltemType Fields 49 CreateAndSendinvoiceResponse Message 50 ResponseEnvelope Fields 50 CreateAndSendinvoiceResponse Fields 51 PPFault Message 51 May 2012 Invoicing Service API Guide Contents E FaultMessage Fields 2 52 ErrorData Fields s ass e cora sor SE AR pa RE UR AE GE a 4 52 ResponseEnvelope Fields 53 CreateAndSendinvoice API Errors oaoa 53 Chapter 6 Updatelnvoice API Operation 55 UpdatelnvoiceRequest Message 55 RequestEnvelope Fields
20. 63 76 84 94 100 108 114 Q quantity request field 31 49 61 R recipientName request field 89 Refund details response field 72 requestEnvelope request field 28 38 46 58 68 82 88 98 106 112 RequestEnvelope request fields 28 37 46 58 67 81 88 97 105 111 Invoicing Service API Guide responseEnvelope PPFault field 34 40 52 63 77 84 V 94 101 108 114 responseEnvelope response field 33 39 51 62 72 83 viaPayPal response field 75 92 100 107 113 ResponseEnvelope response fields 32 35 38 41 50 W 53 62 64 71 78 83 85 91 95 99 102 106 109 112 115 website request field 30 48 60 S sendCopyToMerchant request field 82 severity field 35 41 53 64 78 85 95 102 109 115 shippingAmount request field 29 47 59 shippingAmount response field 73 shippingBusinessName response field 93 shippingFirstName response field 93 shippingInfo request field 29 47 59 shippingInfo response field 73 shippingLastName response field 93 shippingTaxName request field 29 47 59 shippingTaxName response field 73 shippingTaxRate request field 29 47 59 shippingTaxRate response field 74 startDate request field 90 state response field 31 49 status request field 89 status response field 74 93 subdomain field 35 41 53 64 78 85 95 102 109 115 subject request field 82 T taxName request field 31 49 61 taxRate request field 31 49 61 terms request field 29 47 59
21. 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 canceledDate canceledByActor canceledBy lastUpdatedDate lastUpdatedBy firstSentDate Account that created the invoice xs dateTime Date when the invoice was canceled if canceled xs ActorType Actor who canceled the invoice xs string Account that canceled the invoice xs dateTime Date when the invoice was last updated xs string Account that last edited the invoice xs dateTime Date when the invoice was first sent May 2012 Invoicing Service API Guide GetinvoiceDetails API Operation GetinvoiceDetails Response Message 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
22. Invoicing Service API Guide MarkinvoiceAsRefunded API Operation KER MarkInvoiceAsRefundedResponse Message Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 MarkInvoiceAsRefundedResponse Fields Field Description responseEnvelop common ResponseEnvelop Common response information including a timestamp and the response acknowledgement status invoicelD xs string ID of the invoice marked as refunded invoiceNumber xs string Number of the invoice marked as refunded invoiceURL xs string The URL of the details page of the invoice that was marked as refunded Invoicing Service API Guide May 2012 113 MarkInvoiceAsRefunded API Operation PPFault Message PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs ResponseEnvelope E FaultMessage e timestamp 1 1 date
23. en US nvoicelD INV2 RVY 9 UWTW 64HZ BR9W May 2012 Invoicing Service API Guide Invoicing Service API Examples Creating and Sending an Invoice 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 H X PAYPAL H X PAYPAL H X PAYPA ECURITY USERID Your API username ECURITY PASSWORD Your API password ECURITY SIGNATURE Your API signature REQUEST DATA FORMAT NV T H X PAYPAL RESPONSE DATA FORMAT NV H X PAYPAL A requestEnvelop amp invoice merchantl PPLICATION ID Your AppiD https svcs sandbox paypal com Invoice CreateAndSendInvoice rrorLanguage en_US Email merchant 40domain com amp invoice payerEmail jbui amp invoice currencyCode USD amp invoice itemL ist item 0 amp invoice ite L ist item amp invoice ite L ist item ist item amp invoice ite L ist item amp invoice ite m m amp invoice itemL m m L ist item amp invoice paymentT us business2 40paypal com name Banana Leaf 001 description BananatLeaf quantity 1 unitPrice 1 taxName Tax1l taxRate 10 25 rms Net10 amp invoice logoUrl https 3A S2F 2Fwww example com s2FYour_logo jpg
24. message e SearchInvoicesResponse SearchInvoicesResponse e responseEnvelope 1 1 ResponseEnvelope e count 1 1 integer e invoiceList 0 InvoiceSummaryListType e page 1 1 integer e hasNextPage 1 1 boolean e hasPreviousPage 1 1 boolean 90 May 2012 Invoicing Service API Guide e responseEnvelope 1 1 e invoiceList 0 1 e hasNextPage is e hasPreviousPage 1 e count e page E InvoiceSummaryListType sel f invoice 0 InvoiceSummaryType SearchInvoices API Operation EN SearchinvoicesResponse Message SearchInvoicesResponse i ResponseEnvelope 1 1 1 1 1 1 ResponseEnvelope e timestamp 1 1 dateTime integer e ack 1 1 AckCode InvoiceSummaryListType ses e correlationId 1 1 string integer e build 1 1 string boolean 7 any 0 boolean E InvoiceSummaryListType se e invoice 0 InvoiceSummaryType E InvoiceSummaryType e invoicelD 1 1 string Ef merchantEmail 1 1 string E payerEmail 1 1 string number 1 1 string e billingBusinessName 0 1 string e billingFirstName 0 1 string e billingLastName 0 1 string e shippingBusinessName 0 1 string e shippingFirstName 0 1 string e shippingLastName 0 1 string E total Amount 1 1 decimal fe currencyCode 1 1 string e invoiceDate 1 1 dateTime e dueDate 1 1 dateTime fe status 1 1 StatusType Ef origin
25. operation followed by the SendInvoice operation Managing Invoices API Operation Description UpdateInvoice Updates an invoice Get InvoiceDetails 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 E Introduction to the Invoicing Service API IPN Variables for Invoicing API Operations API Operation Description MarkInvoiceAsUnpaid Marks an invoice as unpaid MarkInvoiceAsRefunded Marks an invoice as having been refunded IPN Variables for Invoicing API Operations PayPal sends IPN messages for invoice payments and canceled invoices For more information about IPN see the Instant Payment Notification Guide https cms paypal com cms_content US en_US files developer IPNGuide pdf Invoice Payments mc_gross 37 12 protection_eligibility Eligible address_status confirmed payer_id ABF644D44GSPJ address_street 5656 South Market Street payment_date 15 57 39 Sep 12 2011 PDT payment_status Completed invoice_id INV2 VMYW LOKA OBGC 6YD 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 businessl paypal com address_country United States address_city San Jose verify sign AF
26. returned GetinvoiceDetailsResponse Message e GetInvoiceDetailsResponse GetInvoiceDetailsResponse responseEnvelope 1 1 ResponseEnvelope invoice 1 1 InvoiceType invoiceDetails 1 1 InvoiceDetailsType paymentDetails 0 1 PaymentDetailsType invoiceURL 1 1 string 68 May 2012 Invoicing Service API Guide GetinvoiceDetails API Operation 7 GetinvoiceDetails Response Message E ResponseEnvelope E GetInvoiceDetailsResponse e timestamp 1 1 dateTime ack 1 1 AckCode ees invoiceDetails 1 1 InvoiceDetailsType correlationId 1 1 string build 1 1 string any 0 e responseEnvelope 1 1 ResponseEnvelope e invoice 1 1 InvoiceType paymentDetails 0 1 PaymentDetailsType e invoiceURL 1 1 string ES InvoiceType Ef merchantEmail 1 1 string Ef payerEmail 1 1 string e number 0 1 string LE merchantInfo 0 1 BusinessInfoType E iternList 1 1 InvoiceltemListType Ef currencyCode 1 1 string e invoiceDate 0 1 dateTime Ef dueDate 0 1 dateTime Ef paymentTerms 1 1 PaymentTermsType Ef discountPercent 0 1 decimal E discount mount 0 1 decimal E terms 0 1 string note 0 1 string Ef merchantMemo 0 1 string Ef billinglnfo 0 1 BusinessInfoType LE shippingInfo 0 1 BusinessInfoType Ef shipping mount 0 1 decimal Ef shippingTaxName 0 1 string Ef shippingTaxRate
27. 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 ae Createlnvoice API Operation CreatelnvoiceResponse Message CreatelnvoiceResponse Message The Create InvoiceResponse message contains information returned in response to a CreatelnvoiceRequest message The response contains an invoice ID and the URL to the invoice on the PayPal system responseEnvelope 1 1 invoicelD 1 1 invoiceNumber 1 1 invoiceURL 1 1 total mount 1 1 CreatelnvoiceResponse ResponseEnvelope e timestamp 1 1 dateTime e ack 1 1 AckCode ResponseEnvelope string e correlationId 1 1 string e build 1 1 string FE any 0 string string long ResponseEnvelope Fields Field Description ack build correlationld timestamp common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message xs string Build number It is used only by PayPal Merchant Technical Support xs string Correlation identifier
28. used to display custom amount value If a value is entered for customAmount Label then customAmount Value cannot be empty customAmountValue xs decimal Value of custom amount If a value is entered for customAmountValue then customAmount Label cannot be empty BusinessinfoType Fields Field firstName lastName businessName phone fax website customValue address Description xs string Optional First name of the company contact xs string Optional Last name of the company contact xs string Optional Company business name xs string Optional Phone number for contacting the company xs string Optional Fax number used by the company xs string Optional Website used by the company xs string Optional Custom value to be displayed in the contact information details 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 CreateAndSendinvoice API Operation CreateAndSendinvoiceRequest Message Field Description linel 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 Opt
29. 0 ErrorData ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter ErrorData E ErrorSeverity e errorld long e domain string E ErrorCategory e subdomain 0 1 string e severity ErrorSeverity ErrorParameter name string e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter 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 Cancellnvoice API Operation ER PPFault Message ErrorData Fields Field Description category common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect domain xs string The domain to which this service belongs errorld 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 con
30. 0 1 token e parameter 0 ErrorParameter FaultMessage Fields Field Description error common ErrorData Detailed error information responseEnvelop common ResponseEnvelope Common response information including a timestamp and the response acknowledgement status 108 May 2012 Invoicing Service API Guide MarkinvoiceAsUnpaid API Operation E PPFault Message ErrorData Fields Field Description category common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect domain xs string The domain to which this service belongs errorld 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 e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The o
31. 1 string LE note 0 1 string LE merchantMemo 0 1 string Ef billingInfo 0 1 BusinessInfoType Ef shippinglnfo 0 1 BusinessInfoType Ef shipping mount 0 1 decimal Ef shippingTaxName 0 1 string E shippingTaxRate 0 1 decimal E logoUrl 0 1 string ef referrerCode 0 1 ReferrerCode T any 0 56 May 2012 Invoicing Service API Guide Ef InvoiceType Ef merchantEmail 1 1 string Ef payerEmail 1 1 string Ef number 0 1 string Ef merchantInfo 0 1 BusinessInfoType Ef itemList 1 1 InvoiceltemListType Gi currencyCode 1 1 string e invoiceDate 0 1 dateTime Ef dueDate 0 1 dateTime Gi paymentTerms 1 1 PaymentTermsType fe discountPercent 0 1 decimal Gi discount mount 0 1 decimal E terms 0 1 string Gi note 0 1 string Gi merchantMerno 0 1 string Gi billingInfo 0 1 BusinessInfoType Ef shippingInfo 0 1 BusinessInfoType Ef shipping mount 0 1 decimal Ef shippingTaxName 0 1 string Ef shippingTaxRate 0 1 decimal Ef logoUrl 0 1 string Ef referrerCode 0 1 ReferrerCode j any 0 E InvoiceltemListType ooo e item 1 InvoiceltemType E BusinessInfoType e FirstName 0 1 string e lastName 0 1 string e businessName 0 1 string e phone 0 1 string e Fax 0 1 string e website 0 1 string e customYalue 0 1 string e address 0 1 BaseAddress F any 0
32. InfoType InvoiceltemListType string dateTime dateTime PaymentTermsType decimal decimal string string string BusinessInfoType BusinessInfoType decimal string decimal string ReferrerCode E InvoiceltemListType ceo item 1 InvoiceltemType May 2012 E BusinessInfoType E firstName Ef lastName wd Ef businessName 0 1 Gi phone wl wl string string string string ef fax 1 Ef website wl Ef customValue ad Ef address wl Plany string string string BaseAddress Ej InvoiceltemListType E PaymentTermsType El ReferrerCode E InvoiceltemType e name L e description 0 e date 0 string string dateTime decimal e quantity 1 e unitPrice 1 e taxName 0 decimal string e taxRate 0 1 decimal 7 any o Invoicing Service API Guide GetInvoiceDetails API Operation GetinvoiceDetails Response Message BusinessInfoType BaseAddress e firstName 0 1 string line1 1 string e lastName 0 1 string e linez 1 string e businessName 0 1 string e city 1 string e phone 1 string e state 1 string e Fax 1 string i postalCode 1 string e website 1 string e countryCode 1 1 string e customYalue 1 string e type 1 string e address 1 BaseAddress FE any Fl any st PaymentDetailsType PayPalPaymentDetailsType e viaPayPal 1 1 boolean e
33. PayPal Invoicing Service API Guide 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 L 2449 Luxembourg R C S Luxembourg B 118 349 Consumer advisory The PayPal payment service is regarded as a stored value facility under Singapore law As such it does not require the approval of the Monetary Authority of Singapore You are advised to read the terms and conditions carefully Notice of non liability PayPal Inc is providing the information in this document to you AS IS with all faults PayPal Inc makes no warranties of any kind whether express implied or statutory with respect to the information contained herein PayPal Inc assumes no liability for damages whether direct or indirect caused by errors or omissions or resulting from the use of this document or the information contained in this document or resulting from the application or use of the product or service described herein PayPal Inc rese
34. Request message to mark an invoice as paid e MarkInvoiceAsPaidRequest E MarkInvoiceAsPaidRequest e requestEnvelope 1 1 RequestEnvelope e invoicelD 1 1 string e payment 1 1 OtherPaymentDetailsType RequestEnvelope Fields MarkInvoiceAsPaidRequest e requestEnvelope 1 1 RequestEnvelope e invoicelD 1 1 string e payment 1 1 OtherPaymentDetailsType RequestEnvelope e detailLewel 0 1 DetaillevelCode e errorlanguage 1 1 string Fl any 0 E OtherPaymentDetailsType e method 0 1 PaymentMethodsType e note 0 1 string e date 0 1 dateTime Fany 0 Field Description detailLevel common DetailLevelCode Optional Level of detail required by the client application for components It is one of the following values e ReturnAll This value provides the maximum level of detail default Invoicing Service API Guide May 2012 97 98 MarkinvoiceAsPaid API Operation MarkInvoiceAsPaidRequest Message Field Description errorLanguage xs string Required REC 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 invoicelD xs string Required 1D of the invoice to mark as paid payment inv OtherPaymentDetailsType requestEnvelop Required Details of the payment m
35. Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 ResponseEnvelope Common response information including a timestamp and the response acknowledgement status invoicelD 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 PPFaul
36. Time e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string T any o e responseEnvelope 1 1 ResponseEnvelope e error 0 ErrorData ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter ErrorData E ErrorSeverity e errorld long e domain string E ErrorCategory e subdomain 0 1 string e severity ErrorSeverity ErrorParameter name string e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter FaultMessage Fields Field Description error common ErrorData Detailed error information responseEnvelop common ResponseEnvelope Common response information including a timestamp and the response acknowledgement status 114 May 2012 Invoicing Service API Guide MarkInvoiceAsRefunded API Operation ea PPFault Message ErrorData Fields Field Description category common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect domain xs string The domain to which this service belongs errorld xs long A 6 digit number that unique
37. URE Your API signature X PAYPAL REQUEST DATA FORMAT NV X PAYPAL RESPONSE DATA FORMAT NV X PAYPAL APPLICATION ID Your AppID T https svcs sandbox paypal com Invoice CreateInvoic d requestEnvelope errorLanguage en_US amp invoice merchantEmail merchant 40domain com amp invoice payerEmail jbui us business2 40paypal com amp invoice currencyCode USD amp invoice itemList item 0 name BananatLeaf 001 amp invoice itemList item 0 description Banana Leaf amp invoice itemList item 0 quantity 1 amp invoice itemList item 0 unitPrice 1 amp invoice itemList item 0 taxName Taxl amp invoice itemList item 0 taxRate 10 25 amp invoice paymentTerms Net10 amp invoice logoUrl https 3A 2F 2Fwww example com 2FYour 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 ht d VE amp i 20 rl s insecure X PAYPAL SECURITY USERID Your API username X PAYPAL SECURITY PASSWORD Your API password X PAYPAL SECURITY SIGNATURE Your API signature X PAYPAL REQUEST DATA FORMAT NV X PAYPAL RESPONSE DATA FORMAT NV X PAYPAL APPLICATION ID Your AppID tps svcs sandbox paypal com Invoice SendInvoice T questEnvelope errorLanguage
38. XML Data Formats Header Description X PAYPAL RE QUEST DATA FORMAT X PAYPAL RESPONSE DATA FORMAT The payload format for the request Allowable values are e NV Name value pairs e XML Extensible markup language e JSON JavaScript object notation The payload format for the response Allowable values are e NV Name value pairs e XML Extensible markup language e JSON JavaScript object notation May 2012 Invoicing Service API Guide Invoicing Service API Examples HTTP Headers 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 SOAP 11 value The following is a header example for an Adaptive Payments API call for a SOAP message headers put headers put headers put headers put headers put headers put X PAYPAL SECURITY USERID tok261 biz api abc com X PAYPAL SECURITY PASSWORD 1244612379 X PAYPAL SECURITY SIGNATURE 1kfg9groingghb4uw5 X PAYPAL DEVICE IPADDRESS 168 212 226 204 X PAYPAL MESSAGE PROTOCOL SOAP11 X PAYPAL APPLICATION ID APP 80W284485P519543T AAA Below are the service name port type binding and location for SOAP as defined in the Adaptive Payments WSDL lt wsdl servic
39. ade against this type common requestEnvelop Required Information common to each API operation such as the language in which an error message is returned OtherPaymentDetailsType Fields Field Description method note date 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 e BankTransfer Payment is made by a bank transfer Cash Payment is made in cash Check Payment is made by check CreditCard Payment is made by a credit card DebitCard Payment is made by a debit card Other Payment is made by a method not specified in this list PayPal Payment is made by PayPal WireTransfer Payment is made by a wire transfer xs string Optional Optional note associated with the payment xs dateTime Required Date when the invoice was paid May 2012 Invoicing Service API Guide MarkInvoiceAsPaid API Operation KER MarkInvoiceAsPaidResponse Message MarkinvoiceAsPaidResponse Message The MarkInvoiceAsPaidResponse message marks an invoice as paid MarkInvoiceAsPaidResponse MarkInvoiceAsPaidResponse e responseEnvelope 1 1 ResponseEnvelope e invoicelD 1 1 string e invoiceNumber 1 1 string e invoiceURL 1 1 string ResponseEnvelope Fields Field Description ack common AckCode Acknowledgement code It is one of the following values e
40. age 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 SearchInvoices API Operation EEN PPFault Message ErrorData Fields Field Description category common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect domain xs string The domain to which this service belongs errorld 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 e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed succ
41. ails totalAmount xs long The total amount of the invoice PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvel ope information to your application if an error occurs E ResponseEnvelope FaultMessage e timestamp 1 1 dateTime e ack 1 1 AckCode e responseEnvelope 1 1 ResponseEnvelope e error 0 ErrorData e correlationId 1 1 string e build 1 1 string fe any o ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter Invoicing Service API Guide May 2012 51 52 CreateAndSendinvoice API Operation PPFault Message e errorld e domain e subdomain e severity e category e message e parameter FaultMessage Fields ErrorData e exceptionid 0 1 token E ErrorSeverity long 0 1 string ErrorSeverity ErrorParameter ErrorCategory string 0 ErrorParameter 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 category domain errorld exceptionID message parameter Description common ErrorCateg
42. alse Do not send a copy of the cancelation notification to the merchant default e true Send a copy of the cancelation notification to the merchant CancellnvoiceResponse Message Use the CancelInvoiceResponse message to cancel an invoice CancellnwoiceResponse ResponseEnvelope e invoicelD e invoiceNumber e invoiceURL e responseEnvelope 1 1 ResponseEnvelope e timestamp 1 1 dateTime 1 1 string e ack 1 1 AckCode 1 1 string ses e correlationId 1 1 string 1 1 string e build 1 1 string 7 any 0 Ea CancelInvoiceResponse ResponseEnvelope e responseEnvelope invoicelD e invoiceNumber e invoiceURL 82 1 1 1 1 1 ResponseEnvelope timestamp 1 1 dateTime 1 string e ack 1 1 AckCode string ees e correlationid 1 1 string string e build 1 1 string 7 any 0 May 2012 Invoicing Service API Guide Cancellnvoice API Operation ER Cancellnvoice Response Message ResponseEnvelope Fields Field Description ack common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Me
43. alues e DueOnReceipt Payment is due when the payer receives the invoice e DueOnDateSpecified Payment is due on the date specified in the invoice Net 10 Payment is due 10 days from the invoice date Net 15 Payment is due 15 days from the invoice date Net 30 Payment is due 30 days from the invoice date Net 45 Payment is due 45 days from the invoice date xs decimal Optional Discount percent applied to the invoice xs decimal Optional Discount amount applied to the invoice if any If discountPercent is provided discountAmount is ignored xs string Optional General terms for the invoice xs string Optional Note to the payer company xs string Optional Memo for bookkeeping that is private to the merchant inv BusinessInfoType Optional Billing information for the payer inv BusinessInfoType Optional Shipping information for the payer xs decimal Optional Cost of shipping xs string Optional Name of the applicable tax on shipping cost xs decimal Optional Rate of the applicable tax on shipping cost xs string Optional Complete URL to an external image used as the logo if any xs string Optional Build Notification BN code for tracking transactions with a particular partner Invoicing Service API Guide May 2012 47 CreateAndSendinvoice API Operation CreateAndSendinvoiceRequest Message Field Description customAmount Label xs string Label
44. b87c705a910e 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 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 In
45. cWxV21C7f d0v3bYYYRCpSSR131A23x28hwlOCThw2nNi2s8M1V2010 payer email jbui us personall paypal com txn id 68H067535A2789915 payment_type instant last name Ronald address state CA E 14 May 2012 Invoicing Service API Guide Introduction to the Invoicing Service API ae IPN Variables for Invoicing API Operations receiver email Jbui us businesslftpaypal com payment_fee 1 38 receiver id 9IN3VVZS28ELHL txn type invoice payment mc currency USD residence country US transaction subject Send the Reminder Soon invoice number 0151 payment_gross 37 12 ipn track id ogo4fwr n J7dGNgDiJzqg Canceled Invoices merchant business name Fruits Packaging Inc merchant first name Joan notify version 3 4 txn type invoice payer cancel invoice number 0021 charset windows 1252 payer email jbui us personall paypal com payer last name Bond merchant last name Joan payer first name Henry merchant email Jbui us businesslftpaypal com verify sign AiPC9IBJKCyDFOXbSkoZcggH3hpacAAV9ZVNI GLTI1SsLOHpeeWp3oMQZ invoice id INV2 UHWN STXM 65B7 PT4R ipn track id 2eKZJ cZftAHzSWbsS7qjQ Invoicing Service API Guide May 2012 15 Le Introduction to the Invoicing Service API IPN Variables for Invoicing API Operations 16 May 2012 Invoicing Service API Guide Invoicing Service API Examples You can use the Invoicing Service API to create send update cancel or obtain details of invoices for yo
46. cknowledgement status count xs integer Number of invoices that matched the request invoiceList inv invoiceSummaryList 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 SearchInvoices API Operation EEN SearchinvoicesResponse Message InvoiceSummaryType Fields Field Description invoicelD xs string ID of the invoice merchantEmail xs string Merchant email address payerEmail xs string Payer email address number xs string billingBusinessName billingFirstName billingLastName shippingBusinessName shippingFirstName shippingLastName totalAmount currencyCode invoiceDate dueDate status referrerCode origin Unique identifier for the invoice xs string Company contact information of the merchant company sending the invoice xs string First name of the business information xs string xs string Business name of the shipping information xs string First name of the shipping information xs string Last name of the shipping information xs dec
47. d issues Cancellnvoice API Errors 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 May 2012 Invoicing Service API Guide Searchinvoices API Operation Use the SearchInvoice API operation to search an invoice SearchinvoicesRequest Message Use the SearchInvoiceRequest message to search an invoice e SearchInvoicesRequest SearchInvoicesRequest requestEnvelope 1 1 RequestEnvelope merchantEmail 1 1 string parameters 1 1 SearchParametersType page 1 1 integer pageSize 1 1 integer SearchInvoicesRequest RequestEnvelope e detailLevel 0 1 DetaillevelCode e errorLanguage 1 1 string any 0 SearchParametersType e email 1 string
48. d to the invoice if any If discountPercent is provided discountAmount is ignored xs string Optional General terms for the invoice xs string Optional Note to the payer company xs string Optional Memo for bookkeeping that is private to the merchant inv BusinessInfoType Optional Billing information for the payer inv BusinessInfoType Optional Shipping information for the payer xs decimal Optional Cost of shipping xs string Optional Name of the applicable tax on shipping cost xs decimal Optional Rate of the applicable tax on shipping cost xs string Optional Complete URL to an external image used as the logo if any xs string Optional Build Notification BN code for tracking transactions with a particular partner Invoicing Service API Guide May 2012 29 ae Createlnvoice API Operation CreatelnvoiceRequest Message Field Description customAmount Label xs string Label used to display custom amount value If a value is entered for customAmount Label then customAmount Value cannot be empty customAmountValue xs decimal Value of custom amount If a value is entered for customAmountValue then customAmountLabel cannot be empty BusinessInfoType Fields Field firstName lastName businessName phone fax website customValue address Description xs string Optional First name of the company contact xs string Optional Last name of the co
49. 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 MarkInvoiceAsPaid API Errors Code Message Additional Information 520002 Internal error 102 May 2012 Invoicing Service API Guide MarkinvoiceAsPaid API Operation MarkInvoiceAsPaid API Errors Code Message Additional Information 520005 520009 550026 550027 570058 570065 570066 580022 580047 Authentication failed API credentials are incorrect Account is restricted 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 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 Invalid token Invoice cannot be marked as paid since it has already been paid The payment method of the invoice is invalid This error code corresponds to validation error messages that deal with errors of supplied parameters Invoice does not exist Invoicing Service API Guide May 2012 103 MarkinvoiceAsPaid API Operation MarkInvoiceAsPaid API Errors
50. e g PaymentTermsType E ReferrerCode E InvoiceltemType e name 1 1 string e description 0 1 string e date 0 1 dateTime e quantity 1 1 decimal e unitPrice 1 1 decimal e taxName 0 1 string e taxRate 0 1 decimal 7 any 0 E BaseAddress e line1 1 1 string e line2 0 1 string e city 1 1 string e state 0 1 string postalCode 0 1 string e countryCode 1 1 string e type 0 1 string FE any 0 27 me Createlnvoice API Operation CreatelnvoiceRequest Message RequestEnvelope Fields Field Description detailLevel common DetailLevelCod Optional Level of detail required by the client application for components It is one of the following values e ReturnAll 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 CreatelnvoiceRequest Fields Field Description invoice requestEnvelop inv InvoiceType Required Merchant payer and invoice information common requestEnvelop 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
51. e paymentTerms Eli PaymentTermsType e discountPercent 0 1 decimal e discountAmount 0 1 decimal e terms 0 1 string e note 0 1 string merchantMemo 0 1 string e billingInfo 0 1 BusinessInfoType e shippingInfo 0 1 BusinessInfoType e shipping mount 0 1 decimal e shippingTaxName 0 1 string e shippingTaxRate 0 1 decimal e logourl 0 1 string 7j any 0 44 May 2012 Invoicing Service API Guide ES InvoiceType Ef merchantEmail 1 1 string Ef payerEmail 1 1 string Ef number 0 1 string Ef merchantInfo 0 1 BusinessInfoType Ef itemList 1 1 InvoiceltemListType Gi currencyCode 1 1 string e invoiceDate 0 1 dateTime Ef dueDate 0 1 dateTime Gi paymentTerms 1 1 PaymentTermsType fe discountPercent 0 1 decimal Gi discount mount 0 1 decimal E terms 0 1 string Gi note 0 1 string Gi merchantMerno 0 1 string Gi billingInfo 0 1 BusinessInfoType Ef shippingInfo 0 1 BusinessInfoType Ef shipping mount 0 1 decimal Ef shippingTaxName 0 1 string Ef shippingTaxRate 0 1 decimal Ef logoUrl 0 1 string Ef referrerCode 0 1 ReferrerCode j any 0 E InvoiceltemListType se el item 1 InvoiceltemType E BusinessInfoType e FirstName 0 1 string e lastName 0 1 string e businessName 0 1 string e phone 0 1 string e Fax 0 1 string e websi
52. e 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 documentat ionfeedback paypal com Invoicing Service API Guide May 2012 a Documentation Feedback 10 May 2012 Invoicing Service API Guide 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 Dr Request Createlnvoice ia 2 jum Response Merchant PayPal Server Request gt API Server Sendinvoice B Send Response mmm Legend gt APICall gt Send email am Web Flow 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 Createlnvoice endpoint 2 Examine the response and verify that the ACK field contains SUCCESS 3 Using the invoice ID in the response create a SendInvoi ce request and send it to the https svcs paypal com Invoice SendInvoice endpoint 4 Examine the response and verify that the ACK field contains SUCCESS NOTE You can combine the creation and transmission of an invoice in t
53. e currently supported CreateAndSendinvoiceRequest Fields Field Description requestEnvelope common requestEnvelop 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 merchant Info inv BusinessInfoType Company contact information of the merchant company sending the invoice 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 CreateAndSendinvoice API Operation CE CreateAndSendinvoiceRequest Message Field Description dueDate payment Terms discountPercent discountAmount terms note merchantMemo billingInfo shippingInfo shippingAmount shippingTaxName shippingTaxRate logoURL ReferrerCode xs dateTime Optional Date on which the invoice payment is due inv PaymentTermsType Required Terms by which the invoice payment is due It is one of the following v
54. e name AdaptivePayments gt lt wsdl port name AdaptivePaymentsSOAP11 http lt binding services AdaptivePayment sSOAP11Binding gt lt soap address location https svcs paypal com AdaptivePayments gt Specifying Application and Device Information You also must identify the application You can optionally 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 must 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 Clients 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 Creating an Invoice Creating an Invoice Invoice This example shows how to create an invoice using Create rl s insecure X PAYPAL SECURITY USERID Your API username X PAYPAL SECURITY PASSWORD Your API password X PAYPAL SECURITY SIGNAT
55. ed only by PayPal Merchant Technical Support Invoicing Service API Guide May 2012 41 42 Sendinvoice API Operation Send Invoice API Errors Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 Send Invoice API Errors 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 bee
56. eptionId 0 1 token e parameter 0 ErrorParameter ErrorData E ErrorSeverity e errorld long e domain string E ErrorCategory e subdomain 0 1 string e severity ErrorSeverity ErrorParameter name string e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter 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 FE Updatelnvoice API Operation PPFault Message ErrorData Fields Field Description category domain errorld exceptionID message parameter severity subdomain common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect xs string The domain to which this service belongs xs long A 6 digit number that uniquely identifies a particular error This field is not used xs string A description of the error common ErrorParameter Represents contextual information about the error common ErrorSeverity The severity of the error encountered Possible values are e Erro
57. equest Message Use the SendInvoiceRequest message to send an invoice to a payer and notify the payer of the pending invoice e SendInvoiceRequest SendInvoiceRequest e requestEnvelope 1 1 RequestEnvelope E invoicelD 1 1 string SendinvoiceRequest RequestEnvelope e requestEnvelope 1 1 RequestEnvelope le detailLevel 0 1 DetaillevelCode e invoicelD 1 1 string s e erorlanguage 1 1 string F any 0 RequestEnvelope Fields Field Description detailLevel common DetailLevelCode Optional Level of detail required by the client application for components It is one of the following values e ReturnAll 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 4 Sendinvoice API Operation SendinvoiceResponse Message SendinvoiceRequest Fields The table below lists the fields for the SendInvoiceRequest message Field Description requestEnvelope common requestEnvelope Required Information common to each API operation such as the language in which an error message is returned invoicelD xs string Required 1D of the invoice to send SendinvoiceResponse Message The SendInvoiceResponse message contains information returned in response to a SendInvoiceReq
58. erPaymentRefundDetailsType Required Details of the refund made against this invoice Invoicing Service API Guide May 2012 111 ae MarkInvoiceAsRefunded API Operation MarkInvoiceAsRefundedResponse Message Field Description requestEnvelope common requestEnvelope Required Information common to each API operation such as the language in which an error message is returned OtherRefundDetailsType Fields Field Description note date xs string Optional Optional note associated with the refund xs dateTime Required Date when the invoice was marked as refunded MarkInvoiceAsRefundedResponse Message MarkInvoiceAsRefundedResponse The MarkInvoiceAsRefundedResponse message marks an invoice as refunded E MarkInvoiceAsRefundedResponse e responseEnvelope 1 1 ResponseEnvelope e invoicelD 1 1 string e invoiceNumber 1 1 string e invoiceURL 1 1 string ResponseEnvelope Fields Field Description ack build common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message xs string Build number It is used only by PayPal Merchant Technical Support 112 May 2012
59. ervice API Guide May 2012 35 Createlnvoice API Operation Createlnvoice API Errors Createlnvoice API Errors Code Message Additional Information 520002 520005 520009 570045 570046 570047 570048 570049 570050 570051 570054 570058 570059 580022 580045 580046 Internal error Authentication failed API credentials are incorrect Account is restricted The number of items exceeds this allowed limit The due date occurs before the invoice date The invoice date is earlier than todays date 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 The total amount for the invoice cannot be negative 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 Invoice cannot have more than 10 different taxes Invalid token Invalid token Invoice number is too long This error code corresponds to validation error messages that deal with errors of supplied parameters Merchant does not have a PayPal account associated with this email address An invoice already exists for the merchant with this invoice number 36 May 2012 Invoicing Service API Guide Sendinvoice API Operation Use the SendInvoice API operation to send an invoice to a payer and notify the payer of the pending invoice SendinvoiceR
60. escription responseEnvelop common ResponseEnvelop Common response information including a timestamp and the response acknowledgement status invoicelD 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 4 Sendinvoice API Operation PPFault Message PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs ResponseEnvelope FaultMessage e timestamp 1 1 dateTime e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string T any o e responseEnvelope 1 1 ResponseEnvelope e error 0 ErrorData ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter ErrorData E ErrorSeverity e errorld long e domain string E ErrorCategory e subdomain 0 1 string e severity ErrorSeverity ErrorParameter name string e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter FaultMessage Fields Field Description error common ErrorData Detailed error information responseEnvelope common ResponseEnvelope Common response i
61. essfully however there is a warning message e FailureWithWarning 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 Searchinvoices API Errors Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 Searchinvoices API Errors 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 Use the MarkInvoiceAsPaid API operation to mark an invoice as paid MarkInvoiceAsPaidRequest Message Use the MarkInvoiceAsPaid
62. g Service API Guide Introduction to the Invoicing Service API A 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 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 Createlnvoice 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
63. he invoice taxName xs string Optional Name of the applicable tax taxRate xs decimal Optional Rate of the applicable tax UpdatelnvoiceResponse Message The Update InvoiceResponse message contains information returned in response to an UpdateInvoiceRequest message CreatelnvoiceResponse ResponseEnvelope responseEnvelope 1 1 ResponseEnvelope e timestamp 1 1 dateTime invoicelD 1 1 string e ack 1 1 AckCode invoiceNumber 1 1 string invoiceURL 1 1 string total mount 1 1 long e correlationld 1 1 string e build 1 1 string FE any 0 Invoicing Service API Guide May 2012 61 62 Updatelnvoice API Operation UpdatelnvoiceResponse Message ResponseEnvelope Fields Field Description ack build correlationId timestamp common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message xs string Build number It is used only by PayPal Merchant Technical Support xs string Correlation identifier It is a 13 character alphanumeric string for example db87c705a910e that is used only by PayPal Merchant Technical Support NOTE You must log and store this data for every
64. he same request which is CreateAndSend After you create the request send it to the https svcs paypal com Invoice CreateAndSendInvoice endpoint Invoicing Service API Guide May 2012 11 ES Introduction to the Invoicing Service API 5 Ifthe SendInvoice request was successful PayPal sends an invoice by email to the payer whose email you specified in the CreateInvoice or CreateAndSendInvoice request 12 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 Fruits Packaging Inc Joan Hoang Invoice number 3434 North Second Street San Jose 95131 Invoice date 8 22 2011 United States Payment terms Net 10 Phone 408 967 2020 Fax 408 967 2020 Due date 9 1 2011 jbui us business1 paypal com www FruitsPackagingINc com Bill To Ship To jbui unilateral1 paypal com Selling Fruits DEF packaging Inc James Smith 5656 South Market Street San Jose CA 95131 United States Date Description Quantity Unit price Amount 8 9 2011 Washington Apple Apple From Washington State 1 41 25 41 25 Terms and conditions Subtotal 41 25 Agree To Pay Discount 4 13 Note to recipient Pay Now Total 37 12 USD May 2012 Invoicin
65. hen customAmount Value cannot be empty customAmountValue xs decimal Value of custom amount If a value is entered for customAmountValue then customAmount Label cannot be empty BusinessinfoType Fields Field Description firstName xs string 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 used 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 InvoiceltemType Fields Field Description item inv InvoiceItemType Required Invoice item May 2012 Invoicing Service API Guide Updatelnvoice API Operation ae Updatelnvoice Response Message InvoiceltemType 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 O to 10 000 unitPrice xs decimal Required Price of the item in the currency specified by t
66. ice they did not create an invoice can only be accessed or modified by the party who created it Invalid token Invoice must be marked as paid before it can be marked as unpaid This error code corresponds to validation error messages that deal with errors of supplied parameters Invoice does not exist 110 May 2012 Invoicing Service API Guide MarkinvoiceAsRefunded APl Operation Use the MarkInvoiceAsRefunded API operation to mark an invoice as refunded This API operation can only be used for full refunds MarkinvoiceAsRefundedRequest Message Use the MarkInvoiceAsRefundedRequest message to mark an invoice as refunded MarkInvoiceAsRefundedRequest E MarkInvoiceAsRefundedRequest requestEnvelope 1 1 RequestEnvelope 6 invoicelD 1 1 string Ef refundDetail 1 1 OtherPaymentRefundDetailsType RequestEnvelope Fields Field Description detailLevel common DetailLevelCode Optional Level of detail required by the client application for components It is one of the following values e ReturnAll 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 MarkInvoiceAsRefundedRequest Fields Field Description invoicelD xs string Required 1D of the invoice to mark as refunded refundDetail inv Oth
67. imal Total amount of the invoice xs string Currency used for all invoice item amounts and totals xs dateTime Date on which the invoice is enabled xs dateTime Date on which the invoice payment is due xs statusType Status of the invoice xs string Build Notification BN code for tracking transactions with a particular partner inv originType Indicates whether the invoice was created by the website or by an API call Invoicing Service API Guide May 2012 93 ES Searchinvoices API Operation PPFault Message PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs ResponseEnvelope FaultMessage e timestamp 1 1 dateTime e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string T any o e responseEnvelope 1 1 ResponseEnvelope e error 0 ErrorData ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter ErrorData E ErrorSeverity e errorld long e domain string E ErrorCategory e subdomain 0 1 string e severity ErrorSeverity ErrorParameter name string e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter FaultMess
68. ional Type of address InvoiceltemListType Fields Field Description item inv InvoiceItemType Required Invoice item InvoiceltemType 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 Les CreateAndSendinvoice API Operation CreateAndSendinvoiceResponse Message CreateAndSendinvoiceResponse Message The CreateAndSendInvoiceResponse 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 e CreateAndSendInvoiceResponse CreateAndSendInvoiceResponse responseEnvelope 1 1 ResponseEnvelope invoicelD 1 1 string invoiceNumber 1 1 string invoiceURL 1 1 string total mount 1 1 long ResponseEnvelope Fields Field Description ack common AckCode Ackno
69. ly 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 e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning 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 115 MarkInvoiceAsRefunded API Operation MarkInvoiceAsRefunded API Errors Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 se
70. mpany contact xs string Optional Company business name xs string Optional Phone number for contacting the company xs string Optional Fax number used by the company xs string Optional Website used by the company xs string Optional Custom value to be displayed in the contact information details 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 Createlnvoice API Operation EN CreatelnvoiceRequest Message Field Description linel 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 InvoiceltemListType Fields Field Description item inv InvoiceItemType Required Invoice item InvoiceltemType 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
71. n 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 May 2012 Invoicing Service API Guide CreateAndSendinvoice API 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 e CreateAndSendInvoiceRequest CreateAndSendInvoiceRequest e requestEnvelope 1 1 RequestEnvelope E invoice 1 1 InvoiceType Invoicing Service API Guide May 2012 43 CreateAndSendinvoice API Operation CreateAndSendinvoiceRequest Message E CreateAndSendInvoiceRequest E RequestEnvelope e requestEnvelope 1 1 RequestEnvelope e detailLevel 0 1 DetaillevelCode e invoice 1 1 InvoiceType ees e errorLanguage 1 1 string Ej any o E InvoiceType e merchantEmail 1 string e payerEmail 1 1 string e number 0 1 string e merchantinfo 0 1 BusinessInfoType e itemList ll InvoiceltemListType e currencyCode 1 1 string e invoiceDate 0 1 dateTime e dueDate 0 1 dateTime
72. nformation including a timestamp and the response acknowledgement status 40 May 2012 Invoicing Service API Guide Sendinvoice API Operation ES PPFault Message ErrorData Fields Field Description category common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect domain xs string The domain to which this service belongs errorld 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 e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is us
73. nical 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 520009 550026 550027 570058 580022 580047 Authentication failed API credentials are incorrect Account is restricted 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 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 Invalid token This error code corresponds to validation error messages that deal with errors of supplied parameters Invoice does not exist Invoicing Service API Guide May 2012 79 GetInvoiceDetails API Operation GetinvoiceDetails API Errors 80 May 2012 Invoicing Service API Guide Cancellnvoice API Operation Use the CancelInvoice API operation to cancel an invoice CancellnvoiceRequest Message Use the Cancel InvoiceRequest message to cancel an invoice e CancelInvoiceRequest CancelInvoiceRequest requestEnvelope 1 RequestEnvelope invoicelD 0 1 string subject 0 1 string noteForPayer 0 string sendCopyToMerchant
74. nical Support uses the information to assist with reported issues MarkinvoiceAsUnpaidResponse Fields Field Description responseEnvelop invoicelD invoiceNumber invoiceURL common ResponseEnvelop Common response information including a timestamp and the response acknowledgement status xs string ID of the invoice marked as unpaid xs string Number of the invoice marked as unpaid xs string URL location where merchants view the invoice details Invoicing Service API Guide May 2012 107 MarkInvoiceAsUnpaid API Operation PPFault Message PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs ResponseEnvelope E FaultMessage e timestamp 1 1 dateTime e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string T l any o e responseEnvelope 1 1 ResponseEnvelope e error 0 ErrorData ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter ErrorData E ErrorSeverity e errorld long e domain string E ErrorCategory e subdomain 0 1 string e severity ErrorSeverity ErrorParameter name string e category ErrorCategory e message string e exceptionId
75. nt 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 MarkinvoiceAsRefunded API Errors 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 570080 Invoice must be marked as paid before it can be marked as refunded 570081 Refund date must occur after payment date 580022 This error code corresponds to validation error messages that deal with errors of supplied parameters 580047 Invoice does not exist 116 May 2012 Invoicing Service API Guide Revision History The revision history identifies changes to the PayPal Invoicing Service documentation at a high level Date Description 05 22 2012 Added two new APIs MarkInvoiceAsUnpaid MarkInvoiceAsRefunded 01 24 2012 Clarified use of and examples for image URL 09 19 2011 Initial release draft Invoicing Service API Guide May 2012 117 118 May 2012 Invoicing Service API G
76. nvoiceRequest 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 e CreateInvoiceRequest CreateInvoiceRequest e requestEnvelope 1 1 RequestEnvelope Ef invoice 1 1 InvoiceType Invoicing Service API Guide May 2012 25 26 Createlnvoice API Operation CreatelnvoiceRequest Message E CreateInvoiceRequest e requestEnvelope 1 1 RequestEnvelope E invoice 1 1 InvoiceType May 2012 E RequestEnvelope e detailLewel 0 1 DetaillevelCode ss e errorlanguage 1 1 string FE any 0 E InvoiceType fe merchantEmail Gi payerEmail Ef number Ef merchantInfo Ef itemList Ef currencyCode e invoiceDate E dueDate Ef paymentTerms fe discountPercent fe discount mount Ef terms fe note ci merchantMemo Ef billingInfo Gi shippingInfo E shipping mount Gi shippingTaxMarne Gi shippingTaxRate Gi logoUrl LE referrerCode fl any 1 1 1 1 0 1 0 1 1 1 1 1 0 1 0 1 1 1 ET ET 1 En 1 1 1 gi ET 0 1 0 1 0 1 0 string string string BusinessInfoType InvoiceltemListType string dateTime dateTime PaymentTermsType decirnal decimal string string string BusinessInfoType BusinessInfoType decimal string decimal string ReferrerCode Invoicing Ser
77. ode 1 string 1 string ErrorData e errorld e domain e severity e category e message long string e subdomain 0 1 string ErrorSeverity ErrorCategory string e exceptionId 0 1 token e parameter 0 ErrorParameter May 2012 Invoicing Service API Guide e errorld e domain e subdomain e severity e category e message e exceptionId 0 1 token e parameter FaultMessage Fields ErrorData GetinvoiceDetails API Operation PPFault Message E ErrorSeverity long 0 1 string ErrorSeverity ErrorParameter ErrorCategory string 0 ErrorParameter 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 category domain errorld exceptionID message parameter Description common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect xs string The domain to which this service belongs xs long A 6 digit number that uniquely identifies a particular error This field is not used xs string A description of the err
78. ogoUrl https 3A 2F 2Fwww example comS2FYour_logo jpg Obtaining Invoice Details This example shows how to obtain invoice details using Get InvoiceDetails curl s insecure H X PAYPAL SECURITY USERID Your API username H X PAYPAL SECURITY PASSWORD Your API password H X PAYPAL SECURITY SIGNATURE Your API signature H X PAYPAL R EQUEST DATA FORMAT NV H X PAYPAL RESPONSE DATA FORMAT NV H X PAYPAL APPLICATION ID Your AppiD https svcs sandbox paypal com Invoice GetInvoiceDetails q requestEnvelope detailLevel ReturnAll amp requestEnvelope errorLanguage en_US amp 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 May 2012 Invoicing Service API Guide Invoicing Service API Examples Searching for Invoices curl s insecure H X PAYPAL SECURITY USERID Your API username H X PAYPAL SECURITY PASSWORD Your API password H X PAYPAL SECURITY SIGNATURE Your API signature H X PAYPAL REQUEST DA TA FORMAT NV H X PAYPAL RESPONSE DATA FORMAT NV H X PAYPAL APPLICATION ID Your AppiD https sandbox svcs paypal com Invoice CancelInvoice d requestEnvelope errorLanguage en_US amp invoiceID INV2 RVY9 UWTW 64HZ BR9W amp subject Cancel it amp noteForPayer Cancel it now amp sendCopyToMerchant true
79. oice payment is due It is one of the following values e DueOnReceipt Payment is due when the payer receives the invoice e DueOnDateSpecified Payment is due on the date specified in the invoice e Net 10 Payment is due 10 days from the invoice date e Net15 Payment is due 15 days from the invoice date e Net 30 Payment is due 30 days from the invoice date e Net 45 Payment is due 45 days from the invoice date discountPercent xs decimal Discount percent applied to the invoice discountAmount xs decimal Discount amount applied to the invoice if any If discountPercent 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 BusinessInfoType Billing information for the payer shippingInfo inv BusinessInfoType 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 74 GetinvoiceDetails API Operation GetinvoiceDetails Response 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
80. or common ErrorParameter Represents contextual information about the error Invoicing Service API Guide May 2012 77 7 GetinvoiceDetails API Operation GetinvoiceDetails API Errors Field Description severity common ErrorSeverit y The severity of the error encountered Possible values are e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 Tech
81. ory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect xs string The domain to which this service belongs xs long A 6 digit number that uniquely identifies a particular error This field is not used xs string A description of the error common ErrorParameter Represents contextual information about the error May 2012 Invoicing Service API Guide CreateAndSendinvoice API Operation CreateAndSendinvoice API Errors Field Description severity common ErrorSeverity The severity of the error encountered Possible values are e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example d
82. otherPayment inv OtherPaymentDetailsType 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 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 e BankTransfer Payment is made by a bank transfer Cash Payment is made in cash Check Payment is made by check CreditCard Payment is made by a credit card DebitCard Payment is made by a debit card Other Payment is made by a method not specified in this list PayPal Payment is made by PayPal WireTransfer 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 ResponseEnvel ope information to your application if an error occurs FaultMessage e responseEnvelope 1 1 ResponseEnvelope e timestamp Elo e error 0 ErrorData e ack 1 e correlationId 1 e build dis 7 any 0 76 ResponseEnvelope 1 dateTime 1 AckC
83. paidResponse Message The MarkInvoiceAsUnpaidResponse message marks an invoice as unpaid e MarkInvoiceAsUnpaidResponse E MarkInvoiceAsUnpaidResponse responseEnvelope 1 1 ResponseEnvelose e invocelD 1 1 string el invoiceNumber 1 11 string invoceURL 1 1 string ResponseEnvelope Fields Field Description ack build correlationId common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message xs string Build number It is used only by PayPal Merchant Technical Support xs string Correlation identifier It is a 13 character alphanumeric string for example 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 106 May 2012 Invoicing Service API Guide MarkInvoiceAsUnpaid API Operation MarkInvoiceAsUnpaidResponse 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 Tech
84. peration failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning 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 109 mal MarkInvoiceAsUnpaid API Operation MarkInvoiceAsUnpaid API Errors Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 MarkInvoiceAsUnpaid API Errors Code Message Additional Information 520002 520005 520009 550026 550027 570058 570079 580022 580047 Internal error Authentication failed API credentials are incorrect Account is restricted 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 Merchant cannot access or modify an invo
85. pport uses the information to assist with reported issues GetinvoiceDetailsResponse Fields Field Description responseEnvelop common ResponseEnvelop 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 merchant Info inv BusinessInfoType Company contact information of the merchant company sending the invoice 72 May 2012 Invoicing Service API Guide GetinvoiceDetails API Operation GetinvoiceDetails Response Message Field Description itemList inv InvoiceltemListType 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 PaymentTermsType Terms by which the inv
86. r Processing of the request was interrupted e Warning Processing of the request was completed This field is not used ResponseEnvelope Fields Field Description ack common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning 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 Updatelnvoice API Operation Updatelnvoice API Errors Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 Updatelnvoice API Errors Code Message Additional Information 520002 Internal error 520005 Authentication failed API c
87. rchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 CancellnvoiceResponse Fields Field Description responseEnvelop common ResponseEnvelop Common response information including a timestamp and the response acknowledgement status invoicelD 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 8 Cancellnvoice API Operation PPFault Message PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvel ope information to your application if an error occurs ResponseEnvelope FaultMessage e timestamp 1 1 dateTime e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string T any o e responseEnvelope 1 1 ResponseEnvelope e error
88. redentials 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 66 Updatelnvoice API Operation Updatelnvoice 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 exis
89. request field 30 48 60 lastSentBy response field 75 lastSentDate response field 75 lastUpdatedBy response field 74 lastUpdatedDate response field 74 linel response field 31 49 line2 response field 31 49 logoURL request field 29 47 59 60 logoURL response field 74 93 lowerAmount request field 89 memo request field 89 merchantEmail request field 28 46 58 88 merchantEmail response field 72 93 merchantInfo request field 28 46 58 merchantInfo response field 72 merchantMemo request field 29 47 59 merchantMemo response field 73 message field 34 41 52 64 77 85 95 101 109 115 method request field 76 98 120 May 2012 N name request field 31 49 61 note request field 29 47 59 76 98 112 note response field 73 noteForPayer request field 82 number request field 28 46 58 number response field 72 93 O origin request field 89 origin response field 74 93 otherPayment response field 75 P page request field 89 page response field 92 pageSize request field 89 paidDate response field 75 parameter field 34 41 52 64 77 85 95 101 109 115 parameters request field 88 payerEmail request field 28 46 58 payerEmail response field 72 93 payment request field 98 111 paymentDate request field 90 paymentDetails response field 72 paymentTerms request field 29 47 59 paymentTerms response field 73 paypalPayment response field 75 phone request field 30 48 60 PPFault message 33 40 51
90. response you receive PayPal Technical Support uses the information to assist with reported issues 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 UpdatelnvoiceResponse Fields Field Description responseEnvelop invoiceld invoiceNumber invoiceURL totalAmount common ResponseEnvelop Common response information including a timestamp and the response acknowledgement status xs string ID of the updated invoice xs string Invoice number of the updated invoice xs string URL location where merchants view the updated invoice details xs long The total amount of the invoice May 2012 Invoicing Service API Guide Updatelnvoice API Operation CN PPFault Message PPFault Message The PPFaultMessage returns ErrorData and the ResponseEnvelope information to your application if an error occurs ResponseEnvelope FaultMessage e timestamp 1 1 dateTime e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string T any o e responseEnvelope 1 1 ResponseEnvelope e error 0 ErrorData ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exc
91. rves the right to make changes to any information herein without further notice Preface Chapter Chapter Contents Documentation Feedback 1 Introduction to the Invoicing Service API Sending Invoices on Behalf of a Merchant Invoicing Service API Operations Creating and Sending Invoices Managing Invoices IPN Variables for Invoicing API Operations Invoice Payments Canceled Invoices 2 Invoicing Service API Examples HTTP Headers Authentication 6 60 doe dR ae be e Rat HN RER EEE Specifying JSON NVP or XML Data Formats SOAP Messages Specifying Application and Device Information Creating an Invoice Sending an Invoice Creating and Sending an Invoice Updating an Invoice Obtaining Invoice Details Canceling an Invoice Searching for Invoices Chapter 3 Createlnvoice API Operation CreatelnvoiceRequest Message RequestEnvelope Fields CreatelnvoiceReques
92. se field 73 discouontAmount request field 29 47 59 discouontPercent request field 29 47 59 domain field 34 41 52 64 77 85 95 101 109 115 dueDate request field 29 47 59 90 dueDate response field 73 93 E email request field 89 endDate request field 90 error PPFault field 34 40 52 63 77 84 94 101 108 114 ErrorData fields 34 41 52 64 77 85 95 101 109 115 errorld field 34 41 52 64 77 85 95 101 109 115 errorLanguage request field 28 37 46 58 67 81 88 98 105 111 exceptionID field 34 41 52 64 77 85 95 101 109 115 F FaultMessage PPFault fields 34 40 52 63 77 84 94 101 108 114 fax request field 30 48 60 firstName request field 30 48 60 firstSentDate response field 74 H hasNextPage response field 92 hasPreviousPage response field 92 May 2012 119 invoice request field 58 invoice response field 72 92 invoiceDate request field 28 46 59 90 invoiceDate response field 73 93 invoiceDetails response field 72 invoicelD request field 38 58 68 82 98 106 111 invoiceID response field 33 39 51 62 83 93 100 107 113 invoiceList response field 92 invoiceNumber request field 89 invoiceNumber response field 33 51 62 83 100 107 113 InvoiceType 28 46 invoiceURL response field 33 39 51 62 72 83 100 107 113 item request field 31 49 60 itemList request field 28 46 58 itemList response field 73 L lastName
93. t May 2012 Invoicing Service API Guide GetinvoiceDetails API Operation 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 e GetInvoiceDetailsRequest GetInvoiceDetailsRequest e requestEnvelope 1 1 RequestEnvelope invoicelD 1 1 string GetInvoiceDetailsRequest RequestEnvelope requestEnvelope 1 1 RequestEnvelope e detailLevel 0 1 DetaillevelCode invoicelD 1 1 string se e errorLanquage 1 1 string F any 0 RequestEnvelope Fields Field Description detailLevel common DetailLevelCode Optional Level of detail required by the client application for components It is one of the following values e ReturnAl1 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 GetInvoiceDetailsResponse Message GetinvoiceDetailsRequest Fields Field Description invoicelD xs string Required 1D of the invoice to retrieve requestEnvelope common requestEnvelope Required Information common to each API operation such as the language in which an error message is
94. t Fields InvoiceType Fields BusinessinfoType Fields Invoicing Service API Guide May 2012 11 13 13 13 13 14 14 15 17 17 17 18 19 19 20 20 21 21 22 22 23 FR Contents BaseAddress Fields 30 InvoiceltemListType Fields 31 InvoiceltemType Fields 31 CreatelnvoiceResponse Message 32 ResponseEnvelope Fields 32 CreatelnvoiceResponse Fields 33 PPEault Message 33 FaultMessage Fields 34 ErrorData Fields s som 44 howe 0004 pee mot AA A 34 ResponseEnvelope Fields 35 Createlnvoice API Errors o oo 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 2 24 22 ses RM PDS a a AAA es 40 FaultMessage Fields 2 2
95. tMessage returns ErrorData and the ResponseEnvel ope information to your application if an error occurs FaultMessage ResponseEnvelope e responseEnvelope 1 1 ResponseEnvelope e timestamp 1 1 dateTime e error 0 ErrorData e ack 1 1 AckCode e correlationId 1 1 string e build 1 1 string fe any 0 ErrorData e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter 100 May 2012 Invoicing Service API Guide e errorld e domain e subdomain e severity e category e message e exceptionId 0 1 token e parameter FaultMessage Fields ErrorData MarkinvoiceAsPaid API Operation PPFault Message E ErrorSeverity long 0 1 string ErrorSeverity ErrorParameter ErrorCategory string 0 ErrorParameter 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 category domain errorld exceptionID message parameter Description common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors
96. ta e errorld long e domain string e subdomain 0 1 string e severity ErrorSeverity e category ErrorCategory e message string e exceptionId 0 1 token e parameter 0 ErrorParameter Invoicing Service API Guide May 2012 33 34 Createlnvoice API Operation PPFault Message e errorld e domain e severity e category e message FaultMessage Fields ErrorData e subdomain e exceptionid 0 1 token e parameter E ErrorSeverity long 0 1 string ErrorSeverity ErrorParameter ErrorCategory string 0 ErrorParameter 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 category domain errorld exceptionID message parameter Description common ErrorCategory The location where the error occurred Possible values are e System The system encountered errors try again e Application The application encountered errors try again e Request The request was incorrect xs string The domain to which this service belongs xs long A 6 digit number that uniquely identifies a particular error This field is not used xs string A description of the error common ErrorParameter Represents contextual informa
97. te 0 1 string e customYalue 0 1 string e address 0 1 BaseAddress F any 0 Invoicing Service API Guide May 2012 CreateAndSendinvoice API Operation CN CreateAndSendinvoiceRequest Message ES BusinessInfoType E firstName wl string fe lastName wl string Ef businessName 0 1 string Gi phone 1 string Ef fax wl string Ef website 1 string Gi customValue wl string Ef address 1 BaseAddress Plany E InvoiceltemListType g PaymentTermsType E ReferrerCode E InvoiceltemType e name 1 1 string e description 0 1 string e date 0 1 dateTime e quantity 1 1 decimal e unitPrice 1 1 decimal e taxName 0 1 string e taxRate 0 1 decimal 7 any 0 E BaseAddress e line1 1 1 string e line2 0 1 string e city 1 1 string e state 0 1 string postalCode 0 1 string e countryCode 1 1 string e type 0 1 string FE any 0 45 E CreateAndSendinvoice API Operation CreateAndSendinvoiceRequest Message RequestEnvelope Fields Field Description detailLevel common DetailLevelCod Optional Level of detail required by the client application for components It is one of the following values e ReturnAll 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 languag
98. teSpecified Payment is due on the date specified in the invoice Net 10 Payment is due 10 days from the invoice date Net 15 Payment is due 15 days from the invoice date Net 30 Payment is due 30 days from the invoice date Net 45 Payment is due 45 days from the invoice date xs decimal Optional Discount percent applied to the invoice xs decimal Optional Discount amount applied to the invoice if any If discountPercent is provided discountAmount is ignored xs string Optional General terms for the invoice xs string Optional Note to the payer company xs string Optional Memo for bookkeeping that is private to the merchant inv BusinessInfoType Optional Billing information for the payer inv BusinessInfoType Optional Shipping information for the payer xs decimal Optional Cost of shipping xs string Optional Name of the applicable tax on shipping cost xs decimal Optional Rate of the applicable tax on shipping cost xs string Optional Complete URL to an external image used as the logo if any Invoicing Service API Guide May 2012 59 60 Updatelnvoice API Operation UpdatelnvoiceRequest Message Field Description ReferrerCode xs string Optional Build Notification BN code for tracking transactions with a particular partner customAmount Label xs string Label used to display custom amount value If a value is entered for customAmount Label t
99. textual information about the error severity common ErrorSeverity The severity of the error encountered Possible values are e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning 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 86 Cancellnvoice API Operation Cancellnvoice API Errors Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 reporte
100. 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 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 by a key must be owned by the subject granting the third party permission Specifying JSON NVP or XML Data Formats Use the HTTP header X PAYPAL REQUEST DATA FORMAT to specify the data format the request body You can send messages using JSON NVP or straight XML Use the and X PAYPAL R ESPONS response E DATA FORMAT headers to specify the data format for the For SOAP messages refer to the next section HTTP Headers for JSON NVP and
101. tion about the error May 2012 Invoicing Service API Guide Createlnvoice API Operation FEE PPFault Message Field Description severity common ErrorSeverit y The severity of the error encountered Possible values are e Error Processing of the request was interrupted e Warning 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 e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 S
102. transactionID 1 1 string e paypalPayment 0 1 PayPalPaymentDetailsType sea e date 0 1 dateTime e otherPayment 0 1 OtherPaymentDetailsType FE any 0 lany 0 E OtherPaymentDetailsType e method 0 1 PaymentMethodsType e note 0 1 string e date 0 1 dateTime F jany 0 ResponseEnvelope Fields Field Description ack common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 GetinvoiceDetails Response 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 Su
103. uest message It indicates whether the invoice was sent successfully e SendInvoiceResponse SendinvoiceResponse e responseEnvelope 1 1 ResponseEnvelope e invoicelD 1 1 string e invoiceURL 1 1 string ResponseEnvelope Fields Field Description ack common AckCode Acknowledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning 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 Sendinvoice API Operation ES SendinvoiceResponse Message Field Description correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 Field D
104. uide Index A ack response field 32 35 38 41 50 53 62 64 71 78 83 85 91 95 99 102 106 109 112 115 address request field 30 48 60 BaseAddress request fields 30 48 billingBusinessName response field 93 billingFirstName response field 93 billingInfo request field 29 47 59 billingInfo response field 73 billingLastName response field 93 build response field 32 35 38 41 50 53 62 64 71 78 83 85 91 95 99 102 106 109 112 115 businessName request field 30 48 60 89 C canceledBy response field 74 canceledByActor response field 74 canceledDate response field 74 CancelPreapproval API operation 25 37 43 55 67 81 97 105 111 CancelPreapprovalResponse fields 39 51 72 category field 34 41 52 64 77 85 95 101 109 115 city response field 30 31 48 49 correlationId response field 32 35 39 42 50 53 62 65 71 78 83 86 92 96 99 102 106 110 113 116 count response field 92 countryCode response field 30 48 createdBy response field 74 createdDate response field 74 creationDate request field 90 currencyCode request field 28 46 58 89 currencyCode response field 73 93 customValue request field 30 48 60 Invoicing Service API Guide D date request field 31 49 61 76 98 112 description request field 31 49 61 detailLevel request field 28 37 46 58 67 81 88 97 105 111 discountA mount response field 73 discountPercent respon
105. urself or third party merchants You can also search invoices and mark them as paid unpaid or refunded HTTP Headers Each request message includes HTTP headers specifying authentication the application ID the device ID or IP address and the payload format or protocol SOAP Adaptive Payments supports request bodies with JSON NVP and XML data formats for REST implementations You can specify different formats for the request and response such as sending the request in JSON and requesting an XML response For SOAP you must also include a specific SOAP protocol header see the SOAP messages section The following is an example of HTTP headers for NVP in Java for a web implementation headers put X PAYPAL SECURITY USERID tok261_biz_api abc com headers put X PAYPAL SECURITY PASSWORD 1244612379 headers put X PAYPAL SECURITY SIGNATURE lkfg9groingghb4uw5 headers put X PAYPAL DEVICE IPADDRESS 168 212 226 204 headers put X PAYPAL REQUEST DATA FORMAT NV headers put X PAYPAL RESPONSE DATA FORMAT NV headers put X PAYPAL APPLICATION ID APP 80W284485P519543T 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
106. valid 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 Updatelnvoice API Operation Use the UpdateInvoice API operation to update an invoice UpdatelnvoiceRequest Message Use the UpdateInvoiceRequest message to update an invoice e UpdateInvoiceRequest By E UpdateInvoiceRequest e requestEnvelope 1 1 RequestEnvelope invoicelD 1 1 string Le invoice 1 1 InvoiceType Invoicing Service API Guide May 2012 55 FE Updatelnvoice API Operation UpdatelnvoiceRequest Message E UpdatelnvoiceRequest i RequestEnvelope requestEnvelope 1 1 RequestEnvelope e detaillevel 0 1 DetaillevelCode ewe e invoicelD 1 1 string se e errorlanguage 1 1 string e invoice 1 1 InvoiceType FE any 0 fe merchantEmail 1 1 string E payerEmail 1 1 string Ef number 0 1 string Gi merchantInfo 0 1 BusinessInfoType E itemList 1 1 InvoiceltemListType Gi currencyCode 1 1 string e invoiceDate 0 1 dateTime Ef dueDate 0 1 dateTime Ef paymentTerms 1 1 PaymentTermsType E discountPercent 0 1 decimal E discount amp mount 0 1 decimal terms 0
107. 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 e Web The invoice was created on paypal com e API The invoice was created by an Invoicing Service API call Invoicing Service API Guide May 2012 89 ES Searchinvoices API Operation 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
108. vice API Guide Ef InvoiceType Ef merchantEmail 1 1 string Ef payerEmail 1 1 string Ef number 0 1 string Ef merchantInfo 0 1 BusinessInfoType Ef itemList 1 1 InvoiceltemListType Gi currencyCode 1 1 string e invoiceDate 0 1 dateTime Ef dueDate 0 1 dateTime Gi paymentTerms 1 1 PaymentTermsType fe discountPercent 0 1 decimal Gi discount mount 0 1 decimal E terms 0 1 string Gi note 0 1 string Gi merchantMerno 0 1 string Gi billingInfo 0 1 BusinessInfoType Ef shippingInfo 0 1 BusinessInfoType Ef shipping mount 0 1 decimal Ef shippingTaxName 0 1 string Ef shippingTaxRate 0 1 decimal Ef logoUrl 0 1 string Ef referrerCode 0 1 ReferrerCode j any 0 E InvoiceltemListType ooo e item 1 InvoiceltemType E BusinessInfoType e FirstName 0 1 string e lastName 0 1 string e businessName 0 1 string e phone 0 1 string e Fax 0 1 string e website 0 1 string e customYalue 0 1 string e address 0 1 BaseAddress F any 0 Invoicing Service API Guide May 2012 Createlnvoice API Operation EN CreatelnvoiceRequest Message ES BusinessInfoType E firstName wl string fe lastName wl string Ef businessName 0 1 string Gi phone 1 string Ef fax wl string Ef website 1 string Gi customValue wl string Ef address 1 BaseAddress Plany E InvoiceltemListTyp
109. wledgement code It is one of the following values e Success The operation completed successfully e Failure The operation failed e SuccessWithWarning The operation completed successfully however there is a warning message e FailureWithWarning The operation failed with a warning message build xs string Build number It is used only by PayPal Merchant Technical Support correlationld xs string Correlation identifier It is a 13 character alphanumeric string for example 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 CreateAndSendinvoice API Operation CN PPFault Message CreateAndSendinvoiceResponse Fields Field Description responseEnvelope common ResponseEnvelope Common response information including a timestamp and the response acknowledgement status invoicelD 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 det

PayPal Invoicing - 2012 User Guide

Contents

Download Pdf Manuals

Related Search

Related Contents