Merchant API v104.0 release notes

Merchant API v104.0 includes the following PayPal releases:

Code release version Release date Description
104 06/25/2013 Changes to the API are described below.
105 07/23/2013 No changes to the API.

This release note addresses the API operations within the PayPal Merchant API WSDL and associated schemas:

The Merchant APIs 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
  • PayPal Payments Pro — see the Express Checkout section that follows for related release notes

Express Checkout

For a current list of known issues, see PayPal Notifications page and enter the product or API of interest, such as Express Checkout, in the search box.

Express Checkout - New calls

UpdateAuthorization API operation.

Note: Advanced permission from PayPal is required to use this API operation.

Use the UpdateAuthorization API operation (NVP | SOAP) to change the shipping address of an existing authorization transaction. In order to use this API operation, the original authorization should still be open, not completed, not reversed, not voided, and not on hold for any reason.

Express Checkout - Changed calls

  • DoAuthorization
  • DoExpressCheckoutPayment
  • SetExpressCheckout

Express Checkout - Schema changes

Name DoAuthorizationRequestType.ShipToAddress.AddressType
DoAuthorizationRequestType.PaymentDetailsItem.PaymentDetailsItemType
DoAuthorizationRequestType.ItemTotal.BasicAmountType
DoAuthorizationRequestType.ShippingTotal.BasicAmountType
DoAuthorizationRequestType.HandlingTotal.BasicAmountType
DoAuthorizationRequestType.TaxTotal.BasicAmountType
DoAuthorizationRequestType.InsuranceTotal.BasicAmountType
DoAuthorizationRequestType.ShippingDiscount.BasicAmountType
DoAuthorizationRequestType.OrderDescription
DoAuthorizationRequestType.Custom
Part of schema Element
Type of change New
Description See DoAuthorization (NVP | SOAP) for details.

Name PaymentDetails.PaymentDetailsType.MultiShipping in:
DoExpressCheckoutPaymentRequestDetails
SetExpressCheckoutRequestDetails
Part of schema Element
Type of change New
Description See DoExpressCheckoutPayment (NVP | SOAP) and SetExpressCheckout (NVP | SOAP) for details.

Additional documentation updates

Express Checkout - Additional documentation updates

Merchant API and Express Checkout documentation updates (Jul. 23, 2013)

Moved the SetCustomerBillingAgreement (NVP | SOAP) and GetBillingAgreementCustomerDetails (NVP | SOAP) API operations reference pages to the documentation archive.

Updated the How To Recover from Funding Failure Error Code 10486 in DoExpressCheckoutPayment guide. This error code will now be returned for the Authorization and Capture transaction flow (in addition to the PaymentAction of Sale).

Merchant API and Express Checkout documentation updates (Jul. 09, 2013)

Marked the HDRBORDERCOLOR and HDRBACKCOLOR NVPs and the cpp-header-border and cpp-header-back-color SOAP fields as deprecated in the SetExpressCheckout (NVP | SOAP) API operation.

Added the following note in the Currency Codes page for the Hungarian Forint (HUF) currency.

Note: This currency does not support decimals. Passing a decimal amount throws an error.

Merchant API and Express Checkout documentation updates (Jun. 26, 2013)

Added the following note to description of the INVNUM NVP field and InvoiceID SOAP field in the DoCapture (NVP | SOAP), DoDirectPayment (NVP | SOAP), DoExpressCheckoutPayment (NVP | SOAP), DoReferenceTransaction (NVP | SOAP), RefundTransaction (NVP | SOAP), and SetExpressCheckout (NVP | SOAP) API operations.

Note: PayPal recommends using this field to associate transactions with your internal tracking IDs or invoice numbers; populating the invoice ID field will help you pull transaction information at a later date using only your internal ID.

Corrected the locale code value for Japanese language — Japan from jp_JP to ja_JP in the Callback (NVP) and SetExpressCheckout (NVP | SOAP) API operations.

Added the following note to the PAYMENTADVICECODE NVP field description and the PaymentAdviceCode SOAP field in DoDirectPayment (NVP | SOAP) and DoReferenceTransaction (NVP | SOAP) API operations.

Note: If a recurring payment transaction is declined with the PAYMENTADVICECODE or PaymentAdviceCode value of 03 or 21, it is the merchant's responsibility to stop this recurring payment. These payment advice codes indicate that either the account was closed, fraud was involved, or the cardholder has asked their bank to stop this payment for another reason. Even if a reattempted transaction is successful, it likely results in a chargeback.