PayPal REST API Release Notes 2019

November

November 06

Checkout

Classic

Payouts

Subscriptions

  • Updated the Subscriptions integration doc to include the new Subscriptions Dashboard tool available as well as support for subscribing as a guest.

White Label Wallet

October

October 30

Checkout

Invoicing

October 16

Classic

  • Removed the AppID for the Adaptive APIs section from API Credentials because you can no longer go live with the Adaptive Payments API.
  • Provided guidance to merchants in Shopping Cart HTML Variables to pass 25 or fewer items in a single call.

Payouts

PayPal Commerce Platform

PayPal Here

  • Changed some wording about a merchant's POS Software. Also added detailed instruction for what to do in the completion of isSetupComplete instead of just using the word "Done".

REST APIs

October 09

Alternative Payment Methods

  • Noted in the Alternative Payment Method guides for JavaScript SDK that cross-border shipping isn't currently supported.

PayPal Commerce Platform

  • Added Partner Referrals V2 API and revised Connected Path Upfront onboarding topic to reflect version 2 of the API.
  • Revised Partner Onboarding page to align with the content and positioning presented in the Partner lead form.

October 02

Checkout

General

  • Updated the Webhook Event Names table to include CHECKOUT.CHECKOUT.BUYER-APPROVED. This webhook lets users know when an Express Checkout payment is created and approved by the buyer.

Payments

REST APIs

White Label Wallet

September

September 25

Classic

NVP/SOAP

September 18

Classic

  • Updated content to reflect updates to the Developer Dashboard including simplified onboarding and changes to sandbox account creation.

Enterprise solutions

September 11

Checkout

Classic

NVP/SOAP

  • Added 3-D Secure 2.0 fields to the DoDirectPayment (NVP/SOAP) operation.

Subscriptions

Third Party Solutions

  • Published marketplaces, a new category of third party solutions.

September 04

API Basics

Classic

  • Added information to the Payflow Developer Guide to clarify merchants can complete 3-D Secure authentication using the Buyer Authentication service or by using a 3rd-party plug-in.

August

August 28

Classic

Disputes

  • Added an FAQ for the Disputes API.

August 23

General

August 21

General

  • Updated all currency notes surrounding BRL. PayPal's usage policy with the Brazilian Real has changed to include cross-border payment conversion and a notice for the conversion rate fee.

Payouts

PayPal Here

  • Added new information about the iOS and Android PayPal Here Web SDK including code samples for Objective C, Swift, and Android.

Third Party Solutions**

  • Added a 3rd Party Solutions directory for integrating PayPal with standard eCommerce platform solutions.

White Label Wallet

  • Added new methods of retryUpdateFuelEvent and lookupTransaction to the Fuel API guide to enable a customer care agent to retry an authorization that did not successfully complete at the pump.

August 14

PayPal Commerce Platform

  • Revised all the topics in the Payment section of the PayPal Commerce Platform documents.

August 08

Checkout

Classic

Payouts

White Label Wallet

  • Update — Added PaymentAccount capabilities to the startPaymentAccountEnrollment and continuePaymentAccountEnrollment responses. This enables developers to find the paymentAccountUri as part of a multi-step enrollment process.

July

July 24

Connect with PayPal

Payouts

REST APIs

White Label Wallet

July 10

Service Integrations

  • The Service Integrations subsection of the REST SDKs has been removed because the tutorial is no longer supported.

June

June 26

Checkout

Connect with PayPal

  • Updated the URLs and added info about using the previous Login with PayPal and the signup flow for Connect with PayPal.

Disputes

  • Updated the case_type and reason_codes for Dispute Resolution IPN variables to reflect current reality.
    • case_type - Marked bankreturn as deprecated.
    • reason_codes - Marked adjustment_reimburse and billing as deprecated. Noted that complaint and dispute case types have the same reason codes.
  • Replaced the disputes methods table with an available actions table and added two sequence diagrams and instructions for creating buyer-side credentials to the Disputes Integration Guide.
  • Replaced the disputes management flow with a new image.

REST APIs

REST SDKs

June 12

Checkout

  • Added the PayPal Shopping Cart demo link to the Checkout guide in the Server and Best Practices sections.
  • Changed ProductionEnvironment to LiveEnvironment in the Setup SDK Guide.

Classic

Disputes

Payouts

PayPal Here

