PayPal REST API Release Notes 2016

Each set of release notes describes changes that are applicable to the release:

  • API updates. New, changed, and deleted resources, request parameters, and response fields.

  • New features. New dashboards and tools related to the PayPal REST APIs.

  • Functional updates. Functional updates to operations, including new code list values and validation rule changes.

  • Announcements. Announcements related to the PayPal REST API.

  • Doc updates. Documentation updates not mentioned in API updates, new features, functional updates, or announcements.

If a set of release notes omits an update, such as API updates, that release has no API updates.

22 December 2016

Doc updates

Doc Update
Billing Agreements overview
Billing Agreements API reference
Updated the code samples.
Billing Plans overview
Billing Plans API reference
Updated the code samples.
Invoicing API reference Removed the duplicate summary common object.
Invoicing API reference
Invoicing overview
Updated the code samples.
Payments API reference Removed obsolete error messages.
Web experience profiles
Payment Experience API reference
Updated the code samples.
REST release notes Updated to include all current releases.
Webhooks overview
Webhooks API reference
Notification messages
Recommended the use of PayPal REST SDKs to verify webhook events.
Webhooks overview
Webhooks API reference
Webhooks simulator dashboard
Clarified that the Webhooks simulator generates mock events.

17 November 2016

API updates

API Update
Billing Plans Updated code samples in the API reference.
Payouts
  • Updated code samples.
  • Added the new ACCOUNT_UNCONFIRMED_EMAIL error message.
  • Updated the batch payout CANCELLED status to CANCELED.

Doc updates

Doc Update
Billing Plans overview Added task flow and updated code samples.
Billing Plans API reference Enhanced the description for the billing plan type parameter, which determines whether you must set the number of cycles in the payment definition. A fixed billing plan has a set number of cycles while an infinite billing plan has 0, or infinite, cycles.
Payment Experience overview
Payment Experience API reference
Added description for the user_action parameter.

10 November 2016

API updates

API Update
Payment Experience
  • Removed return_url_label and note_to_seller_url response fields, which are internal fields.
  • Updated code samples.

04 November 2016

API updates

API Update
Payouts Updated code samples.
Webhooks Added the new credit card created, deleted, and updated webhook events.

Doc updates

Doc Update
Service Integrations This new topic shows how to use the PayPal REST APIs to build payment integrations with external services. The first featured integration is Slack bot.
SDK QuickStart Guide Enhanced and expanded this guide to include all available SDKs and languages.
The REST APIs and HATEOAS Consolidated and expanded existing HATEOAS documentation on this single page. The removed pages now redirect to this single page.

27 October 2016

API updates

API Update
Payment Experience
  • Added the new web profile presentation parameters:
    • return_url_label. Optional. A label for the return to merchant link.
    • note_to_seller_label. Optional. A title for the note to seller field. Used only when allow_note is 1.
  • Updated code samples.
Vault

06 October 2016

API updates

API Update
Payments Corrected these issues:
  • Fixed UTF-8 characters in carrier_account field.
  • Updated the overly long apple_pay_resource_containing_tokenized_&_encrypted_apple_pay_data field name to apple_pay_card
  • Removed the three_d_secure_info field from common object definitions.

29 September 2016

API updates

API Update
Invoicing Added the new delete external payment, delete external refund, create template, update template, and delete template methods.
Webhooks Added these new webhook events:
  • PAYMENT.PAYOUTS-ITEM.BLOCKED
  • PAYMENT.PAYOUTS-ITEM.CANCELED
  • PAYMENT.PAYOUTS-ITEM.DENIED
  • PAYMENT.PAYOUTS-ITEM.FAILED
  • PAYMENT.PAYOUTS-ITEM.HELD
  • PAYMENT.PAYOUTS-ITEM.REFUNDED
  • PAYMENT.PAYOUTS-ITEM.RETURNED
  • PAYMENT.PAYOUTS-ITEM.SUCCEEDED
  • PAYMENT.PAYOUTS-ITEM.UNCLAIMED

Doc updates

Doc Update
Invoicing overview Updated to show a recommended integration flow with examples.
REST API errors Consolidated content from the Common REST Payments API errors and Common REST Payments API errors pages on this new page.
REST API errors Added Identity error response information.

08 September 2016

API updates

API Update
Payments Replaced the obsolete invoice_id parameter with the new invoice_number parameter.
Payouts
  • Described how the Payouts API prevents duplicate batches from being processed.
  • Added descriptions for the batch payouts status, item transaction status, and payment receiver enumerated values.
  • Updated code samples.
Webhooks Added the new verify webhook signature method.

Doc updates

Doc Update
REST API Reference Removed validation messages from the REST API reference pages.

01 September 2016

API updates

API Update
Notifications Renamed the Notifications API to Webhooks API. Additionally, the URL for the documentation for this API is now /docs/api/webhooks/.
Payouts Updated the create payouts operation:
  • Removed PRIMARY_BANK and PRIMARY_DEBIT values for funding_enum.
    BALANCE is the only valid value.
  • Removed PROCESSING transaction status.
  • Added new optional sender_batch_header request parameter. Defines the sender-provided batch header for a batch payout request.
  • Added response HATEOAS links.
Payouts Updated the show batch payout details operation:
  • Added new optional fields=batch_header query parameter.
    If specified, returns only the batch payout details in the response.
  • Added new ACKNOWLEDGED and PROCESSING batch payout statuses.
  • Removed PROCESSING transaction status.
Payouts Updated error messages:
  • Removed the duplicate INTERNAL_ERROR error message.
  • Removed the PER_TRANSACTION_SENDING_LIMIT_EXCEEDED error message.

Doc updates

Doc Update
Accept Easy Payments with PayPal Credit in test transactions Described how to enable PayPal Credit for a sandbox account.
Payouts Rewrote Payouts overview.

