Skip to content

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

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
matoous merged 2 commits into from
Oct 9, 2026
Merged

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

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

Filter by extension

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

Large diffs are not rendered by default.

48 changes: 27 additions & 21 deletions sumup/checkouts/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ class CreateCheckoutBodyInput(typing_extensions.TypedDict, total=False):
typing_extensions.Annotated[
str,
typing_extensions.Doc(
"Merchant-defined reference for the new checkout. It should be unique enough for you to identify the payment attemptin your own systems.\nMax length: 64"
"Merchant-defined reference for the new checkout, up to 64 characters. Use it to correlate the checkout withan order or payment attempt in your own system. If a checkout already exists for the supplied unique parameters,creation returns `409` with `DUPLICATED_CHECKOUT`; see the conflict response.\nMax length: 64"
),
]
]
Expand Down Expand Up @@ -155,7 +155,7 @@ class CreateCheckoutBodyInput(typing_extensions.TypedDict, total=False):
typing_extensions.Annotated[
str,
typing_extensions.Doc(
"Optional backend callback URL used by SumUp to notify your platform about processing updates for the checkout.\nFormat:uri"
"Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` andthe checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the[webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.\nFormat: uri"
),
]
]
Expand Down Expand Up @@ -186,7 +186,7 @@ class UpdateCheckoutBodyInput(typing_extensions.TypedDict, total=False):
typing_extensions.Annotated[
str,
typing_extensions.Doc(
"Updated merchant-defined reference for the checkout.\nMax length: 90"
"Updated merchant-defined reference for the checkout.\nMax length: 64"
),
]
]
Expand Down Expand Up @@ -309,7 +309,7 @@ class ProcessCheckoutBodyInput(typing_extensions.TypedDict, total=False):
typing_extensions.Annotated[
str,
typing_extensions.Doc(
"Saved-card token to use instead of raw card details when processing with a previously stored payment instrument."
"Token of a saved payment instrument returned by checkout processing or the customer's payment-instruments endpoint.To charge a saved card, set `payment_type` to `card` and provide both this `token` and the associated `customer_id`instead of raw card details."
),
]
]
Expand All @@ -324,14 +324,16 @@ class CreateApplePaySessionBodyInput(typing_extensions.TypedDict, total=False):
typing_extensions.Annotated[
str,
typing_extensions.Doc(
"the context to create this apple pay session.\nFormat: hostname"
"Hostname of the website displaying the Apple Pay payment sheet, without a URL scheme or path. Use the domainregistered for Apple Pay.\nFormat: hostname"
),
]
]
target: typing_extensions.Required[
typing_extensions.Annotated[
str,
typing_extensions.Doc("The target url to create this apple pay session.\nFormat: uri"),
typing_extensions.Doc(
"Apple Pay validation URL received as `validationURL` in the browser's `onvalidatemerchant` event.\nFormat: uri"
),
]
]

Expand Down Expand Up @@ -377,7 +379,7 @@ class ProcessCheckoutCheckoutSuccessResponseTransaction(pydantic.BaseModel):

amount: float | None = None
"""
Total amount of the transaction.
Total amount of the transaction in major units of `currency`, for example `10.1` for EUR 10.10.
"""

auth_code: str | None = None
Expand All @@ -392,7 +394,7 @@ class ProcessCheckoutCheckoutSuccessResponseTransaction(pydantic.BaseModel):

entry_mode: EntryMode | None = None
"""
Entry mode of the payment details.
How the payment details were captured, for example `CHIP` or `CONTACTLESS` for card-present payments and`CUSTOMER_ENTRY` for card details entered by the payer. For wallet and alternative payment methods, this canidentify the method, such as `APPLE_PAY` or `BLIK`.
"""

id: str | None = None
Expand All @@ -413,7 +415,7 @@ class ProcessCheckoutCheckoutSuccessResponseTransaction(pydantic.BaseModel):

payment_type: PaymentType | None = None
"""
Payment type used for the transaction.
Payment category recorded on a transaction, for example `POS` for a point-of-sale card payment, `ECOM` foran online card payment, or `RECURRING` for a recurring card payment. These reporting values are separate fromthe lowercase `payment_type` values used to process checkouts.
"""