REST APIs

Subscriptions

White Label Wallet

  • Removed all mentions of the Notification Manager in the SSP Help as the SSP Notification Manager is deprecated.

June 06

Payouts

  • Clarified the prerequisites to help customers successfully set up their PayPal business account for payouts. Also scrubbed the overview for readability.

May

May 30

Connect with PayPal

Classic

  • Updated Website Payments Pro (DoDirectPayment) 3-D Secure topic to reflect new CardinalCommerce platform, Cardinal Cruise. Added content to inform merchants of the September 14, 2019 deadline to implement Strong Customer Authentication (SCA) in Europe.
  • Removed outdated content about the PayPal Payments Standard Modify Subscription button. Added information to the modify parameter in the Deprecated Variables list to help users update code that's using the deprecated values for modify.

PayPal Commerce Platform (formerly PayPal for Partners)

PayPal Here

REST APIs

White Label Wallet

May 16

Checkout

Classic

  • Changed supported locale code for India from en-IN to en_IN. We let a little air out of the hyphen to make it an underscore.
  • Added div id="paypal-button-container" to a code sample on Express Checkout with Payflow Gateway. The PayPal button now renders as expected when developers paste the code.

Connect with PayPal

  • Login with PayPal is now Connect with PayPal. Added a new integration guide for Connect with PayPal.

General

Payouts

REST APIs

  • Revised the v2 Payments API error messages to include REFUND_NOT_PERMITTED_DUE_TO_CHARGEBACK and CAPTURE_DISPUTED_PARTIAL_REFUND_NOT_ALLOWED.
  • Removed the banner that notifies users they are viewing a deprecated version from Billing Agreements API v1 as the banner contained a broken link. We're working on fixing the link but until then, we benched the banner.

Subscriptions

White Label Wallet

May 02

Checkout

Classic

Enterprise Solutions

General

PayPal Here

PayPal Commerce Platform

Reports

  • Increased the file limits of some reports to 1 million transactions per file in PayPal Reports.

REST APIs

  • Changed supported locale codes for India from en_GB to en-IN.
  • Removed the internal USER_NAME enumerated value from the recipient_type string and the mention of the internal recipient_wallet string from the Payouts API Reference.

Subscriptions

White Label Wallet

April

April 22

REST APIs

April 18

Classic

  • Deprecated the NVP and SOAP RefundTransaction method fields:

    NVP

    • RefundTransaction request fields: SHIPPINGAMT, TAXAMT
    • InvoiceItemType fields:L_INVOICEITEMNAME_n_, L_DESCRIPTION_n_, L_EAN_n_, L_SKU_n_, L_PRICE_n_, L_PRICECURRENCYCODE_n_, L_ITEMPRICE_n_, L_ITEMPRICECURRENCYCODE_n_, L_ITEMCOUNT_n_, L_ITEMCOUNTUNIT_n_, L_TAXRATE_n_, L_ADDITIONALFEES_n_TYPE_m_, L_ADDITIONALFEES_n_AMT_m_, L_ADDITIONALFEES_n_CURRENCY_m_, L_MPN_n_, L_ISBN_n_, L_PLU_n_, L_MODELNUMBER_n_, and L_STYLENUMBER_n_

    SOAP

    • RefundTransaction request fields: RefundItemDetails, ShippingAmount, TaxAmount
    • InvoiceItemType fields: Name, Description, EAN, SKU, Price, ItemPrice, ItemCount, ItemCountUnit, TaxRate, AdditionalFees, MPN, ISBN, PLU, ModelNumber, and StyleNumber

Checkout

Identity

Orders

Payments

PayPal Commerce Platform

REST APIs

  • Clarified that if you omit a reference_id for an order with one purchase unit for update order, PayPal defaults to a reference_id of default, which enables you to use a path:

    "path": "/purchase_units/@reference_id=='default'/{attribute-or-object}"
    
  • Update — Moved the limited-release Subscriptions API to the external Subscriptions API Reference.

    Note: The Catalog Products API Reference will move to external status in a subsequent release.

April 10

Classic

  • Deprecated these NVP and SOAP DoCapture method fields:
    • NVP: TAXAMT, TRANSACTIONTYPE, RECEIPTID
    • SOAP: TaxAmount, TransactionType, ReceiptID

