PayPal Merchant API Release Notes - Version 115.0

Version 115 of the Merchant API includes the following PayPal releases:

Code release version Release date Description
115 06/17/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 known issues, go to the PayPal Notifications page and enter the product or API of interest, such as Express Checkout, in the search box.

New features

Location type and location ID in Express Checkout

The following fields are added to the SetExpressCheckout API operation in order to support location information for BOPIS (buy online pick-up in store) and PUDO (pick-up drop-off) transactions.

New / Modified element Description Type
SetExpressCheckoutRequestDetailsType.PaymentDetailsType.PaymentCategoryType Added new Payment category enumeration values for BOPIS (buy online pick-up in store) and PUDO (pick-up drop-off) transactions. For details, see the SetExpressCheckout (NVP | SOAP) API operation. (new enumeration values)
SetExpressCheckoutRequestDetailsType.PaymentDetailsType.LocationType Added a new field for specifying the location type for BOPIS (buy online pick-up in store) and PUDO (pick-up drop-off) transactions. For details, see the SetExpressCheckout (NVP | SOAP) API operation. xs:string (new)
SetExpressCheckoutRequestDetailsType.PaymentDetailsType.LocationID Added a new field for specifying the location ID for BOPIS (buy online pick-up in store) or PUDO (pick-up drop-off) transactions. The location ID can be any string with a maximum length of 50 characters. For details, see the SetExpressCheckout (NVP | SOAP) API operation. xs:string (new)

Dynamic soft descriptors in Direct Payment – Website Payments Pro

A soft descriptor is the authorization or charge description that appears on the card holder's statement. Descriptors enable the buyer to recognize the seller and help prevent unauthorized chargebacks. Dynamic Soft descriptors allow the merchant to send a unique business name and phone number on a per transaction basis.

The following fields have been added to several API operations as a part of the merchant soft descriptor feature.

  • SoftDescriptor — This field is for specifying the merchant's name or product soft descriptor information, for example, , , duesor list fee, which typically appears in the account holder's statement.
  • SoftDescriptorCity — This field allows ecommerce merchants to pass a unique phone number, email address or URL, which is displayed on the account holder's statement. PayPal recommends passing a toll-free number because, typically, this is the easiest way for a buyer to contact the seller in the case of an inquiry.

Note: This feature must be enabled for your merchant account before you can take advantage of it. Please contact PayPal Customer Support for feature activation.

New element Description Type
CreateRecurringPaymentsProfile
RequestDetailsType.SoftDescriptor
For details, see the CreateRecurringPaymentsProfile (NVP | SOAP) API operation. xs:string (new)
CreateRecurringPaymentsProfile
RequestDetailsType.SoftDescriptorCity
For details, see the CreateRecurringPaymentsProfile (NVP | SOAP) API operation. xs:string (new)
DoDirectPaymentRequest
DetailsType.SoftDescriptor
For details, see the DoDirectPayment (NVP | SOAP) API operation. xs:string (new)
DoDirectPaymentRequest
DetailsType.SoftDescriptorCity
For details, see the DoDirectPayment (NVP | SOAP) API operation. xs:string (new)
DoReferenceTransactionRequest
DetailsType.PaymentInfoType.SoftDescriptor
For details, see the DoReferenceTransaction (NVP | SOAP) API operation. xs:string (new)
DoReferenceTransactionRequest
DetailsType.PaymentInfoType.SoftDescriptorCity
For details, see the DoReferenceTransaction (NVP | SOAP) API operation. xs:string (new)
GetRecurringPaymentsProfileDetails
ResponseDetailsType.SoftDescriptor
For details, see the GetRecurringPaymentsProfileDetails (NVP | SOAP) API operation. xs:string (new)
GetRecurringPaymentsProfileDetails
ResponseDetailsType.SoftDescriptorCity
For details, see the GetRecurringPaymentsProfileDetails (NVP | SOAP) API operation. xs:string (new)
GetTransactionDetailsResponse
Type.PaymentTransactionDetails.SoftDescriptor
For details, see the GetTransactionDetails (NVP | SOAP) API operation. xs:string (new)

Error and warning codes

  • Added SetExpressCheckout error code to support the new location type and id capability. For details, see the SetExpressCheckout 17004 error code. This error is returned when the LocationType field value is invalid. Set LocationType to Store for a BOPIS (buy online pickup in store) transaction or PICKUP_DROP_OFF for a PUDO (pick up /drop off) transaction.

  • Added five DoDirectPayment warning codes to support the newly added soft descriptor capability. For details, see the DoDirectPayment error codes: 10215, 10217, 10218, 10219, and 10220. These warnings are sent with a successful transaction response when the SoftDescriptor or SoftDescriptorCity fields are modified by the API for containing too many characters or illegal characters, or if the merchant is not enabled to supply soft descriptor information.

Changed functionality

PayPal now supports Canadian issued Visa debit cards within our Website Payments Pro, PayPal Payments Pro, PayPal Payments Advanced and Virtual Terminal products in Canada. An opt-in page to enable this feature is displayed when a merchant logs in to the paypal.com website. Once the merchant clicks accept, the changes are effective; no code changes are required. Merchants can also contact PayPal customer service to enable this feature. Canadian merchants who do not enable this new capability receive the DoDirectPayment error code 10566 for Canadian issued Visa debit card payment transactions.