Skip to content

chore: synced file(s) with sumup/apis #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
appscisumup wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: synced file(s) with sumup/apis #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b21bf5f
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Jul 24, 2026
3a5e35c
chore: generate code
sumup-release-bot[bot] Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
622 changes: 605 additions & 17 deletions openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

136 changes: 130 additions & 6 deletions src/main/java/com/sumup/sdk/clients/ReadersAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,7 @@
import java.util.Objects;
import java.util.concurrent.CompletableFuture;

/**
* Client for the "Readers" API group.
*
* <p>A reader represents a device that accepts payments. You can use the SumUp Solo to accept
* in-person payments.
*/
/** Client for the "Readers" API group. */
public final class ReadersAsyncClient {
private final ApiClient apiClient;

Expand Down Expand Up @@ -159,6 +154,75 @@ public CompletableFuture<com.sumup.sdk.models.CreateReaderCheckoutResponse> crea
requestOptions);
}

/**
* Create a Go Reader Payment
*
* <p>Initiates a payment on the SumUp Go terminal identified by the reader ID. Use
* `client_transaction_id` as an idempotency key: retrying the request with the same value returns
* the result of the original payment instead of creating a duplicate.
*
* <p>Operation ID: CreateGoReaderCheckout
*
* @param merchantCode Short unique identifier for the merchant.
* @param readerId The unique identifier of the reader.
* @param request Payment details to initiate on the reader.
* <p>Call the overload that accepts RequestOptions to customize headers, authorization, or
* request timeout.
* @return CompletableFuture resolved with com.sumup.sdk.models.ReaderPaymentResponse parsed
* response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.ReaderPaymentResponse> createGoCheckout(
String merchantCode,
com.sumup.sdk.models.ReaderId readerId,
com.sumup.sdk.models.ReaderPaymentRequestParams request)
throws ApiException {
return createGoCheckout(merchantCode, readerId, request, null);
}

/**
* Create a Go Reader Payment
*
* <p>Initiates a payment on the SumUp Go terminal identified by the reader ID. Use
* `client_transaction_id` as an idempotency key: retrying the request with the same value returns
* the result of the original payment instead of creating a duplicate.
*
* <p>Operation ID: CreateGoReaderCheckout
*
* @param merchantCode Short unique identifier for the merchant.
* @param readerId The unique identifier of the reader.
* @param request Payment details to initiate on the reader.
* @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass
* {@code null} to use client defaults.
* @return CompletableFuture resolved with com.sumup.sdk.models.ReaderPaymentResponse parsed
* response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.ReaderPaymentResponse> createGoCheckout(
String merchantCode,
com.sumup.sdk.models.ReaderId readerId,
com.sumup.sdk.models.ReaderPaymentRequestParams request,
RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(readerId, "readerId");
Objects.requireNonNull(request, "request");
String path = "/v0/merchants/{merchant_code}/readers/{reader_id}/go-checkout";
path =
path.replace(
"{merchant_code}", ApiClient.urlEncode(ApiClient.parameterValue(merchantCode)));
path = path.replace("{reader_id}", ApiClient.urlEncode(ApiClient.parameterValue(readerId)));

return this.apiClient.sendAsync(
HttpMethod.POST,
path,
null,
null,
request,
new TypeReference<com.sumup.sdk.models.ReaderPaymentResponse>() {},
requestOptions);
}

/**
* Delete a reader
*
Expand Down Expand Up @@ -290,6 +354,66 @@ public CompletableFuture<com.sumup.sdk.models.Reader> get(
requestOptions);
}

/**
* Get a Reader Checkout
*
* <p>Get a Checkout for a Reader.
*
* <p>Operation ID: GetReaderCheckout
*
* @param checkoutId The unique identifier of the Checkout
* @param merchantCode Merchant Code
* @param readerId The unique identifier of the Reader
* <p>Call the overload that accepts RequestOptions to customize headers, authorization, or
* request timeout.
* @return CompletableFuture resolved with com.sumup.sdk.models.GetReaderCheckoutResponse parsed
* response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.GetReaderCheckoutResponse> getCheckout(
String checkoutId, String merchantCode, String readerId) throws ApiException {
return getCheckout(checkoutId, merchantCode, readerId, null);
}

/**
* Get a Reader Checkout
*
* <p>Get a Checkout for a Reader.
*
* <p>Operation ID: GetReaderCheckout
*
* @param checkoutId The unique identifier of the Checkout
* @param merchantCode Merchant Code
* @param readerId The unique identifier of the Reader
* @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass
* {@code null} to use client defaults.
* @return CompletableFuture resolved with com.sumup.sdk.models.GetReaderCheckoutResponse parsed
* response.
* @throws ApiException if the SumUp API returns an error.
*/
public CompletableFuture<com.sumup.sdk.models.GetReaderCheckoutResponse> getCheckout(
String checkoutId, String merchantCode, String readerId, RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(checkoutId, "checkoutId");
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(readerId, "readerId");
String path = "/v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout/{checkout_id}";
path = path.replace("{checkout_id}", ApiClient.urlEncode(ApiClient.parameterValue(checkoutId)));
path =
path.replace(
"{merchant_code}", ApiClient.urlEncode(ApiClient.parameterValue(merchantCode)));
path = path.replace("{reader_id}", ApiClient.urlEncode(ApiClient.parameterValue(readerId)));

return this.apiClient.sendAsync(
HttpMethod.GET,
path,
null,
null,
null,
new TypeReference<com.sumup.sdk.models.GetReaderCheckoutResponse>() {},
requestOptions);
}

