Craftgate Java Client

This repo contains the Java client for Craftgate API.

Requirements

• Java 1.8 or newer

Installation

Apache Maven:

<dependency>
  <groupId>io.craftgate</groupId>
  <artifactId>craftgate</artifactId>
  <version>1.0.41</version>
</dependency>

Gradle Groovy DSL

implementation 'io.craftgate:craftgate:1.0.41'

Gradle Kotlin DSL

implementation("io.craftgate:craftgate:1.0.41")

Usage

To access the Craftgate API you'll first need to obtain API credentials (e.g. an API key and a secret key). If you don't already have a Craftgate account, you can signup at https://craftgate.io

Once you've obtained your API credentials, you can start using Craftgate by instantiating a Craftgate with your credentials.

Craftgate craftgate = new Craftgate("<YOUR API KEY>", "<YOUR SECRET KEY>");
...

By default the Craftgate client connects to the production API servers at https://api.craftgate.io. For testing purposes, please use the sandbox URL https://sandbox-api.craftgate.io using the .

Craftgate craftgate = new Craftgate("<YOUR API KEY>", "<YOUR SECRET KEY>", "https://sandbox-api.craftgate.io");
...

Examples

Included in the project are a number of examples that cover almost all use-cases. Refer to the sample/ folder] for more info.

Running the Examples

If you've cloned this repo on your development machine and wish to run the examples you can run an example with the command ./gradlew test or run single test with the command ./gradlew test --tests PaymentSample.create_payment_sample

Credit Card Payment Use Case

Let's quickly review an example where we implement a credit card payment scenario.

For more examples covering almost all use-cases, check out the examples in the sample/ folder

Craftgate craftgate = new Craftgate("api-key", "secret-key", "https://sandbox-api.craftgate.io");

List<PaymentItem> items = new ArrayList<>();

items.add(PaymentItem.builder()
        .name("item 1")
        .externalId(UUID.randomUUID().toString())
        .price(BigDecimal.valueOf(30))
        .build());

items.add(PaymentItem.builder()
        .name("item 2")
        .externalId(UUID.randomUUID().toString())
        .price(BigDecimal.valueOf(50))
        .build());

items.add(PaymentItem.builder()
        .name("item 3")
        .externalId(UUID.randomUUID().toString())
        .price(BigDecimal.valueOf(20))
        .build());

CreatePaymentRequest request = CreatePaymentRequest.builder()
        .price(BigDecimal.valueOf(100))
        .paidPrice(BigDecimal.valueOf(100))
        .walletPrice(BigDecimal.ZERO)
        .installment(1)
        .currency(Currency.TRY)
        .conversationId("456d1297-908e-4bd6-a13b-4be31a6e47d5")
        .paymentGroup(PaymentGroup.LISTING_OR_SUBSCRIPTION)
        .paymentPhase(PaymentPhase.AUTH)
        .card(Card.builder()
                .cardHolderName("Haluk Demir")
                .cardNumber("5258640000000001")
                .expireYear("2044")
                .expireMonth("07")
                .cvc("000")
                .build())
        .items(items)
        .build();

PaymentResponse response = craftgate.payment().createPayment(request);
System.out.println(String.format("Create Payment Result: %s", response));

Advanced Usage: Adapters

In reality, the Craftgate class serves as a collection of adapters that integrates with different parts of the API. While the intended usage for most use-cases is to instantiate a Craftgate instance (as illustrated in the examples above) and use its adapter accessors (e.g. payment()), you can also manually import a certain adapter class and instantiate it.

Note: When instantiating an adapter, you can use the same options as you would when instantiating a Craftgate

For all adapters in the Craftgate, their purposes, accessors, as well as direct import paths, refer to the list below:

Adapter Name	Purpose	Accessor
InstallmentAdapter	Retrieving per-installment pricing information based on installment count or BIN number	installment()
OnboardingAdapter	Conducting CRUD operations on buyers and submerchants	onboarding()
PaymentAdapter	Conducting payments, retrieving payment information, managing stored cards	payment()
WalletAdapter	Wallet operations like send, receive remittance and search wallets or wallet transactions of member's	wallet()
SettlementReportingAdapter	Settlement operations like search payout completed transactions, search bounced payout transactions	settlementReporting()
SettlementAdapter	Settlement operations like create instant wallet settlement	settlement()

Contributions

For all contributions to this client please see the contribution guide here.

License

MIT