Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna Settlements Payouts API

4 actions 4 updates phrasing extends openapi/klarna-payouts-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Klarna's API. It is a proposal applied on top of the contract, not a document Klarna publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/payouts/summary'].get

$.paths['/payouts/{payment_reference}'].get

$.paths['/payouts'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klarna Settlements Payouts API
  version: 1.0.0
extends: openapi/klarna-payouts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/payouts/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize payouts per currency for a period
      effect: read
      questions:
      - How much has been paid out to me in each currency over a date range?
      - Can I total my payouts between two dates for just one currency?
      instructions:
      - text: Summarize my payouts from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Give me payout totals in {currency_code} between {start_date} and {end_date}.
        slots:
          currency_code: query.currency_code
          start_date: query.start_date
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payouts/{payment_reference}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single payout
      effect: read
      questions:
      - What is in the payout with a given payment reference?
      - Can I look up one settlement payout by its reference?
      instructions:
      - text: Get payout {payment_reference}.
        slots:
          payment_reference: path.payment_reference
      - text: Show the details of the payout with reference {payment_reference}.
        slots:
          payment_reference: path.payment_reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/payouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List payouts
      effect: read
      questions:
      - Which payouts have I received recently?
      - Can I page through my payouts and filter them by currency?
      instructions:
      - text: List my payouts.
      - text: List payouts in {currency_code} from {start_date} to {end_date}, {size} per page.
        slots:
          currency_code: query.currency_code
          start_date: query.start_date
          end_date: query.end_date
          size: query.size
      method: generated
      generated: '2026-09-26'