Disputes

  • Updated the Disputes API Reference to add the Partner Actions resource group and the partially update dispute action and show dispute action details methods.

  • Added evidence types:

    • PROOF_OF_REFUND_OUTSIDE_PAYPAL
    • RECEIPT_OF_MERCHANDISE
    • CUSTOMS_DOCUMENT
    • CUSTOMS_FEE_RECEIPT
    • INFORMATION_ON_RESOLUTION
    • ADDITIONAL_INFORMATION_OF_ITEM
    • DETAILS_OF_PURCHASE
    • PROOF_OF_SIGNIFICANT_DIFFERENCE
    • PROOF_OF_SOFTWARE_OR_SERVICE_NOT_AS_DESCRIBED
    • PROOF_OF_CONFISCATION
    • PROOF_OF_DAMAGE
    • COPY_OF_LAW_ENFORCEMENT_AGENCY_REPORT
    • ADDITIONAL_PROOF_OF_SHIPMENT
    • PROOF_OF_DENIAL_BY_CARRIER
    • THIRDPARTY_PROOF_FOR_DAMAGE_OR_SIGNIFICANT_DIFFERENCE
    • VALID_SUPPORTING_DOCUMENT
    • LEGIBLE_SUPPORTING_DOCUMENT
    • RETURN_TRACKING_INFORMATION
    • DELIVERY_RECEIPT
    • PROOF_OF_INSTORE_RECEIPT
    • ADDITIONAL_TRACKING_INFORMATION
    • PROOF_OF_SHIPMENT_POSTAGE
    • ONLINE_TRACKING_INFORMATION
    • PROOF_OF_INSTORE_REFUND
    • PROOF_FOR_SOFTWARE_OR_SERVICE_DELIVERED
    • RETURN_ADDRESS_FOR_SHIPPING
    • COPY_OF_THE_EPARCEL_MANIFEST
    • COPY_OF_SHIPPING_MANIFEST
    • APPEAL_AFFIDAVIT
    • RECEIPT_OF_REPLACEMENT
    • COPY_OF_DRIVERS_LICENSE
    • ACCOUNT_CHANGE_INFORMATION
    • DELIVERY_ADDRESS
    • CONFIRMATION_OF_RESOLUTION
    • MERCHANT_RESPONSE
    • PERMISSION_DESCRIPTION
    • STATUS_OF_MERCHANDISE
    • LOST_CARD_DETAILS
    • LAST_VALID_TRANSACTION_DETAILS

Invoicing

Payment Services Directive

April 09

Checkout

Connect with PayPal

PayPal Commerce Platform

PayPal Payments

White Label Wallet

  • Changed the 417 error code description in the Android and iOS SDK guides to the request times out from the transaction times out.

March

March 20

Classic

PayPal Commerce Platform

  • Updated link in Configure Webhooks to go directly to the Partners section of the webhook events page.

REST APIs

White Label Wallet

  • Corrected the URL and name of retrieveCustomerByUri, previously retrieveCustomersByUri, but we're not looking back.

March 08

Checkout

Classic

General

NVP/SOAP

Payments

PayPal Commerce Platform

Payouts

REST API

  • Added a note about required scopes for the Disputes create, cancel, and validate eligibility methods.

White Label Wallet

February

February 21

Classic

Orders

  • Corrected the Authorization header examples in the Orders API Reference to use <client_id:secret> instead of <client_id;secret>.

PayPal Commerce Platform

REST APIs

White Label Wallet

February 13

PayPal Commerce Platform

  • Added link to the PayPal Commerce Platform country support to the Reference section of these pages:

Payments

February 07

PayPal Commerce Platform

Paydiant, now White Label Wallet

REST APIs

January

January 24

Classic

Commerce Solutions

Paydiant

Payouts

  • Updated the description for the TRANSACTION_DECLINED_BY_TRAVEL_RULE error message in the Payouts API Reference.

REST APIs

Webhooks

  • Added the BILLING_AGREEMENTS.AGREEMENT.CREATED and BILLING_AGREEMENTS.AGREEMENT.CANCELLED event names to Webhook Event Names.

January 14

Platform

  • Updated Connect with PayPal button builder to remove the Connect option in the buttonType control. Also corrected issues with the generated snippet in Log In with PayPal button builder.

January 09

Classic

General

Identity

PayPal Commerce Platform

Paydiant

REST APIs

Additional release notes