payfac-mp-sdk-java

The PayFac Merchant Provisioner SDK is a Java implementation of the Worldpay PayFac Merchant Provisioner API. This SDK was created to make it as easy as possible to perform operations that allows you to create and update Legal Entities and Sub-merchants, as well as retrieve information about existing Legal Entities and Sub-merchants in near real-time. This SDK utilizes the HTTPS protocol to securely connect to Worldpay. Using the SDK requires coordination with the Vantiv eCommerce team in order to be provided with credentials for accessing our systems.

Each Java SDK release supports all of the functionality present in the associated PayFac Merchant Provisioner API version (e.g., SDK v13.0.0 supports API v13.0.0). Please see our documentation for PayFac Merchant Provisioner API to get more details on what operations are supported.

This SDK is implemented to support the Java programming language and is created by Worldpay. Its intended use is for PayFac API operations with Worldpay.

Getting Started

These instructions will help you get started with using the SDK.

Prerequisites

None.

Setup

1. Add JCenter repository to your Maven or Gradle build:
   1. For Maven, please read instructions at: https://bintray.com/bintray/jcenter
   2. For Gradle, add jcenter() to your repositories { ... }
2. Add the dependency

   1. For Maven:

          <dependency>
            <groupId>com.worldpay</groupId>
            <artifactId>payfac-mp-sdk-java</artifactId>
            <version>13.0.0</version>
            <type>pom</type>
          </dependency>

   2. For Gradle:

          compile 'com.worldpay:payfac-mp-sdk-java:13.0.0'

3. Create your configuration file with one of the following
   • Run java -jar /path/to/payfac-mp-sdk-java-X.X.X.jar and answer the questions, or
   • Add a file .payfac_SDK_config.properties to your home directory with the correct properties in it

Configuration

List of configuration parameters along with their values can be found here.

Usage example

import com.mp.sdk.ApprovedMccResponse;
import com.mp.sdk.Communication;
import com.mp.sdk.Configuration;
import com.mp.sdk.PayFacMcc;

public class SamplePayFacRequest {

  public static void main(String[] args) {

    PayFacMcc payFacMcc = new PayFacMcc();
    ApprovedMccResponse response = payFacMcc.getMcc();
    
    // Display result
    System.out.println("Mcc: " + response.getApprovedMccs());
  }
}

Built With

• Gradle - The build tool
• Maven - Dependency Management

Versioning

For the versions available, see the tags on this repository.

Changelog

For the list of changes, check out the changelog

Authors

• Ayush Agarwal
• Chen Chang

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Examples

More examples can be found in Functional and Unit Tests

Support

Please contact Vantiv eCommerce to receive valid merchant credentials in order to run tests successfully or if you require assistance in any way. Support can also be reached at [email protected]