Skip to content

skip-pay/skippay-payments-java-sdk

Repository files navigation

  • Java client for API documentation for Skip Pay partners.

  • API version: 1.0

  • Package version:

  • Build date: 2023-06-26T12:24:35.068083+02:00[Europe/Prague]

For more information, please visit our developer portal

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven/Gradle

Installation

For Maven

mvn install:install-file -DgroupId="cz.skippay" -DartifactId="skippay-java-sdk" -Dversion="1.0.0" -Dpackaging="packaging"

For Gradle

gradle skippay-java-sdk

Getting Started

Please follow the installation instruction and execute the following Java code:

package cz.my.skippay;

import cz.skippay.api.SecurityApi;
import cz.skippay.model.ApplicationResponse;
import cz.skippay.model.PartnerLogin;
import cz.skippay.model.PartnerLoginResult;

public class SdkDemo {
  public static void main(String[] args) {
    ApiClient client = new ApiClient();

    SecurityApi authApi = new SecurityApi(client);

    PartnerLogin credentials = new PartnerLogin();
    credentials.setUsername("USERNAME");
    credentials.setPassword("PASSWORD");
    
    try {
      PartnerLoginResult login = authApi.loginpartner(credentials);

      client.setBearerToken(login.getAccessToken());
      SkipPaySdk sdk = new SkipPaySdk(client);

      ApplicationResponse response = sdk.getApplicationsApi().getapplicationdetail("APPLICATION_ID");
      System.out.println(response.getId());
    } catch (Exception e) {
      System.out.println(e.getMessage());
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.partner.skippay.cz

Class Method HTTP request Description
.ApplicationOperationsApi cancelapplication PUT /financing/v1/applications/{applicationId}/cancel Cancel application
.ApplicationOperationsApi changeapplicationorder PUT /financing/v1/applications/{applicationId}/order Change application order
.ApplicationOperationsApi createapplication POST /financing/v1/applications Create application
.ApplicationOperationsApi createapplicationfromrecurrence POST /financing/v1/recurrences/{recurrenceId}/applications Create application from recurrence
.ApplicationOperationsApi getapplicationdetail GET /financing/v1/applications/{applicationId} Get application detail
.ApplicationOperationsApi getorder GET /financing/v1/orders Get order
.ApplicationOperationsApi getpaymentsonspecificapplication GET /financing/v1/applications/{applicationId}/payments Get payments on specific application
.ApplicationOperationsApi getrecurrence GET /financing/v1/recurrences/{recurrenceId} Get recurrence
.ApplicationOperationsApi markorderitemsascancelled PUT /financing/v1/applications/{applicationId}/order/cancel Mark order items as cancelled
.ApplicationOperationsApi markorderitemsasdelivered PUT /financing/v1/applications/{applicationId}/order/deliver Mark order items as delivered
.ApplicationOperationsApi markorderitemsasreturned PUT /financing/v1/applications/{applicationId}/order/return Mark order items as returned
.ApplicationOperationsApi markorderitemsassent PUT /financing/v1/applications/{applicationId}/order/send Mark order items as sent
.ApplicationOperationsApi updaterecurrence PATCH /financing/v1/recurrences/{recurrenceId} Update recurrence
.HealthCheckApi aPIhealthcheck GET /v1/health API health check
.PrecheckOperationsApi precheck POST /financing/v1/precheck Precheck
.SecurityApi loginpartner POST /authentication/v1/partner Login partner

Documentation for Authorization

httpBearer

  • Type: Bearer authentication

Author

info@skippay.cz

About

Java SDK for Skip Pay REST API

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages