> ## Documentation Index
> Fetch the complete documentation index at: https://developer.kalixo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Send a test event to a webhook endpoint

> Sandbox only. Signs a sample event of `type` with the endpoint's secret
and sends it to the endpoint once, synchronously. The response tells you
whether your endpoint answered with a `2xx`.

Test events are not stored in `GET /v1/events`, are not retried and go
only to this endpoint, even if it does not subscribe to `type` or is
disabled. Their objects do not exist: `reference` is `kalixo_test_event`
and `metadata.kalixo_test_event` is `"true"` where the object has them.




## OpenAPI

````yaml /checkout/openapi.yaml post /v1/test-helpers/webhook-endpoints/{id}/send-event
openapi: 3.1.0
info:
  title: Kalixo Checkout API
  version: '2026-10-01'
  summary: Payment orchestration API for Kalixo partners.
  description: >
    Kalixo Checkout lets partners collect payments from their shoppers through
    one

    provider-neutral API. Kalixo is merchant of record and handles payment

    processing, so partners never integrate a payment provider directly.


    - Amounts are integers in the currency's minor unit (EUR 49.99 = `4999`).

    - Server endpoints use a secret key (`kc_sk_test_...` or `kc_sk_live_...`).

    - Client endpoints are called by `Kalixo.js` with a publishable key and the
      checkout session's `client_secret`.
    - Every `POST` with a secret key requires an `Idempotency-Key` header.

    - Every response has a `Request-Id` header. Errors repeat it in
    `error.request_id`;
      include it when you contact Kalixo support.
    - Bursts above about 50 requests per second per API key can be rejected with
      `429 rate_limit_error`. Retry with exponential backoff.
    - Request bodies with unknown fields are rejected (`parameter_invalid`).
    Responses
      and events can gain fields at any time; ignore the ones you do not know.
  contact:
    name: Kalixo Checkout integrations
    email: integrations@kalixo.io
  license:
    name: Proprietary
    url: https://kalixo.io/legal
servers:
  - url: https://checkout.kalixo.io
    description: Live
  - url: https://sandbox.checkout.kalixo.io
    description: Sandbox (test keys only, never moves money)
security:
  - secretKey: []
tags:
  - name: Checkout sessions
    description: >-
      Create a session with the amount to charge, then show it with Kalixo.js or
      the hosted checkout.
  - name: Payments
    description: Read payments and capture or cancel authorized payments.
  - name: Refunds
    description: Full and partial refunds of captured payments.
  - name: Payment links
    description: Kalixo-hosted payment links that survive provider switches.
  - name: Customers
    description: Customers and their stored payment methods for one-click checkout.
  - name: Disputes
    description: Chargebacks and information requests, plus evidence upload.
  - name: Events
    description: The event log behind webhooks.
  - name: Webhook endpoints
    description: Where Kalixo delivers signed events.
  - name: Reports
    description: CSV exports of transactions for reconciliation and partner invoicing.
  - name: Test helpers
    description: Sandbox only. Send test webhook events and simulate disputes.
  - name: Client
    description: Called by Kalixo.js and the hosted checkout. Not for partner servers.
