Klarna · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Klarna Hpp API

5 actions 5 updates phrasing extends openapi/klarna-hpp-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 5

$.info
$.paths['/hpp/v1/sessions'].post
$.paths['/hpp/v1/sessions/{session_id}'].get
$.paths['/hpp/v1/sessions/{session_id}'].delete
$.paths['/hpp/v1/sessions/{session_id}/distribution'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Klarna Hpp API
  version: 1.0.0
extends: openapi/klarna-hpp-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: 4
- target: $.paths['/hpp/v1/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a hosted payment page session
      effect: write
      questions:
      - How do I send shoppers to a Klarna-hosted payment page instead of embedding the widget?
      - What do I need before creating a hosted payment page session?
      instructions:
      - text: Create a hosted payment page session for payment session {payment_session_url}.
        slots:
          payment_session_url: requestBody.payment_session_url
      - text: Open an HPP session for {payment_session_url} with redirect URLs {merchant_urls}.
        slots:
          payment_session_url: requestBody.payment_session_url
          merchant_urls: requestBody.merchant_urls
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hpp/v1/sessions/{session_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a hosted payment page session
      effect: read
      questions:
      - Has the customer finished paying on the hosted payment page yet?
      - Can I read the status of a hosted payment page session?
      instructions:
      - text: Get HPP session {session_id}.
        slots:
          session_id: path.session_id
      - text: Check the status of hosted payment page session {session_id}.
        slots:
          session_id: path.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hpp/v1/sessions/{session_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable a hosted payment page session
      effect: destructive
      questions:
      - How do I shut down a hosted payment page link after the payment was cancelled?
      - Can I stop a customer from using an HPP session that is no longer valid?
      instructions:
      - text: Disable HPP session {session_id}.
        slots:
          session_id: path.session_id
      - text: Turn off hosted payment page session {session_id} because the payment was cancelled.
        slots:
          session_id: path.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hpp/v1/sessions/{session_id}/distribution'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a hosted payment page link to a customer
      effect: write
      questions:
      - Can I text or email the payment link to a customer instead of redirecting them?
      - Which delivery methods are available for sharing a hosted payment page link?
      instructions:
      - text: Send the link for HPP session {session_id} by {method} to {contact_information}.
        slots:
          session_id: path.session_id
          method: requestBody.method
          contact_information: requestBody.contact_information
      - text: Email the hosted payment page for session {session_id} to {contact_information}.
        slots:
          session_id: path.session_id
          contact_information: requestBody.contact_information
      method: generated
      generated: '2026-09-26'