PayPal REST API Release Notes 2015

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.

16 December 2015

Doc updates

Doc Update
PayPal REST SDKs This new page describes the available SDKs with links to the GitHub repository for each SDK.

13 November 2015

New features

Feature Description
Live Transactions Added this dashboard.

Doc updates

Doc Update
Test REST API transactions
Manage your applications
Added information about the Live Transactions dashboard.

25 October 2015

New features

Feature Description
Live Webhooks Events dashboard Added this dashboard that enables you to view and manage all webhook events for your apps from a single interface. You can access the dashboard for both the Sandbox and Live environments.

Doc updates

Doc Update
Live Webhooks Events Added documentation in the new dashboard.
Payouts
Batch payouts
Create payouts
Updated the duplicate checking feature information for batch payouts to reflect current functionality.

21 October 2015

API updates

API Update
Webhooks Added the new PAYMENT.CAPTURE.DENIED and PAYMENT.SALE.DENIED webhooks event types.

Doc updates

Doc Update
Webhook event names Added new webhooks events.

12 August 2015

Doc updates

Doc Update
Create agreement
Execute agreement
Clarified that you must execute a billing agreement only when the agreement is for PayPal payment.

19 July 2015

Doc updates

Doc Update
Create webhook Clarified how to use an asterisk (*) as a wild card to subscribe to all event types.

18 June 2015

Doc updates

Doc Update
Notification messages Updated the Webhooks notifications page to include information about the asymmetric algorithm that is used for event signatures.

19 May 2015

API updates

API Update
Webhooks Added new webhook events:
  • PAYMENT.CAPTURE.COMPLETED. Triggered when a capture is completed.
  • PAYMENT.CAPTURE.PENDING. Triggered when a capture goes into pending state.
  • PAYMENT.SALE.PENDING. Triggered when a sale goes into pending state.
  • RISK.DISPUTE.CREATED. Triggered when a dispute is created.

05 May 2015

Doc updates

Doc Update
fmf_details Updated the filter_identifier property to filter_id.
sale Removed the pending_reason property from the object.
Look up an authorization Added the reason_code, payment_mode, and fmf_details response fields.
Simulate webhook event Noted that you cannot use Webhooks API operations to manipulate event data that the webhooks simulator generates.
authorization Added the payment_mode and fmf_details properties.
List plans Added response information, noting that partial plan resources are returned.

23 April 2015

API updates

API Update
Webhooks Introduced wild-card capability for Create webhook. You can now subscribe to all event types by using an asterisk (*) as an event name in the event_types field.

Doc updates

Doc Update
Notification messages Updated the webhooks sample code for obtaining a signature algorithm.

05 April 2015

API updates

API Update
Webhooks Added the new POST v1/notifications/simulate-event/ endpoint. You can simulate webhook event by using a sample payload.

New features

Feature Description
Webhooks Simulator Added the new simulator, an interactive interface, that verifies that webhook URLs can receive event data as expected without firewall or other connectivity issues.

Doc updates

Doc Update
agreement_transaction Added the possible values of the status property
Get user information Updated the description in the response to clarify that the attributes returned depend on the configured scopes in the user's REST app.
capture Fixed the object to include the transaction_fee property that was previously missing.

25 March 2015

Doc updates

Doc Update
Obtain user's consent
Grant token from authorization code
Emphasized, in the Log In with PayPal topics of the REST API reference, the importance of passing a redirect_uri that matches the app's information provided in the application registration page of developer site.

12 March 2015

API updates

API Update
Payments Added these new properties:
  • fmf_details property for sale object
  • transaction_fee field for sale object
  • receivable_amount property for sale object
  • exchange_rate property for sale object
  • receipt_id property for sale object
  • salutation property for payer_info object
  • suffix property for payer_info object
  • middle_name property for payer_info object
  • country_code property for payer_info object
  • status property for address object
  • in_progress state value for state property
  • fmf_details object
Vault Added the new GET /v1/vault/credit-cards endpoint. The list stored credit cards operation lists credit card resources, which you can optionally filter through query parameters.
fmf_details Added the fmf_details object to the Payments common objects.
Payments Added these new properties:
  • fmf_details, transaction_fee, receivable_amount, exchange_rate, and receipt_id properties in sale object
  • salutation, suffix, middle_name, and country_code properties in the payer_info object
  • status property in the address object
  • in progress state in the state property in the payment object

26 February 2015

API updates

API Update
Billing Agreements Added these errors:
  • SUBSCRIPTION_UNMAPPED_ERROR
  • ADDRESS_INVALID
Payments Removed fee from details object.

Doc updates

Doc Update
REST API Reference Updated the C# SDK prerequisites and other requirements to reflect current dependencies.
agreement_state_descriptor Enhanced the description of the amount property in the object to clarify that it is required to bill outstanding amounts but not required when suspending, canceling, or reactivating an agreement.
agreement Corrected the listed properties in the billing object to include the previously missing state and agreement_details properties.
merchant_preferences Enhanced the description of the notify_url property to clarify that this property is read-only and reserved for future use.

13 February 2015

Doc updates

Doc Update
agreement_transaction Corrected the name of the time_updated property in the Billing Agreements API. This property was previously incorrectly named time_stamp in the REST API reference
transaction Enhanced the description of the item_list property to clarify that this property includes the related shipping address for a transaction
Cancel unclaimed payout item Corrected the response description. If successful, this call returns a payout_item_details object with a transaction_status of RETURNED, which was previously incorrectly documented as a payout_item_status.

22 January 2015

API updates

API Update
Payouts Added the new POST /v1/payments/payouts-item/id/cancel endpoint.
Payouts Added the new Cancel unclaimed payout item operation. If an unclaimed item is not claimed within 30 days, the funds are automatically returned to the sender. This call can be used to cancel the unclaimed item prior to the automatic 30-day return.

New features

Feature Description
Demo Portal Added a link to the new Demo Portal to PayPal Payments Standard - Payment buttons.

Additional information