Skip to main content

Java SDK

  • 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 Github

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

ClassMethodHTTP requestDescription
.ApplicationOperationsApicancelapplicationPUT /financing/v1/applications/{applicationId}/cancelCancel application
.ApplicationOperationsApichangeapplicationorderPUT /financing/v1/applications/{applicationId}/orderChange application order
.ApplicationOperationsApicreateapplicationPOST /financing/v1/applicationsCreate application
.ApplicationOperationsApicreateapplicationfromrecurrencePOST /financing/v1/recurrences/{recurrenceId}/applicationsCreate application from recurrence
.ApplicationOperationsApigetapplicationdetailGET /financing/v1/applications/{applicationId}Get application detail
.ApplicationOperationsApigetorderGET /financing/v1/ordersGet order
.ApplicationOperationsApigetpaymentsonspecificapplicationGET /financing/v1/applications/{applicationId}/paymentsGet payments on specific application
.ApplicationOperationsApigetrecurrenceGET /financing/v1/recurrences/{recurrenceId}Get recurrence
.ApplicationOperationsApimarkorderitemsascancelledPUT /financing/v1/applications/{applicationId}/order/cancelMark order items as cancelled
.ApplicationOperationsApimarkorderitemsasdeliveredPUT /financing/v1/applications/{applicationId}/order/deliverMark order items as delivered
.ApplicationOperationsApimarkorderitemsasreturnedPUT /financing/v1/applications/{applicationId}/order/returnMark order items as returned
.ApplicationOperationsApimarkorderitemsassentPUT /financing/v1/applications/{applicationId}/order/sendMark order items as sent
.ApplicationOperationsApiupdaterecurrencePATCH /financing/v1/recurrences/{recurrenceId}Update recurrence
.HealthCheckApiaPIhealthcheckGET /v1/healthAPI health check
.PrecheckOperationsApiprecheckPOST /financing/v1/precheckPrecheck
.SecurityApiloginpartnerPOST /authentication/v1/partnerLogin partner

Documentation for Authorization

httpBearer

  • Type: Bearer authentication

Author

info@skippay.cz