SumUp
SumUp Checkouts API

Checkouts represent online payment sessions that you create before attempting to charge a payer. A checkout captures the payment intent, such as the amount, currency, merchant, and optional customer or redirect settings, and then moves through its lifecycle as you process it. Use this tag to: - create a checkout before collecting or confirming payment details - process the checkout with a card, saved card, wallet, or supported alternative payment method - retrieve or list checkouts to inspect their current state and associated payment attempts - deactivate a checkout that should no longer be used Typical workflow: - create a checkout with the order amount, currency, and merchant information - process the checkout through SumUp client tools such as the [Payment Widget and Swift Checkout SDK](https://developer.sumup.com/online-payments/checkouts) - retrieve the checkout or use the Transactions endpoints to inspect the resulting payment record Checkouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting payment outcome.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: SumUp REST Checkouts API
  version: 1.0.0
  description: 'SumUp’s REST API operates with [JSON](https://www.json.org/json-en.html) HTTP requests and responses. The request bodies are sent through resource-oriented URLs and use the standard [HTTP response codes](https://developer.mozilla.org/docs/Web/HTTP/Status).


    You can experiment and work on your integration in a sandbox that doesn''t affect your regular data and doesn''t process real transactions. To create a sandbox merchant account visit the [dashboard](https://me.sumup.com/settings/developer). To use the sandbox when interacting with SumUp APIs [create an API](https://me.sumup.com/settings/api-keys) key and use it for [authentication](https://developer.sumup.com/api/authentication).'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://api.sumup.com
  description: Production server
tags:
- name: Checkouts
  description: 'Checkouts represent online payment sessions that you create before attempting to charge a payer. A checkout captures the payment intent, such as the amount, currency, merchant, and optional customer or redirect settings, and then moves through its lifecycle as you process it.


    Use this tag to:

    - create a checkout before collecting or confirming payment details

    - process the checkout with a card, saved card, wallet, or supported alternative payment method

    - retrieve or list checkouts to inspect their current state and associated payment attempts

    - deactivate a checkout that should no longer be used


    Typical workflow:

    - create a checkout with the order amount, currency, and merchant information

    - process the checkout through SumUp client tools such as the [Payment Widget and Swift Checkout SDK](https://developer.sumup.com/online-payments/checkouts)

    - retrieve the checkout or use the Transactions endpoints to inspect the resulting payment record


    Checkouts are used to initiate and orchestrate online payments. Transactions remain the authoritative record of the resulting payment outcome.'
  x-core-objects:
  - $ref: '#/components/schemas/Checkout'
paths:
  /v0.1/merchants/{merchant_code}/payment-methods:
    get:
      operationId: GetPaymentMethods
      summary: Get available payment methods
      description: Get payment methods available for the given merchant to use with a checkout.
      parameters:
      - name: merchant_code
        in: path
        description: The SumUp merchant code.
        required: true
        schema:
          type: string
          example: MH4H92C7
      - name: amount
        in: query
        description: The amount for which the payment methods should be eligible, in major units.
        required: false
        schema:
          type: number
          example: 9.99
      - name: currency
        in: query
        description: The currency for which the payment methods should be eligible.
        required: false
        schema:
          type: string
          example: EUR
      responses:
        '200':
          description: Available payment methods
          content:
            application/json:
              schema:
                type: object
                properties:
                  available_payment_methods:
                    type: array
                    items:
                      type: object
                      required:
                      - id
                      properties:
                        id:
                          description: The ID of the payment method.
                          type: string
                          example: qr_code_pix
                    example:
                    - id: apple_pay
                    - id: blik
              examples:
                success:
                  description: Available payment methods
                  value:
                    available_payment_methods:
                    - id: apple_pay
                    - id: blik
        '400':
          description: The request is invalid for the submitted query parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailsError'
              examples:
                Invalid_Parameter:
                  description: One or more of the parameters are invalid.
                  value:
                    failed_constraints:
                    - message: Currency must also be specified when filtering by amount
                      reference: currency
                    status: 400
                    title: Bad Request
      security:
      - apiKey: []
      - oauth2: []
      tags:
      - Checkouts
      x-codegen:
        method_name: list_available_payment_methods
      x-scopes: []
  /v0.1/checkouts:
    post:
      operationId: CreateCheckout
      summary: Create a checkout
      description: 'Creates a new payment checkout resource. The unique `checkout_reference` created by this request, is used for further manipulation of the checkout.


        For 3DS checkouts, add the `redirect_url` parameter to your request body schema.

        To use the [Hosted Checkout](https://developer.sumup.com/online-payments/checkouts/hosted-checkout/) page, set the `hosted_checkout.enabled` to `true`.


        Follow by processing a checkout to charge the provided payment instrument.'
      requestBody:
        description: Details for creating a checkout resource.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckoutCreateRequest'
            examples:
              Checkout:
                description: Standard request body for creating a checkout
                value:
                  checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                  amount: 10.1
                  currency: EUR
                  merchant_code: MH4H92C7
                  description: Purchase
                  valid_until: 2020-02-29 10:56:56+00:00
                  redirect_url: https://sumup.com
              Checkout3DS:
                description: Create a 3DS checkout
                value:
                  checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                  amount: 10.1
                  currency: EUR
                  merchant_code: MH4H92C7
                  description: Purchase
                  return_url: http://example.com/
                  customer_id: 831ff8d4cd5958ab5670
                  redirect_url: https://mysite.com/completed_purchase
              CheckoutAPM:
                description: Create an Alternative Payment Method checkout
                value:
                  checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                  amount: 10.1
                  currency: EUR
                  merchant_code: MH4H92C7
                  redirect_url: https://mysite.com/completed_purchase
              HostedCheckout:
                description: Create a checkout with a SumUp-hosted payment page
                x-beta: true
                value:
                  checkout_reference: b50pr914-6k0e-3091-a592-890010285b3d
                  amount: 12
                  currency: EUR
                  merchant_code: MCXXXXXX
                  description: A sample checkout
                  hosted_checkout:
                    enabled: true
      responses:
        '201':
          description: Returns the created checkout resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Checkout'
              examples:
                Checkout:
                  description: Standard response body for a successfully created checkout
                  value:
                    checkout_reference: 8ea25ec3-3293-40e9-a165-6d7f3b3073c5
                    amount: 10.1
                    currency: EUR
                    merchant_code: MH4H92C7
                    merchant_country: DE
                    description: My Checkout
                    return_url: http://example.com
                    id: 88fcf8de-304d-4820-8f1c-ec880290eb92
                    status: PENDING
                    date: 2020-02-29 10:56:56+00:00
                    valid_until: 2020-02-29 10:56:56+00:00
                    customer_id: 831ff8d4cd5958ab5670
                    mandate:
                      type: recurrent
                      status: active
                      merchant_code: MH4H92C7
                    transactions:
                    - id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                      transaction_code: TEENSK4W2K
                      amount: 10.1
                      currency: EUR
                      timestamp: 2020-02-29 10:56:56.876000+00:00
                      status: SUCCESSFUL
                      payment_type: ECOM
                      installments_count: 1
                      merchant_code: MH4H92C7
                      vat_amount: 6
                      tip_amount: 3
                      entry_mode: CUSTOMER_ENTRY
                      auth_code: '012345'
                Checkout3DS:
                  description: Response body for a successfully created 3DS checkout
                  value:
                    checkout_reference: 8ea25ec3-3293-40e9-a165-6d7f3b3073c5
                    amount: 10.1
                    currency: EUR
                    description: My Checkout
                    return_url: http://example.com
                    id: 88fcf8de-304d-4820-8f1c-ec880290eb92
                    status: PENDING
                    date: 2020-02-29 10:56:56+00:00
                    valid_until: 2020-02-29 10:56:56+00:00
                    customer_id: 831ff8d4cd5958ab5670
                    redirect_url: https://mysite.com/completed_purchase
                    transactions:
                    - id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                      transaction_code: TEENSK4W2K
                      amount: 10.1
                      currency: EUR
                      timestamp: 2020-02-29 10:56:56.876000+00:00
                      status: SUCCESSFUL
                      payment_type: ECOM
                      installments_count: 1
                      merchant_code: MH4H92C7
                      vat_amount: 6
                      tip_amount: 3
                      entry_mode: CUSTOMER_ENTRY
                      auth_code: '012345'
                CheckoutAPM:
                  description: Response body for APMs, including Blik, iDeal, ...
                  value:
                    checkout_reference: 8ea25ec3-3293-40e9-a165-6d7f3b3073c5
                    amount: 10.1
                    currency: EUR
                    merchant_code: MH4H92C7
                    description: My Checkout
                    return_url: http://example.com
                    id: 88fcf8de-304d-4820-8f1c-ec880290eb92
                    status: PENDING
                    date: 2021-06-29 11:08:36+00:00
                    merchant_name: My company
                    merchant_country: DE
                    redirect_url: https://sumup.com
                    purpose: CHECKOUT
                    transactions:
                    - id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                      transaction_code: TEENSK4W2K
                      amount: 10.1
                      currency: EUR
                      timestamp: 2020-02-29 10:56:56.876000+00:00
                      status: SUCCESSFUL
                      payment_type: ECOM
                      installments_count: 1
                      merchant_code: MH4H92C7
                      vat_amount: 6
                      tip_amount: 3
                      entry_mode: CUSTOMER_ENTRY
                      auth_code: '012345'
                HostedCheckout:
                  description: Response body for a checkout with a SumUp-hosted payment page
                  value:
                    checkout_reference: b50pr914-6k0e-3091-a592-890010285b3d
                    amount: 12
                    currency: EUR
                    merchant_code: MCXXXXXX
                    merchant_country: DE
                    merchant_name: Sample Shop
                    description: A sample checkout
                    id: 64553e20-3f0e-49e4-8af3-fd0eca86ce91
                    status: PENDING
                    date: 2000-01-01 12:49:24.899000+00:00
                    purpose: CHECKOUT
                    hosted_checkout:
                      enabled: true
                    hosted_checkout_url: https://checkout.sumup.com/pay/8f9316a3-cda9-42a9-9771-54d534315676
                    transactions: []
        '400':
          description: The request body is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorExtended'
              examples:
                Missing_Parameter:
                  description: A required parameter is missing.
                  value:
                    message: Validation error
                    error_code: MISSING
                    param: merchant_code
        '401':
          description: The request is not authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                Problem_Details:
                  description: Unauthorized response returned by API gateway.
                  value:
                    detail: Unauthorized.
                    status: 401
                    title: Unauthorized
                    trace_id: 3c77294349d3b5647ea2d990f0d8f017
                    type: https://developer.sumup.com/problem/unauthorized
        '403':
          description: The request isn't sufficiently authorized to create a checkout.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorForbidden'
              examples:
                Forbidden:
                  description: You do not have the required permission for making this request.
                  value:
                    error_message: checkout_payments_not_allowed
                    error_code: FORBIDDEN
                    status_code: '403'
        '409':
          description: A checkout already exists for the provided unique parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Existing_Checkout:
                  description: A resource with the specified parameters already exists on the server.
                  value:
                    error_code: DUPLICATED_CHECKOUT
                    message: Checkout with this checkout reference and pay to email already exists
      security:
      - apiKey: []
      - oauth2:
        - payments
      tags:
      - Checkouts
      x-codegen:
        method_name: create
      x-scopes:
      - payments
    get:
      operationId: ListCheckouts
      summary: List checkouts
      description: Lists created checkout resources according to the applied `checkout_reference`.
      parameters:
      - name: checkout_reference
        in: query
        description: Filters the list of checkout resources by the unique ID of the checkout.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Returns a list of checkout resources.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CheckoutSuccess'
              example:
              - checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                amount: 10.1
                currency: EUR
                merchant_code: MH4H92C7
                description: Purchase
                id: 4e425463-3e1b-431d-83fa-1e51c2925e99
                status: PENDING
                date: 2020-02-29 10:56:56+00:00
        '401':
          description: The request is not authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                Problem_Details:
                  description: Unauthorized response returned by API gateway.
                  value:
                    detail: Unauthorized.
                    status: 401
                    title: Unauthorized
                    trace_id: 3c77294349d3b5647ea2d990f0d8f017
                    type: https://developer.sumup.com/problem/unauthorized
      security:
      - apiKey: []
      - oauth2:
        - payments
      tags:
      - Checkouts
      x-codegen:
        method_name: list
      x-scopes:
      - payments
  /v0.1/checkouts/{checkout_id}:
    parameters:
    - name: checkout_id
      in: path
      description: Unique ID of the checkout resource.
      required: true
      schema:
        type: string
    get:
      operationId: GetCheckout
      summary: Retrieve a checkout
      description: Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.
      responses:
        '200':
          description: Returns the requested checkout resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutSuccess'
              example:
                checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                amount: 10.1
                currency: EUR
                merchant_code: MH4H92C7
                description: Purchase
                id: 4e425463-3e1b-431d-83fa-1e51c2925e99
                status: PENDING
                date: 2020-02-29 10:56:56+00:00
                transaction_code: TEENSK4W2K
                transaction_id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
        '401':
          description: The request is not authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                Problem_Details:
                  description: Unauthorized response returned by API gateway.
                  value:
                    detail: Unauthorized.
                    status: 401
                    title: Unauthorized
                    trace_id: 3c77294349d3b5647ea2d990f0d8f017
                    type: https://developer.sumup.com/problem/unauthorized
        '404':
          description: The requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Not_Found:
                  description: The identified resource is not found on the server.
                  value:
                    error_code: NOT_FOUND
                    message: Resource not found
      security:
      - apiKey: []
      - oauth2:
        - payments
      tags:
      - Checkouts
      x-codegen:
        method_name: get
      x-scopes:
      - payments
    put:
      operationId: ProcessCheckout
      summary: Process a checkout
      description: '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.'
      requestBody:
        description: Details of the payment instrument for processing the checkout.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessCheckout'
            examples:
              ProcessCard:
                description: Process a checkout with a card
                value:
                  payment_type: card
                  installments: 1
                  mandate:
                    type: recurrent
                    user_agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.104 Safari/537.36
                    user_ip: 172.217.169.174
                  card:
                    type: VISA
                    name: John Doe
                    number: '1234567890123456'
                    expiry_year: '2023'
                    expiry_month: '01'
                    cvv: '123'
                    zip_code: '12345'
              ProcessToken:
                description: Process a checkout with a token
                value:
                  payment_type: card
                  installments: 1
                  token: ba85dfee-c3cf-48a6-84f5-d7d761fbba50
                  customer_id: MEDKHDTI
              ProcessBoleto:
                description: Process a checkout with Boleto
                value:
                  payment_type: boleto
                  personal_details:
                    email: user@example.com
                    first_name: John
                    last_name: Doe
                    tax_id: 423.378.593-47
                    address:
                      country: BR
                      city: São Paulo
                      line1: Rua Gilberto Sabino, 215
                      state: SP
                      postal_code: 05425-020
              ProcessiDeal:
                description: Process a checkout with iDeal
                value:
                  payment_type: ideal
                  personal_details:
                    email: user@example.com
                    first_name: John
                    last_name: Doe
                    address:
                      country: NL
              ProcessBancontact:
                description: Process a checkout with Bancontact
                value:
                  payment_type: bancontact
                  personal_details:
                    email: user@example.com
                    first_name: John
                    last_name: Doe
                    address:
                      country: BE
      responses:
        '200':
          description: Returns the checkout resource after a processing attempt.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutSuccess'
              examples:
                CheckoutSuccessCard:
                  description: Successfully processed checkout with a card
                  value:
                    checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                    amount: 10.1
                    currency: EUR
                    merchant_code: MH4H92C7
                    description: Purchase
                    return_url: http://example.com
                    id: 4e425463-3e1b-431d-83fa-1e51c2925e99
                    status: PENDING
                    date: 2020-02-29 10:56:56+00:00
                    valid_until: 2020-02-29 10:56:56+00:00
                    customer_id: 831ff8d4cd5958ab5670
                    mandate:
                      type: recurrent
                      status: active
                      merchant_code: MH4H92C7
                    transactions:
                    - id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                      transaction_code: TEENSK4W2K
                      amount: 10.1
                      currency: EUR
                      timestamp: 2020-02-29 10:56:56.876000+00:00
                      status: SUCCESSFUL
                      payment_type: ECOM
                      installments_count: 1
                      merchant_code: MH4H92C7
                      vat_amount: 6
                      tip_amount: 3
                      entry_mode: CUSTOMER_ENTRY
                      auth_code: '053201'
                    transaction_code: TEENSK4W2K
                    transaction_id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                CheckoutSuccessToken:
                  description: Successfully processed checkout with a token
                  value:
                    checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                    amount: 10.1
                    currency: EUR
                    merchant_code: MH4H92C7
                    description: Purchase with token
                    id: 4e425463-3e1b-431d-83fa-1e51c2925e99
                    status: PENDING
                    date: 2020-02-29 10:56:56+00:00
                    transaction_code: TEENSK4W2K
                    transaction_id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                    merchant_name: Sample Merchant
                    redirect_url: https://mysite.com/completed_purchase
                    customer_id: 831ff8d4cd5958ab5670
                    payment_instrument:
                      token: e76d7e5c-9375-4fac-a7e7-b19dc5302fbc
                    transactions:
                    - id: 410fc44a-5956-44e1-b5cc-19c6f8d727a4
                      transaction_code: TEENSK4W2K
                      amount: 10.1
                      currency: EUR
                      timestamp: 2020-02-29 10:56:56.876000+00:00
                      status: SUCCESSFUL
                      payment_type: ECOM
                      installments_count: 1
                      merchant_code: MH4H92C7
                      vat_amount: 6
                      tip_amount: 3
                      entry_mode: CUSTOMER_ENTRY
                      auth_code: '053201'
                CheckoutSuccessBoleto:
                  description: Successfully processed checkout with Boleto
                  value:
                    checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                    amount: 10.1
                    currency: BRL
                    merchant_code: MH4H92C7
                    description: Boleto checkout
                    id: 4e425463-3e1b-431d-83fa-1e51c2925e99
                    status: PENDING
                    date: 2021-07-06 12:34:02+00:00
                    merchant_name: Sample shop
                    boleto:
                      barcode: '34191090081790614310603072340007886840000000200'
                      url: https://checkouts.sample.com/v0.1/checkouts/2e7a36cc-7897-446b-a966-952ab5f049ea/boleto
                    redirect_url: https://website.com
                    purpose: CHECKOUT
                    transactions:
                    - id: debd2986-9852-4e86-8a8e-7ea9c87dd679
                      transaction_code: TEN3E696NP
                      merchant_code: MH4H92C9
                      amount: 10.1
                      vat_amount: 6
                      tip_amount: 3
                      currency: BRL
                      timestamp: 2021-07-06 12:34:16.460000+00:00
                      status: PENDING
                      payment_type: BOLETO
                      entry_mode: BOLETO
                      installments_count: 1
                CheckoutSuccessiDeal:
                  description: Successfully processed checkout with iDeal
                  value:
                    next_step:
                      url: https://r3.girogate.de/ti/simideal
                      method: GET
                      payload:
                        tx: '961473700'
                        rs: ILnaUeQTKJ184fVrjGILrLjePX9E4rmz
                        cs: c8bc0ea231f8372431ca22d6f8319f8de0263d0b1705759ed27155f245f193c5
                      full: https://r3.girogate.de/ti/simideal?tx=961473700&rs=ILnaUeQTKJ184fVrjGILrLjePX9E4rmz&cs=c8bc0ea231f8372431ca22d6f8319f8de0263d0b1705759ed27155f245f193c5
                      mechanism:
                      - browser
                CheckoutSuccessBancontact:
                  description: Successfully processed checkout with Bancontact
                  value:
                    next_step:
                      url: https://r3.girogate.de/ti/simbcmc
                      method: GET
                      payload:
                        tx: '624788471'
                        rs: 5MioXoKt2Gwj9dLgqAX1bMRBuT5xTSdB
                        cs: 697edacdd9175f3f99542500fa0ff08280b66aaff3c2641a2e212e4b039473cc
                      full: https://r3.girogate.de/ti/simbcmc?tx=624788471&rs=5MioXoKt2Gwj9dLgqAX1bMRBuT5xTSdB&cs=697edacdd9175f3f99542500fa0ff08280b66aaff3c2641a2e212e4b039473cc
                      mechanism:
                      - browser
        '202':
          description: Returns the next required action for asynchronous checkout processing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckoutAccepted'
        '400':
          description: The request body is invalid for processing the checkout.
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/ErrorExtended'
                - type: array
                  description: List of error messages.
                  items:
                    $ref: '#/components/schemas/ErrorExtended'
              examples:
                Invalid_Parameter:
                  description: A required parameter has an invalid value.
                  value:
                    message: Validation error
                    error_code: INVALID
                    param: card.expiry_year
                Multiple_Invalid_Parameters:
                  description: Multiple required parameters have invalid values.
                  value:
                  - error_code: INVALID
                    message: Validation error
                    param: card.name
                  - error_code: INVALID
                    message: Validation error
                    param: card.number
                  - error_code: INVALID
                    message: Validation error
                    param: card.expiry_year
        '401':
          description: The request is not authorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Problem'
              examples:
                Problem_Details:
                  description: Unauthorized response returned by API gateway.
                  value:
                    detail: Unauthorized.
                    status: 401
                    title: Unauthorized
                    trace_id: 3c77294349d3b5647ea2d990f0d8f017
                    type: https://developer.sumup.com/problem/unauthorized
        '404':
          description: The requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Not_Found:
                  description: The identified resource is not found on the server.
                  value:
                    error_code: NOT_FOUND
                    message: Resource not found
        '409':
          description: The request conflicts with the current state of the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Checkout_Processed:
                  description: The identified checkout resource is already processed.
                  value:
                    error_code: CHECKOUT_PROCESSED
                    message: Checkout is already processed
      security:
      - apiKey: []
      - oauth2: []
      tags:
      - Checkouts
      x-codegen:
        method_name: process
      x-scopes: []
    delete:
      operationId: DeactivateCheckout
      summary: Deactivate a checkout
      description: Deactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.
      responses:
        '200':
          description: Returns the checkout object after successful deactivation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Checkout'
              example:
                checkout_reference: f00a8f74-b05d-4605-bd73-2a901bae5802
                id: 817340ce-f1d9-4609-b90a-6152f8ee267j
                amount: 2
                currency: EUR
                merchant_code: MH4H92C7
                description: Deletion example
                purpose: CHECKOUT
                status: EXPIRED
                date: 2020-02-29 10:56:56+00:00
                valid_until: 2020-02-29 10:56:56+00:00
 

# --- truncated at 32 KB (67 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sumup/refs/heads/main/openapi/sumup-checkouts-api-openapi.yml
SumUp Checkouts API

Documentation

Specifications

Other Resources

OpenAPI Specification