status: TransactionStatus | None = None
Expand All @@ -434,17 +436,17 @@ class ProcessCheckoutCheckoutSuccessResponseTransaction(pydantic.BaseModel):

tip_amount: float | None = None
"""
Amount of the tip (out of the total transaction amount).
Tip included in the total transaction amount, in major units of the transaction's currency.
"""

transaction_code: str | None = None
"""
Transaction code returned by the acquirer/processing entity after processing the transaction.
SumUp transaction code, for example `TEENSK4W2K`. Use it to look up the transaction with the `transaction_code` queryparameter. This is separate from the transaction's `id` and the card issuer's `auth_code`.
"""

vat_amount: float | None = None
"""
Amount of the applicable VAT (out of the total transaction amount).
VAT included in the total transaction amount, in major units of the transaction's currency.
"""


Expand Down Expand Up @@ -472,7 +474,7 @@ class ProcessCheckoutCheckoutSuccessResponse(pydantic.BaseModel):
checkout_reference: str | None = None
"""
Merchant-defined reference for the checkout. Use it to correlate the SumUp checkout with your own order, cart,subscription, or payment attempt in your systems.
Max length: 90
Max length: 64
"""

currency: Currency | None = None
Expand Down Expand Up @@ -535,8 +537,8 @@ class ProcessCheckoutCheckoutSuccessResponse(pydantic.BaseModel):

return_url: str | None = None
"""
Optional backend callback URL used by SumUp to notify your platform about processing updates for the checkout.
Format:uri
Optional backend callback URL for checkout status notifications. SumUp sends an HTTP POST with `event_type` andthe checkout `id`. Retrieve the checkout to verify its current status before updating your order. See the[webhook guide](https://developer.sumup.com/online-payments/webhooks/) for the payload and response requirements.
Format: uri
"""