11 August 2016

API updates

API Update
Payments Added descriptions about various state fields to the accept credit card payments, capture payments later, create and process an order, refund payments, and accept a PayPal payment operations
Payouts
  • Removed duplicate INTERNAL_ERROR error message from and added the new PER_TRANSACTION_SENDING_LIMIT_EXCEEDED error message.
  • Added descriptions for batch payout statuses and payout item transaction statuses to the payout_enumerations object.

Doc updates

Doc Update
Express Checkout with In-Context Added the new stand-alone, end-to-end REST integration guide for the PayPal Checkout documentation set.
Make Identity Calls on Behalf of a User Updated the authorization endpoint for obtaining user's consent for both live and production environments. This update is seamless for external users as requests to the previous endpoints still work.

04 August 2016

API updates

API Update
Payouts Added the NEW batch payout status and NEW payout item transaction status.

Doc updates

Doc Update
Create a batch payout
Show batch payout details
Added descriptions for the batch payout status values
Create a single payout
Show batch payout details
Added descriptions for the payout item transaction status
Refund captured payment
Show captured payment details
Added the capture_id parameter. This parameter is not new but was missing from the documentation.
Test REST API transactions
  • Updated the note about credit card numbers in the Sandbox account.
  • Simplified the procedures.
  • Added a prerequisites section.
  • Made updates to improve technical accuracy.

27 July 2016

Doc updates

Doc Update
Webhooks Reorganized and updated this overview and related pages for clarity and technical accuracy.

20 July 2016

API updates

API Update
Payouts
  • Revised descriptions for errors and validation messages.
  • Corrected code samples and parameters.

Doc updates

Doc Update
Accept Payments Added a reference to the Shopping Cart section of the PayPal technical support FAQ to better guide users who are looking for support for their third-party shopping cart solution.
PayPal Developer Documentation
  • Removed all references to devtools-paypal.com in preparation for eventual deprecation of this site.
  • Updated the test credit card numbers used in REST API samples and documentation that were causing errors on the sandbox.

07 July 2016

API updates

API Update
Billing Agreements Corrected the descriptions for the state and status response parameters.
Payment Experience Updated the overview to add information about web experience profiles.
Payouts
  • Revised descriptions for errors and added separate validation messages topic.
  • Corrected code samples and parameters.

Doc updates

Doc Update
Important Turkey PayPal service information Because PayPal has suspended business operations in Turkey, removed Turkey from lists of supported countries, interface support for the Turkish language, and associated codes and parameter values throughout developer documentation.
Uploading bulk accounts to Sandbox page Clarified the information and replaced the sample file.
Admin checkout settings page Made minor corrections.
Account Settings & Tools Combined the Manage Transactions and Additional Features & Settings topics into this new topic in the HTML Buttons documentation. The new topic describes how to enable features in your PayPal profile and use the transaction and recurring payments tools in your PayPal account.

16 June 2016

API updates

API Update
Invoicing Added information about third-party permissions:
  • Added the Invoicing scope.
  • Updated the REST Invoicing flow with third-party permissions.
  • Updated the Invoicing use cases with third-party permissions information.

Doc updates

Doc Update
PayPal Developer Documentation Added information about in-context checkout to the Express Checkout topic.
Merchant Technical Support Updated the Developer Portal Support to Merchant Technical Support.
Development guides Renamed and reorganized the page and added guides for the Braintree SDKs, PayPal REST APIs, and PayPal SDKs.

02 June 2016

API updates

API Update
Payments
  • Added the note_to_payer parameter to the create a payment request parameters.
  • Added the soft_descriptor string to the cart_base definition.
  • Added the external_funding, potential_payer_info_resource, processor_response, and three_d_secure_info common object definitions.
Vault Added the total_required query parameter for List stored credit cards.

Doc updates

Doc Update
REST API Reference Completed a design refresh of the documentation on PayPal Developer portal, including an initial iteration to simplify and reorganize the top-level navigation, new layout for REST API reference content, move of former REST API reference (beta) content to new location, and adoption of the PayPal standard font and color palette.
Billing Agreements common object definitions
Billing Plans common object definitions
Identity common object definitions
Invoicing common object definitions
Notifications common object definitions
Payment Experience common object definitions
Payments common object definitions
Payouts common object definitions
Vault common object definitions
Added common object definitions to the API Reference.

11 May 2016

API updates

API Update
Payment Experience Added errors.
Webhooks Added new subscription, billing plan, and billing subscription events to the supported event types.

02 May 2016

Doc updates

Doc Update
REST API reference With help from product owners and development teams, completed migration of limited-release APIs to new documentation tools. All published API references are now generated directly from the API schemas developed according to PayPal as a Service (PPaaS) guidelines.
Create a payment Updated the payer object's status field description with information about VERIFIED payers.

06 April 2016

API updates

API Update
Invoicing Updated the /invoices resource to add these new parameters:
  • template_id request and response parameter, which is useful for copy functionality.
  • generate next invoice number method.
  • cc_emails request parameter. For invoices with Cc: emails, cc_emails defines one or more email addresses to which to send a Cc: copy of the notification. Use this parameter in requests to send an invoice reminder and cancel an invoice.
Invoicing Added the templates resource, which introduces the show template details and list templates methods.

10 March 2016

Doc updates

Doc Update
Currency Codes Clarified that REST direct credit card payments are supported only for UK Pro accounts.

26 February 2016

Doc updates

Doc Update
List payments Clarified that the call lists only those payments that were created by the create payment call.
Make your first call
How PayPal uses OAuth 2.0
Webhooks
Webhooks Events dashboard
Updated developer documentation to reflect the new user interface for the Developer dashboard.

Additional release notes