From 11410ac1b944347a37899782085927b745cdcb2a Mon Sep 17 00:00:00 2001 From: appscisumup Date: Thu, 13 Aug 2026 22:29:16 +0000 Subject: [PATCH 1/2] chore: synced local 'openapi.json' with remote 'specs/openapi.json' --- openapi.json | 614 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 389 insertions(+), 225 deletions(-) diff --git a/openapi.json b/openapi.json index ea2487c..812395f 100755 --- a/openapi.json +++ b/openapi.json @@ -117,7 +117,7 @@ "in": "path", "name": "merchant_code", "required": true, - "description": "The SumUp merchant code.", + "description": "Short unique identifier for the merchant.", "schema": { "type": "string", "example": "MH4H92C7" @@ -154,6 +154,7 @@ "properties": { "available_payment_methods": { "type": "array", + "description": "Payment methods available to the merchant for the checkout.", "example": [ { "id": "apple_pay" @@ -170,7 +171,7 @@ "properties": { "id": { "type": "string", - "description": "The ID of the payment method.", + "description": "Unique identifier of the payment method.", "example": "qr_code_pix" } } @@ -573,10 +574,11 @@ { "name": "checkout_reference", "in": "query", - "description": "Filters the list of checkout resources by the unique ID of the checkout.", + "description": "Filters the list of checkout resources by the unique reference of the checkout.", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "f00a8f74-b05d-4605-bd73-2a901bae5802" } } ], @@ -637,9 +639,10 @@ "name": "checkout_id", "in": "path", "required": true, - "description": "Unique ID of the checkout resource.", + "description": "Unique identifier of the checkout resource.", "schema": { - "type": "string" + "type": "string", + "example": "4e425463-3e1b-431d-83fa-1e51c2925e99" } } ], @@ -1373,9 +1376,10 @@ "name": "checkout_id", "in": "path", "required": true, - "description": "Unique ID of the checkout resource.", + "description": "Unique identifier of the checkout resource.", "schema": { - "type": "string" + "type": "string", + "example": "4e425463-3e1b-431d-83fa-1e51c2925e99" } } ], @@ -1556,13 +1560,19 @@ ], "properties": { "instance": { - "type": "string" + "type": "string", + "description": "Unique identifier of this error occurrence.", + "example": "32a44c6c-85d3-49e8-86bf-a5bba98c4621" }, "error_code": { - "type": "string" + "type": "string", + "description": "Platform code for the error.", + "example": "INVALID" }, "error_message": { - "type": "string" + "type": "string", + "description": "Short description of the error.", + "example": "customer_id" } } } @@ -1651,9 +1661,10 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique ID of the saved customer resource.", + "description": "Unique identifier of the saved customer resource.", "schema": { - "type": "string" + "type": "string", + "example": "831ff8d4cd5958ab5670" } } ], @@ -1878,9 +1889,10 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique ID of the saved customer resource.", + "description": "Unique identifier of the saved customer resource.", "schema": { - "type": "string" + "type": "string", + "example": "831ff8d4cd5958ab5670" } } ], @@ -1993,9 +2005,10 @@ "name": "customer_id", "in": "path", "required": true, - "description": "Unique ID of the saved customer resource.", + "description": "Unique identifier of the saved customer resource.", "schema": { - "type": "string" + "type": "string", + "example": "831ff8d4cd5958ab5670" } }, { @@ -2004,7 +2017,8 @@ "required": true, "description": "Unique token identifying the card saved as a payment instrument resource.", "schema": { - "type": "string" + "type": "string", + "example": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3" } } ], @@ -2125,7 +2139,7 @@ { "name": "merchant_code", "in": "path", - "description": "Merchant code of the account that owns the payment to refund.", + "description": "Short unique identifier for the merchant.", "required": true, "schema": { "type": "string", @@ -2136,9 +2150,10 @@ "name": "transaction_id", "in": "path", "required": true, - "description": "Unique ID of the transaction.", + "description": "Unique identifier of the transaction.", "schema": { - "type": "string" + "type": "string", + "example": "4ffb8dfc-7f2b-413d-a497-2ad00766585e" } } ], @@ -2347,7 +2362,7 @@ { "name": "merchant_code", "in": "path", - "description": "Merchant code of the account whose transaction should be retrieved.", + "description": "Short unique identifier for the merchant.", "required": true, "schema": { "type": "string", @@ -2360,7 +2375,8 @@ "description": "Retrieves the transaction resource with the specified transaction ID (the `id` parameter in the transaction resource).", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "410fc44a-5956-44e1-b5cc-19c6f8d727a4" } }, { @@ -2369,23 +2385,26 @@ "description": "Retrieves the transaction resource with the specified transaction code.", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "TEENSK4W2K" } }, { "name": "foreign_transaction_id", "in": "query", - "description": "External/foreign transaction id (passed by clients).", + "description": "External transaction identifier supplied by the client.", "schema": { - "type": "string" + "type": "string", + "example": "J13253253x1" } }, { "name": "client_transaction_id", "in": "query", - "description": "Client transaction id.", + "description": "Client-supplied identifier of the transaction.", "schema": { - "type": "string" + "type": "string", + "example": "urn:sumup:pos:sale:MNKKNGST:1D4E3B2D-111D-48D7-9AF0-832DAEF63DD7;2" } } ], @@ -2489,7 +2508,7 @@ { "name": "merchant_code", "in": "path", - "description": "Merchant code of the account whose transaction history should be listed.", + "description": "Short unique identifier for the merchant.", "required": true, "schema": { "type": "string", @@ -2502,7 +2521,8 @@ "description": "Retrieves the transaction resource with the specified transaction code.", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "TEENSK4W2K" } }, { @@ -2523,7 +2543,8 @@ "in": "query", "description": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", "schema": { - "type": "integer" + "type": "integer", + "example": 10 } }, { @@ -2552,6 +2573,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "SUCCESSFUL", + "REFUNDED" + ], "items": { "type": "string", "enum": [ @@ -2571,6 +2596,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "ECOM", + "POS" + ], "items": { "$ref": "#/components/schemas/PaymentType" } @@ -2583,6 +2612,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "CUSTOMER_ENTRY", + "CHIP" + ], "items": { "$ref": "#/components/schemas/EntryMode" } @@ -2595,6 +2628,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "PAYMENT", + "REFUND" + ], "items": { "type": "string", "enum": [ @@ -2612,7 +2649,8 @@ "required": false, "schema": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2019-08-28T09:00:00Z" } }, { @@ -2622,7 +2660,8 @@ "required": false, "schema": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2019-08-29T09:00:00Z" } }, { @@ -2631,7 +2670,8 @@ "description": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "090df9bf-93b7-40f1-8181-fbdb236568a1" } }, { @@ -2641,7 +2681,8 @@ "required": false, "schema": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2019-08-28T09:00:00Z" } }, { @@ -2650,7 +2691,8 @@ "description": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *greater* than the specified value. This parameters supersedes the `oldest_time` parameter (if both are provided in the request).", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "090df9bf-93b7-40f1-8181-fbdb236568a1" } } ], @@ -2664,6 +2706,7 @@ "properties": { "items": { "type": "array", + "description": "Transactions in the current result page.", "example": [ { "transaction_code": "TEENSK4W2K", @@ -2688,6 +2731,7 @@ }, "links": { "type": "array", + "description": "Pagination links for navigating the transaction history.", "example": [], "items": { "$ref": "#/components/schemas/TransactionsHistoryLink" @@ -2795,7 +2839,7 @@ { "name": "merchant_code", "in": "path", - "description": "Merchant code of the account whose payouts should be listed.", + "description": "Short unique identifier for the merchant.", "required": true, "schema": { "type": "string", @@ -2993,25 +3037,28 @@ "description": "SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD.", "required": true, "schema": { - "type": "string" + "type": "string", + "example": "410fc44a-5956-44e1-b5cc-19c6f8d727a4" } }, { "in": "query", "name": "mid", - "description": "Merchant code.", + "description": "Short unique identifier for the merchant.", "required": true, "schema": { - "type": "string" + "type": "string", + "example": "MH4H92C7" } }, { "in": "query", "name": "tx_event_id", - "description": "The ID of the transaction event (refund).", + "description": "Unique identifier of the transaction event to include on the receipt.", "required": false, "schema": { - "type": "integer" + "type": "integer", + "example": 9567461191 } } ], @@ -3203,22 +3250,6 @@ } } } - }, - "500": { - "description": "An unexpected error occurred while processing the request.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Problem" - }, - "example": { - "type": "https://developer.sumup.com/problem/internal-server-error", - "title": "Internal Server Error", - "status": 500, - "detail": "An unexpected error occurred while processing the request." - } - } - } } }, "summary": "Create a Go Reader Payment", @@ -6137,6 +6168,7 @@ "type": "string", "description": "Month from the expiration time of the payment card. Accepted format is `MM`.", "writeOnly": true, + "example": "12", "enum": [ "01", "02", @@ -6295,7 +6327,7 @@ }, "merchant_code": { "type": "string", - "description": "Merchant account that receives the payment.", + "description": "Short unique identifier for the merchant that receives the payment.", "example": "MH4H92C7" }, "description": { @@ -6330,7 +6362,7 @@ "type": "string", "example": "2020-02-29T10:56:56+00:00", "format": "date-time", - "description": "Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code." + "description": "The timestamp of when the checkout was created." }, "valid_until": { "type": "string", @@ -6410,7 +6442,7 @@ }, "merchant_code": { "type": "string", - "description": "Merchant account that should receive the payment.", + "description": "Short unique identifier for the merchant that should receive the payment.", "example": "MH4H92C7" }, "description": { @@ -6612,13 +6644,13 @@ }, "transaction_id": { "type": "string", - "description": "Transaction ID of the successful transaction with which the payment for the checkout is completed.", + "description": "Unique identifier of the successful transaction that completed payment for the checkout.", "readOnly": true, "example": "410fc44a-5956-44e1-b5cc-19c6f8d727a4" }, "merchant_name": { "type": "string", - "description": "Name of the merchant", + "description": "Name of the merchant.", "example": "Sample Merchant" }, "redirect_url": { @@ -6632,7 +6664,7 @@ "properties": { "token": { "type": "string", - "description": "Token value", + "description": "Unique token of the saved payment instrument.", "example": "e76d7e5c-9375-4fac-a7e7-b19dc5302fbc" } } @@ -6674,7 +6706,10 @@ "browser" ] }, - "description": "Allowed presentation mechanisms for the next step. `iframe` means the flow can be embedded, while `browser` means it can be completed through a full-page redirect." + "description": "Allowed presentation mechanisms for the next step. `iframe` means the flow can be embedded, while `browser` means it can be completed through a full-page redirect.", + "example": [ + "iframe" + ] }, "payload": { "type": "object", @@ -6702,7 +6737,7 @@ "properties": { "customer_id": { "type": "string", - "description": "Unique ID of the customer.", + "description": "Unique identifier of the customer.", "example": "831ff8d4cd5958ab5670" }, "personal_details": { @@ -6713,7 +6748,7 @@ "Error": { "title": "Error", "type": "object", - "description": "Error message structure.", + "description": "Details of an API error.", "properties": { "message": { "type": "string", @@ -6755,7 +6790,8 @@ "instance": { "description": "A URI reference that identifies the specific occurrence of the problem.", "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99" } }, "additionalProperties": true, @@ -6776,7 +6812,8 @@ "properties": { "param": { "type": "string", - "description": "Parameter name (with relative location) to which the error applies. Parameters from embedded resources are displayed using dot notation. For example, `card.name` refers to the `name` parameter embedded in the `card` object." + "description": "Parameter name (with relative location) to which the error applies. Parameters from embedded resources are displayed using dot notation. For example, `card.name` refers to the `name` parameter embedded in the `card` object.", + "example": "card.name" } } } @@ -6785,7 +6822,7 @@ "ErrorForbidden": { "title": "Error Forbidden", "type": "object", - "description": "Error message for forbidden requests.", + "description": "Details of an error returned for a forbidden request.", "properties": { "error_message": { "type": "string", @@ -6807,7 +6844,7 @@ "DetailsError": { "title": "Details Error", "type": "object", - "description": "Error message structure.", + "description": "Details of a request validation error.", "properties": { "title": { "type": "string", @@ -6821,7 +6858,7 @@ }, "status": { "type": "number", - "description": "The status code.", + "description": "HTTP status code for the error.", "example": 400 }, "failed_constraints": { @@ -6837,10 +6874,14 @@ "type": "object", "properties": { "message": { - "type": "string" + "type": "string", + "description": "Human-readable description of the violated constraint.", + "example": "Currency must also be specified when filtering by amount" }, "reference": { - "type": "string" + "type": "string", + "description": "Name of the field that violated the constraint.", + "example": "currency" } } } @@ -6867,31 +6908,37 @@ "amount": { "type": "number", "format": "float", - "description": "Amount of the event." + "description": "Amount associated with the transaction event, in major units.", + "example": 10.1 }, "timestamp": { "type": "string", "format": "date-time", - "description": "Date and time of the transaction event." + "description": "The timestamp of when the transaction event occurred.", + "example": "2020-05-25T10:49:42.784Z" }, "fee_amount": { "type": "number", "format": "float", - "description": "Amount of the fee related to the event." + "description": "Fee associated with the transaction event, in major units.", + "example": 0.25 }, "installment_number": { "type": "integer", - "description": "Consecutive number of the installment." + "description": "Consecutive number of the installment associated with the event.", + "example": 1 }, "deducted_amount": { "type": "number", "format": "float", - "description": "Amount deducted for the event." + "description": "Amount deducted from the merchant for the event, in major units.", + "example": 10.1 }, "deducted_fee_amount": { "type": "number", "format": "float", - "description": "Amount of the fee deducted for the event." + "description": "Fee deducted from the merchant for the event, in major units.", + "example": 0.25 } } }, @@ -6988,26 +7035,31 @@ "properties": { "rel": { "type": "string", - "description": "Specifies the relation to the current resource." + "description": "Relation of the linked resource to the current resource.", + "example": "refund" }, "href": { "type": "string", "format": "uri", - "description": "URL for accessing the related resource." + "description": "URL for accessing the related resource.", + "example": "https://api.sumup.com/v1.0/merchants/MH4H92C7/payments/4ffb8dfc-7f2b-413d-a497-2ad00766585e/refunds" }, "type": { "type": "string", - "description": "Specifies the media type of the related resource." + "description": "Media type of the linked resource.", + "example": "application/json" }, "min_amount": { "type": "number", "format": "float", - "description": "Minimum allowed amount for the refund." + "description": "Minimum amount allowed for a refund, in major units.", + "example": 0.01 }, "max_amount": { "type": "number", "format": "float", - "description": "Maximum allowed amount for the refund." + "description": "Maximum amount allowed for a refund, in major units.", + "example": 10.1 } } }, @@ -7073,7 +7125,8 @@ "properties": { "type": { "type": "string", - "description": "Type of mandate stored for the checkout or payment instrument." + "description": "Type of mandate stored for the checkout or payment instrument.", + "example": "recurrent" }, "status": { "type": "string", @@ -7086,7 +7139,7 @@ }, "merchant_code": { "type": "string", - "description": "Merchant account for which the mandate is valid.", + "description": "Short unique identifier for the merchant for which the mandate is valid.", "example": "MH4H92C7" } }, @@ -7099,12 +7152,13 @@ "PaymentInstrumentResponse": { "title": "Payment Instrument Response", "type": "object", - "description": "Payment Instrument Response", + "description": "Details of a saved payment instrument.", "properties": { "token": { "type": "string", "description": "Unique token identifying the saved payment card for a customer.", - "readOnly": true + "readOnly": true, + "example": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3" }, "active": { "type": "boolean", @@ -7117,7 +7171,8 @@ "description": "Type of the payment instrument.", "enum": [ "card" - ] + ], + "example": "card" }, "card": { "type": "object", @@ -7141,8 +7196,9 @@ }, "created_at": { "type": "string", - "description": "Creation date of payment instrument. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.", - "format": "date-time" + "description": "The timestamp of when the payment instrument was created.", + "format": "date-time", + "example": "2021-03-30T10:06:07.000+00:00" } }, "example": { @@ -7194,7 +7250,7 @@ }, "tax_id": { "type": "string", - "description": "An identification number user for tax purposes (e.g. CPF)", + "description": "Identification number used for tax purposes, such as a CPF in Brazil.", "maxLength": 255, "example": "423.378.593-47" }, @@ -7206,7 +7262,7 @@ "Product": { "title": "Product", "type": "object", - "description": "Purchase product.", + "description": "Product details associated with a transaction.", "properties": { "name": { "type": "string", @@ -7215,7 +7271,8 @@ }, "price_label": { "type": "string", - "description": "Product description." + "description": "Human-readable label for the product price.", + "example": "EUR 100.00" }, "price": { "type": "number", @@ -7226,22 +7283,26 @@ "vat_rate": { "type": "number", "format": "decimal", - "description": "VAT percentage." + "description": "VAT rate applied to the product price.", + "example": 0.19 }, "single_vat_amount": { "type": "number", "format": "decimal", - "description": "VAT amount for a single product." + "description": "VAT amount for a single product.", + "example": 19 }, "price_with_vat": { "type": "number", "format": "decimal", - "description": "Product price incl. VAT." + "description": "Product price including VAT.", + "example": 119 }, "vat_amount": { "type": "number", "format": "decimal", - "description": "VAT amount." + "description": "Total VAT amount for the product quantity.", + "example": 19 }, "quantity": { "type": "integer", @@ -7251,13 +7312,14 @@ "total_price": { "type": "number", "format": "decimal", - "description": "Quantity x product price.", + "description": "Total price calculated as the product price multiplied by the quantity.", "example": 100 }, "total_with_vat": { "type": "number", "format": "decimal", - "description": "Total price incl. VAT." + "description": "Total product price including VAT.", + "example": 119 } } }, @@ -7286,16 +7348,24 @@ }, "properties": { "tid": { - "type": "string" + "type": "string", + "description": "Identifier of the terminal used for the authorization.", + "example": "12345678" }, "authorization_code": { - "type": "string" + "type": "string", + "description": "Authorization code returned by the acquirer.", + "example": "053201" }, "return_code": { - "type": "string" + "type": "string", + "description": "Return code reported by the acquirer.", + "example": "00" }, "local_time": { - "type": "string" + "type": "string", + "description": "Local timestamp of the card authorization.", + "example": "2020-02-29T11:56:56+01:00" } } } @@ -7321,16 +7391,19 @@ "amount": { "type": "string", "format": "double", - "description": "Amount of the event." + "description": "Amount associated with the transaction event, in major units.", + "example": "10.10" }, "timestamp": { "type": "string", "format": "date-time", - "description": "Date and time of the transaction event." + "description": "The timestamp of when the transaction event occurred.", + "example": "2020-05-25T10:49:42.784Z" }, "receipt_no": { "type": "string", - "description": "Receipt number associated with the event." + "description": "Receipt number associated with the event.", + "example": "123456" } } }, @@ -7341,11 +7414,13 @@ "properties": { "last_4_digits": { "type": "string", - "description": "Card last 4 digits." + "description": "Last four digits of the payment card number.", + "example": "3456" }, "type": { "type": "string", - "description": "Card Scheme." + "description": "Issuing card network of the payment card.", + "example": "VISA" } } }, @@ -7356,18 +7431,20 @@ "properties": { "code": { "type": "string", - "description": "Reader serial number." + "description": "Unique identifier of the physical card reader.", + "example": "U1DT3NA00-CN" }, "type": { "type": "string", - "description": "Reader type." + "description": "Model of the physical card reader.", + "example": "solo" } } }, "ReceiptMerchantData": { "title": "Receipt Merchant Data", "type": "object", - "description": "Receipt merchant data", + "description": "Merchant details displayed on a transaction receipt.", "properties": { "merchant_profile": { "type": "object", @@ -7375,55 +7452,87 @@ "properties": { "merchant_code": { "type": "string", + "description": "Short unique identifier for the merchant.", "example": "MH4H92C7" }, "business_name": { - "type": "string" + "type": "string", + "description": "Business name of the merchant.", + "example": "Coffee House" }, "company_registration_number": { - "type": "string" + "type": "string", + "description": "Company registration number of the merchant.", + "example": "HRB 123456" }, "vat_id": { - "type": "string" + "type": "string", + "description": "VAT identification number of the merchant.", + "example": "DE123456789" }, "website": { - "type": "string" + "type": "string", + "description": "Website of the merchant.", + "example": "https://example.com" }, "email": { - "type": "string" + "type": "string", + "description": "Email address of the merchant.", + "example": "merchant@example.com" }, "language": { - "type": "string" + "type": "string", + "description": "Language configured for the merchant profile.", + "example": "de" }, "address": { "type": "object", + "description": "Business address of the merchant.", "properties": { "address_line1": { - "type": "string" + "type": "string", + "description": "First line of the merchant address.", + "example": "Sample street 1" }, "address_line2": { - "type": "string" + "type": "string", + "description": "Second line of the merchant address.", + "example": "Floor 2" }, "city": { - "type": "string" + "type": "string", + "description": "City of the merchant address.", + "example": "Berlin" }, "country": { - "type": "string" + "type": "string", + "description": "Two-letter ISO 3166-1 alpha-2 country code of the merchant address.", + "example": "DE" }, "country_en_name": { - "type": "string" + "type": "string", + "description": "English name of the country in the merchant address.", + "example": "Germany" }, "country_native_name": { - "type": "string" + "type": "string", + "description": "Localized name of the country in the merchant address.", + "example": "Deutschland" }, "region_name": { - "type": "string" + "type": "string", + "description": "Region or state of the merchant address.", + "example": "Berlin" }, "post_code": { - "type": "string" + "type": "string", + "description": "Postal code of the merchant address.", + "example": "10115" }, "landline": { - "type": "string" + "type": "string", + "description": "Landline phone number of the merchant.", + "example": "+493012345678" } } } @@ -7431,14 +7540,15 @@ }, "locale": { "type": "string", - "description": "Locale used for rendering localized receipt fields." + "description": "Locale used for rendering localized receipt fields.", + "example": "de-DE" } } }, "ReceiptTransaction": { "title": "Receipt Transaction", "type": "object", - "description": "Transaction information.", + "description": "Transaction details displayed on a receipt.", "example": { "transaction_code": "TEENSK4W2K", "transaction_id": "410fc44a-5956-44e1-b5cc-19c6f8d727a4", @@ -7457,51 +7567,62 @@ "properties": { "transaction_code": { "type": "string", - "description": "Transaction code." + "description": "Transaction code returned after processing the transaction.", + "example": "TEENSK4W2K" }, "transaction_id": { "$ref": "#/components/schemas/TransactionID" }, "merchant_code": { "type": "string", - "description": "Merchant code." + "description": "Short unique identifier for the merchant.", + "example": "MH4H92C7" }, "amount": { "type": "string", - "description": "Transaction amount." + "description": "Total transaction amount, in major units.", + "example": "10.10" }, "vat_amount": { "type": "string", - "description": "Transaction VAT amount." + "description": "VAT included in the transaction amount, in major units.", + "example": "6.00" }, "tip_amount": { "type": "string", - "description": "Tip amount (included in transaction amount)." + "description": "Tip included in the transaction amount, in major units.", + "example": "3.00" }, "currency": { "type": "string", - "description": "Transaction currency." + "description": "Three-letter ISO 4217 currency code of the transaction.", + "example": "EUR" }, "timestamp": { "type": "string", "format": "date-time", - "description": "Time created at." + "description": "The timestamp of when the transaction was created.", + "example": "2020-02-29T10:56:56.876Z" }, "status": { "type": "string", - "description": "Transaction processing status." + "description": "Current processing status of the transaction.", + "example": "SUCCESSFUL" }, "payment_type": { "type": "string", - "description": "Transaction type." + "description": "Payment type used for the transaction.", + "example": "ECOM" }, "entry_mode": { "type": "string", - "description": "Transaction entry mode." + "description": "Entry mode of the payment details.", + "example": "CUSTOMER_ENTRY" }, "verification_method": { "type": "string", - "description": "Cardholder verification method." + "description": "Cardholder verification method.", + "example": "none" }, "card_reader": { "$ref": "#/components/schemas/ReceiptReader" @@ -7511,11 +7632,12 @@ }, "installments_count": { "type": "integer", - "description": "Number of installments." + "description": "Number of installments.", + "example": 1 }, "process_as": { "type": "string", - "description": "Debit/Credit.", + "description": "Whether the transaction was processed as credit or debit.", "enum": [ "CREDIT", "DEBIT" @@ -7524,65 +7646,66 @@ }, "products": { "type": "array", - "description": "Products", + "description": "Products associated with the transaction.", "items": { "type": "object", "properties": { "name": { "type": "string", - "description": "Product name", + "description": "Product name.", "example": "Coffee" }, "description": { "type": "string", - "description": "Product description" + "description": "Product description.", + "example": "Cappuccino" }, "price": { "type": "string", "format": "double", - "description": "Product price", + "description": "Product price.", "example": "150.0" }, "vat_rate": { "type": "string", "format": "double", - "description": "VAT rate", + "description": "VAT rate.", "example": "0.0" }, "single_vat_amount": { "type": "string", "format": "double", - "description": "VAT amount for a single product", + "description": "VAT amount for a single product.", "example": "0.0" }, "price_with_vat": { "type": "string", "format": "double", - "description": "Product price including VAT", + "description": "Product price including VAT.", "example": "150.0" }, "vat_amount": { "type": "string", "format": "double", - "description": "VAT amount", + "description": "Total VAT amount for the product quantity.", "example": "0.0" }, "quantity": { "type": "integer", "format": "int64", - "description": "Product quantity", + "description": "Product quantity.", "example": 1 }, "total_price": { "type": "string", "format": "double", - "description": "Quantity x product price", + "description": "Total price calculated as the product price multiplied by the quantity.", "example": "150.0" }, "total_with_vat": { "type": "string", "format": "double", - "description": "Total price including VAT", + "description": "Total product price including VAT.", "example": "150.0" } } @@ -7590,43 +7713,48 @@ }, "vat_rates": { "type": "array", - "description": "Vat rates.", + "description": "VAT breakdown for the transaction.", "items": { "type": "object", "properties": { "gross": { "type": "number", "format": "float", - "description": "Gross" + "description": "Gross amount to which the VAT rate applies.", + "example": 10.1 }, "net": { "type": "number", "format": "float", - "description": "Net" + "description": "Net amount to which the VAT rate applies.", + "example": 8.49 }, "rate": { "type": "number", "format": "float", - "description": "Rate" + "description": "VAT rate applied to the transaction amount.", + "example": 0.19 }, "vat": { "type": "number", "format": "float", - "description": "Vat" + "description": "VAT amount included in the gross amount.", + "example": 1.61 } } } }, "events": { "type": "array", - "description": "Events", + "description": "Transaction events displayed on the receipt.", "items": { "$ref": "#/components/schemas/ReceiptEvent" } }, "receipt_no": { "type": "string", - "description": "Receipt number" + "description": "Receipt number associated with the transaction.", + "example": "123456" } } }, @@ -7678,11 +7806,11 @@ "TransactionBase": { "title": "Transaction Base", "type": "object", - "description": "Details of the transaction.", + "description": "Core details shared by transaction resources.", "properties": { "id": { "type": "string", - "description": "Unique ID of the transaction.", + "description": "Unique identifier of the transaction.", "example": "6b425463-3e1b-431d-83fa-1e51c2925e99" }, "transaction_code": { @@ -7703,7 +7831,7 @@ "type": "string", "example": "2020-02-29T10:56:56.876Z", "format": "date-time", - "description": "Date and time of the creation of the transaction. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code." + "description": "The timestamp of when the transaction was created." }, "status": { "$ref": "#/components/schemas/TransactionStatus" @@ -7713,8 +7841,9 @@ }, "installments_count": { "type": "integer", - "description": "Current number of the installment for deferred payments.", - "minimum": 1 + "description": "Number of installments for a deferred payment.", + "minimum": 1, + "example": 1 } } }, @@ -7757,15 +7886,18 @@ "properties": { "product_summary": { "type": "string", - "description": "Short description of the payment. The value is taken from the `description` property of the related checkout resource." + "description": "Short description of the payment. The value is taken from the `description` property of the related checkout resource.", + "example": "Purchase" }, "payouts_total": { "type": "integer", - "description": "Total number of payouts to the registered user specified in the `user` property." + "description": "Total number of payouts to the registered user specified in the `user` property.", + "example": 1 }, "payouts_received": { "type": "integer", - "description": "Number of payouts that are made to the registered user specified in the `user` property." + "description": "Number of payouts that are made to the registered user specified in the `user` property.", + "example": 1 }, "payout_plan": { "type": "string", @@ -7774,7 +7906,8 @@ "SINGLE_PAYMENT", "TRUE_INSTALLMENT", "ACCELERATED_INSTALLMENT" - ] + ], + "example": "SINGLE_PAYMENT" } } }, @@ -7796,12 +7929,14 @@ }, "client_transaction_id": { "type": "string", - "description": "Client-specific ID of the transaction." + "description": "Client-supplied identifier of the transaction.", + "example": "urn:sumup:pos:sale:MNKKNGST:1D4E3B2D-111D-48D7-9AF0-832DAEF63DD7;2" }, "user": { "type": "string", "format": "email", - "description": "Email address of the registered user (merchant) to whom the payment is made." + "description": "Email address of the registered user (merchant) to whom the payment is made.", + "example": "merchant@example.com" }, "type": { "type": "string", @@ -7810,7 +7945,8 @@ "PAYMENT", "REFUND", "CHARGE_BACK" - ] + ], + "example": "PAYMENT" }, "card_type": { "$ref": "#/components/schemas/CardType" @@ -7856,7 +7992,8 @@ "DIRECT_DEBIT", "APM", "UNKNOWN" - ] + ], + "example": "ECOM" }, "EntryMode": { "title": "Entry Mode", @@ -7890,7 +8027,8 @@ "MOTO", "CONTACTLESS_MAGSTRIPE", "N/A" - ] + ], + "example": "CUSTOMER_ENTRY" }, "CardType": { "title": "Card Type", @@ -7921,7 +8059,8 @@ "VPAY", "VR", "UNKNOWN" - ] + ], + "example": "VISA" }, "TransactionFull": { "title": "Transaction Full", @@ -7941,18 +8080,19 @@ "properties": { "foreign_transaction_id": { "type": "string", - "description": "External/foreign transaction id (passed by clients).", + "description": "External transaction identifier supplied by the client.", "example": "J13253253x1" }, "client_transaction_id": { "type": "string", - "description": "Client transaction id.", + "description": "Client-supplied identifier of the transaction.", "example": "urn:sumup:pos:sale:MNKKNGST:1D4E3B2D-111D-48D7-9AF0-832DAEF63DD7;2" }, "username": { "type": "string", "format": "email", - "description": "Email address of the registered user (merchant) to whom the payment is made." + "description": "Email address of the registered user (merchant) to whom the payment is made.", + "example": "merchant@example.com" }, "fee_amount": { "type": "number", @@ -7972,7 +8112,7 @@ "merchant_id": { "type": "integer", "format": "int64", - "description": "SumUp merchant internal Id.", + "description": "Internal SumUp identifier of the merchant.", "example": 136902 }, "device_info": { @@ -7996,7 +8136,8 @@ "APM", "BITCOIN", "CARD" - ] + ], + "example": "CARD" }, "verification_method": { "type": "string", @@ -8008,7 +8149,8 @@ "online PIN", "offline PIN + signature", "na" - ] + ], + "example": "none" }, "card": { "$ref": "#/components/schemas/CardResponse" @@ -8019,7 +8161,8 @@ "local_time": { "type": "string", "format": "date-time", - "description": "Local date and time of the creation of the transaction." + "description": "Local timestamp of when the transaction was created.", + "example": "2020-02-29T11:56:56+01:00" }, "payout_date": { "type": "string", @@ -8033,11 +8176,12 @@ "enum": [ "BANK_ACCOUNT", "PREPAID_CARD" - ] + ], + "example": "BANK_ACCOUNT" }, "process_as": { "type": "string", - "description": "Debit/Credit.", + "description": "Whether the transaction was processed as credit or debit.", "enum": [ "CREDIT", "DEBIT" @@ -8105,7 +8249,8 @@ "REFUNDED", "NON_COLLECTION", "PENDING" - ] + ], + "example": "SUCCESSFUL" }, "links": { "type": "array", @@ -8138,7 +8283,8 @@ }, "tax_enabled": { "type": "boolean", - "description": "Indicates whether tax deduction is enabled for the transaction." + "description": "Indicates whether tax deduction is enabled for the transaction.", + "example": true } } } @@ -8147,7 +8293,7 @@ "Currency": { "title": "Currency", "type": "string", - "description": "Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.", + "description": "Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.", "enum": [ "BGN", "BRL", @@ -8178,7 +8324,8 @@ "FAILED", "PENDING", "REFUNDED" - ] + ], + "example": "SUCCESSFUL" }, "TransactionEventType": { "title": "Transaction Event Type", @@ -8189,7 +8336,8 @@ "CHARGE_BACK", "REFUND", "PAYOUT_DEDUCTION" - ] + ], + "example": "REFUND" }, "TransactionEventStatus": { "title": "Transaction Event Status", @@ -8203,19 +8351,22 @@ "REFUNDED", "SCHEDULED", "SUCCESSFUL" - ] + ], + "example": "SUCCESSFUL" }, "TransactionEventID": { "title": "Transaction Event ID", "type": "integer", "format": "int64", - "description": "Unique ID of the transaction event." + "description": "Unique identifier of the transaction event.", + "example": 9567461191 }, "HorizontalAccuracy": { "title": "Horizontal Accuracy", "type": "number", "format": "float", - "description": "Indication of the precision of the geographical position received from the payment terminal." + "description": "Indication of the precision of the geographical position received from the payment terminal.", + "example": 5 }, "Lat": { "title": "Latitude", @@ -8223,7 +8374,8 @@ "format": "float", "description": "Latitude value from the coordinates of the payment location (as received from the payment terminal reader).", "minimum": 0, - "maximum": 90 + "maximum": 90, + "example": 52.520008 }, "Lon": { "title": "Longitude", @@ -8231,12 +8383,14 @@ "format": "float", "description": "Longitude value from the coordinates of the payment location (as received from the payment terminal reader).", "minimum": 0, - "maximum": 180 + "maximum": 180, + "example": 13.404954 }, "TransactionID": { "title": "Transaction ID", "type": "string", - "description": "Unique ID of the transaction." + "description": "Unique identifier of the transaction.", + "example": "410fc44a-5956-44e1-b5cc-19c6f8d727a4" }, "Affiliate": { "properties": { @@ -11113,22 +11267,6 @@ } } }, - "InternalError": { - "description": "An unexpected error occurred while processing the request.", - "content": { - "application/problem+json": { - "schema": { - "$ref": "#/components/schemas/Problem" - }, - "example": { - "type": "https://developer.sumup.com/problem/internal-server-error", - "title": "Internal Server Error", - "status": 500, - "detail": "An unexpected error occurred while processing the request." - } - } - } - }, "ListMemberships": { "description": "Returns a list of Membership objects.", "content": { @@ -11206,28 +11344,31 @@ "CheckoutReference": { "name": "checkout_reference", "in": "query", - "description": "Filters the list of checkout resources by the unique ID of the checkout.", + "description": "Filters the list of checkout resources by the unique reference of the checkout.", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "f00a8f74-b05d-4605-bd73-2a901bae5802" } }, "CheckoutID": { "name": "checkout_id", "in": "path", "required": true, - "description": "Unique ID of the checkout resource.", + "description": "Unique identifier of the checkout resource.", "schema": { - "type": "string" + "type": "string", + "example": "4e425463-3e1b-431d-83fa-1e51c2925e99" } }, "CustomerID": { "name": "customer_id", "in": "path", "required": true, - "description": "Unique ID of the saved customer resource.", + "description": "Unique identifier of the saved customer resource.", "schema": { - "type": "string" + "type": "string", + "example": "831ff8d4cd5958ab5670" } }, "Token": { @@ -11236,7 +11377,8 @@ "required": true, "description": "Unique token identifying the card saved as a payment instrument resource.", "schema": { - "type": "string" + "type": "string", + "example": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3" } }, "TransactionCode": { @@ -11245,7 +11387,8 @@ "description": "Retrieves the transaction resource with the specified transaction code.", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "TEENSK4W2K" } }, "OrderFilter": { @@ -11266,7 +11409,8 @@ "in": "query", "description": "Specifies the maximum number of results per page. Value must be a positive integer and if not specified, will return 10 results.", "schema": { - "type": "integer" + "type": "integer", + "example": 10 } }, "UsersFilter": { @@ -11295,6 +11439,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "SUCCESSFUL", + "REFUNDED" + ], "items": { "type": "string", "enum": [ @@ -11314,6 +11462,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "ECOM", + "POS" + ], "items": { "$ref": "#/components/schemas/PaymentType" } @@ -11326,6 +11478,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "CUSTOMER_ENTRY", + "CHIP" + ], "items": { "$ref": "#/components/schemas/EntryMode" } @@ -11338,6 +11494,10 @@ "required": false, "schema": { "type": "array", + "example": [ + "PAYMENT", + "REFUND" + ], "items": { "type": "string", "enum": [ @@ -11355,7 +11515,8 @@ "required": false, "schema": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2019-08-28T09:00:00Z" } }, "NewestTimeFilter": { @@ -11365,7 +11526,8 @@ "required": false, "schema": { "type": "string", - "format": "date-time" + "format": "date-time", + "example": "2019-08-29T09:00:00Z" } }, "NewestRefFilter": { @@ -11374,7 +11536,8 @@ "description": "Filters the results by the reference ID of transaction events and returns only transactions with events whose IDs are *smaller* than the specified value. This parameters supersedes the `newest_time` parameter (if both are provided in the request).", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "090df9bf-93b7-40f1-8181-fbdb236568a1" } }, "TransactionID": { @@ -11383,7 +11546,8 @@ "description": "Retrieves the transaction resource with the specified transaction ID (the `id` parameter in the transaction resource).", "required": false, "schema": { - "type": "string" + "type": "string", + "example": "410fc44a-5956-44e1-b5cc-19c6f8d727a4" } } }, From add4ffd9f9a14f8d4ca0d37bfc173a52a978bca2 Mon Sep 17 00:00:00 2001 From: "sumup-release-bot[bot]" <241716704+sumup-release-bot[bot]@users.noreply.github.com> Date: Thu, 13 Aug 2026 22:30:48 +0000 Subject: [PATCH 2/2] chore: generate code --- .../sdk/clients/CheckoutsAsyncClient.java | 28 ++++---- .../sumup/sdk/clients/CheckoutsClient.java | 28 ++++---- .../sdk/clients/CustomersAsyncClient.java | 16 ++--- .../sumup/sdk/clients/CustomersClient.java | 16 ++--- .../sumup/sdk/clients/PayoutsAsyncClient.java | 6 +- .../com/sumup/sdk/clients/PayoutsClient.java | 6 +- .../sdk/clients/ReceiptsAsyncClient.java | 8 +-- .../com/sumup/sdk/clients/ReceiptsClient.java | 8 +-- .../sdk/clients/TransactionsAsyncClient.java | 24 +++---- .../sumup/sdk/clients/TransactionsClient.java | 24 +++---- .../java/com/sumup/sdk/models/Checkout.java | 19 ++---- .../sdk/models/CheckoutCreateRequest.java | 11 ++-- .../com/sumup/sdk/models/CheckoutSuccess.java | 28 +++----- .../CheckoutSuccessPaymentInstrument.java | 4 +- .../CheckoutSuccessTransactionsItem.java | 23 +++---- .../sdk/models/CheckoutTransactionsItem.java | 23 +++---- .../sdk/models/CheckoutUpdateRequest.java | 7 +- .../java/com/sumup/sdk/models/Currency.java | 5 +- .../java/com/sumup/sdk/models/Customer.java | 4 +- .../com/sumup/sdk/models/DetailsError.java | 6 +- .../DetailsErrorFailedConstraintsItem.java | 10 ++- src/main/java/com/sumup/sdk/models/Error.java | 2 +- .../com/sumup/sdk/models/ErrorForbidden.java | 2 +- src/main/java/com/sumup/sdk/models/Event.java | 32 ++++----- .../sdk/models/GetPaymentMethodsResponse.java | 3 +- ...dsResponseAvailablePaymentMethodsItem.java | 4 +- src/main/java/com/sumup/sdk/models/Link.java | 16 ++--- .../models/ListTransactionsV21Response.java | 7 +- .../com/sumup/sdk/models/MandateResponse.java | 4 +- .../sdk/models/PaymentInstrumentResponse.java | 10 +-- .../com/sumup/sdk/models/PersonalDetails.java | 4 +- .../java/com/sumup/sdk/models/Product.java | 26 ++++---- .../java/com/sumup/sdk/models/Receipt.java | 8 +-- .../sumup/sdk/models/ReceiptAcquirerData.java | 19 ++++-- .../com/sumup/sdk/models/ReceiptCard.java | 8 +-- .../com/sumup/sdk/models/ReceiptEvent.java | 16 ++--- .../sumup/sdk/models/ReceiptMerchantData.java | 2 +- .../ReceiptMerchantDataMerchantProfile.java | 31 ++++++--- ...iptMerchantDataMerchantProfileAddress.java | 36 +++++++--- .../com/sumup/sdk/models/ReceiptReader.java | 8 +-- .../sumup/sdk/models/ReceiptTransaction.java | 66 +++++++++---------- .../models/ReceiptTransactionProcessAs.java | 2 +- .../ReceiptTransactionProductsItem.java | 40 +++++------ .../ReceiptTransactionVatRatesItem.java | 16 ++--- .../com/sumup/sdk/models/TransactionBase.java | 25 +++---- .../sumup/sdk/models/TransactionEvent.java | 4 +- .../sumup/sdk/models/TransactionEventId.java | 2 +- .../com/sumup/sdk/models/TransactionFull.java | 43 ++++++------ .../sdk/models/TransactionFullProcessAs.java | 2 +- .../sumup/sdk/models/TransactionHistory.java | 31 ++++----- .../com/sumup/sdk/models/TransactionId.java | 2 +- 51 files changed, 389 insertions(+), 386 deletions(-) diff --git a/src/main/java/com/sumup/sdk/clients/CheckoutsAsyncClient.java b/src/main/java/com/sumup/sdk/clients/CheckoutsAsyncClient.java index fe71e47..1bc1b71 100644 --- a/src/main/java/com/sumup/sdk/clients/CheckoutsAsyncClient.java +++ b/src/main/java/com/sumup/sdk/clients/CheckoutsAsyncClient.java @@ -108,7 +108,7 @@ public CompletableFuture create( * *

Operation ID: CreateApplePaySession * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request The data needed to create an apple pay session for a checkout. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -132,7 +132,7 @@ public CompletableFuture> createApplePaySession( * *

Operation ID: CreateApplePaySession * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request The data needed to create an apple pay session for a checkout. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -166,7 +166,7 @@ public CompletableFuture> createApplePaySession( * *

Operation ID: DeactivateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return CompletableFuture resolved with com.sumup.sdk.models.Checkout parsed response. @@ -185,7 +185,7 @@ public CompletableFuture deactivate(String checko * *

Operation ID: DeactivateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return CompletableFuture resolved with com.sumup.sdk.models.Checkout parsed response. @@ -215,7 +215,7 @@ public CompletableFuture deactivate( * *

Operation ID: GetCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return CompletableFuture resolved with com.sumup.sdk.models.CheckoutSuccess parsed response. @@ -234,7 +234,7 @@ public CompletableFuture get(String checko * *

Operation ID: GetCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return CompletableFuture resolved with com.sumup.sdk.models.CheckoutSuccess parsed response. @@ -333,7 +333,7 @@ public CompletableFuture> l * *

Operation ID: GetPaymentMethods * - * @param merchantCode The SumUp merchant code. + * @param merchantCode Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return CompletableFuture resolved with com.sumup.sdk.models.GetPaymentMethodsResponse parsed @@ -352,7 +352,7 @@ public CompletableFuture> l * *

Operation ID: GetPaymentMethods * - * @param merchantCode The SumUp merchant code. + * @param merchantCode Short unique identifier for the merchant. * @param getPaymentMethods Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -373,7 +373,7 @@ public CompletableFuture> l * *

Operation ID: GetPaymentMethods * - * @param merchantCode The SumUp merchant code. + * @param merchantCode Short unique identifier for the merchant. * @param getPaymentMethods Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -416,7 +416,7 @@ public CompletableFuture> l * *

Operation ID: ProcessCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details of the payment instrument for processing the checkout. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -437,7 +437,7 @@ public CompletableFuture process( * *

Operation ID: ProcessCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details of the payment instrument for processing the checkout. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -471,7 +471,7 @@ public CompletableFuture process( * *

Operation ID: UpdateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details for updating a checkout resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -490,7 +490,7 @@ public CompletableFuture update( * *

Operation ID: UpdateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details for updating a checkout resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -524,7 +524,7 @@ public static final class ListCheckoutsQueryParams { /** * Sets the checkout_reference query parameter. * - * @param value Filters the list of checkout resources by the unique ID of the checkout. + * @param value Filters the list of checkout resources by the unique reference of the checkout. * @return This ListCheckoutsQueryParams instance. */ public ListCheckoutsQueryParams checkoutReference(String value) { diff --git a/src/main/java/com/sumup/sdk/clients/CheckoutsClient.java b/src/main/java/com/sumup/sdk/clients/CheckoutsClient.java index 708c67b..f150329 100644 --- a/src/main/java/com/sumup/sdk/clients/CheckoutsClient.java +++ b/src/main/java/com/sumup/sdk/clients/CheckoutsClient.java @@ -107,7 +107,7 @@ public com.sumup.sdk.models.Checkout create( * *

Operation ID: CreateApplePaySession * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request The data needed to create an apple pay session for a checkout. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -131,7 +131,7 @@ public java.util.Map createApplePaySession( * *

Operation ID: CreateApplePaySession * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request The data needed to create an apple pay session for a checkout. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -165,7 +165,7 @@ public java.util.Map createApplePaySession( * *

Operation ID: DeactivateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return com.sumup.sdk.models.Checkout parsed response. @@ -183,7 +183,7 @@ public com.sumup.sdk.models.Checkout deactivate(String checkoutId) throws ApiExc * *

Operation ID: DeactivateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return com.sumup.sdk.models.Checkout parsed response. @@ -213,7 +213,7 @@ public com.sumup.sdk.models.Checkout deactivate(String checkoutId, RequestOption * *

Operation ID: GetCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return com.sumup.sdk.models.CheckoutSuccess parsed response. @@ -231,7 +231,7 @@ public com.sumup.sdk.models.CheckoutSuccess get(String checkoutId) throws ApiExc * *

Operation ID: GetCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return com.sumup.sdk.models.CheckoutSuccess parsed response. @@ -326,7 +326,7 @@ public java.util.List list( * *

Operation ID: GetPaymentMethods * - * @param merchantCode The SumUp merchant code. + * @param merchantCode Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return com.sumup.sdk.models.GetPaymentMethodsResponse parsed response. @@ -344,7 +344,7 @@ public com.sumup.sdk.models.GetPaymentMethodsResponse listAvailablePaymentMethod * *

Operation ID: GetPaymentMethods * - * @param merchantCode The SumUp merchant code. + * @param merchantCode Short unique identifier for the merchant. * @param getPaymentMethods Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -363,7 +363,7 @@ public com.sumup.sdk.models.GetPaymentMethodsResponse listAvailablePaymentMethod * *

Operation ID: GetPaymentMethods * - * @param merchantCode The SumUp merchant code. + * @param merchantCode Short unique identifier for the merchant. * @param getPaymentMethods Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -404,7 +404,7 @@ public com.sumup.sdk.models.GetPaymentMethodsResponse listAvailablePaymentMethod * *

Operation ID: ProcessCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details of the payment instrument for processing the checkout. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -425,7 +425,7 @@ public com.sumup.sdk.models.CheckoutSuccess process( * *

Operation ID: ProcessCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details of the payment instrument for processing the checkout. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -459,7 +459,7 @@ public com.sumup.sdk.models.CheckoutSuccess process( * *

Operation ID: UpdateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details for updating a checkout resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -478,7 +478,7 @@ public com.sumup.sdk.models.Checkout update( * *

Operation ID: UpdateCheckout * - * @param checkoutId Unique ID of the checkout resource. + * @param checkoutId Unique identifier of the checkout resource. * @param request Details for updating a checkout resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -512,7 +512,7 @@ public static final class ListCheckoutsQueryParams { /** * Sets the checkout_reference query parameter. * - * @param value Filters the list of checkout resources by the unique ID of the checkout. + * @param value Filters the list of checkout resources by the unique reference of the checkout. * @return This ListCheckoutsQueryParams instance. */ public ListCheckoutsQueryParams checkoutReference(String value) { diff --git a/src/main/java/com/sumup/sdk/clients/CustomersAsyncClient.java b/src/main/java/com/sumup/sdk/clients/CustomersAsyncClient.java index 3215b54..667da57 100644 --- a/src/main/java/com/sumup/sdk/clients/CustomersAsyncClient.java +++ b/src/main/java/com/sumup/sdk/clients/CustomersAsyncClient.java @@ -84,7 +84,7 @@ public CompletableFuture create( * *

Operation ID: DeactivatePaymentInstrument * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param token Unique token identifying the card saved as a payment instrument resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -103,7 +103,7 @@ public CompletableFuture deactivatePaymentInstrument(String customerId, St * *

Operation ID: DeactivatePaymentInstrument * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param token Unique token identifying the card saved as a payment instrument resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -130,7 +130,7 @@ public CompletableFuture deactivatePaymentInstrument( * *

Operation ID: GetCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return CompletableFuture resolved with com.sumup.sdk.models.Customer parsed response. @@ -149,7 +149,7 @@ public CompletableFuture get(String customerId) * *

Operation ID: GetCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return CompletableFuture resolved with com.sumup.sdk.models.Customer parsed response. @@ -178,7 +178,7 @@ public CompletableFuture get( * *

Operation ID: ListPaymentInstruments * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return CompletableFuture resolved with {@code @@ -197,7 +197,7 @@ public CompletableFuture get( * *

Operation ID: ListPaymentInstruments * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return CompletableFuture resolved with {@code @@ -229,7 +229,7 @@ public CompletableFuture get( * *

Operation ID: UpdateCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param request Customer fields to update. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -250,7 +250,7 @@ public CompletableFuture update( * *

Operation ID: UpdateCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param request Customer fields to update. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. diff --git a/src/main/java/com/sumup/sdk/clients/CustomersClient.java b/src/main/java/com/sumup/sdk/clients/CustomersClient.java index 5ca54ed..9702654 100644 --- a/src/main/java/com/sumup/sdk/clients/CustomersClient.java +++ b/src/main/java/com/sumup/sdk/clients/CustomersClient.java @@ -83,7 +83,7 @@ public com.sumup.sdk.models.Customer create( * *

Operation ID: DeactivatePaymentInstrument * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param token Unique token identifying the card saved as a payment instrument resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -100,7 +100,7 @@ public void deactivatePaymentInstrument(String customerId, String token) throws * *

Operation ID: DeactivatePaymentInstrument * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param token Unique token identifying the card saved as a payment instrument resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -125,7 +125,7 @@ public void deactivatePaymentInstrument( * *

Operation ID: GetCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return com.sumup.sdk.models.Customer parsed response. @@ -143,7 +143,7 @@ public com.sumup.sdk.models.Customer get(String customerId) throws ApiException * *

Operation ID: GetCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return com.sumup.sdk.models.Customer parsed response. @@ -172,7 +172,7 @@ public com.sumup.sdk.models.Customer get(String customerId, RequestOptions reque * *

Operation ID: ListPaymentInstruments * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. * @return {@code java.util.List} parsed response. @@ -190,7 +190,7 @@ public java.util.List listPaymen * *

Operation ID: ListPaymentInstruments * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. * @return {@code java.util.List} parsed response. @@ -221,7 +221,7 @@ public java.util.List listPaymen * *

Operation ID: UpdateCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param request Customer fields to update. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -242,7 +242,7 @@ public com.sumup.sdk.models.Customer update( * *

Operation ID: UpdateCustomer * - * @param customerId Unique ID of the saved customer resource. + * @param customerId Unique identifier of the saved customer resource. * @param request Customer fields to update. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. diff --git a/src/main/java/com/sumup/sdk/clients/PayoutsAsyncClient.java b/src/main/java/com/sumup/sdk/clients/PayoutsAsyncClient.java index 5c0d67d..c10db6c 100644 --- a/src/main/java/com/sumup/sdk/clients/PayoutsAsyncClient.java +++ b/src/main/java/com/sumup/sdk/clients/PayoutsAsyncClient.java @@ -40,7 +40,7 @@ public PayoutsAsyncClient(ApiClient apiClient) { * *

Operation ID: ListPayoutsV1 * - * @param merchantCode Merchant code of the account whose payouts should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param endDate End date of the payout period filter, inclusive, in * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be * greater than or equal to `start_date`. @@ -67,7 +67,7 @@ public CompletableFuture list( * *

Operation ID: ListPayoutsV1 * - * @param merchantCode Merchant code of the account whose payouts should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param endDate End date of the payout period filter, inclusive, in * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be * greater than or equal to `start_date`. @@ -98,7 +98,7 @@ public CompletableFuture list( * *

Operation ID: ListPayoutsV1 * - * @param merchantCode Merchant code of the account whose payouts should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param endDate End date of the payout period filter, inclusive, in * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be * greater than or equal to `start_date`. diff --git a/src/main/java/com/sumup/sdk/clients/PayoutsClient.java b/src/main/java/com/sumup/sdk/clients/PayoutsClient.java index 9369b85..d914090 100644 --- a/src/main/java/com/sumup/sdk/clients/PayoutsClient.java +++ b/src/main/java/com/sumup/sdk/clients/PayoutsClient.java @@ -39,7 +39,7 @@ public PayoutsClient(ApiClient apiClient) { * *

Operation ID: ListPayoutsV1 * - * @param merchantCode Merchant code of the account whose payouts should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param endDate End date of the payout period filter, inclusive, in * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be * greater than or equal to `start_date`. @@ -66,7 +66,7 @@ public com.sumup.sdk.models.FinancialPayouts list( * *

Operation ID: ListPayoutsV1 * - * @param merchantCode Merchant code of the account whose payouts should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param endDate End date of the payout period filter, inclusive, in * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be * greater than or equal to `start_date`. @@ -97,7 +97,7 @@ public com.sumup.sdk.models.FinancialPayouts list( * *

Operation ID: ListPayoutsV1 * - * @param merchantCode Merchant code of the account whose payouts should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param endDate End date of the payout period filter, inclusive, in * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) `date` format (`YYYY-MM-DD`). Must be * greater than or equal to `start_date`. diff --git a/src/main/java/com/sumup/sdk/clients/ReceiptsAsyncClient.java b/src/main/java/com/sumup/sdk/clients/ReceiptsAsyncClient.java index 80aac88..79bab29 100644 --- a/src/main/java/com/sumup/sdk/clients/ReceiptsAsyncClient.java +++ b/src/main/java/com/sumup/sdk/clients/ReceiptsAsyncClient.java @@ -36,7 +36,7 @@ public ReceiptsAsyncClient(ApiClient apiClient) { *

Operation ID: GetReceipt * * @param transactionId SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. - * @param mid Merchant code. + * @param mid Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return CompletableFuture resolved with com.sumup.sdk.models.Receipt parsed response. @@ -55,7 +55,7 @@ public CompletableFuture get(String transactionId, *

Operation ID: GetReceipt * * @param transactionId SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. - * @param mid Merchant code. + * @param mid Short unique identifier for the merchant. * @param getReceipt Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -75,7 +75,7 @@ public CompletableFuture get( *

Operation ID: GetReceipt * * @param transactionId SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. - * @param mid Merchant code. + * @param mid Short unique identifier for the merchant. * @param getReceipt Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -117,7 +117,7 @@ public static final class GetReceiptQueryParams { /** * Sets the tx_event_id query parameter. * - * @param value The ID of the transaction event (refund). + * @param value Unique identifier of the transaction event to include on the receipt. * @return This GetReceiptQueryParams instance. */ public GetReceiptQueryParams txEventId(Long value) { diff --git a/src/main/java/com/sumup/sdk/clients/ReceiptsClient.java b/src/main/java/com/sumup/sdk/clients/ReceiptsClient.java index 67a4010..da15c69 100644 --- a/src/main/java/com/sumup/sdk/clients/ReceiptsClient.java +++ b/src/main/java/com/sumup/sdk/clients/ReceiptsClient.java @@ -35,7 +35,7 @@ public ReceiptsClient(ApiClient apiClient) { *

Operation ID: GetReceipt * * @param transactionId SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. - * @param mid Merchant code. + * @param mid Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return com.sumup.sdk.models.Receipt parsed response. @@ -53,7 +53,7 @@ public com.sumup.sdk.models.Receipt get(String transactionId, String mid) throws *

Operation ID: GetReceipt * * @param transactionId SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. - * @param mid Merchant code. + * @param mid Short unique identifier for the merchant. * @param getReceipt Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -73,7 +73,7 @@ public com.sumup.sdk.models.Receipt get( *

Operation ID: GetReceipt * * @param transactionId SumUp unique transaction ID or transaction code, e.g. TS7HDYLSKD. - * @param mid Merchant code. + * @param mid Short unique identifier for the merchant. * @param getReceipt Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -115,7 +115,7 @@ public static final class GetReceiptQueryParams { /** * Sets the tx_event_id query parameter. * - * @param value The ID of the transaction event (refund). + * @param value Unique identifier of the transaction event to include on the receipt. * @return This GetReceiptQueryParams instance. */ public GetReceiptQueryParams txEventId(Long value) { diff --git a/src/main/java/com/sumup/sdk/clients/TransactionsAsyncClient.java b/src/main/java/com/sumup/sdk/clients/TransactionsAsyncClient.java index 78f1e21..d1949e2 100644 --- a/src/main/java/com/sumup/sdk/clients/TransactionsAsyncClient.java +++ b/src/main/java/com/sumup/sdk/clients/TransactionsAsyncClient.java @@ -52,7 +52,7 @@ public TransactionsAsyncClient(ApiClient apiClient) { * *

Operation ID: GetTransactionV2.1 * - * @param merchantCode Merchant code of the account whose transaction should be retrieved. + * @param merchantCode Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return CompletableFuture resolved with com.sumup.sdk.models.TransactionFull parsed response. @@ -72,7 +72,7 @@ public CompletableFuture get(String mercha * *

Operation ID: GetTransactionV2.1 * - * @param merchantCode Merchant code of the account whose transaction should be retrieved. + * @param merchantCode Short unique identifier for the merchant. * @param getTransactionV21 Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -93,7 +93,7 @@ public CompletableFuture get( * *

Operation ID: GetTransactionV2.1 * - * @param merchantCode Merchant code of the account whose transaction should be retrieved. + * @param merchantCode Short unique identifier for the merchant. * @param getTransactionV21 Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -132,7 +132,7 @@ public CompletableFuture get( * *

Operation ID: ListTransactionsV2.1 * - * @param merchantCode Merchant code of the account whose transaction history should be listed. + * @param merchantCode Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return CompletableFuture resolved with com.sumup.sdk.models.ListTransactionsV21Response parsed @@ -151,7 +151,7 @@ public CompletableFuture list( * *

Operation ID: ListTransactionsV2.1 * - * @param merchantCode Merchant code of the account whose transaction history should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param listTransactionsV21 Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -171,7 +171,7 @@ public CompletableFuture list( * *

Operation ID: ListTransactionsV2.1 * - * @param merchantCode Merchant code of the account whose transaction history should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param listTransactionsV21 Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -211,8 +211,8 @@ public CompletableFuture list( * *

Operation ID: RefundTransaction * - * @param merchantCode Merchant code of the account that owns the payment to refund. - * @param transactionId Unique ID of the transaction. + * @param merchantCode Short unique identifier for the merchant. + * @param transactionId Unique identifier of the transaction. * @param request Optional amount for partial refunds. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -234,8 +234,8 @@ public CompletableFuture> refund( * *

Operation ID: RefundTransaction * - * @param merchantCode Merchant code of the account that owns the payment to refund. - * @param transactionId Unique ID of the transaction. + * @param merchantCode Short unique identifier for the merchant. + * @param transactionId Unique identifier of the transaction. * @param request Optional amount for partial refunds. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -275,7 +275,7 @@ public static final class GetTransactionV21QueryParams { /** * Sets the client_transaction_id query parameter. * - * @param value Client transaction id. + * @param value Client-supplied identifier of the transaction. * @return This GetTransactionV21QueryParams instance. */ public GetTransactionV21QueryParams clientTransactionId(String value) { @@ -287,7 +287,7 @@ public GetTransactionV21QueryParams clientTransactionId(String value) { /** * Sets the foreign_transaction_id query parameter. * - * @param value External/foreign transaction id (passed by clients). + * @param value External transaction identifier supplied by the client. * @return This GetTransactionV21QueryParams instance. */ public GetTransactionV21QueryParams foreignTransactionId(String value) { diff --git a/src/main/java/com/sumup/sdk/clients/TransactionsClient.java b/src/main/java/com/sumup/sdk/clients/TransactionsClient.java index 10eeffd..657ac91 100644 --- a/src/main/java/com/sumup/sdk/clients/TransactionsClient.java +++ b/src/main/java/com/sumup/sdk/clients/TransactionsClient.java @@ -51,7 +51,7 @@ public TransactionsClient(ApiClient apiClient) { * *

Operation ID: GetTransactionV2.1 * - * @param merchantCode Merchant code of the account whose transaction should be retrieved. + * @param merchantCode Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return com.sumup.sdk.models.TransactionFull parsed response. @@ -70,7 +70,7 @@ public com.sumup.sdk.models.TransactionFull get(String merchantCode) throws ApiE * *

Operation ID: GetTransactionV2.1 * - * @param merchantCode Merchant code of the account whose transaction should be retrieved. + * @param merchantCode Short unique identifier for the merchant. * @param getTransactionV21 Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -91,7 +91,7 @@ public com.sumup.sdk.models.TransactionFull get( * *

Operation ID: GetTransactionV2.1 * - * @param merchantCode Merchant code of the account whose transaction should be retrieved. + * @param merchantCode Short unique identifier for the merchant. * @param getTransactionV21 Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -130,7 +130,7 @@ public com.sumup.sdk.models.TransactionFull get( * *

Operation ID: ListTransactionsV2.1 * - * @param merchantCode Merchant code of the account whose transaction history should be listed. + * @param merchantCode Short unique identifier for the merchant. *

Call the overload that accepts optional parameter objects or RequestOptions to customize * headers, authorization, query values, or timeouts. * @return com.sumup.sdk.models.ListTransactionsV21Response parsed response. @@ -148,7 +148,7 @@ public com.sumup.sdk.models.ListTransactionsV21Response list(String merchantCode * *

Operation ID: ListTransactionsV2.1 * - * @param merchantCode Merchant code of the account whose transaction history should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param listTransactionsV21 Optional query parameters for this request. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -167,7 +167,7 @@ public com.sumup.sdk.models.ListTransactionsV21Response list( * *

Operation ID: ListTransactionsV2.1 * - * @param merchantCode Merchant code of the account whose transaction history should be listed. + * @param merchantCode Short unique identifier for the merchant. * @param listTransactionsV21 Optional query parameters for this request. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -206,8 +206,8 @@ public com.sumup.sdk.models.ListTransactionsV21Response list( * *

Operation ID: RefundTransaction * - * @param merchantCode Merchant code of the account that owns the payment to refund. - * @param transactionId Unique ID of the transaction. + * @param merchantCode Short unique identifier for the merchant. + * @param transactionId Unique identifier of the transaction. * @param request Optional amount for partial refunds. *

Call the overload that accepts RequestOptions to customize headers, authorization, or * request timeout. @@ -229,8 +229,8 @@ public java.util.Map refund( * *

Operation ID: RefundTransaction * - * @param merchantCode Merchant code of the account that owns the payment to refund. - * @param transactionId Unique ID of the transaction. + * @param merchantCode Short unique identifier for the merchant. + * @param transactionId Unique identifier of the transaction. * @param request Optional amount for partial refunds. * @param requestOptions Request-specific overrides (headers, authorization, or timeout). Pass * {@code null} to use client defaults. @@ -270,7 +270,7 @@ public static final class GetTransactionV21QueryParams { /** * Sets the client_transaction_id query parameter. * - * @param value Client transaction id. + * @param value Client-supplied identifier of the transaction. * @return This GetTransactionV21QueryParams instance. */ public GetTransactionV21QueryParams clientTransactionId(String value) { @@ -282,7 +282,7 @@ public GetTransactionV21QueryParams clientTransactionId(String value) { /** * Sets the foreign_transaction_id query parameter. * - * @param value External/foreign transaction id (passed by clients). + * @param value External transaction identifier supplied by the client. * @return This GetTransactionV21QueryParams instance. */ public GetTransactionV21QueryParams foreignTransactionId(String value) { diff --git a/src/main/java/com/sumup/sdk/models/Checkout.java b/src/main/java/com/sumup/sdk/models/Checkout.java index 373e13a..0585653 100644 --- a/src/main/java/com/sumup/sdk/models/Checkout.java +++ b/src/main/java/com/sumup/sdk/models/Checkout.java @@ -17,8 +17,7 @@ public record Checkout( String checkoutReference, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, @@ -29,10 +28,7 @@ public record Checkout( */ String customerId, - /** - * Date and time of the creation of the payment checkout. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the checkout was created. */ java.time.OffsetDateTime date, /** @@ -53,7 +49,7 @@ public record Checkout( /** Details of the mandate linked to the saved payment instrument. */ com.sumup.sdk.models.MandateResponse mandate, - /** Merchant account that receives the payment. */ + /** Short unique identifier for the merchant that receives the payment. */ String merchantCode, /** @@ -133,8 +129,8 @@ public Builder checkoutReference(String checkoutReference) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -158,8 +154,7 @@ public Builder customerId(String customerId) { /** * Sets the value for {@code date}. * - * @param date Date and time of the creation of the payment checkout. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param date The timestamp of when the checkout was created. * @return This builder instance. */ public Builder date(java.time.OffsetDateTime date) { @@ -194,7 +189,7 @@ public Builder mandate(com.sumup.sdk.models.MandateResponse mandate) { /** * Sets the value for {@code merchantCode}. * - * @param merchantCode Merchant account that receives the payment. + * @param merchantCode Short unique identifier for the merchant that receives the payment. * @return This builder instance. */ public Builder merchantCode(String merchantCode) { diff --git a/src/main/java/com/sumup/sdk/models/CheckoutCreateRequest.java b/src/main/java/com/sumup/sdk/models/CheckoutCreateRequest.java index e16e9c4..da1c507 100644 --- a/src/main/java/com/sumup/sdk/models/CheckoutCreateRequest.java +++ b/src/main/java/com/sumup/sdk/models/CheckoutCreateRequest.java @@ -18,8 +18,7 @@ public record CheckoutCreateRequest( String checkoutReference, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, @@ -41,7 +40,7 @@ public record CheckoutCreateRequest( */ com.sumup.sdk.models.HostedCheckout hostedCheckout, - /** Merchant account that should receive the payment. */ + /** Short unique identifier for the merchant that should receive the payment. */ String merchantCode, /** @@ -123,8 +122,8 @@ public Builder checkoutReference(String checkoutReference) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -171,7 +170,7 @@ public Builder hostedCheckout(com.sumup.sdk.models.HostedCheckout hostedCheckout /** * Sets the value for {@code merchantCode}. * - * @param merchantCode Merchant account that should receive the payment. + * @param merchantCode Short unique identifier for the merchant that should receive the payment. * @return This builder instance. */ public Builder merchantCode(String merchantCode) { diff --git a/src/main/java/com/sumup/sdk/models/CheckoutSuccess.java b/src/main/java/com/sumup/sdk/models/CheckoutSuccess.java index db398c4..ade1473 100644 --- a/src/main/java/com/sumup/sdk/models/CheckoutSuccess.java +++ b/src/main/java/com/sumup/sdk/models/CheckoutSuccess.java @@ -17,8 +17,7 @@ public record CheckoutSuccess( String checkoutReference, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, @@ -29,10 +28,7 @@ public record CheckoutSuccess( */ String customerId, - /** - * Date and time of the creation of the payment checkout. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the checkout was created. */ java.time.OffsetDateTime date, /** @@ -53,10 +49,10 @@ public record CheckoutSuccess( /** Details of the mandate linked to the saved payment instrument. */ com.sumup.sdk.models.MandateResponse mandate, - /** Merchant account that receives the payment. */ + /** Short unique identifier for the merchant that receives the payment. */ String merchantCode, - /** Name of the merchant */ + /** Name of the merchant. */ String merchantName, /** Details of the saved payment instrument created or reused during checkout processing. */ @@ -84,10 +80,7 @@ public record CheckoutSuccess( */ String transactionCode, - /** - * Transaction ID of the successful transaction with which the payment for the checkout is - * completed. - */ + /** Unique identifier of the successful transaction that completed payment for the checkout. */ String transactionId, /** @@ -157,8 +150,8 @@ public Builder checkoutReference(String checkoutReference) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -182,8 +175,7 @@ public Builder customerId(String customerId) { /** * Sets the value for {@code date}. * - * @param date Date and time of the creation of the payment checkout. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param date The timestamp of when the checkout was created. * @return This builder instance. */ public Builder date(java.time.OffsetDateTime date) { @@ -218,7 +210,7 @@ public Builder mandate(com.sumup.sdk.models.MandateResponse mandate) { /** * Sets the value for {@code merchantCode}. * - * @param merchantCode Merchant account that receives the payment. + * @param merchantCode Short unique identifier for the merchant that receives the payment. * @return This builder instance. */ public Builder merchantCode(String merchantCode) { @@ -229,7 +221,7 @@ public Builder merchantCode(String merchantCode) { /** * Sets the value for {@code merchantName}. * - * @param merchantName Name of the merchant + * @param merchantName Name of the merchant. * @return This builder instance. */ public Builder merchantName(String merchantName) { diff --git a/src/main/java/com/sumup/sdk/models/CheckoutSuccessPaymentInstrument.java b/src/main/java/com/sumup/sdk/models/CheckoutSuccessPaymentInstrument.java index 6f88a46..cacb9c7 100644 --- a/src/main/java/com/sumup/sdk/models/CheckoutSuccessPaymentInstrument.java +++ b/src/main/java/com/sumup/sdk/models/CheckoutSuccessPaymentInstrument.java @@ -3,7 +3,7 @@ /** Details of the saved payment instrument created or reused during checkout processing. */ public record CheckoutSuccessPaymentInstrument( - /** Token value */ + /** Unique token of the saved payment instrument. */ String token) { /** * Creates a builder for CheckoutSuccessPaymentInstrument. @@ -23,7 +23,7 @@ private Builder() {} /** * Sets the value for {@code token}. * - * @param token Token value + * @param token Unique token of the saved payment instrument. * @return This builder instance. */ public Builder token(String token) { diff --git a/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java b/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java index ca62b9c..48024f5 100644 --- a/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java +++ b/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java @@ -12,18 +12,17 @@ public record CheckoutSuccessTransactionsItem( String authCode, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, /** Entry mode of the payment details. */ com.sumup.sdk.models.EntryMode entryMode, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ String id, - /** Current number of the installment for deferred payments. */ + /** Number of installments for a deferred payment. */ Long installmentsCount, /** Unique code of the registered merchant to whom the payment is made. */ @@ -41,10 +40,7 @@ public record CheckoutSuccessTransactionsItem( */ com.sumup.sdk.models.TransactionStatus status, - /** - * Date and time of the creation of the transaction. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the transaction was created. */ java.time.OffsetDateTime timestamp, /** Amount of the tip (out of the total transaction amount). */ @@ -110,8 +106,8 @@ public Builder authCode(String authCode) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -133,7 +129,7 @@ public Builder entryMode(com.sumup.sdk.models.EntryMode entryMode) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction. + * @param id Unique identifier of the transaction. * @return This builder instance. */ public Builder id(String id) { @@ -144,7 +140,7 @@ public Builder id(String id) { /** * Sets the value for {@code installmentsCount}. * - * @param installmentsCount Current number of the installment for deferred payments. + * @param installmentsCount Number of installments for a deferred payment. * @return This builder instance. */ public Builder installmentsCount(Long installmentsCount) { @@ -192,8 +188,7 @@ public Builder status(com.sumup.sdk.models.TransactionStatus status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the creation of the transaction. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param timestamp The timestamp of when the transaction was created. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { diff --git a/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java b/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java index 0e0bda9..70f15ea 100644 --- a/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java +++ b/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java @@ -12,18 +12,17 @@ public record CheckoutTransactionsItem( String authCode, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, /** Entry mode of the payment details. */ com.sumup.sdk.models.EntryMode entryMode, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ String id, - /** Current number of the installment for deferred payments. */ + /** Number of installments for a deferred payment. */ Long installmentsCount, /** Unique code of the registered merchant to whom the payment is made. */ @@ -41,10 +40,7 @@ public record CheckoutTransactionsItem( */ com.sumup.sdk.models.TransactionStatus status, - /** - * Date and time of the creation of the transaction. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the transaction was created. */ java.time.OffsetDateTime timestamp, /** Amount of the tip (out of the total transaction amount). */ @@ -110,8 +106,8 @@ public Builder authCode(String authCode) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -133,7 +129,7 @@ public Builder entryMode(com.sumup.sdk.models.EntryMode entryMode) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction. + * @param id Unique identifier of the transaction. * @return This builder instance. */ public Builder id(String id) { @@ -144,7 +140,7 @@ public Builder id(String id) { /** * Sets the value for {@code installmentsCount}. * - * @param installmentsCount Current number of the installment for deferred payments. + * @param installmentsCount Number of installments for a deferred payment. * @return This builder instance. */ public Builder installmentsCount(Long installmentsCount) { @@ -192,8 +188,7 @@ public Builder status(com.sumup.sdk.models.TransactionStatus status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the creation of the transaction. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param timestamp The timestamp of when the transaction was created. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { diff --git a/src/main/java/com/sumup/sdk/models/CheckoutUpdateRequest.java b/src/main/java/com/sumup/sdk/models/CheckoutUpdateRequest.java index 6255a4a..8a02747 100644 --- a/src/main/java/com/sumup/sdk/models/CheckoutUpdateRequest.java +++ b/src/main/java/com/sumup/sdk/models/CheckoutUpdateRequest.java @@ -12,8 +12,7 @@ public record CheckoutUpdateRequest( String checkoutReference, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, @@ -73,8 +72,8 @@ public Builder checkoutReference(String checkoutReference) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { diff --git a/src/main/java/com/sumup/sdk/models/Currency.java b/src/main/java/com/sumup/sdk/models/Currency.java index 6d03a37..54902a3 100644 --- a/src/main/java/com/sumup/sdk/models/Currency.java +++ b/src/main/java/com/sumup/sdk/models/Currency.java @@ -5,10 +5,7 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.util.Objects; -/** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. - */ +/** Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ public final class Currency { public static final Currency BGN = new Currency("BGN"); public static final Currency BRL = new Currency("BRL"); diff --git a/src/main/java/com/sumup/sdk/models/Customer.java b/src/main/java/com/sumup/sdk/models/Customer.java index f4dc0d9..d90a2bc 100644 --- a/src/main/java/com/sumup/sdk/models/Customer.java +++ b/src/main/java/com/sumup/sdk/models/Customer.java @@ -5,7 +5,7 @@ /** Saved customer details. */ public record Customer( - /** Unique ID of the customer. */ + /** Unique identifier of the customer. */ String customerId, /** Personal details for the customer. */ @@ -29,7 +29,7 @@ private Builder() {} /** * Sets the value for {@code customerId}. * - * @param customerId Unique ID of the customer. + * @param customerId Unique identifier of the customer. * @return This builder instance. */ public Builder customerId(String customerId) { diff --git a/src/main/java/com/sumup/sdk/models/DetailsError.java b/src/main/java/com/sumup/sdk/models/DetailsError.java index 0f91b94..7474261 100644 --- a/src/main/java/com/sumup/sdk/models/DetailsError.java +++ b/src/main/java/com/sumup/sdk/models/DetailsError.java @@ -1,7 +1,7 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Error message structure. */ +/** Details of a request validation error. */ public record DetailsError( /** Details of the error. */ String details, @@ -9,7 +9,7 @@ public record DetailsError( /** List of violated validation constraints. */ java.util.List failedConstraints, - /** The status code. */ + /** HTTP status code for the error. */ Double status, /** Short title of the error. */ @@ -59,7 +59,7 @@ public Builder failedConstraints( /** * Sets the value for {@code status}. * - * @param status The status code. + * @param status HTTP status code for the error. * @return This builder instance. */ public Builder status(Double status) { diff --git a/src/main/java/com/sumup/sdk/models/DetailsErrorFailedConstraintsItem.java b/src/main/java/com/sumup/sdk/models/DetailsErrorFailedConstraintsItem.java index 61a7ed9..3294615 100644 --- a/src/main/java/com/sumup/sdk/models/DetailsErrorFailedConstraintsItem.java +++ b/src/main/java/com/sumup/sdk/models/DetailsErrorFailedConstraintsItem.java @@ -1,8 +1,12 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -public record DetailsErrorFailedConstraintsItem(String message, String reference) { +public record DetailsErrorFailedConstraintsItem( + /** Human-readable description of the violated constraint. */ + String message, + /** Name of the field that violated the constraint. */ + String reference) { /** * Creates a builder for DetailsErrorFailedConstraintsItem. * @@ -22,7 +26,7 @@ private Builder() {} /** * Sets the value for {@code message}. * - * @param message Value for the message field. + * @param message Human-readable description of the violated constraint. * @return This builder instance. */ public Builder message(String message) { @@ -33,7 +37,7 @@ public Builder message(String message) { /** * Sets the value for {@code reference}. * - * @param reference Value for the reference field. + * @param reference Name of the field that violated the constraint. * @return This builder instance. */ public Builder reference(String reference) { diff --git a/src/main/java/com/sumup/sdk/models/Error.java b/src/main/java/com/sumup/sdk/models/Error.java index 14cb628..de83797 100644 --- a/src/main/java/com/sumup/sdk/models/Error.java +++ b/src/main/java/com/sumup/sdk/models/Error.java @@ -1,7 +1,7 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Error message structure. */ +/** Details of an API error. */ public record Error( /** Platform code for the error. */ String errorCode, diff --git a/src/main/java/com/sumup/sdk/models/ErrorForbidden.java b/src/main/java/com/sumup/sdk/models/ErrorForbidden.java index f4668e5..da9a1aa 100644 --- a/src/main/java/com/sumup/sdk/models/ErrorForbidden.java +++ b/src/main/java/com/sumup/sdk/models/ErrorForbidden.java @@ -1,7 +1,7 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Error message for forbidden requests. */ +/** Details of an error returned for a forbidden request. */ public record ErrorForbidden( /** Platform code for the error. */ String errorCode, diff --git a/src/main/java/com/sumup/sdk/models/Event.java b/src/main/java/com/sumup/sdk/models/Event.java index a375ef8..82595c5 100644 --- a/src/main/java/com/sumup/sdk/models/Event.java +++ b/src/main/java/com/sumup/sdk/models/Event.java @@ -3,22 +3,22 @@ /** High-level transaction event details. */ public record Event( - /** Amount of the event. */ + /** Amount associated with the transaction event, in major units. */ Float amount, - /** Amount deducted for the event. */ + /** Amount deducted from the merchant for the event, in major units. */ Float deductedAmount, - /** Amount of the fee deducted for the event. */ + /** Fee deducted from the merchant for the event, in major units. */ Float deductedFeeAmount, - /** Amount of the fee related to the event. */ + /** Fee associated with the transaction event, in major units. */ Float feeAmount, - /** Unique ID of the transaction event. */ + /** Unique identifier of the transaction event. */ com.sumup.sdk.models.TransactionEventId id, - /** Consecutive number of the installment. */ + /** Consecutive number of the installment associated with the event. */ Long installmentNumber, /** @@ -39,10 +39,10 @@ public record Event( */ com.sumup.sdk.models.TransactionEventStatus status, - /** Date and time of the transaction event. */ + /** The timestamp of when the transaction event occurred. */ java.time.OffsetDateTime timestamp, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ com.sumup.sdk.models.TransactionId transactionId, /** Type of the transaction event. */ @@ -74,7 +74,7 @@ private Builder() {} /** * Sets the value for {@code amount}. * - * @param amount Amount of the event. + * @param amount Amount associated with the transaction event, in major units. * @return This builder instance. */ public Builder amount(Float amount) { @@ -85,7 +85,7 @@ public Builder amount(Float amount) { /** * Sets the value for {@code deductedAmount}. * - * @param deductedAmount Amount deducted for the event. + * @param deductedAmount Amount deducted from the merchant for the event, in major units. * @return This builder instance. */ public Builder deductedAmount(Float deductedAmount) { @@ -96,7 +96,7 @@ public Builder deductedAmount(Float deductedAmount) { /** * Sets the value for {@code deductedFeeAmount}. * - * @param deductedFeeAmount Amount of the fee deducted for the event. + * @param deductedFeeAmount Fee deducted from the merchant for the event, in major units. * @return This builder instance. */ public Builder deductedFeeAmount(Float deductedFeeAmount) { @@ -107,7 +107,7 @@ public Builder deductedFeeAmount(Float deductedFeeAmount) { /** * Sets the value for {@code feeAmount}. * - * @param feeAmount Amount of the fee related to the event. + * @param feeAmount Fee associated with the transaction event, in major units. * @return This builder instance. */ public Builder feeAmount(Float feeAmount) { @@ -118,7 +118,7 @@ public Builder feeAmount(Float feeAmount) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction event. + * @param id Unique identifier of the transaction event. * @return This builder instance. */ public Builder id(com.sumup.sdk.models.TransactionEventId id) { @@ -129,7 +129,7 @@ public Builder id(com.sumup.sdk.models.TransactionEventId id) { /** * Sets the value for {@code installmentNumber}. * - * @param installmentNumber Consecutive number of the installment. + * @param installmentNumber Consecutive number of the installment associated with the event. * @return This builder instance. */ public Builder installmentNumber(Long installmentNumber) { @@ -165,7 +165,7 @@ public Builder status(com.sumup.sdk.models.TransactionEventStatus status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the transaction event. + * @param timestamp The timestamp of when the transaction event occurred. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { @@ -176,7 +176,7 @@ public Builder timestamp(java.time.OffsetDateTime timestamp) { /** * Sets the value for {@code transactionId}. * - * @param transactionId Unique ID of the transaction. + * @param transactionId Unique identifier of the transaction. * @return This builder instance. */ public Builder transactionId(com.sumup.sdk.models.TransactionId transactionId) { diff --git a/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponse.java b/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponse.java index 217c949..43d915b 100644 --- a/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponse.java +++ b/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponse.java @@ -2,6 +2,7 @@ package com.sumup.sdk.models; public record GetPaymentMethodsResponse( + /** Payment methods available to the merchant for the checkout. */ java.util.List availablePaymentMethods) { /** @@ -24,7 +25,7 @@ private Builder() {} /** * Sets the value for {@code availablePaymentMethods}. * - * @param availablePaymentMethods Value for the availablePaymentMethods field. + * @param availablePaymentMethods Payment methods available to the merchant for the checkout. * @return This builder instance. */ public Builder availablePaymentMethods( diff --git a/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponseAvailablePaymentMethodsItem.java b/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponseAvailablePaymentMethodsItem.java index 99c81c2..092f11c 100644 --- a/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponseAvailablePaymentMethodsItem.java +++ b/src/main/java/com/sumup/sdk/models/GetPaymentMethodsResponseAvailablePaymentMethodsItem.java @@ -4,7 +4,7 @@ import java.util.Objects; public record GetPaymentMethodsResponseAvailablePaymentMethodsItem( - /** The ID of the payment method. */ + /** Unique identifier of the payment method. */ String id) { /** * Creates a builder for GetPaymentMethodsResponseAvailablePaymentMethodsItem. @@ -25,7 +25,7 @@ private Builder() {} /** * Sets the value for {@code id}. * - * @param id The ID of the payment method. + * @param id Unique identifier of the payment method. * @return This builder instance. */ public Builder id(String id) { diff --git a/src/main/java/com/sumup/sdk/models/Link.java b/src/main/java/com/sumup/sdk/models/Link.java index 82570b8..313a9e8 100644 --- a/src/main/java/com/sumup/sdk/models/Link.java +++ b/src/main/java/com/sumup/sdk/models/Link.java @@ -6,16 +6,16 @@ public record Link( /** URL for accessing the related resource. */ String href, - /** Maximum allowed amount for the refund. */ + /** Maximum amount allowed for a refund, in major units. */ Float maxAmount, - /** Minimum allowed amount for the refund. */ + /** Minimum amount allowed for a refund, in major units. */ Float minAmount, - /** Specifies the relation to the current resource. */ + /** Relation of the linked resource to the current resource. */ String rel, - /** Specifies the media type of the related resource. */ + /** Media type of the linked resource. */ String type) { /** * Creates a builder for Link. @@ -50,7 +50,7 @@ public Builder href(String href) { /** * Sets the value for {@code maxAmount}. * - * @param maxAmount Maximum allowed amount for the refund. + * @param maxAmount Maximum amount allowed for a refund, in major units. * @return This builder instance. */ public Builder maxAmount(Float maxAmount) { @@ -61,7 +61,7 @@ public Builder maxAmount(Float maxAmount) { /** * Sets the value for {@code minAmount}. * - * @param minAmount Minimum allowed amount for the refund. + * @param minAmount Minimum amount allowed for a refund, in major units. * @return This builder instance. */ public Builder minAmount(Float minAmount) { @@ -72,7 +72,7 @@ public Builder minAmount(Float minAmount) { /** * Sets the value for {@code rel}. * - * @param rel Specifies the relation to the current resource. + * @param rel Relation of the linked resource to the current resource. * @return This builder instance. */ public Builder rel(String rel) { @@ -83,7 +83,7 @@ public Builder rel(String rel) { /** * Sets the value for {@code type}. * - * @param type Specifies the media type of the related resource. + * @param type Media type of the linked resource. * @return This builder instance. */ public Builder type(String type) { diff --git a/src/main/java/com/sumup/sdk/models/ListTransactionsV21Response.java b/src/main/java/com/sumup/sdk/models/ListTransactionsV21Response.java index 02258b2..e07fe54 100644 --- a/src/main/java/com/sumup/sdk/models/ListTransactionsV21Response.java +++ b/src/main/java/com/sumup/sdk/models/ListTransactionsV21Response.java @@ -2,7 +2,10 @@ package com.sumup.sdk.models; public record ListTransactionsV21Response( + /** Transactions in the current result page. */ java.util.List items, + + /** Pagination links for navigating the transaction history. */ java.util.List links) { /** * Creates a builder for ListTransactionsV21Response. @@ -23,7 +26,7 @@ private Builder() {} /** * Sets the value for {@code items}. * - * @param items Value for the items field. + * @param items Transactions in the current result page. * @return This builder instance. */ public Builder items(java.util.List items) { @@ -34,7 +37,7 @@ public Builder items(java.util.List ite /** * Sets the value for {@code links}. * - * @param links Value for the links field. + * @param links Pagination links for navigating the transaction history. * @return This builder instance. */ public Builder links(java.util.List links) { diff --git a/src/main/java/com/sumup/sdk/models/MandateResponse.java b/src/main/java/com/sumup/sdk/models/MandateResponse.java index ee1f96c..6a73bb2 100644 --- a/src/main/java/com/sumup/sdk/models/MandateResponse.java +++ b/src/main/java/com/sumup/sdk/models/MandateResponse.java @@ -3,7 +3,7 @@ /** Details of the mandate linked to the saved payment instrument. */ public record MandateResponse( - /** Merchant account for which the mandate is valid. */ + /** Short unique identifier for the merchant for which the mandate is valid. */ String merchantCode, /** Current lifecycle status of the mandate. */ @@ -31,7 +31,7 @@ private Builder() {} /** * Sets the value for {@code merchantCode}. * - * @param merchantCode Merchant account for which the mandate is valid. + * @param merchantCode Short unique identifier for the merchant for which the mandate is valid. * @return This builder instance. */ public Builder merchantCode(String merchantCode) { diff --git a/src/main/java/com/sumup/sdk/models/PaymentInstrumentResponse.java b/src/main/java/com/sumup/sdk/models/PaymentInstrumentResponse.java index 4fabd28..5927a4e 100644 --- a/src/main/java/com/sumup/sdk/models/PaymentInstrumentResponse.java +++ b/src/main/java/com/sumup/sdk/models/PaymentInstrumentResponse.java @@ -1,7 +1,7 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Payment Instrument Response */ +/** Details of a saved payment instrument. */ public record PaymentInstrumentResponse( /** * Indicates whether the payment instrument is active and can be used for payments. To @@ -12,10 +12,7 @@ public record PaymentInstrumentResponse( /** Details of the payment card. */ com.sumup.sdk.models.PaymentInstrumentResponseCard card, - /** - * Creation date of payment instrument. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the payment instrument was created. */ java.time.OffsetDateTime createdAt, /** Details of the mandate linked to the saved payment instrument. */ @@ -58,8 +55,7 @@ public Builder card(com.sumup.sdk.models.PaymentInstrumentResponseCard card) { /** * Sets the value for {@code createdAt}. * - * @param createdAt Creation date of payment instrument. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param createdAt The timestamp of when the payment instrument was created. * @return This builder instance. */ public Builder createdAt(java.time.OffsetDateTime createdAt) { diff --git a/src/main/java/com/sumup/sdk/models/PersonalDetails.java b/src/main/java/com/sumup/sdk/models/PersonalDetails.java index d0b5561..209c84b 100644 --- a/src/main/java/com/sumup/sdk/models/PersonalDetails.java +++ b/src/main/java/com/sumup/sdk/models/PersonalDetails.java @@ -21,7 +21,7 @@ public record PersonalDetails( /** Phone number of the customer. */ String phone, - /** An identification number user for tax purposes (e.g. CPF) */ + /** Identification number used for tax purposes, such as a CPF in Brazil. */ String taxId) { /** * Creates a builder for PersonalDetails. @@ -113,7 +113,7 @@ public Builder phone(String phone) { /** * Sets the value for {@code taxId}. * - * @param taxId An identification number user for tax purposes (e.g. CPF) + * @param taxId Identification number used for tax purposes, such as a CPF in Brazil. * @return This builder instance. */ public Builder taxId(String taxId) { diff --git a/src/main/java/com/sumup/sdk/models/Product.java b/src/main/java/com/sumup/sdk/models/Product.java index fdb86c5..bd58c07 100644 --- a/src/main/java/com/sumup/sdk/models/Product.java +++ b/src/main/java/com/sumup/sdk/models/Product.java @@ -1,7 +1,7 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Purchase product. */ +/** Product details associated with a transaction. */ public record Product( /** Product name. */ String name, @@ -9,10 +9,10 @@ public record Product( /** Product price. */ Double price, - /** Product description. */ + /** Human-readable label for the product price. */ String priceLabel, - /** Product price incl. VAT. */ + /** Product price including VAT. */ Double priceWithVat, /** Product quantity. */ @@ -21,16 +21,16 @@ public record Product( /** VAT amount for a single product. */ Double singleVatAmount, - /** Quantity x product price. */ + /** Total price calculated as the product price multiplied by the quantity. */ Double totalPrice, - /** Total price incl. VAT. */ + /** Total product price including VAT. */ Double totalWithVat, - /** VAT amount. */ + /** Total VAT amount for the product quantity. */ Double vatAmount, - /** VAT percentage. */ + /** VAT rate applied to the product price. */ Double vatRate) { /** * Creates a builder for Product. @@ -81,7 +81,7 @@ public Builder price(Double price) { /** * Sets the value for {@code priceLabel}. * - * @param priceLabel Product description. + * @param priceLabel Human-readable label for the product price. * @return This builder instance. */ public Builder priceLabel(String priceLabel) { @@ -92,7 +92,7 @@ public Builder priceLabel(String priceLabel) { /** * Sets the value for {@code priceWithVat}. * - * @param priceWithVat Product price incl. VAT. + * @param priceWithVat Product price including VAT. * @return This builder instance. */ public Builder priceWithVat(Double priceWithVat) { @@ -125,7 +125,7 @@ public Builder singleVatAmount(Double singleVatAmount) { /** * Sets the value for {@code totalPrice}. * - * @param totalPrice Quantity x product price. + * @param totalPrice Total price calculated as the product price multiplied by the quantity. * @return This builder instance. */ public Builder totalPrice(Double totalPrice) { @@ -136,7 +136,7 @@ public Builder totalPrice(Double totalPrice) { /** * Sets the value for {@code totalWithVat}. * - * @param totalWithVat Total price incl. VAT. + * @param totalWithVat Total product price including VAT. * @return This builder instance. */ public Builder totalWithVat(Double totalWithVat) { @@ -147,7 +147,7 @@ public Builder totalWithVat(Double totalWithVat) { /** * Sets the value for {@code vatAmount}. * - * @param vatAmount VAT amount. + * @param vatAmount Total VAT amount for the product quantity. * @return This builder instance. */ public Builder vatAmount(Double vatAmount) { @@ -158,7 +158,7 @@ public Builder vatAmount(Double vatAmount) { /** * Sets the value for {@code vatRate}. * - * @param vatRate VAT percentage. + * @param vatRate VAT rate applied to the product price. * @return This builder instance. */ public Builder vatRate(Double vatRate) { diff --git a/src/main/java/com/sumup/sdk/models/Receipt.java b/src/main/java/com/sumup/sdk/models/Receipt.java index ee9002f..24102ba 100644 --- a/src/main/java/com/sumup/sdk/models/Receipt.java +++ b/src/main/java/com/sumup/sdk/models/Receipt.java @@ -9,10 +9,10 @@ public record Receipt( /** EMV-specific metadata returned for card-present payments. */ java.util.Map emvData, - /** Receipt merchant data */ + /** Merchant details displayed on a transaction receipt. */ com.sumup.sdk.models.ReceiptMerchantData merchantData, - /** Transaction information. */ + /** Transaction details displayed on a receipt. */ com.sumup.sdk.models.ReceiptTransaction transactionData) { /** * Creates a builder for Receipt. @@ -57,7 +57,7 @@ public Builder emvData(java.util.Map emvData) { /** * Sets the value for {@code merchantData}. * - * @param merchantData Receipt merchant data + * @param merchantData Merchant details displayed on a transaction receipt. * @return This builder instance. */ public Builder merchantData(com.sumup.sdk.models.ReceiptMerchantData merchantData) { @@ -68,7 +68,7 @@ public Builder merchantData(com.sumup.sdk.models.ReceiptMerchantData merchantDat /** * Sets the value for {@code transactionData}. * - * @param transactionData Transaction information. + * @param transactionData Transaction details displayed on a receipt. * @return This builder instance. */ public Builder transactionData(com.sumup.sdk.models.ReceiptTransaction transactionData) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptAcquirerData.java b/src/main/java/com/sumup/sdk/models/ReceiptAcquirerData.java index 56e610c..49fa824 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptAcquirerData.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptAcquirerData.java @@ -3,8 +3,17 @@ /** Acquirer-specific metadata related to the card authorization. */ public record ReceiptAcquirerData( - String authorizationCode, String localTime, String returnCode, String tid) { + /** Authorization code returned by the acquirer. */ + String authorizationCode, + /** Local timestamp of the card authorization. */ + String localTime, + + /** Return code reported by the acquirer. */ + String returnCode, + + /** Identifier of the terminal used for the authorization. */ + String tid) { /** * Creates a builder for ReceiptAcquirerData. * @@ -26,7 +35,7 @@ private Builder() {} /** * Sets the value for {@code authorizationCode}. * - * @param authorizationCode Value for the authorizationCode field. + * @param authorizationCode Authorization code returned by the acquirer. * @return This builder instance. */ public Builder authorizationCode(String authorizationCode) { @@ -37,7 +46,7 @@ public Builder authorizationCode(String authorizationCode) { /** * Sets the value for {@code localTime}. * - * @param localTime Value for the localTime field. + * @param localTime Local timestamp of the card authorization. * @return This builder instance. */ public Builder localTime(String localTime) { @@ -48,7 +57,7 @@ public Builder localTime(String localTime) { /** * Sets the value for {@code returnCode}. * - * @param returnCode Value for the returnCode field. + * @param returnCode Return code reported by the acquirer. * @return This builder instance. */ public Builder returnCode(String returnCode) { @@ -59,7 +68,7 @@ public Builder returnCode(String returnCode) { /** * Sets the value for {@code tid}. * - * @param tid Value for the tid field. + * @param tid Identifier of the terminal used for the authorization. * @return This builder instance. */ public Builder tid(String tid) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptCard.java b/src/main/java/com/sumup/sdk/models/ReceiptCard.java index 9878141..416b33b 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptCard.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptCard.java @@ -3,10 +3,10 @@ /** Payment card details displayed on the receipt. */ public record ReceiptCard( - /** Card last 4 digits. */ + /** Last four digits of the payment card number. */ String last4Digits, - /** Card Scheme. */ + /** Issuing card network of the payment card. */ String type) { /** * Creates a builder for ReceiptCard. @@ -27,7 +27,7 @@ private Builder() {} /** * Sets the value for {@code last4Digits}. * - * @param last4Digits Card last 4 digits. + * @param last4Digits Last four digits of the payment card number. * @return This builder instance. */ public Builder last4Digits(String last4Digits) { @@ -38,7 +38,7 @@ public Builder last4Digits(String last4Digits) { /** * Sets the value for {@code type}. * - * @param type Card Scheme. + * @param type Issuing card network of the payment card. * @return This builder instance. */ public Builder type(String type) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptEvent.java b/src/main/java/com/sumup/sdk/models/ReceiptEvent.java index 9a6dd10..20bae0f 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptEvent.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptEvent.java @@ -3,10 +3,10 @@ /** Transaction event details as rendered on the receipt. */ public record ReceiptEvent( - /** Amount of the event. */ + /** Amount associated with the transaction event, in major units. */ String amount, - /** Unique ID of the transaction event. */ + /** Unique identifier of the transaction event. */ com.sumup.sdk.models.TransactionEventId id, /** Receipt number associated with the event. */ @@ -30,10 +30,10 @@ public record ReceiptEvent( */ com.sumup.sdk.models.TransactionEventStatus status, - /** Date and time of the transaction event. */ + /** The timestamp of when the transaction event occurred. */ java.time.OffsetDateTime timestamp, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ com.sumup.sdk.models.TransactionId transactionId, /** Type of the transaction event. */ @@ -62,7 +62,7 @@ private Builder() {} /** * Sets the value for {@code amount}. * - * @param amount Amount of the event. + * @param amount Amount associated with the transaction event, in major units. * @return This builder instance. */ public Builder amount(String amount) { @@ -73,7 +73,7 @@ public Builder amount(String amount) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction event. + * @param id Unique identifier of the transaction event. * @return This builder instance. */ public Builder id(com.sumup.sdk.models.TransactionEventId id) { @@ -120,7 +120,7 @@ public Builder status(com.sumup.sdk.models.TransactionEventStatus status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the transaction event. + * @param timestamp The timestamp of when the transaction event occurred. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { @@ -131,7 +131,7 @@ public Builder timestamp(java.time.OffsetDateTime timestamp) { /** * Sets the value for {@code transactionId}. * - * @param transactionId Unique ID of the transaction. + * @param transactionId Unique identifier of the transaction. * @return This builder instance. */ public Builder transactionId(com.sumup.sdk.models.TransactionId transactionId) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptMerchantData.java b/src/main/java/com/sumup/sdk/models/ReceiptMerchantData.java index d3758b3..ad6a37e 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptMerchantData.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptMerchantData.java @@ -1,7 +1,7 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Receipt merchant data */ +/** Merchant details displayed on a transaction receipt. */ public record ReceiptMerchantData( /** Locale used for rendering localized receipt fields. */ String locale, diff --git a/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfile.java b/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfile.java index a2dfafc..b89e7b7 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfile.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfile.java @@ -3,13 +3,28 @@ /** Merchant profile details displayed on the receipt. */ public record ReceiptMerchantDataMerchantProfile( + /** Business address of the merchant. */ com.sumup.sdk.models.ReceiptMerchantDataMerchantProfileAddress address, + + /** Business name of the merchant. */ String businessName, + + /** Company registration number of the merchant. */ String companyRegistrationNumber, + + /** Email address of the merchant. */ String email, + + /** Language configured for the merchant profile. */ String language, + + /** Short unique identifier for the merchant. */ String merchantCode, + + /** VAT identification number of the merchant. */ String vatId, + + /** Website of the merchant. */ String website) { /** * Creates a builder for ReceiptMerchantDataMerchantProfile. @@ -36,7 +51,7 @@ private Builder() {} /** * Sets the value for {@code address}. * - * @param address Value for the address field. + * @param address Business address of the merchant. * @return This builder instance. */ public Builder address(com.sumup.sdk.models.ReceiptMerchantDataMerchantProfileAddress address) { @@ -47,7 +62,7 @@ public Builder address(com.sumup.sdk.models.ReceiptMerchantDataMerchantProfileAd /** * Sets the value for {@code businessName}. * - * @param businessName Value for the businessName field. + * @param businessName Business name of the merchant. * @return This builder instance. */ public Builder businessName(String businessName) { @@ -58,7 +73,7 @@ public Builder businessName(String businessName) { /** * Sets the value for {@code companyRegistrationNumber}. * - * @param companyRegistrationNumber Value for the companyRegistrationNumber field. + * @param companyRegistrationNumber Company registration number of the merchant. * @return This builder instance. */ public Builder companyRegistrationNumber(String companyRegistrationNumber) { @@ -69,7 +84,7 @@ public Builder companyRegistrationNumber(String companyRegistrationNumber) { /** * Sets the value for {@code email}. * - * @param email Value for the email field. + * @param email Email address of the merchant. * @return This builder instance. */ public Builder email(String email) { @@ -80,7 +95,7 @@ public Builder email(String email) { /** * Sets the value for {@code language}. * - * @param language Value for the language field. + * @param language Language configured for the merchant profile. * @return This builder instance. */ public Builder language(String language) { @@ -91,7 +106,7 @@ public Builder language(String language) { /** * Sets the value for {@code merchantCode}. * - * @param merchantCode Value for the merchantCode field. + * @param merchantCode Short unique identifier for the merchant. * @return This builder instance. */ public Builder merchantCode(String merchantCode) { @@ -102,7 +117,7 @@ public Builder merchantCode(String merchantCode) { /** * Sets the value for {@code vatId}. * - * @param vatId Value for the vatId field. + * @param vatId VAT identification number of the merchant. * @return This builder instance. */ public Builder vatId(String vatId) { @@ -113,7 +128,7 @@ public Builder vatId(String vatId) { /** * Sets the value for {@code website}. * - * @param website Value for the website field. + * @param website Website of the merchant. * @return This builder instance. */ public Builder website(String website) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfileAddress.java b/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfileAddress.java index 8fed159..26b232f 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfileAddress.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptMerchantDataMerchantProfileAddress.java @@ -1,15 +1,33 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; +/** Business address of the merchant. */ public record ReceiptMerchantDataMerchantProfileAddress( + /** First line of the merchant address. */ String addressLine1, + + /** Second line of the merchant address. */ String addressLine2, + + /** City of the merchant address. */ String city, + + /** Two-letter ISO 3166-1 alpha-2 country code of the merchant address. */ String country, + + /** English name of the country in the merchant address. */ String countryEnName, + + /** Localized name of the country in the merchant address. */ String countryNativeName, + + /** Landline phone number of the merchant. */ String landline, + + /** Postal code of the merchant address. */ String postCode, + + /** Region or state of the merchant address. */ String regionName) { /** * Creates a builder for ReceiptMerchantDataMerchantProfileAddress. @@ -37,7 +55,7 @@ private Builder() {} /** * Sets the value for {@code addressLine1}. * - * @param addressLine1 Value for the addressLine1 field. + * @param addressLine1 First line of the merchant address. * @return This builder instance. */ public Builder addressLine1(String addressLine1) { @@ -48,7 +66,7 @@ public Builder addressLine1(String addressLine1) { /** * Sets the value for {@code addressLine2}. * - * @param addressLine2 Value for the addressLine2 field. + * @param addressLine2 Second line of the merchant address. * @return This builder instance. */ public Builder addressLine2(String addressLine2) { @@ -59,7 +77,7 @@ public Builder addressLine2(String addressLine2) { /** * Sets the value for {@code city}. * - * @param city Value for the city field. + * @param city City of the merchant address. * @return This builder instance. */ public Builder city(String city) { @@ -70,7 +88,7 @@ public Builder city(String city) { /** * Sets the value for {@code country}. * - * @param country Value for the country field. + * @param country Two-letter ISO 3166-1 alpha-2 country code of the merchant address. * @return This builder instance. */ public Builder country(String country) { @@ -81,7 +99,7 @@ public Builder country(String country) { /** * Sets the value for {@code countryEnName}. * - * @param countryEnName Value for the countryEnName field. + * @param countryEnName English name of the country in the merchant address. * @return This builder instance. */ public Builder countryEnName(String countryEnName) { @@ -92,7 +110,7 @@ public Builder countryEnName(String countryEnName) { /** * Sets the value for {@code countryNativeName}. * - * @param countryNativeName Value for the countryNativeName field. + * @param countryNativeName Localized name of the country in the merchant address. * @return This builder instance. */ public Builder countryNativeName(String countryNativeName) { @@ -103,7 +121,7 @@ public Builder countryNativeName(String countryNativeName) { /** * Sets the value for {@code landline}. * - * @param landline Value for the landline field. + * @param landline Landline phone number of the merchant. * @return This builder instance. */ public Builder landline(String landline) { @@ -114,7 +132,7 @@ public Builder landline(String landline) { /** * Sets the value for {@code postCode}. * - * @param postCode Value for the postCode field. + * @param postCode Postal code of the merchant address. * @return This builder instance. */ public Builder postCode(String postCode) { @@ -125,7 +143,7 @@ public Builder postCode(String postCode) { /** * Sets the value for {@code regionName}. * - * @param regionName Value for the regionName field. + * @param regionName Region or state of the merchant address. * @return This builder instance. */ public Builder regionName(String regionName) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptReader.java b/src/main/java/com/sumup/sdk/models/ReceiptReader.java index 0b1d6fd..54797e5 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptReader.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptReader.java @@ -3,10 +3,10 @@ /** Card reader details displayed on the receipt. */ public record ReceiptReader( - /** Reader serial number. */ + /** Unique identifier of the physical card reader. */ String code, - /** Reader type. */ + /** Model of the physical card reader. */ String type) { /** * Creates a builder for ReceiptReader. @@ -27,7 +27,7 @@ private Builder() {} /** * Sets the value for {@code code}. * - * @param code Reader serial number. + * @param code Unique identifier of the physical card reader. * @return This builder instance. */ public Builder code(String code) { @@ -38,7 +38,7 @@ public Builder code(String code) { /** * Sets the value for {@code type}. * - * @param type Reader type. + * @param type Model of the physical card reader. * @return This builder instance. */ public Builder type(String type) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptTransaction.java b/src/main/java/com/sumup/sdk/models/ReceiptTransaction.java index 4421a02..1e23185 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptTransaction.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptTransaction.java @@ -1,9 +1,9 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Transaction information. */ +/** Transaction details displayed on a receipt. */ public record ReceiptTransaction( - /** Transaction amount. */ + /** Total transaction amount, in major units. */ String amount, /** Payment card details displayed on the receipt. */ @@ -12,52 +12,52 @@ public record ReceiptTransaction( /** Card reader details displayed on the receipt. */ com.sumup.sdk.models.ReceiptReader cardReader, - /** Transaction currency. */ + /** Three-letter ISO 4217 currency code of the transaction. */ String currency, - /** Transaction entry mode. */ + /** Entry mode of the payment details. */ String entryMode, - /** Events */ + /** Transaction events displayed on the receipt. */ java.util.List events, /** Number of installments. */ Long installmentsCount, - /** Merchant code. */ + /** Short unique identifier for the merchant. */ String merchantCode, - /** Transaction type. */ + /** Payment type used for the transaction. */ String paymentType, - /** Debit/Credit. */ + /** Whether the transaction was processed as credit or debit. */ com.sumup.sdk.models.ReceiptTransactionProcessAs processAs, - /** Products */ + /** Products associated with the transaction. */ java.util.List products, - /** Receipt number */ + /** Receipt number associated with the transaction. */ String receiptNo, - /** Transaction processing status. */ + /** Current processing status of the transaction. */ String status, - /** Time created at. */ + /** The timestamp of when the transaction was created. */ java.time.OffsetDateTime timestamp, - /** Tip amount (included in transaction amount). */ + /** Tip included in the transaction amount, in major units. */ String tipAmount, - /** Transaction code. */ + /** Transaction code returned after processing the transaction. */ String transactionCode, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ com.sumup.sdk.models.TransactionId transactionId, - /** Transaction VAT amount. */ + /** VAT included in the transaction amount, in major units. */ String vatAmount, - /** Vat rates. */ + /** VAT breakdown for the transaction. */ java.util.List vatRates, /** Cardholder verification method. */ @@ -99,7 +99,7 @@ private Builder() {} /** * Sets the value for {@code amount}. * - * @param amount Transaction amount. + * @param amount Total transaction amount, in major units. * @return This builder instance. */ public Builder amount(String amount) { @@ -132,7 +132,7 @@ public Builder cardReader(com.sumup.sdk.models.ReceiptReader cardReader) { /** * Sets the value for {@code currency}. * - * @param currency Transaction currency. + * @param currency Three-letter ISO 4217 currency code of the transaction. * @return This builder instance. */ public Builder currency(String currency) { @@ -143,7 +143,7 @@ public Builder currency(String currency) { /** * Sets the value for {@code entryMode}. * - * @param entryMode Transaction entry mode. + * @param entryMode Entry mode of the payment details. * @return This builder instance. */ public Builder entryMode(String entryMode) { @@ -154,7 +154,7 @@ public Builder entryMode(String entryMode) { /** * Sets the value for {@code events}. * - * @param events Events + * @param events Transaction events displayed on the receipt. * @return This builder instance. */ public Builder events(java.util.List events) { @@ -176,7 +176,7 @@ public Builder installmentsCount(Long installmentsCount) { /** * Sets the value for {@code merchantCode}. * - * @param merchantCode Merchant code. + * @param merchantCode Short unique identifier for the merchant. * @return This builder instance. */ public Builder merchantCode(String merchantCode) { @@ -187,7 +187,7 @@ public Builder merchantCode(String merchantCode) { /** * Sets the value for {@code paymentType}. * - * @param paymentType Transaction type. + * @param paymentType Payment type used for the transaction. * @return This builder instance. */ public Builder paymentType(String paymentType) { @@ -198,7 +198,7 @@ public Builder paymentType(String paymentType) { /** * Sets the value for {@code processAs}. * - * @param processAs Debit/Credit. + * @param processAs Whether the transaction was processed as credit or debit. * @return This builder instance. */ public Builder processAs(com.sumup.sdk.models.ReceiptTransactionProcessAs processAs) { @@ -209,7 +209,7 @@ public Builder processAs(com.sumup.sdk.models.ReceiptTransactionProcessAs proces /** * Sets the value for {@code products}. * - * @param products Products + * @param products Products associated with the transaction. * @return This builder instance. */ public Builder products( @@ -221,7 +221,7 @@ public Builder products( /** * Sets the value for {@code receiptNo}. * - * @param receiptNo Receipt number + * @param receiptNo Receipt number associated with the transaction. * @return This builder instance. */ public Builder receiptNo(String receiptNo) { @@ -232,7 +232,7 @@ public Builder receiptNo(String receiptNo) { /** * Sets the value for {@code status}. * - * @param status Transaction processing status. + * @param status Current processing status of the transaction. * @return This builder instance. */ public Builder status(String status) { @@ -243,7 +243,7 @@ public Builder status(String status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Time created at. + * @param timestamp The timestamp of when the transaction was created. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { @@ -254,7 +254,7 @@ public Builder timestamp(java.time.OffsetDateTime timestamp) { /** * Sets the value for {@code tipAmount}. * - * @param tipAmount Tip amount (included in transaction amount). + * @param tipAmount Tip included in the transaction amount, in major units. * @return This builder instance. */ public Builder tipAmount(String tipAmount) { @@ -265,7 +265,7 @@ public Builder tipAmount(String tipAmount) { /** * Sets the value for {@code transactionCode}. * - * @param transactionCode Transaction code. + * @param transactionCode Transaction code returned after processing the transaction. * @return This builder instance. */ public Builder transactionCode(String transactionCode) { @@ -276,7 +276,7 @@ public Builder transactionCode(String transactionCode) { /** * Sets the value for {@code transactionId}. * - * @param transactionId Unique ID of the transaction. + * @param transactionId Unique identifier of the transaction. * @return This builder instance. */ public Builder transactionId(com.sumup.sdk.models.TransactionId transactionId) { @@ -287,7 +287,7 @@ public Builder transactionId(com.sumup.sdk.models.TransactionId transactionId) { /** * Sets the value for {@code vatAmount}. * - * @param vatAmount Transaction VAT amount. + * @param vatAmount VAT included in the transaction amount, in major units. * @return This builder instance. */ public Builder vatAmount(String vatAmount) { @@ -298,7 +298,7 @@ public Builder vatAmount(String vatAmount) { /** * Sets the value for {@code vatRates}. * - * @param vatRates Vat rates. + * @param vatRates VAT breakdown for the transaction. * @return This builder instance. */ public Builder vatRates( diff --git a/src/main/java/com/sumup/sdk/models/ReceiptTransactionProcessAs.java b/src/main/java/com/sumup/sdk/models/ReceiptTransactionProcessAs.java index 5b20f11..95e08dd 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptTransactionProcessAs.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptTransactionProcessAs.java @@ -5,7 +5,7 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.util.Objects; -/** Debit/Credit. */ +/** Whether the transaction was processed as credit or debit. */ public final class ReceiptTransactionProcessAs { public static final ReceiptTransactionProcessAs CREDIT = new ReceiptTransactionProcessAs("CREDIT"); diff --git a/src/main/java/com/sumup/sdk/models/ReceiptTransactionProductsItem.java b/src/main/java/com/sumup/sdk/models/ReceiptTransactionProductsItem.java index a5af95d..6a0b2f3 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptTransactionProductsItem.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptTransactionProductsItem.java @@ -2,34 +2,34 @@ package com.sumup.sdk.models; public record ReceiptTransactionProductsItem( - /** Product description */ + /** Product description. */ String description, - /** Product name */ + /** Product name. */ String name, - /** Product price */ + /** Product price. */ String price, - /** Product price including VAT */ + /** Product price including VAT. */ String priceWithVat, - /** Product quantity */ + /** Product quantity. */ Long quantity, - /** VAT amount for a single product */ + /** VAT amount for a single product. */ String singleVatAmount, - /** Quantity x product price */ + /** Total price calculated as the product price multiplied by the quantity. */ String totalPrice, - /** Total price including VAT */ + /** Total product price including VAT. */ String totalWithVat, - /** VAT amount */ + /** Total VAT amount for the product quantity. */ String vatAmount, - /** VAT rate */ + /** VAT rate. */ String vatRate) { /** * Creates a builder for ReceiptTransactionProductsItem. @@ -58,7 +58,7 @@ private Builder() {} /** * Sets the value for {@code description}. * - * @param description Product description + * @param description Product description. * @return This builder instance. */ public Builder description(String description) { @@ -69,7 +69,7 @@ public Builder description(String description) { /** * Sets the value for {@code name}. * - * @param name Product name + * @param name Product name. * @return This builder instance. */ public Builder name(String name) { @@ -80,7 +80,7 @@ public Builder name(String name) { /** * Sets the value for {@code price}. * - * @param price Product price + * @param price Product price. * @return This builder instance. */ public Builder price(String price) { @@ -91,7 +91,7 @@ public Builder price(String price) { /** * Sets the value for {@code priceWithVat}. * - * @param priceWithVat Product price including VAT + * @param priceWithVat Product price including VAT. * @return This builder instance. */ public Builder priceWithVat(String priceWithVat) { @@ -102,7 +102,7 @@ public Builder priceWithVat(String priceWithVat) { /** * Sets the value for {@code quantity}. * - * @param quantity Product quantity + * @param quantity Product quantity. * @return This builder instance. */ public Builder quantity(Long quantity) { @@ -113,7 +113,7 @@ public Builder quantity(Long quantity) { /** * Sets the value for {@code singleVatAmount}. * - * @param singleVatAmount VAT amount for a single product + * @param singleVatAmount VAT amount for a single product. * @return This builder instance. */ public Builder singleVatAmount(String singleVatAmount) { @@ -124,7 +124,7 @@ public Builder singleVatAmount(String singleVatAmount) { /** * Sets the value for {@code totalPrice}. * - * @param totalPrice Quantity x product price + * @param totalPrice Total price calculated as the product price multiplied by the quantity. * @return This builder instance. */ public Builder totalPrice(String totalPrice) { @@ -135,7 +135,7 @@ public Builder totalPrice(String totalPrice) { /** * Sets the value for {@code totalWithVat}. * - * @param totalWithVat Total price including VAT + * @param totalWithVat Total product price including VAT. * @return This builder instance. */ public Builder totalWithVat(String totalWithVat) { @@ -146,7 +146,7 @@ public Builder totalWithVat(String totalWithVat) { /** * Sets the value for {@code vatAmount}. * - * @param vatAmount VAT amount + * @param vatAmount Total VAT amount for the product quantity. * @return This builder instance. */ public Builder vatAmount(String vatAmount) { @@ -157,7 +157,7 @@ public Builder vatAmount(String vatAmount) { /** * Sets the value for {@code vatRate}. * - * @param vatRate VAT rate + * @param vatRate VAT rate. * @return This builder instance. */ public Builder vatRate(String vatRate) { diff --git a/src/main/java/com/sumup/sdk/models/ReceiptTransactionVatRatesItem.java b/src/main/java/com/sumup/sdk/models/ReceiptTransactionVatRatesItem.java index 28fdf71..f906173 100644 --- a/src/main/java/com/sumup/sdk/models/ReceiptTransactionVatRatesItem.java +++ b/src/main/java/com/sumup/sdk/models/ReceiptTransactionVatRatesItem.java @@ -2,16 +2,16 @@ package com.sumup.sdk.models; public record ReceiptTransactionVatRatesItem( - /** Gross */ + /** Gross amount to which the VAT rate applies. */ Float gross, - /** Net */ + /** Net amount to which the VAT rate applies. */ Float net, - /** Rate */ + /** VAT rate applied to the transaction amount. */ Float rate, - /** Vat */ + /** VAT amount included in the gross amount. */ Float vat) { /** * Creates a builder for ReceiptTransactionVatRatesItem. @@ -34,7 +34,7 @@ private Builder() {} /** * Sets the value for {@code gross}. * - * @param gross Gross + * @param gross Gross amount to which the VAT rate applies. * @return This builder instance. */ public Builder gross(Float gross) { @@ -45,7 +45,7 @@ public Builder gross(Float gross) { /** * Sets the value for {@code net}. * - * @param net Net + * @param net Net amount to which the VAT rate applies. * @return This builder instance. */ public Builder net(Float net) { @@ -56,7 +56,7 @@ public Builder net(Float net) { /** * Sets the value for {@code rate}. * - * @param rate Rate + * @param rate VAT rate applied to the transaction amount. * @return This builder instance. */ public Builder rate(Float rate) { @@ -67,7 +67,7 @@ public Builder rate(Float rate) { /** * Sets the value for {@code vat}. * - * @param vat Vat + * @param vat VAT amount included in the gross amount. * @return This builder instance. */ public Builder vat(Float vat) { diff --git a/src/main/java/com/sumup/sdk/models/TransactionBase.java b/src/main/java/com/sumup/sdk/models/TransactionBase.java index c10e97d..351810d 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionBase.java +++ b/src/main/java/com/sumup/sdk/models/TransactionBase.java @@ -1,21 +1,20 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Details of the transaction. */ +/** Core details shared by transaction resources. */ public record TransactionBase( /** Total amount of the transaction. */ Float amount, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ String id, - /** Current number of the installment for deferred payments. */ + /** Number of installments for a deferred payment. */ Long installmentsCount, /** Payment type used for the transaction. */ @@ -30,10 +29,7 @@ public record TransactionBase( */ com.sumup.sdk.models.TransactionStatus status, - /** - * Date and time of the creation of the transaction. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the transaction was created. */ java.time.OffsetDateTime timestamp, /** @@ -76,8 +72,8 @@ public Builder amount(Float amount) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -88,7 +84,7 @@ public Builder currency(com.sumup.sdk.models.Currency currency) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction. + * @param id Unique identifier of the transaction. * @return This builder instance. */ public Builder id(String id) { @@ -99,7 +95,7 @@ public Builder id(String id) { /** * Sets the value for {@code installmentsCount}. * - * @param installmentsCount Current number of the installment for deferred payments. + * @param installmentsCount Number of installments for a deferred payment. * @return This builder instance. */ public Builder installmentsCount(Long installmentsCount) { @@ -136,8 +132,7 @@ public Builder status(com.sumup.sdk.models.TransactionStatus status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the creation of the transaction. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param timestamp The timestamp of when the transaction was created. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { diff --git a/src/main/java/com/sumup/sdk/models/TransactionEvent.java b/src/main/java/com/sumup/sdk/models/TransactionEvent.java index 1fde871..6807dd7 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionEvent.java +++ b/src/main/java/com/sumup/sdk/models/TransactionEvent.java @@ -15,7 +15,7 @@ public record TransactionEvent( /** Type of the transaction event. */ com.sumup.sdk.models.TransactionEventType eventType, - /** Unique ID of the transaction event. */ + /** Unique identifier of the transaction event. */ com.sumup.sdk.models.TransactionEventId id, /** @@ -113,7 +113,7 @@ public Builder eventType(com.sumup.sdk.models.TransactionEventType eventType) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction event. + * @param id Unique identifier of the transaction event. * @return This builder instance. */ public Builder id(com.sumup.sdk.models.TransactionEventId id) { diff --git a/src/main/java/com/sumup/sdk/models/TransactionEventId.java b/src/main/java/com/sumup/sdk/models/TransactionEventId.java index 54cb8cb..c77c296 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionEventId.java +++ b/src/main/java/com/sumup/sdk/models/TransactionEventId.java @@ -1,5 +1,5 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Unique ID of the transaction event. */ +/** Unique identifier of the transaction event. */ public record TransactionEventId(Long value) {} diff --git a/src/main/java/com/sumup/sdk/models/TransactionFull.java b/src/main/java/com/sumup/sdk/models/TransactionFull.java index 455c78c..1460cd0 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionFull.java +++ b/src/main/java/com/sumup/sdk/models/TransactionFull.java @@ -15,12 +15,11 @@ public record TransactionFull( /** Details of the payment card. */ com.sumup.sdk.models.CardResponse card, - /** Client transaction id. */ + /** Client-supplied identifier of the transaction. */ String clientTransactionId, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, @@ -39,7 +38,7 @@ public record TransactionFull( /** Transaction SumUp total fee amount. */ Double feeAmount, - /** External/foreign transaction id (passed by clients). */ + /** External transaction identifier supplied by the client. */ String foreignTransactionId, /** @@ -47,10 +46,10 @@ public record TransactionFull( */ com.sumup.sdk.models.HorizontalAccuracy horizontalAccuracy, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ String id, - /** Current number of the installment for deferred payments. */ + /** Number of installments for a deferred payment. */ Long installmentsCount, /** @@ -62,7 +61,7 @@ public record TransactionFull( /** List of hyperlinks for accessing related resources. */ java.util.List links, - /** Local date and time of the creation of the transaction. */ + /** Local timestamp of when the transaction was created. */ java.time.OffsetDateTime localTime, /** Details of the payment location as received from the payment terminal. */ @@ -77,7 +76,7 @@ public record TransactionFull( /** Unique code of the registered merchant to whom the payment is made. */ String merchantCode, - /** SumUp merchant internal Id. */ + /** Internal SumUp identifier of the merchant. */ Long merchantId, /** Payment type used for the transaction. */ @@ -98,7 +97,7 @@ public record TransactionFull( /** Total number of payouts to the registered user specified in the `user` property. */ Long payoutsTotal, - /** Debit/Credit. */ + /** Whether the transaction was processed as credit or debit. */ com.sumup.sdk.models.TransactionFullProcessAs processAs, /** @@ -142,10 +141,7 @@ public record TransactionFull( /** Indicates whether tax deduction is enabled for the transaction. */ Boolean taxEnabled, - /** - * Date and time of the creation of the transaction. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the transaction was created. */ java.time.OffsetDateTime timestamp, /** Amount of the tip (out of the total transaction amount). */ @@ -263,7 +259,7 @@ public Builder card(com.sumup.sdk.models.CardResponse card) { /** * Sets the value for {@code clientTransactionId}. * - * @param clientTransactionId Client transaction id. + * @param clientTransactionId Client-supplied identifier of the transaction. * @return This builder instance. */ public Builder clientTransactionId(String clientTransactionId) { @@ -274,8 +270,8 @@ public Builder clientTransactionId(String clientTransactionId) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -341,7 +337,7 @@ public Builder feeAmount(Double feeAmount) { /** * Sets the value for {@code foreignTransactionId}. * - * @param foreignTransactionId External/foreign transaction id (passed by clients). + * @param foreignTransactionId External transaction identifier supplied by the client. * @return This builder instance. */ public Builder foreignTransactionId(String foreignTransactionId) { @@ -364,7 +360,7 @@ public Builder horizontalAccuracy(com.sumup.sdk.models.HorizontalAccuracy horizo /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction. + * @param id Unique identifier of the transaction. * @return This builder instance. */ public Builder id(String id) { @@ -375,7 +371,7 @@ public Builder id(String id) { /** * Sets the value for {@code installmentsCount}. * - * @param installmentsCount Current number of the installment for deferred payments. + * @param installmentsCount Number of installments for a deferred payment. * @return This builder instance. */ public Builder installmentsCount(Long installmentsCount) { @@ -409,7 +405,7 @@ public Builder links(java.util.List links) { /** * Sets the value for {@code localTime}. * - * @param localTime Local date and time of the creation of the transaction. + * @param localTime Local timestamp of when the transaction was created. * @return This builder instance. */ public Builder localTime(java.time.OffsetDateTime localTime) { @@ -454,7 +450,7 @@ public Builder merchantCode(String merchantCode) { /** * Sets the value for {@code merchantId}. * - * @param merchantId SumUp merchant internal Id. + * @param merchantId Internal SumUp identifier of the merchant. * @return This builder instance. */ public Builder merchantId(Long merchantId) { @@ -534,7 +530,7 @@ public Builder payoutsTotal(Long payoutsTotal) { /** * Sets the value for {@code processAs}. * - * @param processAs Debit/Credit. + * @param processAs Whether the transaction was processed as credit or debit. * @return This builder instance. */ public Builder processAs(com.sumup.sdk.models.TransactionFullProcessAs processAs) { @@ -629,8 +625,7 @@ public Builder taxEnabled(Boolean taxEnabled) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the creation of the transaction. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param timestamp The timestamp of when the transaction was created. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { diff --git a/src/main/java/com/sumup/sdk/models/TransactionFullProcessAs.java b/src/main/java/com/sumup/sdk/models/TransactionFullProcessAs.java index e4312f9..d7bc9d2 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionFullProcessAs.java +++ b/src/main/java/com/sumup/sdk/models/TransactionFullProcessAs.java @@ -5,7 +5,7 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.util.Objects; -/** Debit/Credit. */ +/** Whether the transaction was processed as credit or debit. */ public final class TransactionFullProcessAs { public static final TransactionFullProcessAs CREDIT = new TransactionFullProcessAs("CREDIT"); public static final TransactionFullProcessAs DEBIT = new TransactionFullProcessAs("DEBIT"); diff --git a/src/main/java/com/sumup/sdk/models/TransactionHistory.java b/src/main/java/com/sumup/sdk/models/TransactionHistory.java index f383d3e..2e7abf9 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionHistory.java +++ b/src/main/java/com/sumup/sdk/models/TransactionHistory.java @@ -9,19 +9,18 @@ public record TransactionHistory( /** Issuing card network of the payment card used for the transaction. */ com.sumup.sdk.models.CardType cardType, - /** Client-specific ID of the transaction. */ + /** Client-supplied identifier of the transaction. */ String clientTransactionId, /** - * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the - * amount. Currently supported currency values are enumerated above. + * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount. */ com.sumup.sdk.models.Currency currency, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ String id, - /** Current number of the installment for deferred payments. */ + /** Number of installments for a deferred payment. */ Long installmentsCount, /** Payment type used for the transaction. */ @@ -60,10 +59,7 @@ public record TransactionHistory( */ com.sumup.sdk.models.TransactionStatus status, - /** - * Date and time of the creation of the transaction. Response format expressed according to - * [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. - */ + /** The timestamp of when the transaction was created. */ java.time.OffsetDateTime timestamp, /** @@ -71,7 +67,7 @@ public record TransactionHistory( */ String transactionCode, - /** Unique ID of the transaction. */ + /** Unique identifier of the transaction. */ com.sumup.sdk.models.TransactionId transactionId, /** Type of the transaction for the registered user specified in the `user` property. */ @@ -138,7 +134,7 @@ public Builder cardType(com.sumup.sdk.models.CardType cardType) { /** * Sets the value for {@code clientTransactionId}. * - * @param clientTransactionId Client-specific ID of the transaction. + * @param clientTransactionId Client-supplied identifier of the transaction. * @return This builder instance. */ public Builder clientTransactionId(String clientTransactionId) { @@ -149,8 +145,8 @@ public Builder clientTransactionId(String clientTransactionId) { /** * Sets the value for {@code currency}. * - * @param currency Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the - * currency for the amount. Currently supported currency values are enumerated above. + * @param currency Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code + * of the amount. * @return This builder instance. */ public Builder currency(com.sumup.sdk.models.Currency currency) { @@ -161,7 +157,7 @@ public Builder currency(com.sumup.sdk.models.Currency currency) { /** * Sets the value for {@code id}. * - * @param id Unique ID of the transaction. + * @param id Unique identifier of the transaction. * @return This builder instance. */ public Builder id(String id) { @@ -172,7 +168,7 @@ public Builder id(String id) { /** * Sets the value for {@code installmentsCount}. * - * @param installmentsCount Current number of the installment for deferred payments. + * @param installmentsCount Number of installments for a deferred payment. * @return This builder instance. */ public Builder installmentsCount(Long installmentsCount) { @@ -290,8 +286,7 @@ public Builder status(com.sumup.sdk.models.TransactionStatus status) { /** * Sets the value for {@code timestamp}. * - * @param timestamp Date and time of the creation of the transaction. Response format expressed - * according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code. + * @param timestamp The timestamp of when the transaction was created. * @return This builder instance. */ public Builder timestamp(java.time.OffsetDateTime timestamp) { @@ -314,7 +309,7 @@ public Builder transactionCode(String transactionCode) { /** * Sets the value for {@code transactionId}. * - * @param transactionId Unique ID of the transaction. + * @param transactionId Unique identifier of the transaction. * @return This builder instance. */ public Builder transactionId(com.sumup.sdk.models.TransactionId transactionId) { diff --git a/src/main/java/com/sumup/sdk/models/TransactionId.java b/src/main/java/com/sumup/sdk/models/TransactionId.java index b5803c8..46d5ffa 100644 --- a/src/main/java/com/sumup/sdk/models/TransactionId.java +++ b/src/main/java/com/sumup/sdk/models/TransactionId.java @@ -1,5 +1,5 @@ // Code generated by sumup-java/codegen. DO NOT EDIT. package com.sumup.sdk.models; -/** Unique ID of the transaction. */ +/** Unique identifier of the transaction. */ public record TransactionId(String value) {}