status: ProcessCheckoutCheckoutSuccessResponseStatus | None = None
Expand Down Expand Up @@ -593,7 +595,7 @@ def list_available_payment_methods(
"""
Get available payment methods

Get payment methods available for the given merchant to use with a checkout.
Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filtersto check eligibility for a particular payment before presenting payment options to the payer.


Raises:
Expand Down Expand Up @@ -745,7 +747,7 @@ def get(self, checkout_id: str, headers: HeaderTypes | None = None) -> CheckoutS
"""
Retrieve a checkout

Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and informthe end user respectively.
Retrieves a checkout by its SumUp `checkout_id`. After processing a payment, returning from a redirect, or receiving acheckout notification, retrieve the checkout to confirm its current `status` before updating your order ordisplaying the payment outcome to the payer.


Raises:
Expand Down Expand Up @@ -853,7 +855,9 @@ def process(

Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resourceinitiated in the `Create a checkout` endpoint.

Follow this request with `Retrieve a checkout` to confirm its status.
A processing response can require an additional payer action, such as a 3DS challenge or a payment-provider redirect.If `next_step` is returned, follow its instructions to continue the payment flow.

Retrieve the checkout afterwards to confirm its payment status. Acceptance of the processing request does not byitself mean the checkout is paid.


Raises:
Expand Down Expand Up @@ -1015,7 +1019,7 @@ async def list_available_payment_methods(
"""
Get available payment methods

Get payment methods available for the given merchant to use with a checkout.
Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filtersto check eligibility for a particular payment before presenting payment options to the payer.


Raises:
Expand Down Expand Up @@ -1167,7 +1171,7 @@ async def get(self, checkout_id: str, headers: HeaderTypes | None = None) -> Che
"""
Retrieve a checkout

Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and informthe end user respectively.
Retrieves a checkout by its SumUp `checkout_id`. After processing a payment, returning from a redirect, or receiving acheckout notification, retrieve the checkout to confirm its current `status` before updating your order ordisplaying the payment outcome to the payer.


Raises:
Expand Down Expand Up @@ -1275,7 +1279,9 @@ async def process(

Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resourceinitiated in the `Create a checkout` endpoint.

Follow this request with `Retrieve a checkout` to confirm its status.
A processing response can require an additional payer action, such as a 3DS challenge or a payment-provider redirect.If `next_step` is returned, follow its instructions to continue the payment flow.

Retrieve the checkout afterwards to confirm its payment status. Acceptance of the processing request does not byitself mean the checkout is paid.


Raises:
Expand Down
29 changes: 16 additions & 13 deletions sumup/customers/resource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Code generated by `py-sdk-gen`. DO NOT EDIT.
# ruff: noqa: F401, F541
"""
Allow your regular customers to save their information with the Customers model.
Customers represent payers in your integration. Create a customer with your own `customer_id` to associate their personal details and saved payment instruments with your business records.

This will prevent re-entering payment instrument information for recurring payments on your platform.
To save a card, create a checkout for that customer with `purpose = SETUP_RECURRING_PAYMENT`, then process it with the payer's consent and mandate details. See the [tokenization guide](https://developer.sumup.com/online-payments/guides/tokenization-with-payment-sdk/).

Depending on the needs you can allow, creating, listing or deactivating payment instruments & creating, retrieving and updating customers.
Use the Customers endpoints to create, retrieve, or update customer details and to list or deactivate saved payment instruments. For subsequent payments, process a new checkout with the saved instrument's `token` and its associated `customer_id`.
"""

from __future__ import annotations
Expand Down Expand Up @@ -46,12 +46,15 @@

class CreateCustomerBodyInput(typing_extensions.TypedDict, total=False):
"""
Saved customer details.
Saved payer details identified by the `customer_id` supplied by your integration. A customer can have savedpayment instruments for subsequent payments.
"""

customer_id: typing_extensions.Required[
typing_extensions.Annotated[
str, typing_extensions.Doc("Unique identifier of the customer.")
str,
typing_extensions.Doc(
"Identifier you supply when creating the customer. Use an ID from your own system and retain it for subsequent customer,checkout, and saved-payment-instrument requests."
),
]
]
personal_details: typing_extensions.NotRequired[
Expand Down Expand Up @@ -95,11 +98,11 @@ def create(
"""
Create a customer

Creates a new saved customer resource which you can later manipulate and save payment instruments to.
Creates a customer using the `customer_id` you supply. Choose an identifier that maps to the payer in your own systemand reuse it when retrieving the customer or associating checkouts and saved payment instruments with them.


Raises:
APIError: Raised when the API returns one of the documented error responses:
APIError: Raised when the API returns one of the documented error responses:
400: The request body is invalid.
401: The request is not authorized.
403: The request is authenticated but not permitted for this operation.
Expand Down Expand Up @@ -143,11 +146,11 @@ def get(self, customer_id: str, headers: HeaderTypes | None = None) -> Customer:
"""
Retrieve a customer

Retrieves an identified saved customer resource through the unique `customer_id` parameter, generated upon customer creation.
Retrieves a saved customer using the `customer_id` you supplied when creating the customer.


Raises:
APIError: Raised when the API returns one of the documented error responses:
APIError: Raised when the API returns one of the documented error responses:
401: The request is not authorized.
403: The request is authenticated but not permitted for this operation.
404: The requested resource does not exist.
Expand Down Expand Up @@ -326,11 +329,11 @@ async def create(
"""
Create a customer

Creates a new saved customer resource which you can later manipulate and save payment instruments to.
Creates a customer using the `customer_id` you supply. Choose an identifier that maps to the payer in your own systemand reuse it when retrieving the customer or associating checkouts and saved payment instruments with them.


Raises:
APIError: Raised when the API returns one of the documented error responses:
APIError: Raised when the API returns one of the documented error responses:
400: The request body is invalid.
401: The request is not authorized.
403: The request is authenticated but not permitted for this operation.
Expand Down Expand Up @@ -374,11 +377,11 @@ async def get(self, customer_id: str, headers: HeaderTypes | None = None) -> Cus
"""
Retrieve a customer

Retrieves an identified saved customer resource through the unique `customer_id` parameter, generated upon customer creation.
Retrieves a saved customer using the `customer_id` you supplied when creating the customer.


Raises:
APIError: Raised when the API returns one of the documented error responses:
APIError: Raised when the API returns one of the documented error responses:
401: The request is not authorized.
403: The request is authenticated but not permitted for this operation.
404: The requested resource does not exist.
Expand Down
Loading
Loading