From da72637b643f2b793188b8904d48b5a5cc88e93d Mon Sep 17 00:00:00 2001 From: "sumup-release-bot[bot]" <241716704+sumup-release-bot[bot]@users.noreply.github.com> Date: Thu, 12 Nov 2026 16:29:14 +0000 Subject: [PATCH 1/2] chore: synced local 'openapi.json' with remote 'specs/openapi31.json' --- openapi.json | 424 ++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 317 insertions(+), 107 deletions(-) diff --git a/openapi.json b/openapi.json index 0711ccb2..64d1f0aa 100644 --- a/openapi.json +++ b/openapi.json @@ -106,13 +106,10 @@ }, { "name": "Sales", - "description": "Operations related to reading sales data.", + "description": "Read a merchant's fully-paid, closed sales, including item lines, taxes, discounts, and payments.\n\nList sales to retrieve full `Sale` objects, or search by date, payment status, and sales channel\nto retrieve summaries. Use a summary's `id` to get the full sale.\n\nAmounts are expressed in minor units according to each sale's `currency.scale`.", "x-core-objects": [ { "$ref": "#/components/schemas/Sale" - }, - { - "$ref": "#/components/schemas/PublicPaymentV10" } ], "x-displayName": "Sales" @@ -275,7 +272,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "checkouts.write" ] } @@ -616,7 +617,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "checkouts.read" ] } @@ -717,7 +722,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "checkouts.read" ] } @@ -856,7 +865,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "checkouts.write" ] } @@ -968,7 +981,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "checkouts.write" ] } @@ -1412,7 +1429,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "checkouts.write" ] } @@ -1657,7 +1678,11 @@ }, { "oauth2": [ - "payment_instruments", + "payment_instruments" + ] + }, + { + "oauth2": [ "customers.write" ] } @@ -1808,7 +1833,11 @@ }, { "oauth2": [ - "payment_instruments", + "payment_instruments" + ] + }, + { + "oauth2": [ "customers.read" ] } @@ -1907,7 +1936,11 @@ }, { "oauth2": [ - "payment_instruments", + "payment_instruments" + ] + }, + { + "oauth2": [ "customers.write" ] } @@ -2036,7 +2069,11 @@ }, { "oauth2": [ - "payment_instruments", + "payment_instruments" + ] + }, + { + "oauth2": [ "customers.read" ] } @@ -2162,7 +2199,11 @@ }, { "oauth2": [ - "payment_instruments", + "payment_instruments" + ] + }, + { + "oauth2": [ "customers.write" ] } @@ -2297,7 +2338,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "refunds.write" ] } @@ -2483,7 +2528,11 @@ }, { "oauth2": [ - "transactions.history", + "transactions.history" + ] + }, + { + "oauth2": [ "transactions.read" ] } @@ -2565,7 +2614,7 @@ "merchant_code": "MH4H92C7", "vat_amount": 6, "tip_amount": 3, - "entry_mode": "CUSTOMER_ENTRY", + "entry_mode": "customer entry", "auth_code": "053201" } } @@ -2629,7 +2678,11 @@ }, { "oauth2": [ - "transactions.history", + "transactions.history" + ] + }, + { + "oauth2": [ "transactions.read" ] } @@ -2750,8 +2803,8 @@ "schema": { "type": "array", "example": [ - "CUSTOMER_ENTRY", - "CHIP" + "customer entry", + "chip" ], "items": { "$ref": "#/components/schemas/EntryMode" @@ -2958,8 +3011,16 @@ }, { "oauth2": [ - "user.profile", - "user.profile_readonly", + "user.profile" + ] + }, + { + "oauth2": [ + "user.profile_readonly" + ] + }, + { + "oauth2": [ "payouts.read" ] } @@ -3157,7 +3218,11 @@ }, { "oauth2": [ - "receipts.read", + "receipts.read" + ] + }, + { + "oauth2": [ "transactions.history" ] } @@ -3437,7 +3502,11 @@ }, { "oauth2": [ - "payments", + "payments" + ] + }, + { + "oauth2": [ "readers.write" ] } @@ -3465,7 +3534,11 @@ }, { "oauth2": [ - "user.profile", + "user.profile" + ] + }, + { + "oauth2": [ "user.profile_readonly" ] } @@ -3764,7 +3837,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "members.read" ] } @@ -3826,7 +3903,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "members.write" ] } @@ -4007,7 +4088,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "members.read" ] } @@ -4090,7 +4175,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "members.write" ] } @@ -4278,7 +4367,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "members.write" ] } @@ -4372,7 +4465,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "roles.read" ] } @@ -4442,7 +4539,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "roles.write" ] } @@ -4590,7 +4691,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "roles.read" ] } @@ -4659,7 +4764,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "roles.write" ] } @@ -4751,7 +4860,11 @@ }, { "oauth2": [ - "user.subaccounts", + "user.subaccounts" + ] + }, + { + "oauth2": [ "roles.write" ] } @@ -4910,7 +5023,11 @@ }, { "oauth2": [ - "user.profile", + "user.profile" + ] + }, + { + "oauth2": [ "user.profile_readonly" ] } @@ -4979,7 +5096,11 @@ }, { "oauth2": [ - "user.profile", + "user.profile" + ] + }, + { + "oauth2": [ "user.profile_readonly" ] } @@ -5048,7 +5169,11 @@ }, { "oauth2": [ - "user.profile", + "user.profile" + ] + }, + { + "oauth2": [ "user.profile_readonly" ] } @@ -5127,7 +5252,11 @@ }, { "oauth2": [ - "readers.read", + "readers.read" + ] + }, + { + "oauth2": [ "terminals.read" ] } @@ -5211,7 +5340,11 @@ }, { "oauth2": [ - "readers.write", + "readers.write" + ] + }, + { + "oauth2": [ "terminals.write" ] } @@ -5382,7 +5515,11 @@ }, { "oauth2": [ - "readers.read", + "readers.read" + ] + }, + { + "oauth2": [ "terminals.read" ] } @@ -5489,7 +5626,11 @@ }, { "oauth2": [ - "readers.write", + "readers.write" + ] + }, + { + "oauth2": [ "terminals.write" ] } @@ -5568,7 +5709,11 @@ }, { "oauth2": [ - "readers.write", + "readers.write" + ] + }, + { + "oauth2": [ "terminals.write" ] } @@ -5670,9 +5815,18 @@ "tags": [ "Sales" ], - "summary": "Lists sales", + "summary": "List sales", "description": "Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the\n**newest event** recorded for each sale. Pagination tokens follow that order.\n\nCovers the merchant’s **last two years** of sales. Non-finalised sales are never returned;\nonly fully-paid sales. Use `POST /sales/search` for filtered queries.", "operationId": "ListSalesV10", + "x-codegen": { + "method_name": "list" + }, + "x-scopes": [ + "sales.read" + ], + "x-permissions": [ + "merchant.read" + ], "security": [ { "apiKey": [] @@ -5683,12 +5837,6 @@ ] } ], - "x-scopes": [ - "sales.read" - ], - "x-permissions": [ - "merchant_read" - ], "parameters": [ { "name": "merchant_code", @@ -5705,11 +5853,10 @@ "name": "pagination_token", "in": "query", "required": false, - "description": "Pagination token for subsequent requests. Should only be set by clients if they have\nreceived a token in the previous response, and this request is an immediate follow-up\nrequest to that response to load the subsequent page. Clients should treat this as an\nopaque token and should not attempt to parse it in any way.", + "description": "Opaque token from the previous list response. Omit it on the first request. To load\nthe next page, pass the returned token unchanged. Not interchangeable with tokens\nfrom `POST /sales/search`.", "schema": { "type": "string" - }, - "example": "66bcbtzelrubzeuzruzgu76678trncH" + } }, { "name": "pagination_limit", @@ -5757,7 +5904,7 @@ } }, "403": { - "description": "Missing `sales.read`, merchant code mismatch on the token, or no `merchant_read` permission.", + "description": "Missing `sales.read`, merchant code mismatch on the token, or no `merchant.read` permission.", "content": { "application/problem+json": { "schema": { @@ -5784,9 +5931,18 @@ "tags": [ "Sales" ], - "summary": "Searches sales", + "summary": "Search sales", "description": "Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are\nsorted **newest first** by **sale close date**.\n\nFilters from different categories stack with **logical AND**; multiple values in one array\nfield stack with **logical OR**. Results cover the merchant’s **last two years** of sales\n(narrow further with `start_date` / `end_date`). Pagination tokens are not interchangeable\nwith `GET /sales`.", "operationId": "SearchSalesV10", + "x-codegen": { + "method_name": "search" + }, + "x-scopes": [ + "sales.read" + ], + "x-permissions": [ + "merchant.read" + ], "security": [ { "apiKey": [] @@ -5797,12 +5953,6 @@ ] } ], - "x-scopes": [ - "sales.read" - ], - "x-permissions": [ - "merchant_read" - ], "parameters": [ { "name": "merchant_code", @@ -5822,6 +5972,19 @@ "application/json": { "schema": { "$ref": "#/components/schemas/SaleSearchRequest" + }, + "examples": { + "date_range": { + "summary": "Search point-of-sale sales in a date range", + "value": { + "start_date": "2026-06-01T00:00:00Z", + "end_date": "2026-06-02T23:59:59Z", + "sales_channels": [ + "POS" + ], + "pagination_limit": 10 + } + } } } } @@ -5858,7 +6021,7 @@ } }, "403": { - "description": "Missing `sales.read`, merchant code mismatch on the token, or no `merchant_read` permission.", + "description": "Missing `sales.read`, merchant code mismatch on the token, or no `merchant.read` permission.", "content": { "application/problem+json": { "schema": { @@ -5885,9 +6048,18 @@ "tags": [ "Sales" ], - "summary": "Gets a sale", + "summary": "Get a sale", "description": "Returns `Sale` for `sale_id`, including item lines and `payments[]`.\nNon-finalised sales are never returned; only fully-paid sales.", "operationId": "GetSaleV10", + "x-codegen": { + "method_name": "get" + }, + "x-scopes": [ + "sales.read" + ], + "x-permissions": [ + "merchant.read" + ], "security": [ { "apiKey": [] @@ -5898,12 +6070,6 @@ ] } ], - "x-scopes": [ - "sales.read" - ], - "x-permissions": [ - "merchant_read" - ], "parameters": [ { "name": "merchant_code", @@ -5944,14 +6110,14 @@ "tax_mode": "GROSS", "state": "CLOSED", "price": { - "net_amount": 777, - "gross_amount": 925, + "net_amount": 252, + "gross_amount": 300, "taxes": [ { "id": "tax-vat-19", - "net_amount": 777, - "gross_amount": 925, - "tax_amount": 148 + "net_amount": 252, + "gross_amount": 300, + "tax_amount": 48 } ] }, @@ -5966,6 +6132,11 @@ "type": "CATALOG", "name": "Cappuccino", "quantity": 1, + "unit_of_measure": { + "group_id": "quantity", + "unit_id": "quantity.piece", + "unit_ratio": 1 + }, "price": { "unit_amount": 300, "total_net_amount": 252, @@ -5996,7 +6167,7 @@ "method": "apple_pay", "reference": "TERTYFQ4G3", "type": "purchase", - "amount": 975, + "amount": 300, "status": "SUCCESSFUL", "processed_at": "2026-06-02T10:20:00Z" } @@ -6016,7 +6187,7 @@ } }, "403": { - "description": "Missing `sales.read`, merchant code mismatch on the token, or no `merchant_read` permission.", + "description": "Missing `sales.read`, merchant code mismatch on the token, or no `merchant.read` permission.", "content": { "application/problem+json": { "schema": { @@ -7401,6 +7572,14 @@ }, { "$ref": "#/components/schemas/TransactionCheckoutInfo" + }, + { + "type": "object", + "properties": { + "entry_mode": { + "$ref": "#/components/schemas/CheckoutEntryMode" + } + } } ] } @@ -8913,9 +9092,6 @@ "description": "Tip included in the total transaction amount, in major units of the transaction's currency.", "example": 3 }, - "entry_mode": { - "$ref": "#/components/schemas/EntryMode" - }, "auth_code": { "type": "string", "description": "Authorization code for the transaction sent by the payment card issuer or bank. Applicable only to card payments.", @@ -8928,6 +9104,9 @@ "description": "Additional transaction fields used by history and detailed views.", "type": "object", "properties": { + "entry_mode": { + "$ref": "#/components/schemas/EntryMode" + }, "product_summary": { "type": "string", "description": "Short description of the payment. The value is taken from the `description` property of the related checkout resource.", @@ -9042,13 +9221,16 @@ ], "example": "ECOM" }, - "EntryMode": { - "title": "Entry Mode", + "CheckoutEntryMode": { + "title": "Checkout Entry Mode", "type": "string", - "description": "How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present payments and `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative payment methods, this can identify the method, such as `APPLE_PAY` or `BLIK`.", + "description": "How the payment details were captured for a checkout transaction, for example `CUSTOMER_ENTRY` for card details entered by the payer or `APPLE_PAY` for an Apple Pay payment. Checkout entry modes use uppercase values, unlike entry modes returned by the Transactions endpoints.", "enum": [ + "CUSTOMER_ENTRY", + "MOTO", + "CARD", "BOLETO", - "SOFORT", + "DIRECT_DEBIT", "IDEAL", "BANCONTACT", "EPS", @@ -9059,24 +9241,52 @@ "GIROPAY", "PIX", "QR_CODE_PIX", + "KLARNA", + "BANCOMATPAY", "APPLE_PAY", - "GOOGLE_PAY", "PAYPAL", - "TWINT", - "NONE", - "CHIP", - "MANUAL_ENTRY", - "CUSTOMER_ENTRY", - "MAGSTRIPE_FALLBACK", - "MAGSTRIPE", - "DIRECT_DEBIT", - "CONTACTLESS", - "MOTO", - "CONTACTLESS_MAGSTRIPE", - "N/A" + "GOOGLE_PAY" ], "example": "CUSTOMER_ENTRY" }, + "EntryMode": { + "title": "Entry Mode", + "type": "string", + "description": "How the payment details were captured, for example `chip` or `contactless` for card-present payments and `customer entry` for card details entered by the payer. For wallet and alternative payment methods, this can identify the method, such as `apple pay` or `blik`.", + "enum": [ + "none", + "magstripe", + "chip", + "manual entry", + "customer entry", + "magstripe fallback", + "contactless", + "moto", + "contactless magstripe", + "boleto", + "direct debit", + "sofort", + "ideal", + "bancontact", + "eps", + "mybank", + "satispay", + "blik", + "p24", + "giropay", + "pix", + "qr code pix", + "apple pay", + "google pay", + "sumup gift card", + "paypal", + "twint", + "iris", + "sumup pay", + "na" + ], + "example": "customer entry" + }, "CardType": { "title": "Card Type", "type": "string", @@ -12278,7 +12488,7 @@ "properties": { "method": { "type": "string", - "description": "Payment method on public sales read API v1.0.\nDigital wallets are first-class methods. Gift card payments use `gift_card`, not `apm`.\nInput is case-insensitive; the canonical form is lowercase snake_case.\n**VALUES**: [card, cash, apm, external, apple_pay, google_pay, whatsapp_pay, gift_card].", + "description": "Payment method on public sales read API v1.0.\nDigital wallets are first-class methods. Gift card payments use `gift_card`, not `apm`.\nValues use lowercase snake_case. Known values are `card`, `cash`, `apm`, `external`,\n`apple_pay`, `google_pay`, `whatsapp_pay`, and `gift_card`.\nAdditional values may be returned as new payment methods become available.", "example": "card", "maxLength": 20 }, @@ -12291,7 +12501,7 @@ "type": { "type": "string", "default": "purchase", - "description": "Payment operation type.\nThis is distinct from the payment instrument in `method`.\nInput is case-insensitive; the canonical form is lowercase snake_case.\n**VALUES**: [purchase, unreferenced_refund]\nDefaults to \"purchase\" if unspecified. Either a normal purchase or an unreferenced refund for negative\nsales like deposit returns.\n", + "description": "Payment operation type.\nThis is distinct from the payment instrument in `method`.\nValues use lowercase snake_case. Known values are `purchase` for a normal purchase\nand `unreferenced_refund` for negative sales such as deposit returns.\n", "example": "purchase" }, "amount": { @@ -12319,7 +12529,7 @@ }, "apm_type": { "type": "string", - "description": "Alternative payment method type when `method` is `apm`.\nGift card is not an APM on this API.\nInput is case-insensitive; the canonical form is lowercase snake_case.\n**VALUES**: [qr_code_pix, sepa_dd, paypal, sumup_pay, twint, iris].", + "description": "Alternative payment method type when `method` is `apm`.\nGift card is not an APM on this API.\nValues use lowercase snake_case. Known values are `qr_code_pix`, `sepa_dd`, `paypal`,\n`sumup_pay`, `twint`, and `iris`.\nAdditional values may be returned as new alternative payment methods become available.", "maxLength": 20 }, "card": { @@ -12332,7 +12542,7 @@ "type": "string", "format": "date-time", "description": "UTC date-time when SumUp recorded this payment’s exposed `status` (successful, failed,\nor canceled). Server processed time when available; otherwise the payment provider’s\ntransaction time. Not the device clock.", - "example": "2017-07-21T17:32:28+01:00" + "example": "2026-06-02T10:20:00Z" } } }, @@ -12443,7 +12653,7 @@ "SalePage": { "title": "SalePage", "type": "object", - "description": "Paginated list of `Sale` objects. Results are ordered **newest first** by the newest\nactivity recorded for each sale. See `ListSalesV10`.", + "description": "Paginated list of `Sale` objects. Results are ordered **newest first** by the newest\nactivity recorded for each sale.", "required": [ "items" ], @@ -12455,7 +12665,7 @@ } }, "pagination_token": { - "description": "Pagination token for subsequent requests. Should only be set by clients if they have\nreceived a token in the previous response, and this request is an immediate follow-up\nrequest to that response to load the subsequent page. Clients should treat this as an\nopaque token and should not attempt to parse it in any way.", + "description": "Opaque token for the next page. Pass it as the `pagination_token` query parameter\non the next list request. Omitted when no further page is available.", "type": "string", "example": "66bcbtzelrubzeuzruzgu76678trncH" } @@ -12573,7 +12783,7 @@ }, "pagination_token": { "type": "string", - "description": "Opaque pagination token from a previous search response. Not interchangeable with tokens\nfrom `GET /sales`.", + "description": "Opaque token from the previous search response. To load the next page, send it with\nthe same filters. Not interchangeable with tokens from `GET /sales`.", "example": "66bcbtzelrubzeuzruzgu76678trncH" }, "pagination_limit": { @@ -12686,7 +12896,7 @@ ] }, "pagination_token": { - "description": "Opaque token for the next page of search results.", + "description": "Opaque token for the next page. Pass it as `pagination_token` in the next search\nrequest body with the same filters. Omitted when no further page is available.", "type": "string", "example": "66bcbtzelrubzeuzruzgu76678trncH" } @@ -14087,8 +14297,8 @@ "schema": { "type": "array", "example": [ - "CUSTOMER_ENTRY", - "CHIP" + "customer entry", + "chip" ], "items": { "$ref": "#/components/schemas/EntryMode" From 9a3e31ab51688869a6952176014833bdf00c7b51 Mon Sep 17 00:00:00 2001 From: "sumup-release-bot[bot]" <241716704+sumup-release-bot[bot]@users.noreply.github.com> Date: Thu, 12 Nov 2026 16:31:20 +0000 Subject: [PATCH 2/2] chore: generate code --- .../sumup/sdk/clients/SalesAsyncClient.java | 48 ++++++------ .../com/sumup/sdk/clients/SalesClient.java | 49 ++++++------ .../sumup/sdk/models/CheckoutEntryMode.java | 76 +++++++++++++++++++ .../CheckoutSuccessTransactionsItem.java | 21 ++--- .../sdk/models/CheckoutTransactionsItem.java | 21 ++--- .../java/com/sumup/sdk/models/EntryMode.java | 63 +++++++-------- .../sumup/sdk/models/PublicPaymentV10.java | 35 ++++----- .../java/com/sumup/sdk/models/SalePage.java | 14 ++-- .../sumup/sdk/models/SaleSearchRequest.java | 8 +- .../sumup/sdk/models/SaleSearchResponse.java | 9 ++- .../sdk/models/TransactionCheckoutInfo.java | 24 +----- .../com/sumup/sdk/models/TransactionFull.java | 14 ++-- .../sumup/sdk/models/TransactionHistory.java | 23 ++++++ .../sdk/models/TransactionMixinHistory.java | 25 +++++- 14 files changed, 270 insertions(+), 160 deletions(-) create mode 100644 src/main/java/com/sumup/sdk/models/CheckoutEntryMode.java diff --git a/src/main/java/com/sumup/sdk/clients/SalesAsyncClient.java b/src/main/java/com/sumup/sdk/clients/SalesAsyncClient.java index 9d30c276..977af915 100644 --- a/src/main/java/com/sumup/sdk/clients/SalesAsyncClient.java +++ b/src/main/java/com/sumup/sdk/clients/SalesAsyncClient.java @@ -14,7 +14,10 @@ /** * Client for the "Sales" API group. * - *
Operations related to reading sales data. + *
Read a merchant's fully-paid, closed sales, including item lines, taxes, discounts, and + * payments. List sales to retrieve full `Sale` objects, or search by date, payment status, and + * sales channel to retrieve summaries. Use a summary's `id` to get the full sale. Amounts are + * expressed in minor units according to each sale's `currency.scale`. */ public final class SalesAsyncClient { private final ApiClient apiClient; @@ -29,7 +32,7 @@ public SalesAsyncClient(ApiClient apiClient) { } /** - * Gets a sale + * Get a sale * *
Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
@@ -43,13 +46,13 @@ public SalesAsyncClient(ApiClient apiClient) {
* @return CompletableFuture resolved with com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public CompletableFuture Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
@@ -63,7 +66,7 @@ public CompletableFuture Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
@@ -99,13 +102,13 @@ public CompletableFuture Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
@@ -121,13 +124,13 @@ public CompletableFuture Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
@@ -143,7 +146,7 @@ public CompletableFuture Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
@@ -185,13 +188,13 @@ public CompletableFuture Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
@@ -209,7 +212,7 @@ public CompletableFuture Operations related to reading sales data.
+ * Read a merchant's fully-paid, closed sales, including item lines, taxes, discounts, and
+ * payments. List sales to retrieve full `Sale` objects, or search by date, payment status, and
+ * sales channel to retrieve summaries. Use a summary's `id` to get the full sale. Amounts are
+ * expressed in minor units according to each sale's `currency.scale`.
*/
public final class SalesClient {
private final ApiClient apiClient;
@@ -28,7 +31,7 @@ public SalesClient(ApiClient apiClient) {
}
/**
- * Gets a sale
+ * Get a sale
*
* Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
@@ -42,13 +45,12 @@ public SalesClient(ApiClient apiClient) {
* @return com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.Sale getSaleV10(String merchantCode, String saleId)
- throws ApiException {
- return getSaleV10(merchantCode, saleId, null);
+ public com.sumup.sdk.models.Sale get(String merchantCode, String saleId) throws ApiException {
+ return get(merchantCode, saleId, null);
}
/**
- * Gets a sale
+ * Get a sale
*
* Returns `Sale` for `sale_id`, including item lines and `payments[]`. Non-finalised sales are
* never returned; only fully-paid sales.
@@ -62,7 +64,7 @@ public com.sumup.sdk.models.Sale getSaleV10(String merchantCode, String saleId)
* @return com.sumup.sdk.models.Sale parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.Sale getSaleV10(
+ public com.sumup.sdk.models.Sale get(
String merchantCode, String saleId, RequestOptions requestOptions) throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
Objects.requireNonNull(saleId, "saleId");
@@ -83,7 +85,7 @@ public com.sumup.sdk.models.Sale getSaleV10(
}
/**
- * Lists sales
+ * List sales
*
* Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
@@ -98,12 +100,12 @@ public com.sumup.sdk.models.Sale getSaleV10(
* @return com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.SalePage listSalesV10(String merchantCode) throws ApiException {
- return listSalesV10(merchantCode, null);
+ public com.sumup.sdk.models.SalePage list(String merchantCode) throws ApiException {
+ return list(merchantCode, null);
}
/**
- * Lists sales
+ * List sales
*
* Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
@@ -119,13 +121,13 @@ public com.sumup.sdk.models.SalePage listSalesV10(String merchantCode) throws Ap
* @return com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.SalePage listSalesV10(
+ public com.sumup.sdk.models.SalePage list(
String merchantCode, ListSalesV10QueryParams listSalesV10) throws ApiException {
- return listSalesV10(merchantCode, listSalesV10, null);
+ return list(merchantCode, listSalesV10, null);
}
/**
- * Lists sales
+ * List sales
*
* Returns a paginated list of `Sale` objects. Results are sorted **newest first** by the
* **newest event** recorded for each sale. Pagination tokens follow that order. Covers the
@@ -141,7 +143,7 @@ public com.sumup.sdk.models.SalePage listSalesV10(
* @return com.sumup.sdk.models.SalePage parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.SalePage listSalesV10(
+ public com.sumup.sdk.models.SalePage list(
String merchantCode, ListSalesV10QueryParams listSalesV10, RequestOptions requestOptions)
throws ApiException {
Objects.requireNonNull(merchantCode, "merchantCode");
@@ -165,7 +167,7 @@ public com.sumup.sdk.models.SalePage listSalesV10(
}
/**
- * Searches sales
+ * Search sales
*
* Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
@@ -182,13 +184,13 @@ public com.sumup.sdk.models.SalePage listSalesV10(
* @return com.sumup.sdk.models.SaleSearchResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.SaleSearchResponse searchSalesV10(
+ public com.sumup.sdk.models.SaleSearchResponse search(
String merchantCode, com.sumup.sdk.models.SaleSearchRequest request) throws ApiException {
- return searchSalesV10(merchantCode, request, null);
+ return search(merchantCode, request, null);
}
/**
- * Searches sales
+ * Search sales
*
* Returns a paginated list of `SaleSearchItem` rows matching filter criteria. Results are
* sorted **newest first** by **sale close date**. Filters from different categories stack with
@@ -205,7 +207,7 @@ public com.sumup.sdk.models.SaleSearchResponse searchSalesV10(
* @return com.sumup.sdk.models.SaleSearchResponse parsed response.
* @throws ApiException if the SumUp API returns an error.
*/
- public com.sumup.sdk.models.SaleSearchResponse searchSalesV10(
+ public com.sumup.sdk.models.SaleSearchResponse search(
String merchantCode,
com.sumup.sdk.models.SaleSearchRequest request,
RequestOptions requestOptions)
@@ -245,10 +247,9 @@ public ListSalesV10QueryParams paginationLimit(Long value) {
/**
* Sets the pagination_token query parameter.
*
- * @param value Pagination token for subsequent requests. Should only be set by clients if they
- * have received a token in the previous response, and this request is an immediate
- * follow-up request to that response to load the subsequent page. Clients should treat this
- * as an opaque token and should not attempt to parse it in any way.
+ * @param value Opaque token from the previous list response. Omit it on the first request. To
+ * load the next page, pass the returned token unchanged. Not interchangeable with tokens
+ * from `POST /sales/search`.
* @return This ListSalesV10QueryParams instance.
*/
public ListSalesV10QueryParams paginationToken(String value) {
diff --git a/src/main/java/com/sumup/sdk/models/CheckoutEntryMode.java b/src/main/java/com/sumup/sdk/models/CheckoutEntryMode.java
new file mode 100644
index 00000000..cb4c792e
--- /dev/null
+++ b/src/main/java/com/sumup/sdk/models/CheckoutEntryMode.java
@@ -0,0 +1,76 @@
+// Code generated by sumup-java/codegen. DO NOT EDIT.
+package com.sumup.sdk.models;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonValue;
+import java.util.Objects;
+
+/**
+ * How the payment details were captured for a checkout transaction, for example `CUSTOMER_ENTRY`
+ * for card details entered by the payer or `APPLE_PAY` for an Apple Pay payment. Checkout entry
+ * modes use uppercase values, unlike entry modes returned by the Transactions endpoints.
+ */
+public final class CheckoutEntryMode {
+ public static final CheckoutEntryMode CUSTOMER_ENTRY = new CheckoutEntryMode("CUSTOMER_ENTRY");
+ public static final CheckoutEntryMode MOTO = new CheckoutEntryMode("MOTO");
+ public static final CheckoutEntryMode CARD = new CheckoutEntryMode("CARD");
+ public static final CheckoutEntryMode BOLETO = new CheckoutEntryMode("BOLETO");
+ public static final CheckoutEntryMode DIRECT_DEBIT = new CheckoutEntryMode("DIRECT_DEBIT");
+ public static final CheckoutEntryMode IDEAL = new CheckoutEntryMode("IDEAL");
+ public static final CheckoutEntryMode BANCONTACT = new CheckoutEntryMode("BANCONTACT");
+ public static final CheckoutEntryMode EPS = new CheckoutEntryMode("EPS");
+ public static final CheckoutEntryMode MYBANK = new CheckoutEntryMode("MYBANK");
+ public static final CheckoutEntryMode SATISPAY = new CheckoutEntryMode("SATISPAY");
+ public static final CheckoutEntryMode BLIK = new CheckoutEntryMode("BLIK");
+ public static final CheckoutEntryMode P24 = new CheckoutEntryMode("P24");
+ public static final CheckoutEntryMode GIROPAY = new CheckoutEntryMode("GIROPAY");
+ public static final CheckoutEntryMode PIX = new CheckoutEntryMode("PIX");
+ public static final CheckoutEntryMode QR_CODE_PIX = new CheckoutEntryMode("QR_CODE_PIX");
+ public static final CheckoutEntryMode KLARNA = new CheckoutEntryMode("KLARNA");
+ public static final CheckoutEntryMode BANCOMATPAY = new CheckoutEntryMode("BANCOMATPAY");
+ public static final CheckoutEntryMode APPLE_PAY = new CheckoutEntryMode("APPLE_PAY");
+ public static final CheckoutEntryMode PAYPAL = new CheckoutEntryMode("PAYPAL");
+ public static final CheckoutEntryMode GOOGLE_PAY = new CheckoutEntryMode("GOOGLE_PAY");
+
+ private final String value;
+
+ private CheckoutEntryMode(String value) {
+ this.value = Objects.requireNonNull(value, "value");
+ }
+
+ /**
+ * Creates a CheckoutEntryMode for a value not yet known to this SDK version.
+ *
+ * @param value Wire value sent to or received from the API.
+ * @return Open enum value wrapping {@code value}.
+ */
+ public static CheckoutEntryMode of(String value) {
+ return new CheckoutEntryMode(value);
+ }
+
+ @JsonValue
+ public String getValue() {
+ return value;
+ }
+
+ @Override
+ public String toString() {
+ return value;
+ }
+
+ @JsonCreator
+ public static CheckoutEntryMode fromValue(String value) {
+ return value == null ? null : new CheckoutEntryMode(value);
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ return this == other
+ || (other instanceof CheckoutEntryMode that && this.value.equals(that.value));
+ }
+
+ @Override
+ public int hashCode() {
+ return value.hashCode();
+ }
+}
diff --git a/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java b/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java
index 040c5b49..825cabb1 100644
--- a/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java
+++ b/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java
@@ -20,11 +20,12 @@ public record CheckoutSuccessTransactionsItem(
com.sumup.sdk.models.Currency currency,
/**
- * How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present
- * payments and `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and
- * alternative payment methods, this can identify the method, such as `APPLE_PAY` or `BLIK`.
+ * How the payment details were captured for a checkout transaction, for example
+ * `CUSTOMER_ENTRY` for card details entered by the payer or `APPLE_PAY` for an Apple Pay
+ * payment. Checkout entry modes use uppercase values, unlike entry modes returned by the
+ * Transactions endpoints.
*/
- com.sumup.sdk.models.EntryMode entryMode,
+ com.sumup.sdk.models.CheckoutEntryMode entryMode,
/** Unique identifier of the transaction. */
String id,
@@ -85,7 +86,7 @@ public static final class Builder {
private Float amount;
private String authCode;
private com.sumup.sdk.models.Currency currency;
- private com.sumup.sdk.models.EntryMode entryMode;
+ private com.sumup.sdk.models.CheckoutEntryMode entryMode;
private String id;
private Long installmentsCount;
private String merchantCode;
@@ -137,13 +138,13 @@ public Builder currency(com.sumup.sdk.models.Currency currency) {
/**
* Sets the value for {@code entryMode}.
*
- * @param entryMode How the payment details were captured, for example `CHIP` or `CONTACTLESS`
- * for card-present payments and `CUSTOMER_ENTRY` for card details entered by the payer. For
- * wallet and alternative payment methods, this can identify the method, such as `APPLE_PAY`
- * or `BLIK`.
+ * @param entryMode How the payment details were captured for a checkout transaction, for
+ * example `CUSTOMER_ENTRY` for card details entered by the payer or `APPLE_PAY` for an
+ * Apple Pay payment. Checkout entry modes use uppercase values, unlike entry modes returned
+ * by the Transactions endpoints.
* @return This builder instance.
*/
- public Builder entryMode(com.sumup.sdk.models.EntryMode entryMode) {
+ public Builder entryMode(com.sumup.sdk.models.CheckoutEntryMode entryMode) {
this.entryMode = entryMode;
return this;
}
diff --git a/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java b/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java
index a8a83c0e..560398eb 100644
--- a/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java
+++ b/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java
@@ -20,11 +20,12 @@ public record CheckoutTransactionsItem(
com.sumup.sdk.models.Currency currency,
/**
- * How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present
- * payments and `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and
- * alternative payment methods, this can identify the method, such as `APPLE_PAY` or `BLIK`.
+ * How the payment details were captured for a checkout transaction, for example
+ * `CUSTOMER_ENTRY` for card details entered by the payer or `APPLE_PAY` for an Apple Pay
+ * payment. Checkout entry modes use uppercase values, unlike entry modes returned by the
+ * Transactions endpoints.
*/
- com.sumup.sdk.models.EntryMode entryMode,
+ com.sumup.sdk.models.CheckoutEntryMode entryMode,
/** Unique identifier of the transaction. */
String id,
@@ -85,7 +86,7 @@ public static final class Builder {
private Float amount;
private String authCode;
private com.sumup.sdk.models.Currency currency;
- private com.sumup.sdk.models.EntryMode entryMode;
+ private com.sumup.sdk.models.CheckoutEntryMode entryMode;
private String id;
private Long installmentsCount;
private String merchantCode;
@@ -137,13 +138,13 @@ public Builder currency(com.sumup.sdk.models.Currency currency) {
/**
* Sets the value for {@code entryMode}.
*
- * @param entryMode How the payment details were captured, for example `CHIP` or `CONTACTLESS`
- * for card-present payments and `CUSTOMER_ENTRY` for card details entered by the payer. For
- * wallet and alternative payment methods, this can identify the method, such as `APPLE_PAY`
- * or `BLIK`.
+ * @param entryMode How the payment details were captured for a checkout transaction, for
+ * example `CUSTOMER_ENTRY` for card details entered by the payer or `APPLE_PAY` for an
+ * Apple Pay payment. Checkout entry modes use uppercase values, unlike entry modes returned
+ * by the Transactions endpoints.
* @return This builder instance.
*/
- public Builder entryMode(com.sumup.sdk.models.EntryMode entryMode) {
+ public Builder entryMode(com.sumup.sdk.models.CheckoutEntryMode entryMode) {
this.entryMode = entryMode;
return this;
}
diff --git a/src/main/java/com/sumup/sdk/models/EntryMode.java b/src/main/java/com/sumup/sdk/models/EntryMode.java
index 00f6a24c..ad4aa6f6 100644
--- a/src/main/java/com/sumup/sdk/models/EntryMode.java
+++ b/src/main/java/com/sumup/sdk/models/EntryMode.java
@@ -6,38 +6,41 @@
import java.util.Objects;
/**
- * How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present
- * payments and `CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative
- * payment methods, this can identify the method, such as `APPLE_PAY` or `BLIK`.
+ * How the payment details were captured, for example `chip` or `contactless` for card-present
+ * payments and `customer entry` for card details entered by the payer. For wallet and alternative
+ * payment methods, this can identify the method, such as `apple pay` or `blik`.
*/
public final class EntryMode {
- public static final EntryMode BOLETO = new EntryMode("BOLETO");
- public static final EntryMode SOFORT = new EntryMode("SOFORT");
- public static final EntryMode IDEAL = new EntryMode("IDEAL");
- public static final EntryMode BANCONTACT = new EntryMode("BANCONTACT");
- public static final EntryMode EPS = new EntryMode("EPS");
- public static final EntryMode MYBANK = new EntryMode("MYBANK");
- public static final EntryMode SATISPAY = new EntryMode("SATISPAY");
- public static final EntryMode BLIK = new EntryMode("BLIK");
- public static final EntryMode P24 = new EntryMode("P24");
- public static final EntryMode GIROPAY = new EntryMode("GIROPAY");
- public static final EntryMode PIX = new EntryMode("PIX");
- public static final EntryMode QR_CODE_PIX = new EntryMode("QR_CODE_PIX");
- public static final EntryMode APPLE_PAY = new EntryMode("APPLE_PAY");
- public static final EntryMode GOOGLE_PAY = new EntryMode("GOOGLE_PAY");
- public static final EntryMode PAYPAL = new EntryMode("PAYPAL");
- public static final EntryMode TWINT = new EntryMode("TWINT");
- public static final EntryMode NONE = new EntryMode("NONE");
- public static final EntryMode CHIP = new EntryMode("CHIP");
- public static final EntryMode MANUAL_ENTRY = new EntryMode("MANUAL_ENTRY");
- public static final EntryMode CUSTOMER_ENTRY = new EntryMode("CUSTOMER_ENTRY");
- public static final EntryMode MAGSTRIPE_FALLBACK = new EntryMode("MAGSTRIPE_FALLBACK");
- public static final EntryMode MAGSTRIPE = new EntryMode("MAGSTRIPE");
- public static final EntryMode DIRECT_DEBIT = new EntryMode("DIRECT_DEBIT");
- public static final EntryMode CONTACTLESS = new EntryMode("CONTACTLESS");
- public static final EntryMode MOTO = new EntryMode("MOTO");
- public static final EntryMode CONTACTLESS_MAGSTRIPE = new EntryMode("CONTACTLESS_MAGSTRIPE");
- public static final EntryMode N_A = new EntryMode("N/A");
+ public static final EntryMode NONE = new EntryMode("none");
+ public static final EntryMode MAGSTRIPE = new EntryMode("magstripe");
+ public static final EntryMode CHIP = new EntryMode("chip");
+ public static final EntryMode MANUAL_ENTRY = new EntryMode("manual entry");
+ public static final EntryMode CUSTOMER_ENTRY = new EntryMode("customer entry");
+ public static final EntryMode MAGSTRIPE_FALLBACK = new EntryMode("magstripe fallback");
+ public static final EntryMode CONTACTLESS = new EntryMode("contactless");
+ public static final EntryMode MOTO = new EntryMode("moto");
+ public static final EntryMode CONTACTLESS_MAGSTRIPE = new EntryMode("contactless magstripe");
+ public static final EntryMode BOLETO = new EntryMode("boleto");
+ public static final EntryMode DIRECT_DEBIT = new EntryMode("direct debit");
+ public static final EntryMode SOFORT = new EntryMode("sofort");
+ public static final EntryMode IDEAL = new EntryMode("ideal");
+ public static final EntryMode BANCONTACT = new EntryMode("bancontact");
+ public static final EntryMode EPS = new EntryMode("eps");
+ public static final EntryMode MYBANK = new EntryMode("mybank");
+ public static final EntryMode SATISPAY = new EntryMode("satispay");
+ public static final EntryMode BLIK = new EntryMode("blik");
+ public static final EntryMode P24 = new EntryMode("p24");
+ public static final EntryMode GIROPAY = new EntryMode("giropay");
+ public static final EntryMode PIX = new EntryMode("pix");
+ public static final EntryMode QR_CODE_PIX = new EntryMode("qr code pix");
+ public static final EntryMode APPLE_PAY = new EntryMode("apple pay");
+ public static final EntryMode GOOGLE_PAY = new EntryMode("google pay");
+ public static final EntryMode SUMUP_GIFT_CARD = new EntryMode("sumup gift card");
+ public static final EntryMode PAYPAL = new EntryMode("paypal");
+ public static final EntryMode TWINT = new EntryMode("twint");
+ public static final EntryMode IRIS = new EntryMode("iris");
+ public static final EntryMode SUMUP_PAY = new EntryMode("sumup pay");
+ public static final EntryMode NA = new EntryMode("na");
private final String value;
diff --git a/src/main/java/com/sumup/sdk/models/PublicPaymentV10.java b/src/main/java/com/sumup/sdk/models/PublicPaymentV10.java
index 4d2ff5bf..3505d4c1 100644
--- a/src/main/java/com/sumup/sdk/models/PublicPaymentV10.java
+++ b/src/main/java/com/sumup/sdk/models/PublicPaymentV10.java
@@ -17,8 +17,9 @@ public record PublicPaymentV10(
/**
* Alternative payment method type when `method` is `apm`. Gift card is not an APM on this API.
- * Input is case-insensitive; the canonical form is lowercase snake_case. **VALUES**:
- * [qr_code_pix, sepa_dd, paypal, sumup_pay, twint, iris].
+ * Values use lowercase snake_case. Known values are `qr_code_pix`, `sepa_dd`, `paypal`,
+ * `sumup_pay`, `twint`, and `iris`. Additional values may be returned as new alternative
+ * payment methods become available.
*/
String apmType,
@@ -34,9 +35,9 @@ public record PublicPaymentV10(
/**
* Payment method on public sales read API v1.0. Digital wallets are first-class methods. Gift
- * card payments use `gift_card`, not `apm`. Input is case-insensitive; the canonical form is
- * lowercase snake_case. **VALUES**: [card, cash, apm, external, apple_pay, google_pay,
- * whatsapp_pay, gift_card].
+ * card payments use `gift_card`, not `apm`. Values use lowercase snake_case. Known values are
+ * `card`, `cash`, `apm`, `external`, `apple_pay`, `google_pay`, `whatsapp_pay`, and
+ * `gift_card`. Additional values may be returned as new payment methods become available.
*/
String method,
@@ -54,10 +55,9 @@ public record PublicPaymentV10(
com.sumup.sdk.models.PublicPaymentV10Status status,
/**
- * Payment operation type. This is distinct from the payment instrument in `method`. Input is
- * case-insensitive; the canonical form is lowercase snake_case. **VALUES**: [purchase,
- * unreferenced_refund] Defaults to "purchase" if unspecified. Either a normal purchase or an
- * unreferenced refund for negative sales like deposit returns.
+ * Payment operation type. This is distinct from the payment instrument in `method`. Values use
+ * lowercase snake_case. Known values are `purchase` for a normal purchase and
+ * `unreferenced_refund` for negative sales such as deposit returns.
*/
String type) {
/**
@@ -99,8 +99,9 @@ public Builder amount(Long amount) {
* Sets the value for {@code apmType}.
*
* @param apmType Alternative payment method type when `method` is `apm`. Gift card is not an
- * APM on this API. Input is case-insensitive; the canonical form is lowercase snake_case.
- * **VALUES**: [qr_code_pix, sepa_dd, paypal, sumup_pay, twint, iris].
+ * APM on this API. Values use lowercase snake_case. Known values are `qr_code_pix`,
+ * `sepa_dd`, `paypal`, `sumup_pay`, `twint`, and `iris`. Additional values may be returned
+ * as new alternative payment methods become available.
* @return This builder instance.
*/
public Builder apmType(String apmType) {
@@ -136,9 +137,10 @@ public Builder giftCard(com.sumup.sdk.models.PublicGiftCardPayment giftCard) {
* Sets the value for {@code method}.
*
* @param method Payment method on public sales read API v1.0. Digital wallets are first-class
- * methods. Gift card payments use `gift_card`, not `apm`. Input is case-insensitive; the
- * canonical form is lowercase snake_case. **VALUES**: [card, cash, apm, external,
- * apple_pay, google_pay, whatsapp_pay, gift_card].
+ * methods. Gift card payments use `gift_card`, not `apm`. Values use lowercase snake_case.
+ * Known values are `card`, `cash`, `apm`, `external`, `apple_pay`, `google_pay`,
+ * `whatsapp_pay`, and `gift_card`. Additional values may be returned as new payment methods
+ * become available.
* @return This builder instance.
*/
public Builder method(String method) {
@@ -186,9 +188,8 @@ public Builder status(com.sumup.sdk.models.PublicPaymentV10Status status) {
* Sets the value for {@code type}.
*
* @param type Payment operation type. This is distinct from the payment instrument in `method`.
- * Input is case-insensitive; the canonical form is lowercase snake_case. **VALUES**:
- * [purchase, unreferenced_refund] Defaults to "purchase" if unspecified. Either a normal
- * purchase or an unreferenced refund for negative sales like deposit returns.
+ * Values use lowercase snake_case. Known values are `purchase` for a normal purchase and
+ * `unreferenced_refund` for negative sales such as deposit returns.
* @return This builder instance.
*/
public Builder type(String type) {
diff --git a/src/main/java/com/sumup/sdk/models/SalePage.java b/src/main/java/com/sumup/sdk/models/SalePage.java
index 3efe2fa7..83af0af7 100644
--- a/src/main/java/com/sumup/sdk/models/SalePage.java
+++ b/src/main/java/com/sumup/sdk/models/SalePage.java
@@ -5,16 +5,14 @@
/**
* Paginated list of `Sale` objects. Results are ordered **newest first** by the newest activity
- * recorded for each sale. See `ListSalesV10`.
+ * recorded for each sale.
*/
public record SalePage(
java.util.List