Skip to content

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

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

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

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

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
b58c6eb
chore: synced local 'openapi.json' with remote 'specs/openapi31.json'
Oct 10, 2026
8dd4800
chore: generate code
sumup-release-bot[bot] Oct 10, 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.

36 changes: 18 additions & 18 deletions src/SumUp/CheckoutsClient.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ public async Task<ApiResponse<Checkout>> CreateAsync(CheckoutCreateRequest body,
/// Create an Apple Pay session
/// </summary>
/// <remarks>Creates an Apple Pay merchant session for the specified checkout. Use this endpoint after the customer selects Apple Pay and before calling ApplePaySession.completeMerchantValidation(...) in the browser. SumUp validates the merchant session request and returns the Apple Pay session object that your frontend should pass to Apple's JavaScript API.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <param name="body">The data needed to create an apple pay session for a checkout.</param>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="body">Merchant validation details from the Apple Pay session in the payer's browser.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public ApiResponse<JsonDocument> CreateApplePaySession(string checkoutId, CheckoutsCreateApplePaySessionRequest? body = null, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -217,8 +217,8 @@ public ApiResponse<JsonDocument> CreateApplePaySession(string checkoutId, Checko
/// Create an Apple Pay session
/// </summary>
/// <remarks>Creates an Apple Pay merchant session for the specified checkout. Use this endpoint after the customer selects Apple Pay and before calling ApplePaySession.completeMerchantValidation(...) in the browser. SumUp validates the merchant session request and returns the Apple Pay session object that your frontend should pass to Apple's JavaScript API.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <param name="body">The data needed to create an apple pay session for a checkout.</param>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="body">Merchant validation details from the Apple Pay session in the payer's browser.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public async Task<ApiResponse<JsonDocument>> CreateApplePaySessionAsync(string checkoutId, CheckoutsCreateApplePaySessionRequest? body = null, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -276,7 +276,7 @@ public async Task<ApiResponse<JsonDocument>> CreateApplePaySessionAsync(string c
/// Deactivate a checkout
/// </summary>
/// <remarks>Deactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public ApiResponse<Checkout> Deactivate(string checkoutId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -335,7 +335,7 @@ public ApiResponse<Checkout> Deactivate(string checkoutId, RequestOptions? reque
/// Deactivate a checkout
/// </summary>
/// <remarks>Deactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public async Task<ApiResponse<Checkout>> DeactivateAsync(string checkoutId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -393,8 +393,8 @@ public async Task<ApiResponse<Checkout>> DeactivateAsync(string checkoutId, Requ
/// <summary>
/// Retrieve a checkout
/// </summary>
/// <remarks>Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <remarks>Retrieves a checkout by its SumUp checkout_id. After processing a payment, returning from a redirect, or receiving a checkout notification, retrieve the checkout to confirm its current status before updating your order or displaying the payment outcome to the payer.</remarks>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public ApiResponse<CheckoutSuccess> Get(string checkoutId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -447,8 +447,8 @@ public ApiResponse<CheckoutSuccess> Get(string checkoutId, RequestOptions? reque
/// <summary>
/// Retrieve a checkout
/// </summary>
/// <remarks>Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <remarks>Retrieves a checkout by its SumUp checkout_id. After processing a payment, returning from a redirect, or receiving a checkout notification, retrieve the checkout to confirm its current status before updating your order or displaying the payment outcome to the payer.</remarks>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
public async Task<ApiResponse<CheckoutSuccess>> GetAsync(string checkoutId, RequestOptions? requestOptions = null, CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -601,7 +601,7 @@ public async Task<ApiResponse<IEnumerable<CheckoutSuccess>>> ListAsync(Checkouts
/// <summary>
/// Get available payment methods
/// </summary>
/// <remarks>Get payment methods available for the given merchant to use with a checkout.</remarks>
/// <remarks>Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filters to check eligibility for a particular payment before presenting payment options to the payer.</remarks>
/// <param name="merchantCode">Short unique identifier for the merchant.</param>
/// <param name="options">Query and header parameters for the request.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
Expand Down Expand Up @@ -654,7 +654,7 @@ public ApiResponse<CheckoutsListAvailablePaymentMethodsResponse> ListAvailablePa
/// <summary>
/// Get available payment methods
/// </summary>
/// <remarks>Get payment methods available for the given merchant to use with a checkout.</remarks>
/// <remarks>Lists the payment methods available to the merchant for checkout payments. Use the optional amount and currency filters to check eligibility for a particular payment before presenting payment options to the payer.</remarks>
/// <param name="merchantCode">Short unique identifier for the merchant.</param>
/// <param name="options">Query and header parameters for the request.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
Expand Down Expand Up @@ -707,8 +707,8 @@ public async Task<ApiResponse<CheckoutsListAvailablePaymentMethodsResponse>> Lis
/// <summary>
/// Process a checkout
/// </summary>
/// <remarks>:::caution[PCI DSS compliance required] When you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable PCI DSS requirements. You should only use this integration if your environment is appropriately PCI DSS compliant. ::: Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the Create a checkout endpoint. Follow this request with Retrieve a checkout to confirm its status.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <remarks>:::caution[PCI DSS compliance required] When you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable PCI DSS requirements. You should only use this integration if your environment is appropriately PCI DSS compliant. ::: Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the Create a checkout endpoint. 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 by itself mean the checkout is paid.</remarks>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="body">Details of the payment instrument for processing the checkout.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
Expand Down Expand Up @@ -776,8 +776,8 @@ public ApiResponse<CheckoutsProcessResponse> Process(string checkoutId, ProcessC
/// <summary>
/// Process a checkout
/// </summary>
/// <remarks>:::caution[PCI DSS compliance required] When you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable PCI DSS requirements. You should only use this integration if your environment is appropriately PCI DSS compliant. ::: Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the Create a checkout endpoint. Follow this request with Retrieve a checkout to confirm its status.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <remarks>:::caution[PCI DSS compliance required] When you submit raw card details directly to the Checkout API, your systems store, process, or transmit cardholder data and are therefore subject to applicable PCI DSS requirements. You should only use this integration if your environment is appropriately PCI DSS compliant. ::: Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the Create a checkout endpoint. 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 by itself mean the checkout is paid.</remarks>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="body">Details of the payment instrument for processing the checkout.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
Expand Down Expand Up @@ -846,7 +846,7 @@ public async Task<ApiResponse<CheckoutsProcessResponse>> ProcessAsync(string che
/// Update a checkout
/// </summary>
/// <remarks>Updates the amount, currency, description, reference, expiration, or customer associated with an existing checkout. Only the supplied fields are updated. This request changes the checkout details; it does not charge a payment instrument. Process the checkout separately to attempt a payment.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="body">Details for updating a checkout resource.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
Expand Down Expand Up @@ -905,7 +905,7 @@ public ApiResponse<Checkout> Update(string checkoutId, CheckoutUpdateRequest bod
/// Update a checkout
/// </summary>
/// <remarks>Updates the amount, currency, description, reference, expiration, or customer associated with an existing checkout. Only the supplied fields are updated. This request changes the checkout details; it does not charge a payment instrument. Process the checkout separately to attempt a payment.</remarks>
/// <param name="checkoutId">Unique identifier of the checkout resource.</param>
/// <param name="checkoutId">SumUp-generated id returned when creating a checkout. Use this value to retrieve, update, process, or deactivate the checkout.</param>
/// <param name="body">Details for updating a checkout resource.</param>
/// <param name="requestOptions">Optional per-request overrides.</param>
/// <param name="cancellationToken">Token used to cancel the request.</param>
Expand Down
Loading
Loading