Skip to content
GoPay's JAVA SDK for Payments REST API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
apache-cxf
apache-http-client
common
resteasy
.gitignore
.travis.yml
LICENSE
Readme.md
pom.xml

Readme.md

GoPay Java API

Detailed guide: https://doc.gopay.com

Requirements

  • Java 7+

Building

git clone https://github.com/gopaycommunity/gopay-java-api.git
cd gopay-java-api
mvn package
  • Building a specific module
git clone https://github.com/gopaycommunity/gopay-java-api.git
cd gopay-java-api/<module-name>
mvn package

Maven

All artifacts are located in the maven central repository.

http://mvnrepository.com/artifact/cz.gopay

<!-- GPAPI common -->
<dependency>
    <groupId>cz.gopay</groupId>
    <artifactId>gp-java-api-v3-common</artifactId>
    <version>3.4.6</version>
</dependency>
<!-- GPAPI Apache Http Client -->
<dependency>
   	<groupId>cz.gopay</groupId>
   	<artifactId>gp-java-api-v3-apache-http-client</artifactId>
   	<version>3.4.6</version>
</dependency>

OAuth

To be able to communicate with our gateway it's required to create an auth token.

IGPConnector connector = HttpClientGPConnector.build(<API_URL>);
connector.getAppToken(<CLIENT_ID>,<CLIENT_CREDENTIALS>); 

The token gets cached in GPConnector object and its lifetime is 30 minutes. The method getAppToken(String, String) creates token in a scope "payment-create". If you would like to create a token in a different scope call method getAppToken(<CLIENT_ID>,<CLIENT_CREDENTIALS>,<SCOPE>) Once the token expires its required to obtain a new one by calling the method getAppToken again.

Basic usage

Creating an instance of GPConnector

IGPConnector connector = HttpClientGPConnector.build(<API_URL>);

The connector provides methods for interacting with our gateway.

Avalaible methods

Method API Action
createPayment https://doc.gopay.com/en/#standard-payment
paymentStatus https://doc.gopay.com/en/#status-of-the-payment
refundPayment https://doc.gopay.com/en/#refund-of-the-payment-(cancelation)
createRecurrentPayment https://doc.gopay.com/en/#recurring-payment
voidRecurrency https://doc.gopay.com/en/#cancellation-of-the-recurring-payment
voidAuthorization https://doc.gopay.com/en/#cancellation-of-the-pre-authorized-payment
capturePayment https://doc.gopay.com/en/#charge-of-pre-authorized-payment
Create a payment
BasePayment payment = PaymentFactory.createBasePaymentBuilder()
    .order(<ORDER_NUMBER>, <AMOUNT>, Currency.EUR, <DESCRIPTION>)
    .addItem(<ITEM_NAME>, <AMOUNT>, <FEE>, <COUNT>)
    .addAdditionalParameter(<Key>, <VALUE>)
    .withCallback(<RETURN_URL>, <NOTIFY_URL>)
    .payer(<Payer>)
    .inLang(Lang.EN)
    .toEshop(<GO_ID>)
    .build();
try {
    Payment result = connector.createPayment(payment);
} catch (GPClientException e) {
    
}
Payment status
try {
    Payment payment = connector.paymentStatus(<PAYMENT_ID>);
} catch (GPClientException e) {
     //
}
Payment refund
try {
      PaymentResult result = connector.refundPayment(<PAYMENT_ID>, <AMOUNT>);
} catch (GPClientException e) {
      //
}
Create preauthorized payment
Payment payment = PaymentFactory.createPaymentBuilder().preauthorize()...
try {
    connector.createPayment(payment);
} catch (GPClientException ex) {
    //
}
Void authorization
try {
    PaymentResult voidAuthorization = connector.voidAuthorization(<ID>);
} catch (GPClientException ex) {
    //
}
Recurrent payment
Calendar calendar = Calendar.getInstance();
calendar.set(Calendar.YEAR, 2016);
calendar.set(Calendar.MONTH, 2);
calendar.set(Calendar.DAY_OF_MONTH, 1);
Recurrence r = Recurrence.build(calendar.getTime())
    .withTimeInterval(RecurrenceCycle.WEEK, 1)
    .inState(Recurrence.RecurrenceState.STARTED);
payment.setRecurrence(r);
 
try {
    connector.createPayment(payment);
} catch {GPClientException e) {
    //
}
Capture payment
try {
    PaymentResult capture = connector.capturePayment(<ID>);
} catch (GPClientException ex) {
    //
}
Void recurrency
try {
   PaymentResult voidRecurrency = connector.voidRecurrency(<ID>);
} catch (GPClientException ex) {
    //
}

All methods above throw checked exception GPClientException on a failure.

try {
    HttpClientGPConnector.build(<API_URL>).getAppToken(<CLIENT_ID>,<CLIENT_CREDENTIALS>)
        .createPayment(payment);
} catch (GPClientException e) {
    for (ErrorElement err : e.getError().getErrorMessages()) {
        int code = err.getErrorCode();
        String message = err.getMessage();
        String field = err.getField();
        
    }
}

For more code samples check out unit tests

Framework support

If Apache HTTP Client does not suit you, the api supports two frameworks

  • Resteasy
  • Apache CXF

Each integration has its own maven module.

  • Creating Resteasy connector

    IGPConnector connector = ResteasyGPConnector.build(<API_URL>);

    Requires Resteasy connector:

    <dependency>
       <groupId>cz.gopay</groupId>
       <artifactId>gp-java-api-v3-resteasy</artifactId>
       <version>3.4.6</version>
    </dependency>
  • Creating Apache CXF connector

    IGPConnector connector = CXFGPConnector.build(<API_URL>);

    Requires apache cxf connector:

      <dependency>
          <groupId>cz.gopay</groupId>
          <artifactId>gp-java-api-v3-apache-cxf</artifactId>
          <version>3.4.6</version>
      </dependency>

If you would like to create your own GPConnector, inherit from a class AbstractGPConnector and override a method T createRESTClientProxy(String apiUrl, Class<T> proxy).The proxy parameter is either an interface PaymentClient or AuthClient. You must create implementations of both and return instance of correct class.

  • Model builders

You can use several builder objects to achieve better code readability.

  • Payment builder

    BasePayment payment = PaymentFactory.createBasePaymentBuilder()
            .order(<ORDER_NUMBER>, <AMOUNT>, Currency.EUR, <DESCRIPTION>)
            .addItem(<ITEM_NAME>, <AMOUNT>, <FEE>, <COUNT>)
            .addAdditionalParameter(<Key>, <VALUE>)
            .withCallback(<RETURN_URL>, <NOTIFY_URL>)
            .payer(<Payer>)
            .inLang(Lang.EN)
            .toEshop(<GO_ID>)
            .build();
  • Payer builder

    Payer payer = new PayerBuilder()
            .withAllowedPaymentInstruments(Arrays.asList(PaymentInstrument.BANK_ACCOUNT))
            .addAllowedSwift(<SWIFT>).build();

Contributing

Contributions from others would be very much appreciated! Send pull request/ issue. Thanks!

License

Copyright (c) 2016 GoPay.com. MIT Licensed, see LICENSE for details.

You can’t perform that action at this time.