Payment form and interoperability data

Enable a seamless checkout experience by integrating its payment presentation and interoperability features to enhance the checkout experience with up-to-date payment method listings.

​With this integration path, Acquiring Partners are responsible for:

  • Supporting Partners in building the payment form and selector.
  • Directly referring to Klarna’s official presentation requirements in their documentation - see how to present Klarna.
  • Ensuring compatibility with Klarna’s Payment Presentation API, if applicable.

This guide outlines how to handle interoperability parameters and return dynamic Klarna assets to Partners, using Klarna’s Presentation API.

This step only applies to Acquiring Partners that have APIs that allow Partners to retrieve available payment methods.

If an Acquiring Partner provides an API for retrieving payment methods, it must:

  • Accept interoperability_token and interoperability_data in requests.
  • Use Klarna’s Payment Presentation API to fetch the most up-to-date Klarna content.
  • Include Klarna-specific display instructions and assets (labels, icons, etc.) in the API response sent to Partners.

Klarna uses interoperability_token and interoperability_data to ensure all information and context associated with a Payment Transaction is preserved throughout the journey of a customer. These must be forwarded accurately.

Below an example of how Acquiring Partners can accept the interoperability parameters in their Get Payment Method API endpoint.

Sample request

JSON
{
  "currency": "USD",
  "amount": 17800,
  "locale": "en-US",
  "payment_method_options": {
    "klarna": {
      "interoperability_token": "eyJhbGciOiJ...",
      "interoperability_data": "****"
    }
  }

You should name these fields clearly, using either:

  • klarna_interoperability_token / klarna_interoperability_data, or
  • interoperability_token / interoperability_data (in Klarna-specific context).

This ensures easy identification for any Partner.

Parameter validation guidelines

As those parameters can change over time and are versioned so that the third party integration continues to work, Acquiring Partners need to respect these guidelines if they wish to validate parameters:

ParameterTypeMax lengthValidation

interoperability_token

string (JWT)8192 charsOptional: verify format only

interoperability_data

string (stringified JSON object)10240 charsOptional: check for valid JSON

The Acquiring Partner can validate the input based on the provided guidelines but must not modify it. The input must always be forwarded as received, without any interference.

The Klarna Payment Presentation API enables Acquiring Partners to retrieve Klarna-branded presentation assets (e.g. button text, icons, descriptors) tailored to a specific payment context. These assets help Partners render Klarna in compliance with Klarna’s brand and UX guidelines.

Request parameters

Path
ParameterDescription

partner_account_id

The unique identifier of the Partner account. This is used to scope the request.
Header
ParameterDescription

Authorization

Acquiring Partners use their Klarna API key to authenticate:
Basic <API key>

Klarna-Interoperability-Token

Must contain the interoperability token if provided by the Partner.
Body
ParameterDescription

locale

The locale to use for localization of Klarna assets (IETF BCP 47 format e.g., en-US, fr-FR).

amount

The total payment amount in minor units (e.g., 11836 = $118.36).

currency

ISO 4217 3-letter currency code (e.g., USD, EUR).

intents

List of requested intents. Currently, ["PAY"] is the supported value.

Sample request

SHELL
curl https://api-global.test.klarna.com/v2/accounts/{partner_account_id}/payment/presentation \
  -H 'Authorization: Basic <API key>' \
  -H 'Content-Type: application/json' \
  -H 'Klarna-Interoperability-Token: eyJhbGciOiJIU...' \
  -d '{
        "locale": "en-US",
        "amount": 11836,
        "currency": "USD",
        "intents": ["PAY"]
      }'

Response parameters

FieldTypeDescription

instruction

stringKlarna display instruction (e.g., SHOW_KLARNA, HIDE_KLARNA, etc.).

payment_button

objectContains the label to be used on the Klarna payment button.

descriptor

objectContains all Klarna display assets for the payment selector, including:
  • header

    : Main title (e.g., "Pay with Klarna")
  • subheader.short

    : Short message (e.g., "Pay in 4.")
  • subheader.enriched

    : Detailed offer text with optional link
  • icon

    : Badge images (square, rectangle, alt text)

Sample response

JSON
{
  "instruction": "SHOW_KLARNA",
  "payment_button": {
    "text": "Pay with Klarna"
  },
  "descriptor": {
    "header": {
      "text": "Pay with Klarna"
    },
    "subheader": {

Your API response (e.g., for Get Payment Methods) should include the Klarna assets returned in the response from the Payment Presentation API, so your Partner can render the payment method correctly.

You have two options:

  1. Map Individual Fields : Extract and structure the response from Klarna’s Payment Presentation API and map relevant keys (e.g., descriptor, payment_button) into your API response format.
  2. Serialize the Entire Response : Alternatively, you may populate a single field—klarna_payment_presentation_data—with a serialized version (e.g., JSON string) of the full response obtained from Klarna’s Payment Presentation API. This avoids the need to map each field individually.
JSON
{
  "paymentMethods": [
    {
      "name": "VISA",
      "type": "scheme"
    },
    {
      "name": "Pay with Klarna",
      "type": "klarna",
      "klarna_payment_presentation_data": "{\"instruction\":\"SHOW_KLARNA\",...}"

You may structure the response to fit your API format, but ensure that the Klarna presentation data is clearly identifiable. Use a field name like:

  • klarna_payment_presentation_data
  • or payment_presentation_data (when used specifically for Klarna)

This makes it easy for Partner integrations to parse and use Klarna presentation data dynamically.

  • Include Klarna presentation rules in your documentation
  • Support interoperability_token and interoperability_data in your APIs
  • Forward these values unaltered to Klarna’s APIs
  • Use Klarna’s Payment Presentation API to fetch assets
  • Return Klarna’s presentation data to your Partners in a consistent format.
  • Optionally serialize the full response from the Payment Presentation API into klarna_payment_presentation_data