PayPal REST API Release Notes 2018

Each set of release notes describes changes that apply 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.

15 November 2018

Checkout

Commerce Solutions

Customer Disputes

Paydiant

Payments

Payouts

REST APIs

01 November 2018

Checkout

  • Added a note that in a horizontal layout, the PayPal Credit button is enabled by default, and removed additional payment option icons for the horizontal layout.

Paydiant

Payouts

REST APIs

18 October 2018

Checkout

REST APIs

  • Added the TRANSACTION_RECEIVING_LIMIT_EXCEEDED error message to, removed the purchase_unit_reference_id response field from, and removed the pending authorization state from the Payments API Reference.

Payouts

04 October 2018

Checkout

Marketplaces

  • Added a note that currency codes for partner_fee_details must match the transaction amount on Move Money.

Marketing Solutions

REST APIs

21 September 2018

Checkout

  • Repaired the PayPal Help Center link on the PayPal Checkout v1 FAQ. The PayPal Help Center link now correctly directs users to Checkout in the Help center. Also added Edge version 12 and later to the list of supported PayPal browsers.
  • On the Checkout best practices page, corrected funds are held to funds are not held.
  • Removed unnecessary screen shots from the Checkout Prerequisites page.

Marketplaces

  • Added a note that users must pass the PayPal-Auth-Assertion header in the live environment to the Refund payment topic in the Marketplaces Orders API Integration Guide.

Payouts

REST APIs

04 September 2018

General

  • Changed PayPal internal links to https:// instead of http://.
  • Fixed a number of issues on the PayPal PLUS Germany page, including removing incorrect information and replacing an incorrect link.

Checkout

REST APIs

  • Added missing terms to the API glossary and corrected a formatting problem with H entries.

21 August 2018

Checkout

Payouts

PayPal PLUS

Rest APIs

09 August 2018

Checkout

Marketplaces

REST APIs

26 July 2018

Checkout

Payouts

Subscriptions

Marketplaces

  • Removed the limited-release, corner-case Additional ways to pay information from the Marketplaces Orders API Integration Guide.
  • Because the PATCH operation is no longer supported, removed the Patch cart topic from the Additional checkout experience options page in the Marketplaces Orders API Integration Guide.
  • To match current PayPal sandbox account settings, updated the Create a PayPal app topic on the Marketplaces Prerequisites page.
  • Because developers need OAuth 2.0 information sooner, moved it to the top of the Get an access token topic on the Marketplaces Prerequisites page.
  • Added information about available reports and their benefits to the Generate Reports page.
  • Added information about the partner_fee_details parameter to the Move Money page of the PayPal Marketplaces docs. Added an example of the partner_fee_details parameter to a code block.
  • Added descriptions to enumerated values for the Capabilities object on Marketplaces Upfront Onboarding for Connected Path.
  • Added the get seller's onboarding status integration step to the Integration steps topic of the Marketplaces Upfront Onboarding for Connected Path page.
  • Removed a link to a non-existent demonstration from the Next topic of the Marketplaces Progressive Onboarding page.
  • Because the PayPal expert team no longer exists as of the end of July, removed mention of it from Marketplaces Overview.
  • Deleted information about the approval status of some sellers to use progressive on-boarding from the Types of sellers topic on the Onboard Sellers page. These sellers are not approved to use progressive on-boarding.

Reports

  • Repaired the navigation sidebar so that it correctly displays child pages for the PayPal Reports page.

12 July 2018

26 June 2018

14 June 2018

31 May 2018

17 May 2018

  • Removed the PayPal for Marketplaces-specific webhooks page and redirected the removed page to the Webhooks page because the removed page duplicated information.
  • Enhanced the current information on Express Checkout shortcut and acceptance mark integrations in Add the PayPal Button and Best Practices Guide.
  • Updated the maximum number of payouts from 5000 to 15000 in the Payouts documentation.
  • To orient the reader, clarified the Express Checkout product name in Upgrade to checkout.js.
  • Corrected Integation to Integration in the INTEGRATION GUIDE entries in the left-hand navigation.
  • Added the minimum length values for various response fields in the Payments API Reference.
  • Updated INR currency in the Currency Codes table to reflect its new GA status.

03 May 2018

19 April 2018

05 April 2018

  • Added the CHECKOUT.ORDER.PROCESSED and PAYMENT.REFERENCED-PAYOUT-ITEM.COMPLETED webhooks to Webhook event names.
  • Removed the supported countries from the left-hand navigation of the PayPal Express Checkout Integration page and removed this note from Availability on that same page:

    Note: If you use Braintree, all currencies that are available for PayPal transactions are supported, but not all Express Checkout countries are supported.

  • Indicated that the 2. Pay an ordermethod is asynchronous, and documented how to determine whether an order is approved.
  • Updated Payments API reference with these changes:
    • Updated the count parameter with the maximum value, which is 20.
    • Enhanced the payment_method and credit_card_id parameter descriptions.
    • Removed the word encrypted from the merchant_id parameter description.
    • Added the application_context object.
    • Clarified that a valid value for the refund description, description, is a string of single-byte alphanumeric characters.

22 March 2018

15 March 2018

23 February 2018

  • Updated the Billing Agreements API reference to:
    • Update Canceled to Cancelled in the state parameter description for various methods.
    • Document currency_code and recipient_name.
    • Indicate that the start date must be 24 hours from current date.
  • Updated Webhook event names with the new BILLING.SUBSCRIPTION.EXPIRED webhook event.
  • Updated Using the PayPal Here SDK to add a customizations topic and code sample.
  • Updated the Payments API reference to:
    • Add the REFUND_FAILED_INSUFFICIENT_FUNDS message.
    • Update the payer_info parameter.
    • Add the maximum lengths to the HTTP request headers.
    • Clarify the email property of the payee object.
    • Expand the incomplete descriptions for quantity and price.
  • Updated 2. Pay an orderto remove references to INSTANT for the disbursement_mode parameter.
  • Updated the PayPal Sync API reference and PayPal Sync API integration guide to:
    • Update the show transaction details call to list transactions. This call was incorrectly documented as show transaction details.
    • Clarify that it takes a maximum of three hours before transactions show up in a list transactions call.
    • Remove all references to the deprecated transaction_date query parameter.
    • Indicate that all query parameters are optional.
    • Clarify that the earliest start date for the list transactions call is July 2016.

15 February 2018

  • Updated list plans in the Billing Plans API reference to show these defaults:
    • Default for status is CREATED
    • Default for total_required is no
  • Added a note to the PayPal-Request-Id header description in HTTP Request Headers to note that not all APIs support this header.
  • Updated create order in the Orders API reference to remove the incorrect status, create_time, update_time, and links request parameters.
  • Published the OpenAPI-based Webhooks API reference. Also updated Webhooks and Webhook event names.

08 February 2018

  • Clarified the use of multi-part form and JSON upload on the Customer Disputes API provide evidence page.
  • Corrected the comment lines from // to # in the Python sample on the complete the payment and get the authorization ID page in the REST API SDK Quickstart.
  • Removed the Prefer request header from the disburse funds code sample.

01 February 2018

25 January 2018

18 January 2018

  • To add header information to and correct the syntax of cURL samples, updated refund payment in the PayPal For Marketplaces Orders Integration Guide.

  • Updated Customer Disputes API reference to address these issues:

    Additionally, added information about dispute reason codes.

11 January 2018

04 January 2018

Additional release notes

Feedback