PayPal REST API Release Notes 2014

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.

17 December 2014

API updates

API Update
Vault Updated these endpoints:
POST /v1/vault/credit-cards
DELETE /v1/vault/credit-cards/id
GET /v1/vault/credit-cards/id
PATCH /v1/vault/credit-cards/id
Vault Deprecated the operations with credit-card in the endpoint in favor of credit-cards. Both sets of operations are still valid.
HTTP status codes Updated the list of standard HTTP status codes.

10 December 2014

API updates

API Update
Payouts Added these new endpoints:
POST /v1/payments/payouts
GET /v1/payments/payouts/payout_batch_id
GET /v1/payments/payouts-item/payout_item_id

The Payouts enables you to send up to 500 disbursements in one API call to any email address or US mobile phone number. Send, track, and search for your previously made payouts

03 December 2014

New features

Feature Description
Web checkout guide Revamped this guide.
REST API authentication and headers Added the new PayPal-Client-Metadata-Id header, which replaces the Paypal-Application-Correlation-Id header. For details, see Make future payments.

05 November 2014

API updates

API Update
Webhooks
  • Added the new PAYMENT.SALE.REVERSED and PAYMENT.CAPTURE.REVERSED event types.
  • Removed the PAYMENT.CAPTURE.COMPLETED webhook event type.

23 October 2014

API updates

API Update
Payments Added the new PATCH /v1/payments/payment/Payment-Id method. You can now use PATCH to update the shipping address and the transaction amount of a payment.

15 October 2014

API updates

API Update
Billing Plans Revised the pagination for the list plans method:
GET /v1/payments/billing-plans?page_size=page_size&
  page=page&total_required=total_required

You can now use these parameters for pagination:
  • page_size. The maximum number of results to return at one time. The page_size is a non-negative, non-zero integer. Default is 10.
  • page. The page to return. Default is 0.
  • total_required. The total number of items (total_items) and pages (total_pages) to return in the response.

01 October 2014

API updates

API Update
Webhooks Added these new endpoints:
GET /v1/notifications/webhooks
POST /v1/notifications/webhooks
GET /v1/notifications/webhooks/webhook_id
PATCH /v1/notifications/webhooks/webhook_id
DELETE /v1/notifications/webhooks/webhook_id
GET v1/notifications/webhooks/webhook_id/event-types
GET /v1/notifications/webhooks-events
GET /v1/notifications/webhooks-events/event_id
POST /v1/notifications/webhooks-events/event_id/resend
GET /v1/notifications/webhooks-event-types

Webhooks are HTTP callbacks that receive notification messages for events. As a merchant, you can configure a webhook listener and subscribe it to events. A webhook listener is a server that listens at a specific URL for incoming HTTP POST notification messages that are triggered when events occur. PayPal signs each notification message that it delivers to your webhook listener. Use this API to create, show details for, list, update, and delete webhooks, show event notification details, list event notifications, and resend the notification for an event, list events to which webhooks can subscribe, list event subscriptions for a webhook, and use a sample payload to simulate a webhook event.

17 September 2014

API updates

API Update
Payment Experience Added these new endpoints:
POST /v1/payment-experience/web-profiles
GET /v1/payment-experience/web-profiles
GET /v1/payment-experience/web-profiles/id
PUT /v1/payment-experience/web-profiles/id
PATCH /v1/payment-experience/web-profiles/id
DELETE /v1/payment-experience/web-profiles/id

As a merchant, you can use the to create web experience profiles. A web experience profile enables you to customize payment flow experiences to meet the demands of various products across PayPal. When you create a payment, you can reference a web experience profile. This profile provides your customers with a seamless experience from your merchant cart to the payment flow.

13 August 2014

API updates

API Update
Payments Added these new response fields:
  • clearing_time in the authorization, order, and sale objects
  • custom in the transaction object
  • description in the item object
  • handling_fee in the details object
  • insurance in the details object
  • invoice_number in the transaction object
  • payment_mode in the sale object
  • pending_reason in the sale object
  • protection_eligibility in the authorization, order, and sale objects
  • protection_eligibility_type in the authorization, order, and sale objects
  • reason_code in the order and sale objects
  • shipping_discount in the details object
  • soft_descriptor in the transaction object
  • status in the payer object
  • tax in the item object
  • tax_id in the payer_info object
  • tax_id_type in the payer_info object

Removed middle_name from userinfo object.

Payments The create payment method introduces new parameters that enable capabilities in payment transactions.

23 July 2014

API updates

API Update
Invoicing Added these new endpoints:
GET /v1/invoicing/invoices/invoice-id/qr-code?Query-String
POST /v1/invoicing/invoices/invoice-id/record-payment
POST /v1/invoicing/invoices/invoice-id/record-refund

After you generate QR code for an invoice, you can add the QR code to a paper or PDF invoice. When a customer uses their mobile device to scan the QR code, the customer is redirected to the PayPal mobile payment flow, where they can pay online with PayPal or a credit card.

You can mark invoice as paid and mark invoice as refunded.
Payments Added these new endpoints:
GET /v1/payments/orders
POST /v1/payments/orders

Added the new order intent to the POST /v1/payments/payment method.

Merchants can create and process an order to accept orders for items that may not yet be available for shipment. Additionally, the payment object properties have been updated. The intent can now be set to order, in addition to sale or authorize.

07 July 2014

API updates

API Update
Billing Plans Added these new endpoints:
POST /v1/payments/billing-plans
POST /v1/payments/billing-agreements

You can make automated, recurring payments at regularly scheduled intervals. Billing agreements are contracts between a payer and a payee or between payer and facilitator to send payments according to a billing plan that consists of payment amount, billing cycle, number of billing cycles, and so on.

07 March 2014

API updates

API Update
Invoicing Added the new POST /v1/invoicing/ endpoint. Use this endpoint to create, send, and manage invoices.

Additional information