paths:
  /v1/test-helpers/webhook-endpoints/{id}/send-event:
    parameters:
      - $ref: '#/components/parameters/PathId'
    post:
      tags:
        - Test helpers
      summary: Send a test event to a webhook endpoint
      description: |
        Sandbox only. Signs a sample event of `type` with the endpoint's secret
        and sends it to the endpoint once, synchronously. The response tells you
        whether your endpoint answered with a `2xx`.

        Test events are not stored in `GET /v1/events`, are not retried and go
        only to this endpoint, even if it does not subscribe to `type` or is
        disabled. Their objects do not exist: `reference` is `kalixo_test_event`
        and `metadata.kalixo_test_event` is `"true"` where the object has them.
      operationId: sendTestWebhookEvent
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  allOf:
                    - $ref: '#/components/schemas/EventType'
                  default: payment.captured
            examples:
              paymentCaptured:
                $ref: '#/components/examples/SendTestEvent'
      responses:
        '200':
          description: The delivery result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookTestDelivery'
              examples:
                delivered:
                  $ref: '#/components/examples/TestDelivery'
        '400':
          $ref: '#/components/responses/TestHelperBadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/IdempotencyConflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    PathId:
      name: id
      in: path
      required: true
      schema:
        type: string
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: true
      description: >
        Unique key per logical request, reused on retries. 1 to 255 characters,
        kept for

        24 hours. A retry with the same key and body returns the stored response
        with the

        header `Idempotent-Replayed: true`.
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    EventType:
      type: string
      enum:
        - checkout_session.completed
        - checkout_session.expired
        - payment.authorized
        - payment.captured
        - payment.partially_captured
        - payment.failed
        - payment.canceled
        - payment.expired
        - payment.amount_updated
        - payment.amount_mismatch
        - payment.fraud_reported
        - capture.failed
        - refund.succeeded
        - refund.failed
        - dispute.created
        - dispute.updated
        - dispute.funds_withdrawn
        - dispute.won
        - dispute.lost
        - payment_method.attached
        - payment_method.updated
        - payment_method.detached
    WebhookTestDelivery:
      type: object
      required:
        - object
        - webhook_endpoint
        - event
        - delivered
        - status_code
        - error
        - duration_ms
      properties:
        object:
          type: string
          const: webhook_test_delivery
        webhook_endpoint:
          type: string
          examples:
            - we_01JABCDEF
        event:
          $ref: '#/components/schemas/Event'
        delivered:
          type: boolean
          description: True if your endpoint answered with a `2xx`.
        status_code:
          type:
            - integer
            - 'null'
          description: >-
            HTTP status your endpoint returned. `null` if it could not be
            reached.
        error:
          type:
            - string
            - 'null'
          description: Why the delivery failed, for example `HTTP 500` or a timeout.
        duration_ms:
          type: integer
    Event:
      type: object
      required:
        - id
        - type
        - api_version
        - created_at
        - livemode
        - partner_id
        - data
      properties:
        id:
          type: string
          examples:
            - evt_01JABCDEF
        type:
          $ref: '#/components/schemas/EventType'
        api_version:
          type: string
          examples:
            - '2026-10-01'
        created_at:
          type: string
          format: date-time
        livemode:
          type: boolean
        partner_id:
          type: string
        data:
          type: object
          required:
            - object
          properties:
            object:
              description: Full snapshot of the object after the change.
              oneOf:
                - $ref: '#/components/schemas/Payment'
                - $ref: '#/components/schemas/CheckoutSession'
                - $ref: '#/components/schemas/Refund'
                - $ref: '#/components/schemas/Capture'
                - $ref: '#/components/schemas/Dispute'
                - $ref: '#/components/schemas/PaymentMethod'
            related:
              type: object
              description: Related objects, for example the payment of a refund event.
              additionalProperties: true
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - not_found_error
                - idempotency_error
                - payment_error
                - rate_limit_error
                - api_error
            code:
              type: string
              examples:
                - amount_locked
              description: >-
                Stable machine-readable code. Branch on `code`, not on
                `message`.
            decline_code:
              type:
                - string
                - 'null'
              description: Set on declined payments only.
            message:
              type: string
              description: Human-readable explanation. Can change; do not parse it.
            param:
              type:
                - string
                - 'null'
              description: >-
                The request field or header that caused the error, when there is
                one.
            request_id:
              type: string
              description: >-
                Same as the `Request-Id` response header. Include it when you
                contact support.
    Payment:
      type: object
      required:
        - id
        - object
        - status
        - amount
        - currency
        - amount_authorized
        - amount_captured
        - amount_refunded
        - amount_disputed
        - amount_capturable
        - capture_method
        - reference
        - metadata
        - version
        - created_at
        - livemode
      properties:
        id:
          type: string
          examples:
            - pay_01JABCDEF
        object:
          type: string
          const: payment
        status:
          $ref: '#/components/schemas/PaymentStatus'
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        amount_authorized:
          $ref: '#/components/schemas/Amount'
        amount_captured:
          $ref: '#/components/schemas/Amount'
        amount_refunded:
          $ref: '#/components/schemas/Amount'
        amount_disputed:
          $ref: '#/components/schemas/Amount'
        amount_capturable:
          $ref: '#/components/schemas/Amount'
        amount_mismatch:
          type: boolean
          description: >-
            True if the provider reported an amount different from the expected
            one.
        capture_method:
          $ref: '#/components/schemas/CaptureMethod'
        checkout_session:
          type: string
        customer:
          type:
            - string
            - 'null'
        reference:
          type: string
        description:
          type:
            - string
            - 'null'
        payment_method:
          description: How the shopper paid. `null` until an attempt is authorised.
          oneOf:
            - $ref: '#/components/schemas/PaymentMethodDetails'
            - type: 'null'
        last_payment_error:
          oneOf:
            - $ref: '#/components/schemas/PaymentError'
            - type: 'null'
        metadata:
          $ref: '#/components/schemas/Metadata'
        version:
          type: integer
          description: Increases with every change.
        authorized_at:
          type:
            - string
            - 'null'
          format: date-time
        captured_at:
          type:
            - string
            - 'null'
          format: date-time
        canceled_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        livemode:
          type: boolean
    CheckoutSession:
      type: object
      required:
        - id
        - object
        - status
        - payment
        - amount
        - currency
        - country
        - reference
        - capture_method
        - return_url
        - url
        - expires_at
        - created_at
        - livemode
        - metadata
      properties:
        id:
          type: string
          examples:
            - cs_01JABCDEF
        object:
          type: string
          const: checkout_session
        status:
          $ref: '#/components/schemas/CheckoutSessionStatus'
        payment:
          type: string
          description: ID of the payment created with this session.
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        country:
          $ref: '#/components/schemas/Country'
        reference:
          type: string
          description: The partner's order reference.
        description:
          type:
            - string
            - 'null'
        capture_method:
          $ref: '#/components/schemas/CaptureMethod'
        customer:
          type:
            - string
            - 'null'
        customer_email:
          type:
            - string
            - 'null'
        line_items:
          type: array
          items:
            $ref: '#/components/schemas/LineItem'
        store_payment_method:
          type: boolean
        locale:
          type: string
          examples:
            - en-GB
        return_url:
          type: string
          format: uri
        url:
          type:
            - string
            - 'null'
          format: uri
          description: >-
            Hosted checkout URL. Contains the client secret in the URL fragment.
            `null` in list responses and events.
        client_secret:
          type: string
          description: >-
            Pass to Kalixo.js. Do not log or store it in analytics. Omitted in
            list responses and events.
        amount_locked:
          type: boolean
          description: True once the first payment attempt has started.
        payment_link:
          type:
            - string
            - 'null'
        version:
          type: integer
          minimum: 1
          description: >-
            Increases with every change. Ignore a `checkout_session.*` event
            whose session has a lower `version` than the one you stored.
        expires_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        livemode:
          type: boolean
        metadata:
          $ref: '#/components/schemas/Metadata'
    Refund:
      type: object
      required:
        - id
        - object
        - payment
        - amount
        - currency
        - status
        - reason
        - metadata
        - created_at
      properties:
        id:
          type: string
          examples:
            - re_01JABCDEF
        object:
          type: string
          const: refund
        payment:
          type: string
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        status:
          type: string
          enum:
            - pending
            - succeeded
            - failed
        reason:
          type: string
          enum:
            - requested_by_customer
            - duplicate
            - fraudulent
            - amount_mismatch
            - other
        failure_reason:
          type:
            - string
            - 'null'
        metadata:
          $ref: '#/components/schemas/Metadata'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Capture:
      type: object
      required:
        - id
        - object
        - payment
        - amount
        - currency
        - status
        - created_at
      properties:
        id:
          type: string
          examples:
            - cap_01JABCDEF
        object:
          type: string
          const: capture
        payment:
          type: string
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        status:
          type: string
          enum:
            - pending
            - succeeded
            - failed
        failure_reason:
          type:
            - string
            - 'null'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Dispute:
      type: object
      required:
        - id
        - object
        - payment
        - status
        - amount
        - currency
        - created_at
      properties:
        id:
          type: string
          examples:
            - dp_01JABCDEF
        object:
          type: string
          const: dispute
        payment:
          type: string
        status:
          $ref: '#/components/schemas/DisputeStatus'
        amount:
          $ref: '#/components/schemas/Amount'
        currency:
          $ref: '#/components/schemas/Currency'
        reason_code:
          type:
            - string
            - 'null'
        reason:
          type:
            - string
            - 'null'
        evidence_due_by:
          type:
            - string
            - 'null'
          format: date-time
        evidence:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              document_type:
                type: string
              file_name:
                type: string
              created_at:
                type: string
                format: date-time
        version:
          type: integer
          description: Increases with every change.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    PaymentMethod:
      type: object
      required:
        - id
        - object
        - customer
        - type
        - status
        - available
        - created_at
      properties:
        id:
          type: string
          examples:
            - pm_01JABCDEF
        object:
          type: string
          const: payment_method
        customer:
          type: string
        type:
          type: string
          examples:
            - card
        card:
          type:
            - object
            - 'null'
          properties:
            brand:
              type: string
            last4:
              type: string
            exp_month:
              type: integer
            exp_year:
              type: integer
        status:
          type: string
          enum:
            - active
            - detached
        available:
          type: boolean
          description: >-
            False when the partner is routed to a provider that cannot use this
            stored method.
        created_at:
          type: string
          format: date-time
    PaymentStatus:
      type: string
      enum:
        - requires_payment_method
        - processing
        - requires_action
        - authorized
        - partially_captured
        - captured
        - partially_refunded
        - refunded
        - canceled
        - expired
        - disputed
        - charged_back
    Amount:
      type: integer
      format: int64
      minimum: 0
      description: Amount in the currency's minor unit.
    Currency:
      type: string
      pattern: ^[A-Z]{3}$
      description: ISO 4217 currency code, uppercase.
      examples:
        - EUR
    CaptureMethod:
      type: string
      enum:
        - automatic
        - manual
      description: >
        `automatic` captures the payment as soon as the payment provider
        confirms the

        authorisation: you receive `payment.authorized`, then
        `payment.captured`.

        `manual` stops at `authorized` until you call `POST
        /v1/payments/{id}/capture`.

        When you omit it, Kalixo uses your account's default, which is
        `automatic`

        unless Kalixo configured `manual` for your account.
    PaymentMethodDetails:
      type: object
      properties:
        type:
          type: string
          examples:
            - card
            - ideal
            - applepay
            - googlepay
        brand:
          type:
            - string
            - 'null'
          examples:
            - visa
        last4:
          type:
            - string
            - 'null'
        exp_month:
          type:
            - integer
            - 'null'
        exp_year:
          type:
            - integer
            - 'null'
        stored_payment_method:
          type:
            - string
            - 'null'
          description: '`pm_...` if this payment used or saved a stored method.'
    PaymentError:
      type: object
      properties:
        code:
          type: string
          examples:
            - payment_declined
        decline_code:
          type:
            - string
            - 'null'
          examples:
            - insufficient_funds
        message:
          type: string
    Metadata:
      type: object
      description: >-
        Up to 50 keys. Keys up to 40 characters, values up to 500 characters.
        Echoed back unchanged.
      additionalProperties:
        type: string
        maxLength: 500
      maxProperties: 50
    CheckoutSessionStatus:
      type: string
      enum:
        - open
        - complete
        - expired
    Country:
      type: string
      pattern: ^[A-Z]{2}$
      description: ISO 3166-1 alpha-2 country code of the shopper.
      examples:
        - NL
    LineItem:
      type: object
      description: >
        Optional itemisation, stored on the session and sent to the payment
        provider with

        the payment. The sum of `quantity * unit_amount` over all lines must
        equal the session

        `amount` exactly (`line_items_mismatch` otherwise).
      required:
        - name
        - quantity
        - unit_amount
      properties:
        type:
          type: string
          enum:
            - item
            - shipping
            - discount
          default: item
          description: >-
            `discount` lines reduce the total and are the only lines with a
            negative `unit_amount`.
        name:
          type: string
          maxLength: 200
        quantity:
          type: integer
          minimum: 1
        unit_amount:
          type: integer
          format: int64
          description: >
            Price of one unit in the minor unit, **including tax**. Zero or
            positive for

            `item` and `shipping`, zero or negative for `discount`.
          examples:
            - 2500
            - -500
        tax_amount:
          type: integer
          format: int64
          description: >
            Tax included in one unit's `unit_amount`, in the minor unit. Has the
            same sign

            as `unit_amount` and is never larger than it in absolute value.
            Informational:

            Kalixo does not calculate tax.
          examples:
            - 434
        tax_percentage:
          type: integer
          minimum: 0
          maximum: 10000
          description: >-
            Tax rate in basis points (hundredths of a percent). 21% is `2100`,
            5.5% is `550`.
          examples:
            - 2100
        sku:
          type: string
          maxLength: 100
        product_url:
          type: string
          format: uri
        image_url:
          type: string
          format: uri
    DisputeStatus:
      type: string
      enum:
        - needs_response
        - under_review
        - funds_withdrawn
        - won
        - lost
        - accepted
  examples:
    SendTestEvent:
      summary: Send a sample payment.captured event
      value:
        type: payment.captured
    TestDelivery:
      summary: Delivered to your endpoint
      value:
        object: webhook_test_delivery
        webhook_endpoint: we_01M75NE5G1H4J7K1M4N7P2Q5RS
        delivered: true
        status_code: 200
        error: null
        duration_ms: 182
        event:
          id: evt_01M75NG7J3K6M9N3P6Q9R4S7TV
          type: payment.captured
          api_version: '2026-10-01'
          created_at: '2026-10-13T16:21:06.000Z'
          livemode: false
          partner_id: ptn_01M75N0J8SFRJV6H2JGMCJR6Q2
          data:
            object:
              id: pay_01M75NG8K4M7N1P4Q7R1S5T8VW
              object: payment
              status: captured
              amount: 4999
              currency: EUR
              amount_authorized: 4999
              amount_captured: 4999
              amount_refunded: 0
              amount_disputed: 0
              amount_capturable: 0
              amount_mismatch: false
              capture_method: automatic
              checkout_session: cs_01M75NG9M5N8P2Q5R8S2T6V9WX
              customer: null
              reference: kalixo_test_event
              description: Kalixo test event
              payment_method:
                type: card
                brand: visa
                last4: '1111'
                exp_month: 3
                exp_year: 2030
                stored_payment_method: null
              last_payment_error: null
              metadata:
                kalixo_test_event: 'true'
              version: 3
              authorized_at: '2026-10-13T16:21:06.000Z'
              captured_at: '2026-10-13T16:21:06.000Z'
              canceled_at: null
              created_at: '2026-10-13T16:21:06.000Z'
              updated_at: '2026-10-13T16:21:06.000Z'
              livemode: false
    ErrTestModeOnly:
      summary: test_mode_only
      value:
        error:
          type: invalid_request_error
          code: test_mode_only
          decline_code: null
          message: Test helpers are available in the sandbox only
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrTestHelperUnavailable:
      summary: test_helper_unavailable
      value:
        error:
          type: invalid_request_error
          code: test_helper_unavailable
          decline_code: null
          message: >-
            Dispute simulation works only for payments made with the sandbox
            test cards
          param: id
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrParameterInvalid:
      summary: parameter_invalid
      value:
        error:
          type: invalid_request_error
          code: parameter_invalid
          decline_code: null
          message: amount must be an integer number
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrApiKeyMissing:
      summary: api_key_missing
      value:
        error:
          type: authentication_error
          code: api_key_missing
          decline_code: null
          message: Provide your API key in the Authorization header as a Bearer token
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrApiKeyInvalid:
      summary: api_key_invalid
      value:
        error:
          type: authentication_error
          code: api_key_invalid
          decline_code: null
          message: Invalid API key
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrApiKeyModeMismatch:
      summary: api_key_mode_mismatch
      value:
        error:
          type: authentication_error
          code: api_key_mode_mismatch
          decline_code: null
          message: This environment only accepts test keys
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrSecretKeyRequired:
      summary: secret_key_required
      value:
        error:
          type: authentication_error
          code: secret_key_required
          decline_code: null
          message: This endpoint requires a secret key
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrResourceMissing:
      summary: resource_missing
      value:
        error:
          type: not_found_error
          code: resource_missing
          decline_code: null
          message: 'No such payment: ''pay_01M75N56PRT5WA5G2JF25B20RJ'''
          param: id
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrIdempotencyKeyReused:
      summary: idempotency_key_reused
      value:
        error:
          type: idempotency_error
          code: idempotency_key_reused
          decline_code: null
          message: This Idempotency-Key was already used with a different request
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrIdempotencyInProgress:
      summary: idempotency_request_in_progress
      value:
        error:
          type: idempotency_error
          code: idempotency_request_in_progress
          decline_code: null
          message: A request with this Idempotency-Key is still in progress
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrRateLimited:
      summary: rate_limited
      value:
        error:
          type: rate_limit_error
          code: rate_limited
          decline_code: null
          message: Too many requests. Slow down and retry with backoff.
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    ErrInternal:
      summary: internal_error
      value:
        error:
          type: api_error
          code: internal_error
          decline_code: null
          message: An internal error occurred. Retry with the same Idempotency-Key.
          param: null
          request_id: req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
  responses:
    TestHelperBadRequest:
      description: Invalid request (`invalid_request_error`).
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            test_mode_only:
              $ref: '#/components/examples/ErrTestModeOnly'
            test_helper_unavailable:
              $ref: '#/components/examples/ErrTestHelperUnavailable'
            parameter_invalid:
              $ref: '#/components/examples/ErrParameterInvalid'
    Unauthorized:
      description: Missing, invalid or wrong-mode API key (`authentication_error`).
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            api_key_missing:
              $ref: '#/components/examples/ErrApiKeyMissing'
            api_key_invalid:
              $ref: '#/components/examples/ErrApiKeyInvalid'
            api_key_mode_mismatch:
              $ref: '#/components/examples/ErrApiKeyModeMismatch'
            secret_key_required:
              $ref: '#/components/examples/ErrSecretKeyRequired'
    NotFound:
      description: The object does not exist for your account (`not_found_error`).
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            resource_missing:
              $ref: '#/components/examples/ErrResourceMissing'
    IdempotencyConflict:
      description: Idempotency key conflict (`idempotency_error`).
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            idempotency_key_reused:
              $ref: '#/components/examples/ErrIdempotencyKeyReused'
            idempotency_request_in_progress:
              $ref: '#/components/examples/ErrIdempotencyInProgress'
    TooManyRequests:
      description: >-
        Too many requests (`rate_limit_error`). Wait for `Retry-After` seconds,
        then retry with exponential backoff.
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rate_limited:
              $ref: '#/components/examples/ErrRateLimited'
    ServerError:
      description: Kalixo-side error (`api_error`). Retry with the same `Idempotency-Key`.
      headers:
        Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal_error:
              $ref: '#/components/examples/ErrInternal'
  headers:
    RequestId:
      description: >-
        Unique ID of the request. Send it to Kalixo support. Matches
        `error.request_id`.
      schema:
        type: string
        examples:
          - req_6f1c2a9e0b7d4c3f8a1e5d2b9c0f4a7e
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
        examples:
          - 12
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      description: Secret key, `kc_sk_test_...` or `kc_sk_live_...`. Server-side only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.