> ## 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.

# Retrieve an event



## OpenAPI

````yaml /checkout/openapi.yaml get /v1/events/{id}
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.
  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, connected to the provider test environment)
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: Client
    description: Called by Kalixo.js and the hosted checkout. Not for partner servers.
paths:
  /v1/events/{id}:
    parameters:
      - $ref: '#/components/parameters/PathId'
    get:
      tags:
        - Events
      summary: Retrieve an event
      operationId: retrieveEvent
      responses:
        '200':
          description: The event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        default:
          $ref: '#/components/responses/Error'
components:
  parameters:
    PathId:
      name: id
      in: path
      required: true
      schema:
        type: string
  schemas:
    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
    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
    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:
          $ref: '#/components/schemas/PaymentMethodDetails'
        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
          format: uri
          description: Hosted checkout URL. Contains the client secret in the URL fragment.
        client_secret:
          type: string
          description: Pass to Kalixo.js. Do not log or store it in analytics.
        amount_locked:
          type: boolean
          description: True once the first payment attempt has started.
        payment_link:
          type:
            - string
            - 'null'
        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
        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
    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
            decline_code:
              type:
                - string
                - 'null'
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            request_id:
              type: string
    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
    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
      required:
        - name
        - quantity
        - unit_amount
      properties:
        name:
          type: string
          maxLength: 200
        quantity:
          type: integer
          minimum: 1
        unit_amount:
          $ref: '#/components/schemas/Amount'
        tax_amount:
          $ref: '#/components/schemas/Amount'
        tax_percentage:
          type: integer
          description: Tax percentage in basis points (21% = 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
  responses:
    Error:
      description: Error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  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.