PermissionsSDK

The PayPal Permission SDK provides Java APIs for developers to request and obtain permissions from merchants and consumers, to execute APIs on behalf of them. The permissions include variety of operations from processing payments to accessing account transaction history.

License

License

GroupId

GroupId

com.paypal.sdk
ArtifactId

ArtifactId

permissionssdk
Last Version

Last Version

2.6.109
Release Date

Release Date

Type

Type

jar
Description

Description

PermissionsSDK
The PayPal Permission SDK provides Java APIs for developers to request and obtain permissions from merchants and consumers, to execute APIs on behalf of them. The permissions include variety of operations from processing payments to accessing account transaction history.
Project URL

Project URL

https://developer.paypal.com/
Source Code Management

Source Code Management

https://github.com/paypal/permissions-sdk-java.git

Download permissionssdk

How to add to project

<!-- https://jarcasting.com/artifacts/com.paypal.sdk/permissionssdk/ -->
<dependency>
    <groupId>com.paypal.sdk</groupId>
    <artifactId>permissionssdk</artifactId>
    <version>2.6.109</version>
</dependency>
// https://jarcasting.com/artifacts/com.paypal.sdk/permissionssdk/
implementation 'com.paypal.sdk:permissionssdk:2.6.109'
// https://jarcasting.com/artifacts/com.paypal.sdk/permissionssdk/
implementation ("com.paypal.sdk:permissionssdk:2.6.109")
'com.paypal.sdk:permissionssdk:jar:2.6.109'
<dependency org="com.paypal.sdk" name="permissionssdk" rev="2.6.109">
  <artifact name="permissionssdk" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.paypal.sdk', module='permissionssdk', version='2.6.109')
)
libraryDependencies += "com.paypal.sdk" % "permissionssdk" % "2.6.109"
[com.paypal.sdk/permissionssdk "2.6.109"]

Dependencies

compile (1)

Group / Artifact Type Version
com.paypal.sdk : paypal-core jar 1.7.0

Project Modules

There are no modules declared in this project.

This repository contains java sdk and samples for Permissions API.

Support

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

Prerequisites:

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.0.jar -DgroupId=com.paypal.sdk -DartifactId=paypal-core -Dversion=1.0 -Dpackaging=jar
    mvn install:install-file -Dfile=permissionssdk-2.5.109.jar -DgroupId=com.paypal.sdk -DartifactId=permissionssdk -Dversion=2.5.109 -Dpackaging=jar	
    

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.0.jar -DgroupId=com.paypal.sdk -DartifactId=paypal-core -Dversion=1.0 -Dpackaging=jar
    mvn install:install-file -Dfile=permissionssdk-2.5.109.jar -DgroupId=com.paypal.sdk -DartifactId=permissionssdk -Dversion=2.5.109 -Dpackaging=jar	
    
  • Create a new maven application.

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

    <dependency>
        <groupId>com.paypal.sdk</groupId>
        <artifactId>permissionssdk</artifactId>
        <version>2.5.109</version>
    </dependency>

To make an API call:

  • Import PermissionsService.java into your code.

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

    new PermissionsService();
  • For Dynamic configuration(configuration is valid for the lifetime of the service object)

    new PermissionsService(new File("/pathto/custom.properties"));
    		Or
    new PermissionsService(new FileInputStream(new File("/pathto/custom.properties")));
    		Or
    new PermissionsService("/pathto/custom.properties");
    		Or
    new PermissionsService(Map<String, String> customConfigurationMap);
    		Or
    new PermissionsService(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 com.paypal.svcs.services.PermissionsService;
    import com.paypal.svcs.types.common.RequestEnvelope;
    import com.paypal.svcs.types.perm.*;
    ...
    RequestEnvelope env = new RequestEnvelope();
    env.setErrorLanguage("en_US");
    ...
    List<String> scope = new ArrayList<String>();
    String value="INVOICING";
    scope.add(value);
    ...
    RequestPermissionsRequest requestPermissionsRequest = new RequestPermissionsRequest(scope, callback);
    requestPermissionsRequest.setRequestEnvelope(env);
    ...
    PermissionsService permissionsService = new PermissionsService();
    		Or
    Map<String, String> customConfigurationMap = new HashMap<String, String>();
    customConfigurationMap.put("mode", "sandbox"); // Load the map with all mandatory parameters
    ...
    PermissionsService permissionsService = new PermissionsService(Map<String, String> customConfigurationMap);
    RequestPermissionsResponse requestPermissionsResponse = permissionsService.requestPermissions(
                                                                    requestPermissionsRequest,userName);

SDK Logging:

  • For logging - java.util.logging has been used. To change the default configuration, edit the logging.properties 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 Permissions API, please refer to https://www.x.com/developers/paypal/documentation-tools/api

com.paypal.sdk

PayPal

Versions

Version
2.6.109
2.5.109
2.4.109
2.3.106
2.2.101
2.2.100
2.1.96