Merchant API v117.0 release notes

Merchant API v117.0 includes the following PayPal releases:

Code release version Release date Description
117 08/20/2014 See release details.

These release notes include the API operations within the PayPal Merchant API WSDL and associated schemas.

The document covers changes to the Merchant APIs, which include:

  • Express Checkout
  • Direct Payment
  • Recurring Payments
  • Mass Payments
  • Button Manager
  • PayPal Payments Standard
  • Website Payments Pro

Release details

For a current list of PayPal product and API issues, as well as upcoming maintenance events, go to PayPal Status.

New features

Support for PLCC and co-branded payment cards

The following fields have been added to the Express Checkout API operations to support private label credit cards (PLCC) and co-branded payment cards. For code samples that show how to integrate the following new fields, see How To Use Loyalty Programs and PLCC in Express Checkout.

New element Description Type
GetExpressCheckoutDetailsResponseDetailsType.
InstrumentDetails
Added new response field. Returned when a promotional payment instrument is used in the payment, such as PayPal Credit® (formerly Bill Me Later®) or a private label credit card (PLCC) payment. For details, see the GetExpressCheckoutDetails (NVP | SOAP) API operation. ebl:InstrumentDetailsType
GetExpressCheckoutDetailsResponseDetailsType.
InstrumentDetails.
InstrumentDetailsType.InstrumentCategory
Added new response field. Returns the category of the promotional payment instrument used in the payment, such as, PayPal Credit® (formerly Bill Me Later) or a private label credit card (PLCC) payment. For details, see the GetExpressCheckoutDetails (NVP | SOAP) API operation. xs:string
GetExpressCheckoutDetailsResponseDetailsType.
InstrumentDetails.
InstrumentDetailsType.InstrumentID
Added new response field. Returns the instrument ID (issued by the external party) corresponding to the funding source used in the payment. For details, see the GetExpressCheckoutDetails (NVP | SOAP) API operation. xs:string
DoExpressCheckoutPaymentRequestDetailsType.
PaymentDetails.PaymentDetailsType.
MerchantData
Added new request fields. Can be used to pass any merchant-specific data. For details, see the DoExpressCheckoutPayment (NVP | SOAP) API operation. ebl:MerchantDataType
DoExpressCheckoutPaymentRequestDetailsType.
PaymentDetails.PaymentDetailsType.
MerchantData.MerchantDataTuple
Added new request field. Holds all merchant data key-value pairs passed from the merchant. For details, see the DoExpressCheckoutPayment (NVP | SOAP) API operation. ebl:MerchantDataType
DoExpressCheckoutPaymentRequestDetailsType.
PaymentDetails.PaymentDetailsType.
MerchantData.MerchantDataTuple.Key
Added new request field for the merchant data key name, part of a key-value pair. For details, see the DoExpressCheckoutPayment (NVP | SOAP) API operation. xs:string
DoExpressCheckoutPaymentRequestDetailsType.
PaymentDetails.PaymentDetailsType.
MerchantData.MerchantDataTuple.Value
Added new request field for merchant data value, part of a key-value pair. For details, see the DoExpressCheckoutPayment (NVP | SOAP) API operation. xs:string

Error and warning codes

This release adds these error codes:

API operation Code
DoUATPAuthorization 14001
ManagePendingTransactionStatus 11614

See API error codes.