Merchant API v98.0 release notes

Merchant API v98.0 includes these PayPal releases:

Code release version Release date Description
99 02/20/2013 No changes to the API.
98 02/01/2013 Changes to the API are described below.

This release note addresses 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 Pay
  • Button Manager
  • PayPal Payments Standard
  • Website Payments Pro

Affected products

This release affects these products:

  • Express Checkout
  • Website Payments Pro — See Express Checkout section for related release notes

Express Checkout

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

Express Checkout - Changed calls

  • DoAuthorization
  • DoCapture
  • DoExpressCheckoutPayment
  • DoReferenceTransaction
  • GetExpressCheckoutDetails
  • GetTransactionDetails
  • RefundTransaction

Express Checkout - Schema changes

Name AddressType.AddressNormalizationStatusCodeType in
Part of schema Element
Type of change New
Description The AddressNormalizationStatus field returns the normalization status of the address. Possible values are Normalized, Unnormalized, and None. For more information, see the GetExpressCheckoutDetailsSOAP and NVP API reference pages.

Name AuthorizationInfoType.PendingStatusCodeType in
PaymentInfoType.PendingStatusCodeType in:
PaymentTransactionType.PaymentInfoType.PendingStatusCodeType in
RefundInfoType.PendingStatusCodeType in
Part of schema Enumeration
Type of change New
Description The PendingReason field can return a new value: regulatory-review (SOAP) or regulatoryreview (NVP).
Important: As of September 2017, the return value is regulatoryreview.

Additional documentation updates

Express Checkout - Additional documentation updates

API reference and Express Checkout documentation updates (Jun. 05, 2013)

Added the Montenegro ME and the Republic of Serbia RS country codes.

Starting on the 5th of June 2013, PayPal returns, in the majority of DoExpressCheckoutPayment funding failure cases, error code 10486 instead of 10417. Both errors 10417 and 10486 are returned when the transaction cannot be completed, but with API error code 10486 you can redirect the user to PayPal using the existing token to select an alternate funding source, without the need to reinitiate the entire transaction flow. See the How To Recover from Funding Failure Error Code 10486 in DoExpressCheckout guide for more information. Additionally, funding failure error code 10486 is now returned for all versions of the Merchant API, and not only for versions 88 and higher.

Updated the long message for the 10417 error code in API error codes to Instruct the customer to retry the transaction using an alternative payment method from the customer's PayPal wallet. The transaction did not complete with the customer's selected payment method.

API reference and Express Checkout documentation updates (May 08, 2013)

Added LOGOIMG and CARTBORDERCOLOR NVP fields to the SetExpressCheckout NVP API reference page and cpp-logo-image and cpp-cart-border-color to the SetExpressCheckout SOAP API reference page.

Added MassPayItem Type fields to the MassPay SOAP API reference page and to the MassPay NVP API reference page.

In the ExpressCheckout Integration Guide, clarified idempotency behavior as follows: The result in subsequent responses is different from the original transaction response and returns SuccessWithWarning instead of Success.

API reference and Express Checkout documentation updates (Mar. 27, 2013)

Added Sandbox testing instructions to the HowTo guide on recovering from the Express Checkout error 10486.

Clarified that the L_PAYMENTREQUEST_n_AMTm field in the SetExpressCheckout NVP API Operation is required for the payment details to appear to the buyer at checkout.

Removed Mobile Express Checkout Library requirement for mobile Express Checkout apps in the Express Checkout Integration Guide Mobile Devices chapter (page discontinued).

Corrected typo in the name of the L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNIDm NVP request field in the DoExpressCheckoutPayment and SetExpressCheckout API operations.

API reference updates (Mar. 06, 2013)

Updated the DoReferenceTransaction SOAP and DoReferenceTransaction NVP API operation request fields. The IPADDRESS (NVP) and IPAddress (SOAP) field now accept IPv6 and IPv4-mapped IPv6 IP addresses in addition to IPv4 IP addresses.

API reference updates (Mar. 01, 2013)

Updated the DoDirectPayment, DoExpressCheckoutPayment, DoReferenceTransaction SOAP API operation request fields. Corrected the data type of the ReturnFMFDetails field to xs:int.

API reference updates (Feb. 01, 2013)

Updated the API error codes. Added the following DoReferenceTransaction error codes: 10422, 10445, 10613, 11457, 11458, 13109 Added the 10544 error code. Added the 11607 error code to the CreateBillingAgreement, DoAuthorization, DoCapture, DoDirectPayment, DoExpressCheckoutPayment, DoReAuthorization, DoReferenceTransaction, DoVoid, and the Recurring Payments API error codes. Updated the error message for 13122 in the DoAuthorization, DoCapture, DoExpressCheckoutPayment, DoReferenceTransaction, the Recurring Payments, and RefundTransaction API error codes.

Corrected the list of possible response values returned in the fields CHECKOUTSTATUS (NVP) and CheckoutStatus (SOAP) in the GetExpressCheckoutDetails API documentation.

Added the following to the description of the PAYMENTREQUEST_n_CURRENCYCODE NVP field in the DoExpressCheckoutPayment and SetExpressCheckout API documentation and to the description of the OrderTotal SOAP field in the DoExpressCheckoutPayment and the SetExpressCheckout API documentation: When multiple payments are passed in one transaction, all of the payments must have the same currency code.

Updated the INVNUM payment details request field description in the DoReferenceTransaction API documentation. Updated the FIRSTNAME and LASTNAME payer information request fields descriptions in the DoReferenceTransaction API documentation.