elepay-java-sdk

elepay API リファレンス

• API version: 1.2.4

elepay APIはRESTをベースに構成された決済APIです。支払い処理、返金処理など、決済に関わる運用における様々なことができます。

For more information, please visit https://elepay.io

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.elepay</groupId>
  <artifactId>elepay-java-sdk</artifactId>
  <version>1.2.4</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.elepay:elepay-java-sdk:1.2.4"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/elepay-java-sdk-1.2.4.jar
• target/lib/*.jar

Getting Started

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

import io.elepay.client.charge.*;
import io.elepay.client.charge.auth.*;
import io.elepay.client.charge.pojo.*;
import io.elepay.client.charge.api.ChargeApi;

public class ChargeApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure HTTP basic authorization: basicAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("Your elepay Secret Key");

        ChargeApi apiInstance = new ChargeApi(defaultClient);
        ChargeReq chargeReq = new ChargeReq(); // ChargeReq | 支払リクエスト
        // Set required fields
        try {
            ChargeDto result = apiInstance.createCharge(chargeReq);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ChargeApi#createCharge");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.elepay.io

Class	Method	HTTP request	Description
ChargeApi	captureCharge	POST /charges/{id}/capture	Capture charge
ChargeApi	createCharge	POST /charges	Create charge
ChargeApi	listCharges	GET /charges	List charges
ChargeApi	retrieveCharge	GET /charges/{id}	Retrieve charge
ChargeApi	retrieveChargeStatus	GET /charges/{id}/status	Retrieve charge's status
ChargeApi	revokeCharge	POST /charges/{id}/revoke	Revoke charge
CodeApi	closeCode	DELETE /codes/{codeId}	Close EasyQR code
CodeApi	createCode	POST /codes	Create EasyQR code
CodeApi	retrieveCode	GET /codes/{codeId}	Retrieve EasyQR code
CodeSettingApi	listCodePaymentMethods	GET /code-setting/payment-methods	List all enabled EasyQR payment methods
CustomerApi	createCustomer	POST /customers	Create customer
CustomerApi	createSource	POST /customers/{customerId}/sources	Create source
CustomerApi	deleteCustomer	DELETE /customers/{customerId}	Delete customer
CustomerApi	deleteSource	DELETE /customers/{customerId}/sources/{sourceId}	Delete source
CustomerApi	listCustomers	GET /customers	List customers
CustomerApi	listSources	GET /customers/{customerId}/sources	List sources by customer ID
CustomerApi	retrieveCustomer	GET /customers/{customerId}	Retrieve customer
CustomerApi	retrieveSource	GET /customers/{customerId}/sources/{sourceId}	Retrieve source
CustomerApi	retrieveSourceStatus	GET /sources/{sourceId}/status	Retrieve source's status
CustomerApi	updateCustomer	POST /customers/{customerId}	Update customer
DisputeApi	listDisputes	GET /disputes	List disputes
DisputeApi	retrieveDispute	GET /disputes/{id}	Retrieve dispute
InvoiceApi	cancelInvoice	POST /invoices/{invoiceId}/cancel	cancel invoice
InvoiceApi	createInvoice	POST /invoices	Create invoice
InvoiceApi	deleteInvoice	DELETE /invoices/{invoiceId}	Delete invoice
InvoiceApi	listInvoices	GET /invoices	List invoices
InvoiceApi	retrieveInvoice	GET /invoices/{invoiceId}	Retrieve invoice
InvoiceApi	sendInvoice	POST /invoices/{invoiceId}/send	send invoice
InvoiceApi	submitInvoice	POST /invoices/{invoiceId}/submit	submit invoice
InvoiceApi	updateInvoice	POST /invoices/{invoiceId}	Update invoice
PaymentMethodApi	listPaymentMethods	GET /payment-methods	List supported payment methods
RefundApi	createRefund	POST /charges/{id}/refunds	Create refund
RefundApi	listChargesRefunds	GET /charges/{id}/refunds	List refunds
RefundApi	retrieveChargeRefund	GET /charges/{id}/refunds/{refundId}	Retrieve refund
SubscriptionApi	cancelSubscription	POST /subscriptions/{subscriptionId}/cancel	Cancel subscription
SubscriptionApi	createSubscription	POST /subscriptions	Create subscription
SubscriptionApi	listSubscriptionPeriods	GET /subscriptions/{subscriptionId}/periods	List subscription periods
SubscriptionApi	listSubscriptions	GET /subscriptions	List subscriptions
SubscriptionApi	resumeSubscription	POST /subscriptions/{subscriptionId}/resume	Resume subscription
SubscriptionApi	retrieveSubscription	GET /subscriptions/{subscriptionId}	Retrieve subscription
SubscriptionApi	startSubscription	POST /subscriptions/{subscriptionId}/start	Start subscription
SubscriptionApi	updateSubscription	POST /subscriptions/{subscriptionId}	Update subscription
TerminalApi	createReader	POST /terminal/readers	create terminal reader
TerminalApi	deleteReader	DELETE /terminal/readers/{readerId}	delete reader
TerminalApi	getReader	GET /terminal/readers/{readerId}	get reader
TerminalApi	listLocations	GET /terminal/locations	list locations
TerminalApi	listReaders	GET /terminal/readers	list readers

Documentation for Models

• CardBrandType
• CardInfo
• ChannelPropertiesDto
• ChargeCaptureReq
• ChargeDateTimeType
• ChargeDto
• ChargeReq
• ChargeStatusDto
• ChargeStatusType
• ChargesResponse
• CodeDto
• CodeItem
• CodePaymentMethodResponse
• CodeReq
• CodeStatusType
• CustomerDto
• CustomerPropertiesDto
• CustomerReq
• CustomerResponse
• CustomerStatusType
• DisputeDateTimeType
• DisputeDto
• DisputeStatusType
• DisputesResponse
• InvoiceDto
• InvoiceItem
• InvoiceReq
• InvoiceStatusType
• InvoicesResponse
• LocationDto
• LocationsResponse
• PaymentMethodDto
• PaymentMethodResponse
• PaymentMethodType
• ReaderStatusType
• RefundDto
• RefundReq
• RefundStatusType
• RefundsDto
• RefundsResponse
• ResourceType
• ResourceWebEnvType
• SortOrderType
• SourceDto
• SourceReq
• SourceResponse
• SourceStatusDto
• SourceStatusType
• SubscriptionDto
• SubscriptionIntervalType
• SubscriptionPeriodDto
• SubscriptionPeriodsResponse
• SubscriptionReq
• SubscriptionScheduleChargesResponse
• SubscriptionStatusType
• SubscriptionUpdateReq
• SubscriptionsResponse
• TerminalReaderDto
• TerminalReaderReq
• TerminalReadersResponse

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

bearerAuth

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@elestyle.jp