PayPal REST API Release Notes 2017

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.

11 May 2017

API updates

API Update
Webhook event names Added the new PAYMENT.ORDER.CANCELLED and PAYMENT.ORDER.CREATED events.

Doc updates

Docs Updates
Billing Agreements API reference
Invoicing API reference Updated the incorrect descriptions for the page and page_size query parameters.
Payments API reference
  • Removed the refund_from_transaction_fee response field, which is not returned, from the refund sale operation.
  • Removed the status field, which is not returned.
Sandbox Testing Guide Because the information on the Using the Sandbox mode on the PayPal mobile app page was no longer valid, removed this page from the navigation and redirected the page to the Sandbox Testing Guide Overview.

04 May 2017

API updates

API Update
Payments Updated the enumerated values for the sort query parameters in list payments.

Doc updates

Docs Update
Billing Agreements API reference Updated the funding_instruments definition in create agreement.

25 April 2017

Doc updates

Docs Update
Billing Plans API reference Updated the description request parameter in the create plan operation with constraint information. The maximum length is 127 single-byte alphanumeric characters.

13 April 2017

Doc updates

Docs Update
Billing Plans and Agreements Removed duplicate information.
Authorize and capture payments
Credit card payments
Payments REST API
Payments API reference
PayPal payments
Refund payments
Test REST API transactions
Added integration steps, updated the left-hand-navigation, and refreshed code samples.

30 March 2017

API updates

API Update
Invoices Added the new allow_tip parameter and response field to the invoice create and template create operations.

Doc updates

Docs Update
Billing Plans API reference Updated the initial_fail_amount_action parameter description.
Billing Plans and Agreements
Billing Agreements API reference
Billing Plans API reference
REST SDK Quickstart Guide
Updated the terminology in these topics to remove the confusion that the term subscription presented.
Invoices API reference
  • Clarified that when you search for invoices by status, you must specify the status value as an array.
  • Added the country_code field to the show template details response.
  • Updated the cancel invoice response to 202 (Accepted).
  • Updated the invoice delete response to 204 (No Content).
Payments API Enhanced the INSTRUMENT_DECLINED error message with additional information.
Webhooks API reference Added error codes.

23 March 2017

Doc updates

Docs Update
Credit card payments
Payments API reference
Enhanced the related_resources array description.
Payments REST API overview Removed the redundant explore payment capabilities page.
Identity overview To address customer feedback:

16 March 2017

Doc updates

Docs Update
Billing Plans API reference Updated the charge_models type description.
Credit cards payments
Orders
  • Updated the code samples.
  • Updated formatting and style to match other REST API integration guides.
Payments API reference Updated the Payments and Orders resource groups' code samples.
REST API reference Updated the api.paypal.com to api.sandbox.paypal.com links in many sample responses. The updated URLs more accurately represent actual API responses.
REST API overviews and references Enhanced information about access tokens.
Webhooks API reference
  • Removed the transmissions and status response fields from the show event notification details method.
  • Updated the code sample for the resend event notification method.
  • Added the missing sample request to the list available events method.

27 February 2017

API updates

API Update
Payments Updated the information_link properties so that the links point to the top-level heading for error messages. Previously, the links pointed to non-existent anchors.

Doc updates

Docs Update
Billing Agreements API reference
Billing Plans API reference
Billing Plans and Agreements
  • Updated the code samples.
  • Combined the Billing Plans and Billing Agreements overviews into one updated overview.

16 February 2017

API updates

API Update
Payouts Synchronous mode, which immediately returns the results of a payout, will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations.

Doc updates

Doc Update
Express Checkout deprecated documentation Noted that PayPal recommends that all new integrations use the REST Payments API for Express Checkout integrations.
Webhook event names Added related resources to webhook event names.

02 February 2017

API updates

API Update
Payments Corrected the recipient_name field in the code samples to specify the name as first-name last-name rather than last-name, first-name.

25 January 2017

Doc updates

Doc Update
Payouts API reference Updated the code samples.
Payouts
Batch payouts
Single payout
Added integration steps and updated the code samples.
Vault API reference Updated the code samples.
Vault overview Added integration steps and updated the code samples.

05 January 2017

Doc updates

Doc Update
PayPal PLUS Germany integration guide Added a link to this doc in the docs directory and alphabetical directory.

Additional information