Getting Started

Craftgate Payment Gateway Spring Supported Library

You can add spring-craftgate as a dependency and then use it as plug-and-play for payment. The spring-craftgate uses the official dependency published as the 1.0.33 version for models.

maven

<dependency>
    <groupId>io.github.gklp</groupId>
    <artifactId>spring-craftgate</artifactId>
    <version>1.0.0</version>
</dependency>

gradle

implementation 'io.github.gklp:spring-craftgate:1.0.0'

Configurations

You can get required information using https://sandbox-panel.craftgate.io/login

craftgate:
  api:
    url: https://sandbox-api.craftgate.io
    key: <your_key>
    secret: <your_secret>
    authVersion: v1
    clientVersion: craftgate-java-client:1.0.33
  log:
    enabled: false

Configuration defaults. Intelligent code completion gives advice for the completion of the spring application YAML. They are already defined by the library.

property	defaults
craftgate.enabled	true
craftgate.api.url	n/a
craftgate.api.key	n/a
craftgate.api.secret	n/a
craftgate.api.authVersion	v1
craftgate.api.clientVersion	craftgate-java-client:1.0.33
craftgate.log.enabled	false

Minimal Configuration

craftgate:
  api:
    url: https://sandbox-api.craftgate.io
    key: <your_key>
    secret: <your_secret>

• Offical Developer Guide

Simple Usage

Reactive Way

@Service
public class MyPaymentService {

    @Autowired
    private CraftGatePayment payment;

    public void makePayment() {
        CreatePaymentRequest request = //<ommited>;

        Mono<PaymentResponse> payment = underTest.createPayment(request);
    }
}

Non-Reactive Way

@Service
public class MyPaymentService {

    @Autowired
    private CraftGatePayment payment;

    public void makePayment() {
        CreatePaymentRequest request = //<ommited>;

        PaymentResponse response = underTest.createPayment(request).block();
    }
}

• Test Cards

Additional Information

Exception Handling

You can handle exceptions using CraftgateException class. This class provides pretty descriptions for you.

• Offical Error Codes

Signature Creation

If you want to call Craftgate API, you need to pass the signature encoded with header. This signature creation process requires a key. As default you can use below definition. Otherwise, you can define a bean called craftgateRandomKeyProvider with a different implementation.

@Bean
@ConditionalOnMissingBean
public RandomKeyProvider craftgateRandomKeyProvider() {
    return () -> UUID.randomUUID().toString();
}

Custom object mapper

You can change object mapper properties and provide new encoder or decoder like below beans.

@Bean
@ConditionalOnMissingBean
public ExchangeStrategies.Builder craftgateExchangeBuilder(@CraftGateObjectMapper ObjectMapper objectMapper) {
    Jackson2JsonEncoder encoder = new Jackson2JsonEncoder(objectMapper, MediaType.APPLICATION_JSON);
    Jackson2JsonDecoder decoder = new Jackson2JsonDecoder(objectMapper, MediaType.APPLICATION_JSON);
    
    return ExchangeStrategies.builder().codecs(configurer -> {
        configurer.defaultCodecs().jackson2JsonEncoder(encoder);
        configurer.defaultCodecs().jackson2JsonDecoder(decoder);
    });
}

Supported Endpoints

Members

https://developer.craftgate.io/en/api/member/create-member

Bean -> CraftGateOnboarding

operation	api	version
Create Member	POST /onboarding/v1/members	1.0.0
Update Member	PUT /onboarding/v1/members/:id	1.0.0
Retrieve Member	GET /onboarding/v1/members/:id	1.0.0
Search Members	GET /onboarding/v1/members	1.0.0

Installment and BIN Inquiry

https://developer.craftgate.io/en/api/installment-and-bin-inquiry/search-installments

Bean -> CraftGateInstallment

operation	api	version
Search Installments	GET /installment/v1/installments	1.0.0
Retrieve BIN	GET /installment/v1/bins	1.0.0