/**
* Get a Reader Status
*
Expand Down
132 changes: 126 additions & 6 deletions src/main/java/com/sumup/sdk/clients/ReadersClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,7 @@
import java.util.Map;
import java.util.Objects;

/**
* Client for the "Readers" API group.
*
* <p>A reader represents a device that accepts payments. You can use the SumUp Solo to accept
* in-person payments.
*/
/** Client for the "Readers" API group. */
public final class ReadersClient {
private final ApiClient apiClient;

Expand Down Expand Up @@ -156,6 +151,73 @@ public com.sumup.sdk.models.CreateReaderCheckoutResponse createCheckout(
requestOptions);
}

/**
* Create a Go Reader Payment
*
* <p>Initiates a payment on the SumUp Go terminal identified by the reader ID. Use
* `client_transaction_id` as an idempotency key: retrying the request with the same value returns
* the result of the original payment instead of creating a duplicate.
*
* <p>Operation ID: CreateGoReaderCheckout
*
* @param merchantCode Short unique identifier for the merchant.
* @param readerId The unique identifier of the reader.
* @param request Payment details to initiate on the reader.
* <p>Call the overload that accepts RequestOptions to customize headers, authorization, or
* request timeout.
* @return com.sumup.sdk.models.ReaderPaymentResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.ReaderPaymentResponse createGoCheckout(
String merchantCode,
com.sumup.sdk.models.ReaderId readerId,
com.sumup.sdk.models.ReaderPaymentRequestParams request)
throws ApiException {
return createGoCheckout(merchantCode, readerId, request, null);
}

/**
* Create a Go Reader Payment
*
* <p>Initiates a payment on the SumUp Go terminal identified by the reader ID. Use
* `client_transaction_id` as an idempotency key: retrying the request with the same value returns
* the result of the original payment instead of creating a duplicate.
*
* <p>Operation ID: CreateGoReaderCheckout
*
* @param merchantCode Short unique identifier for the merchant.
* @param readerId The unique identifier of the reader.
* @param request Payment details to initiate on the reader.
* @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass
* {@code null} to use client defaults.
* @return com.sumup.sdk.models.ReaderPaymentResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.ReaderPaymentResponse createGoCheckout(
String merchantCode,
com.sumup.sdk.models.ReaderId readerId,
com.sumup.sdk.models.ReaderPaymentRequestParams request,
RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(readerId, "readerId");
Objects.requireNonNull(request, "request");
String path = "/v0/merchants/{merchant_code}/readers/{reader_id}/go-checkout";
path =
path.replace(
"{merchant_code}", ApiClient.urlEncode(ApiClient.parameterValue(merchantCode)));
path = path.replace("{reader_id}", ApiClient.urlEncode(ApiClient.parameterValue(readerId)));

return this.apiClient.send(
HttpMethod.POST,
path,
null,
null,
request,
new TypeReference<com.sumup.sdk.models.ReaderPaymentResponse>() {},
requestOptions);
}

/**
* Delete a reader
*
Expand Down Expand Up @@ -284,6 +346,64 @@ public com.sumup.sdk.models.Reader get(
requestOptions);
}

/**
* Get a Reader Checkout
*
* <p>Get a Checkout for a Reader.
*
* <p>Operation ID: GetReaderCheckout
*
* @param checkoutId The unique identifier of the Checkout
* @param merchantCode Merchant Code
* @param readerId The unique identifier of the Reader
* <p>Call the overload that accepts RequestOptions to customize headers, authorization, or
* request timeout.
* @return com.sumup.sdk.models.GetReaderCheckoutResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.GetReaderCheckoutResponse getCheckout(
String checkoutId, String merchantCode, String readerId) throws ApiException {
return getCheckout(checkoutId, merchantCode, readerId, null);
}

/**
* Get a Reader Checkout
*
* <p>Get a Checkout for a Reader.
*
* <p>Operation ID: GetReaderCheckout
*
* @param checkoutId The unique identifier of the Checkout
* @param merchantCode Merchant Code
* @param readerId The unique identifier of the Reader
* @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass
* {@code null} to use client defaults.
* @return com.sumup.sdk.models.GetReaderCheckoutResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
public com.sumup.sdk.models.GetReaderCheckoutResponse getCheckout(
String checkoutId, String merchantCode, String readerId, RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(checkoutId, "checkoutId");
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(readerId, "readerId");
String path = "/v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout/{checkout_id}";
path = path.replace("{checkout_id}", ApiClient.urlEncode(ApiClient.parameterValue(checkoutId)));
path =
path.replace(
"{merchant_code}", ApiClient.urlEncode(ApiClient.parameterValue(merchantCode)));
path = path.replace("{reader_id}", ApiClient.urlEncode(ApiClient.parameterValue(readerId)));

return this.apiClient.send(
HttpMethod.GET,
path,
null,
null,
null,
new TypeReference<com.sumup.sdk.models.GetReaderCheckoutResponse>() {},
requestOptions);
}

/**
* Get a Reader Status
*
Expand Down
Loading
Loading