Java SDK for integrating with PayPal's Express Checkout / MassPay / Web Payments Pro APIs
Clone or download
Bryant Luk
Latest commit 62fc5b7 Feb 15, 2018

This repository contains java sdk and samples for Merchant API.


Please contact PayPal Technical Support for any live or account issues.


To build sdk and samples:

SDK Integration:

For Non-Maven Users:

  • Create a new application.

  • Copy all the jar files present inside 'lib' folder to your application.

For Maven Users:

  • Install all the jar files present inside 'lib' folder manually to local repository.

    mvn install:install-file -Dfile=commons-codec-1.3.jar -DgroupId=commons-codec -DartifactId=commons-codec -Dversion=1.3 -Dpackaging=jar
    mvn install:install-file -Dfile=paypal-core-1.7.0.jar -DgroupId=com.paypal.sdk -DartifactId=paypal-core -Dversion=1.7.0 -Dpackaging=jar
    mvn install:install-file -Dfile=merchantsdk-2.14.117.jar -DgroupId=com.paypal.sdk -DartifactId=merchantsdk -Dversion=2.15.122 -Dpackaging=jar	
  • Create a new maven application.

  • Add dependency to sdk in your application's pom.xml as below.


To make an API call:

  • Import into your code.

  • Create a configuration file '' with parameters specified in configuration section (make sure the file is in class path). Use the default constructor to run with configuration used from '' found in classpath.

    new PayPalAPIInterfaceServiceService();
  • For Dynamic configuration(configuration is tied to the lifetime of the service object)

    new PayPalAPIInterfaceServiceService(new File("/pathto/"));
    new PayPalAPIInterfaceServiceService(new FileInputStream(new File("/pathto/")));
    new PayPalAPIInterfaceServiceService("/pathto/");
    new PayPalAPIInterfaceServiceService(Map<String, String> customConfigurationMap);
    new PayPalAPIInterfaceServiceService(Properties customProperties);
  • The SDK takes defaults for certain parameters (eg: Account Credentials and either of 'mode' or 'service.Endpoint' are mandatory parameters).

  • Create a service wrapper object.

  • Create a request object as per your project needs.

  • Invoke the appropriate method on the service wrapper object.

    For example,

    import urn.ebay.api.PayPalAPI.*;
    TransactionSearchReq txnreq = new TransactionSearchReq();
    TransactionSearchRequestType requestType = new TransactionSearchRequestType();
    PayPalAPIInterfaceServiceService service = new PayPalAPIInterfaceServiceService();
    Map<String, String> customConfigurationMap = new HashMap<String, String>();
    customConfigurationMap.put("mode", "sandbox"); // Load the map with all mandatory parameters
    PayPalAPIInterfaceServiceService service = new PayPalAPIInterfaceServiceService(Map<String, String> customConfigurationMap);
    TransactionSearchResponseType txnresponse = service.transactionSearch(txnreq, username);

SDK Logging:

  • For logging - java.util.logging has been used. To change the default configuration, edit the file in 'jre/lib' folder under your JDK root.

SDK Configuration:

The SDK uses dynamic configuration map or '*.properties' format configuration file as shown in code snippet above, to configure

  • Mode is specified using the parameter name 'mode' with values 'sandbox' or 'live', if specified 'service.EndPoint' parameter is not required and the SDK chooses the sandbox or live endpoints automatically.

  • (Multiple) API account credentials, by appending a '.' (dot) character and the service name to 'service.EndPoint' parameter.

  • HTTP connection parameters, if certain connection parameters are not specified, the SDK will assume defaults for them.

  • Service configuration.

  • You can refer full list of configuration parameters in wiki page.

Multiple SDK usage (Multiple End-points Support)

Multiple end-points configuration can be done by specifying mulitple end-points identified by specific property keys. When using multiple SDKs in combination, like Merchant and Permissions etc..configure the endpoints as shown below one for each service used, The existing service.EndPoint property is still supported for backward compatibility (using a single SDK). The list below specifies endpoints for different services, in SANDBOX and PRODUCTION, with their property keys and end-point as property values.

For additional information on Merchant API, please refer to

Instant Payment Notification(IPN)