Klarna Settlements API — Payouts

naftiko: 1.0.0-alpha2
info:
  label: Klarna Settlements API — Payouts
  description: 'Klarna Settlements API — Payouts. 3 operations. Lead operation: Klarna List all payouts. Self-contained Naftiko
    capability covering one Klarna business surface.'
  tags:
  - Klarna
  - Payouts
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    KLARNA_API_KEY: KLARNA_API_KEY
capability:
  consumes:
  - type: http
    namespace: settlements-payouts
    baseUri: https://api.klarna.com/settlements/v1
    description: Klarna Settlements API — Payouts business capability. Self-contained, no shared references.
    resources:
    - name: payouts
      path: /payouts
      operations:
      - name: getpayouts
        method: GET
        description: Klarna List all payouts
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start_date
          in: query
          type: string
          description: ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults
            to the start of the day, ie 00:00:00. For example 2020-01-
        - name: end_date
          in: query
          type: string
          description: ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults
            to the start of the day, ie 00:00:00. This might lead to u
        - name: currency_code
          in: query
          type: string
          description: An optional currency code to filter the result for different currencies. If not provided the result
            returned in the response might include multiple results grou
        - name: size
          in: query
          type: integer
          description: How many elements to include in the result. If no value for size is provided, a default of 20 will
            be used. A maximum of 500 can be set
        - name: offset
          in: query
          type: integer
          description: The current offset. Describes "where" in a collection the current starts.
    - name: payouts-summary
      path: /payouts/summary
      operations:
      - name: getpayoutsummary
        method: GET
        description: Klarna Payout summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: start_date
          in: query
          type: string
          description: ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults
            to the start of the day, ie 00:00:00. For example 2020-01-
          required: true
        - name: end_date
          in: query
          type: string
          description: ISO 8601 date time format. This is a filter for the payout date. If no time is given then it defaults
            to the start of the day, ie 00:00:00. This might lead to u
          required: true
        - name: currency_code
          in: query
          type: string
          description: An optional currency code to filter the result for different currencies. If not provided the result
            returned in the response might include multiple results grou
    - name: payouts-payment_reference
      path: /payouts/{payment_reference}
      operations:
      - name: getpayout
        method: GET
        description: Klarna Payout details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: payment_reference
          in: path
          type: string
          description: The reference id of the payout. Normally this reference can be found on your payment slip statement
            of your bank.
          required: true
    authentication:
      type: basic
      username: '{{env.KLARNA_USER}}'
      password: '{{env.KLARNA_PASS}}'
  exposes:
  - type: rest
    namespace: settlements-payouts-rest
    port: 8080
    description: REST adapter for Klarna Settlements API — Payouts. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/payouts
      name: payouts
      description: REST surface for payouts.
      operations:
      - method: GET
        name: getpayouts
        description: Klarna List all payouts
        call: settlements-payouts.getpayouts
        with:
          start_date: rest.start_date
          end_date: rest.end_date
          currency_code: rest.currency_code
          size: rest.size
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payouts/summary
      name: payouts-summary
      description: REST surface for payouts-summary.
      operations:
      - method: GET
        name: getpayoutsummary
        description: Klarna Payout summary
        call: settlements-payouts.getpayoutsummary
        with:
          start_date: rest.start_date
          end_date: rest.end_date
          currency_code: rest.currency_code
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/payouts/{payment-reference}
      name: payouts-payment-reference
      description: REST surface for payouts-payment_reference.
      operations:
      - method: GET
        name: getpayout
        description: Klarna Payout details
        call: settlements-payouts.getpayout
        with:
          payment_reference: rest.payment_reference
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: settlements-payouts-mcp
    port: 9090
    transport: http
    description: MCP adapter for Klarna Settlements API — Payouts. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: klarna-list-all-payouts
      description: Klarna List all payouts
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: settlements-payouts.getpayouts
      with:
        start_date: tools.start_date
        end_date: tools.end_date
        currency_code: tools.currency_code
        size: tools.size
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: klarna-payout-summary
      description: Klarna Payout summary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: settlements-payouts.getpayoutsummary
      with:
        start_date: tools.start_date
        end_date: tools.end_date
        currency_code: tools.currency_code
      outputParameters:
      - type: object
        mapping: $.
    - name: klarna-payout-details
      description: Klarna Payout details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: settlements-payouts.getpayout
      with:
        payment_reference: tools.payment_reference
      outputParameters:
      - type: object
        mapping: $.