"use strict"; const {jsx: _jsx} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const apiSpecs = { "name": "klarna-notifications-api", "title": "Notifications", "type": "klarna-network", "intendedFor": "partner_through_ap", "version": "v2", "release": "stable", "spec": { "openapi": "3.1.1", "info": { "title": "Klarna Notifications API", "description": "next", "contact": { "url": "https://www.klarna.com" }, "version": "v2/stable" }, "security": [{ "klarna_api_key": [] }], "tags": [{ "name": "Webhooks", "description": "The **Webhooks API** allows the *authenticated* **Partner Account** to manage **Webhook** configurations. This includes creating and updating webhooks, which enable partners to receive notifications about events related to different partner products, such as the **Payment Product**." }, { "name": "Signing Keys", "description": "The **Signing Keys API** allows the *authenticated* **Partner Account** to manage **Signing Keys**.\nThis includes creating and deleting signing keys.\n\n**Signing Keys** enable partners to verify the authenticity of the incoming webhook notifications through the **HMAC-SHA-256** algorithm.\nThis process guards against tampering and forgery by ensuring that the received messages are unaltered and genuinely originate from the expected sender.\n" }], "paths": { "/v2/notification/webhooks": { "post": { "summary": "Create webhook", "operationId": "createWebhook", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Creates a new webhook for the given partner account. Webhook will trigger for the declared events and send notifications to the provided URL.

\n \n Operation ID:\n A unique identifier for the operation.\n \n createWebhook\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n SLA Service Class:\n The SLA Service Class this operation is classified at when evaluating SLA compliance.\n \n Operations, webhooks and other services that are outside the scope of both Tier 1 and Tier 2 ServicesTier 3 Services\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations necessary to onboard or migrate a partner account and provision its initial resources.Partner Account Onboarding\n

", "tags": ["Webhooks"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookRequest" } } } }, "responses": { "201": { "description": "Webhook created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] }, "get": { "summary": "List webhooks", "operationId": "listWebhooks", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Retrieves all webhooks for the given partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n listWebhooks\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Webhooks"], "responses": { "200": { "description": "Webhooks returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPage" }, "examples": { "List of webhooks": { "value": { "webhooks": [{ "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-dee8-43ca-9858-dca726e639b5", "url": "https://partner.api/receive-dispute-hook", "event_types": ["payment.request.state-change.submitted", "payment.request.state-change.completed", "payment.request.state-change.expired"], "event_version": "v2", "signing_key_id": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5", "status": "ENABLED", "created_at": "2021-01-01T00:00:00Z", "updated_at": "2021-01-01T00:00:00Z" }] } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] } }, "/v2/notification/webhooks/{webhook_id}": { "parameters": [{ "name": "webhook_id", "in": "path", "description": "The unique identifier of the webhook", "required": true, "schema": { "$ref": "#/components/schemas/WebhookIdentifier" } }], "get": { "summary": "Get webhook", "operationId": "getWebhookById", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Retrieves details of a specific webhook for the given partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n getWebhookById\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Webhooks"], "responses": { "200": { "description": "Webhook returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] }, "patch": { "summary": "Update webhook", "operationId": "updateWebhook", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Updates a specific webhook for the given partner account. Webhook will remain intact for the fields not mentioned in the request.

\n \n Operation ID:\n A unique identifier for the operation.\n \n updateWebhook\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Webhooks"], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdateRequest" } } } }, "responses": { "200": { "description": "Webhook updated successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] }, "delete": { "summary": "Delete webhook", "operationId": "deleteWebhook", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Deletes a specific webhook for the given partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n deleteWebhook\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Webhooks"], "responses": { "204": { "description": "Webhook deleted successfully.", "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] } }, "/v2/notification/signing-keys": { "post": { "summary": "Create signing key", "operationId": "createSigningKey", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Creates a new signing key for the given partner account. Webhook notifications can be verified with the signing key generated.

\n \n Operation ID:\n A unique identifier for the operation.\n \n createSigningKey\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations necessary to onboard or migrate a partner account and provision its initial resources.Partner Account Onboarding\n

", "tags": ["Signing Keys"], "responses": { "201": { "description": "Signing key created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningKey" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] }, "get": { "summary": "List signing keys", "operationId": "listSigningKeys", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Retrieves all signing keys for the given partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n listSigningKeys\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Signing Keys"], "responses": { "200": { "description": "Signing keys returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningKeysPage" }, "examples": { "List of signing keys": { "value": { "signing_keys": [{ "signing_key_id": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5", "in_use": true, "created_at": "2021-01-01T00:00:00Z" }] } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] } }, "/v2/notification/signing-keys/{signing_key_id}": { "parameters": [{ "name": "signing_key_id", "in": "path", "description": "The unique identifier of the signing key", "required": true, "schema": { "$ref": "#/components/schemas/SigningKeyId" } }], "get": { "summary": "Get signing key", "operationId": "getSigningKeyById", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Retrieves details of a specific signing key for the given partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n getSigningKeyById\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Signing Keys"], "responses": { "200": { "description": "Signing key returned successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SigningKeyReadOnly" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] }, "delete": { "summary": "Delete signing key", "operationId": "deleteSigningKey", "description": "

General AvailabilityFully available for general use of Klarna Partners

Indirect PartnerPartners offer Klarna’s payment solutions through a third-party provider or Acquiring Partner.

Deletes a specific signing key for the given partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n deleteSigningKey\n

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion.Account Operations\n

\n \n Availability in Test environment:\n Indicates if the feature is available in the Klarna Test environment\n \n Feature is available in the Klarna Test environmentAvailable\n

\n \n Availability in Production environment:\n Indicates if the feature is available in the Klarna Production environment\n \n Feature is available in the Klarna Production environmentAvailable\n

\n \n Request Idle Timeout:\n The maximum idle timeout for this operation in milliseconds\n \n 12000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage a partner account and its resources, after onboarding.Partner Account Management\n

", "tags": ["Signing Keys"], "responses": { "204": { "description": "Signing key deleted successfully.", "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "parameters": [{ "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }] } } }, "components": { "securitySchemes": { "klarna_api_key": { "in": "header", "name": "Authorization", "type": "apiKey", "description": "Use the Klarna API key as HTTP Basic Authentication credentials" } }, "schemas": { "WebhookUpdateRequest": { "properties": { "url": { "description": "Optional - The new endpoint URL to be called when the event happens if you want to update it", "example": "https://example.com/receive-hook", "x-validation-info": "Validation that is a valid url.", "format": "url", "type": "string", "minLength": 0 }, "event_types": { "description": "Optional - A new set of event types for the webhook if you want to update it", "x-validation-info": "Validation that event types exists.", "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": "array", "uniqueItems": true, "example": ["payment.request.state-change.submitted", "payment.request.state-change.completed", "payment.request.state-change.expired"] }, "event_version": { "description": "Optional - A new event version configured for the webhook if you want to update it\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `v2` | |\n", "format": "enum", "x-validation-info": "Strict validation that version exists", "type": "string", "example": "v2", "enum": ["v2"] }, "signing_key_id": { "description": "Optional - A new signing key id for the webhook if you want to update it", "example": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42", "x-validation-info": "There is validation that the id/resource exists", "type": "string", "minLength": 0 }, "status": { "description": "Optional - A new status (ENABLED/DISABLED) for the webhook if you want to update it\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ENABLED` | The webhook subscription is active and the associated endpoint is eligible to receive event notifications. |\n| `DISABLED` | The webhook subscription is inactive, preventing the endpoint from receiving any event notifications. |\n", "x-validation-info": "Validation against the enum of possible values.", "format": "enum", "type": "string", "default": "ENABLED", "example": "ENABLED", "enum": ["ENABLED", "DISABLED"] } }, "type": "object" }, "WebhookRequest": { "properties": { "url": { "$ref": "#/components/schemas/WebhookEndpoint" }, "event_types": { "$ref": "#/components/schemas/WebhookEventTypes" }, "event_version": { "$ref": "#/components/schemas/WebhookEventVersion" }, "signing_key_id": { "$ref": "#/components/schemas/SigningKeyId" }, "status": { "$ref": "#/components/schemas/WebhookStatus" } }, "required": ["event_types", "event_version", "url", "signing_key_id"], "type": "object" }, "WebhookIdentifier": { "description": "The unique identifier assigned to the webhook", "x-validation-info": "There is validation that the resource exists. There is validation about the KRN format (to-be-removed).", "example": "krn:partner:global:notification:webhook:120e5b7e-dee8-43ca-9858-dca726e639b5", "type": "string", "minLength": 0 }, "WebhookEndpoint": { "description": "Specifies the HTTPS URL to which the webhook notifications will be delivered. The value must be a valid, secure URL (HTTPS) where the partner's system can receive HTTP POST requests upon the occurrence of subscribed events.", "example": "https://example.com/receive-hook", "x-validation-info": "Validation that is a valid url.", "format": "url", "type": "string", "minLength": 0 }, "WebhookEventType": { "description": "Defined webhook events\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment.request.state-change.submitted` | |\n| `payment.request.state-change.in-progress` | |\n| `payment.request.state-change.canceled` | |\n| `payment.request.state-change.completed` | |\n| `payment.request.state-change.expired` | |\n| `payment.request.state-change.declined` | |\n| `payment.request.updated` | |\n| `partner.account.state-change.operational` | |\n| `partner.account.change.created` | |\n| `identity.customer-token.state-change.revoked` | |\n| `identity.request.state-change.submitted` | |\n| `identity.request.state-change.in-progress` | |\n| `identity.request.state-change.completed` | |\n| `identity.request.state-change.canceled` | |\n| `identity.request.state-change.expired` | |\n| `identity.request.state-change.declined` | |\n| `payment.transaction.state-change.authorized` | |\n| `payment.transaction.state-change.completed` | |\n| `payment.transaction.state-change.expired` | |\n| `payment.transaction.state-change.closed` | |\n| `payment.transaction.captured` | |\n| `payment.transaction.chargeback` | |\n| `payment.transaction.refunded` | |\n| `payment.funding.state-change.funded` | |\n| `payment.funding.state-change.expired` | |\n| `payment.dispute.state-change.initiated` | |\n| `payment.dispute.state-change.representment` | |\n| `payment.dispute.state-change.pre-arbitration` | |\n| `payment.dispute.state-change.arbitration` | |\n| `payment.dispute.state-change.closed` | |\n| `payment.dispute.updated.representment-deadline-extended` | |\n| `settlement.report.created` | |\n| `settlement.report.uploaded-to-sftp` | |\n| `settlement.payout.processed` | |\n| `settlement.payout.confirmed` | |\n| `settlement.payout.failed` | |\n| `partner.compliance.decision.created` | |\n| `partner.risk.payment-account.customer-protection.state-change` | |\n", "x-validation-info": "Validation that event type exists.", "type": "string", "example": "payment.request.state-change.completed", "enum": ["payment.request.state-change.submitted", "payment.request.state-change.in-progress", "payment.request.state-change.canceled", "payment.request.state-change.completed", "payment.request.state-change.expired", "payment.request.state-change.declined", "payment.request.updated", "partner.account.state-change.operational", "partner.account.change.created", "identity.customer-token.state-change.revoked", "identity.request.state-change.submitted", "identity.request.state-change.in-progress", "identity.request.state-change.completed", "identity.request.state-change.canceled", "identity.request.state-change.expired", "identity.request.state-change.declined", "payment.transaction.state-change.authorized", "payment.transaction.state-change.completed", "payment.transaction.state-change.expired", "payment.transaction.state-change.closed", "payment.transaction.captured", "payment.transaction.chargeback", "payment.transaction.refunded", "payment.funding.state-change.funded", "payment.funding.state-change.expired", "payment.dispute.state-change.initiated", "payment.dispute.state-change.representment", "payment.dispute.state-change.pre-arbitration", "payment.dispute.state-change.arbitration", "payment.dispute.state-change.closed", "payment.dispute.updated.representment-deadline-extended", "settlement.report.created", "settlement.report.uploaded-to-sftp", "settlement.payout.processed", "settlement.payout.confirmed", "settlement.payout.failed", "partner.compliance.decision.created", "partner.risk.payment-account.customer-protection.state-change"] }, "WebhookEventTypes": { "description": "Specifies the types of events to which the webhook is subscribed. This field supports the wildcard (*) notation that allows for broader event subscriptions. For example, specifying `payment.*` subscribes the webhook to all events related to the **Payment Product**.", "x-validation-info": "Validation that event types exists.", "items": { "$ref": "#/components/schemas/WebhookEventType" }, "type": "array", "uniqueItems": true, "example": ["payment.request.state-change.submitted", "payment.request.state-change.completed", "payment.request.state-change.expired"] }, "WebhookEventVersion": { "description": "Specifies the version of events to which the webhook is subscribed. All the subscribed event types will adhere to the schema of the specified event version.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `v2` | |\n", "format": "enum", "x-validation-info": "Strict validation that version exists", "type": "string", "example": "v2", "enum": ["v2"] }, "SigningKeyId": { "description": "The `signing_key_id` field represents the identifier of the HMAC signing key that will be used for signing the webhook event notifications. This signing key, which must be created separately, accordingly enables the HMAC signing process for the webhook event notifications. Each event notification delivered to the webhook endpoint will carry a signature header, which is produced using the specified HMAC signing key. The inclusion of this signature provides a mechanism for partners to confirm the authenticity of incoming notifications, reinforcing the security of the communication process.", "example": "krn:partner:global:notification:signing-key:49bcd37b-79a7-4e6e-b067-2903b45fef42", "x-validation-info": "There is validation that the id/resource exists", "type": "string", "minLength": 0 }, "WebhookCreatedAt": { "type": "string", "format": "date-time", "description": "Point in time when the webhook is created. Timestamp adheres to ISO 8601 format with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "WebhookUpdatedAt": { "type": "string", "format": "date-time", "description": "Point in time when the webhook was last updated. Timestamp adheres to ISO 8601 format with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "WebhookStatus": { "description": "The `status` dictates the active/inactive state of the webhook subscription. When this field is not provided, it defaults to `ENABLED`.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ENABLED` | The webhook subscription is active and the associated endpoint is eligible to receive event notifications. |\n| `DISABLED` | The webhook subscription is inactive, preventing the endpoint from receiving any event notifications. |\n", "x-validation-info": "Validation against the enum of possible values.", "format": "enum", "type": "string", "default": "ENABLED", "example": "ENABLED", "enum": ["ENABLED", "DISABLED"] }, "Webhook": { "properties": { "webhook_id": { "$ref": "#/components/schemas/WebhookIdentifier" }, "url": { "$ref": "#/components/schemas/WebhookEndpoint" }, "event_types": { "$ref": "#/components/schemas/WebhookEventTypes" }, "event_version": { "$ref": "#/components/schemas/WebhookEventVersion" }, "signing_key_id": { "$ref": "#/components/schemas/SigningKeyId" }, "created_at": { "$ref": "#/components/schemas/WebhookCreatedAt" }, "updated_at": { "$ref": "#/components/schemas/WebhookUpdatedAt" }, "status": { "$ref": "#/components/schemas/WebhookStatus" } }, "type": "object", "required": ["webhook_id", "url", "event_types", "event_version", "signing_key_id", "created_at", "status"] }, "WebhookList": { "description": "Array of webhook objects, each representing a unique webhook that has been configured for the given partner account.", "items": { "$ref": "#/components/schemas/Webhook" }, "type": "array" }, "WebhooksPage": { "properties": { "webhooks": { "$ref": "#/components/schemas/WebhookList" } }, "type": "object" }, "SigningKeyCreatedAt": { "type": "string", "format": "date-time", "description": "Point in time when the signing key is created. Timestamp adheres to ISO 8601 format with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "SigningKeyReadOnly": { "properties": { "signing_key_id": { "$ref": "#/components/schemas/SigningKeyId" }, "in_use": { "description": "Indicates whether the signing key has been used in any of the webhooks", "example": false, "type": "boolean" }, "created_at": { "$ref": "#/components/schemas/SigningKeyCreatedAt" } }, "type": "object", "required": ["signing_key_id", "in_use", "created_at"] }, "SigningKeyList": { "items": { "$ref": "#/components/schemas/SigningKeyReadOnly" }, "description": "Array of webhook objects, each representing a unique webhook that has been configured for the given partner account.", "type": "array" }, "SigningKeysPage": { "properties": { "signing_keys": { "$ref": "#/components/schemas/SigningKeyList" } }, "type": "object" }, "SigningKey": { "properties": { "signing_key_id": { "$ref": "#/components/schemas/SigningKeyId" }, "signing_key": { "description": "Signing key with which the HTTP request of the webhook will be signed with.", "example": "b040893b9e02f6445b205ae2102e3e9e1d0aa9035e61cdebde39b5c230a7bc5a", "type": "string", "minLength": 1 }, "created_at": { "$ref": "#/components/schemas/SigningKeyCreatedAt" } }, "type": "object", "required": ["signing_key_id", "signing_key", "created_at"] }, "AccessErrorRateLimited": { "type": "object", "description": "The request was rate limited.\n\nAll requests from this client are temporarily rate limited.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "RATE_LIMITED" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "ACCESS_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Too many requests - please try again later" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "AccessErrorUnauthorized": { "type": "object", "description": "The presented credentials failed authentication.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "UNAUTHORIZED" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "ACCESS_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The presented credentials failed authentication" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "InputErrorContentTypeError": { "type": "object", "description": "The input does not conform to the expected content type syntax. For example invalid JSON.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "INVALID_CONTENT_TYPE" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "INPUT_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The received input is not valid JSON" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "InputErrorValidationError": { "type": "object", "description": "An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "VALIDATION_ERROR" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "INPUT_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048 }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 }, "validation_errors": { "type": "array", "description": "A list of validation errors that occurred\n", "maxItems": 100, "items": { "type": "object", "description": "A validation error that occurred on a specific parameter.\n", "required": ["parameter", "reason"], "properties": { "parameter": { "type": "string", "minLength": 0, "maxLength": 256, "description": "The name of the parameter that caused the error.\nSpecified in JSON dot-notation syntax.\n" }, "reason": { "type": "string", "minLength": 0, "maxLength": 512, "description": "A human readable error message describing the error.\n" }, "doc_url": { "type": "string", "minLength": 0, "maxLength": 2048, "description": "A deep link to the relevant documentation page on klarna.docs on how to fix the error.\n", "format": "uri" } } } } } }, "ResourceErrorOperationForbidden": { "type": "object", "description": "Insufficient privileges to perform the requested operation on the resource.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "OPERATION_FORBIDDEN" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Insufficient privileges to on resource " }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "ResourceErrorNotFoundError": { "type": "object", "description": "The requested resource was not found.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_NOT_FOUND" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Resource does not exist" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "TechnicalErrorInternalError": { "type": "object", "description": "An unexpected error occurred in the API.\n\nThe request may be retried without modification after a delay.\n\nIf this error persists, please reach out to your Klarna support contact.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "INTERNAL_ERROR" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "TECHNICAL_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Something went wrong at Klarna, if the error persists please reach out to your support contact and include this message" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "TechnicalErrorTemporaryUnavailable": { "type": "object", "description": "The system is temporarily unavailable to process the request.\n\nThe request may be retried without modification after a delay.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "TEMPORARY_UNAVAILABLE" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "TECHNICAL_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The system is temporarily unavailable to process the request" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "TechnicalErrorTimeout": { "type": "object", "description": "The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.\n\nThe request may be retried without modification after a delay.\n\nIf this error persists, please reach out to your Klarna support contact.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "TIMEOUT" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "TECHNICAL_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "The request timed out. Please retry after a short delay." }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } }, "ResourceErrorConflictError": { "type": "object", "description": "There was a conflict in using the resource.\nIdempotency violation or concurrent updates to a resource occurred.\n", "required": ["error_id", "error_code", "error_message"], "properties": { "error_id": { "description": "Unique error identifier", "type": "string", "format": "uuid", "pattern": "([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})", "maxLength": 36 }, "error_code": { "description": "Error code within the error type", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_CONFLICT" }, "error_type": { "deprecated": true, "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "const": "RESOURCE_ERROR" }, "error_message": { "description": "A human readable error message describing the error.\n", "type": "string", "minLength": 0, "maxLength": 2048, "example": "Concurrent update on resource | Idempotent operation on failed" }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } } }, "parameters": { "KlarnaIntegrationMetadata": { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, serialized as a valid JSON object string literal, to improve troubleshooting.\n\nThe header value as appearing on the wire should be a JSON object string literal without newlines as produced by `JSON.stringify()`.\n\nExample: `Klarna-Integration-Metadata: {\"integrator\":{\"name\":\"AcquiringPartner\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v1.0\"},\"originators\":[{\"name\":\"ecommerceCompany\",\"session_reference\":\"ecomm_5555-474\",\"module_name\":\"subIntegrationPath\",\"module_version\":\"v2.0\"}]}`", "content": { "application/json": { "schema": { "title": "application/json", "type": "object", "properties": { "integrator": { "description": "An integrator is the entity that is responsible for the integration with Klarna.", "type": "object", "properties": { "name": { "description": "The name of the integrator using SCREAMING_SNAKE_CASE.\n", "minLength": 1, "maxLength": 50, "type": "string", "pattern": "^[A-Z0-9_]+$", "example": "PSP" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "minLength": 1, "type": "string" }, "module_name": { "description": "The name of the module that is being used to initiate the request\n", "maxLength": 50, "type": "string", "minLength": 1, "example": "psp-new-payment" }, "module_version": { "description": "The version of the module that is being used.\nCan be a semantic version, commit hash, date or any other versioning scheme to identify which code that issued the request.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] }, "originators": { "description": "Array of originators that are responsible for the request.\nIf the request is sent through multiple systems before reaching the integrator, each system can be represented as an originator.\n", "type": "array", "maxItems": 10, "items": { "description": "An originator is the entity that is responsible for the request.", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the originator using SCREAMING_SNAKE_CASE.\n", "maxLength": 50, "minLength": 1, "pattern": "^[A-Z0-9_]+$", "example": "ECOMMERCE_COMPANY" }, "session_reference": { "description": "A reference to the session that is being used.\n", "maxLength": 100, "type": "string", "minLength": 1 }, "module_name": { "description": "The name of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 }, "module_version": { "description": "The version of the module that is being used.\n", "maxLength": 50, "type": "string", "minLength": 1 } }, "required": ["name", "session_reference"] } } }, "required": ["integrator"] } } } }, "PartnerCorrelationIdRequest": { "name": "Partner-Correlation-Id", "in": "header", "required": false, "schema": { "description": "A partner-supplied identifier for this request. Klarna returns it unchanged in the `Partner-Correlation-Id` response header, so you can match your own logs against Klarna's.", "type": "string", "minLength": 1, "maxLength": 255 } }, "KlarnaWorkloadType": { "name": "Klarna-Workload-Type", "in": "header", "required": false, "description": "Signal the processing priority of this request. Set to \"background\" to indicate a lower-priority request. Background requests are metered against a separate rate limit bucket, protecting interactive traffic quota. Omit this header for default interactive rate limiting. Use \"background\" for scheduled or bulk processing jobs such as settlement retrieval, bulk order management, or periodic reconciliation.", "schema": { "type": "string", "maxLength": 255, "minLength": 1, "x-validation-info": "Accepts 'background' or 'standard'. Omitting the header defaults to interactive rate limiting. Klarna rejects unsupported values with 400 Bad Request.", "description": "\n\n**Open Enum - values** ([what is an open enum?](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/integration-resilience/data-types/#open-enums)):\n\n| Value | Description |\n|-------|-------------|\n| `background` | Lower-priority processing — metered against a separate rate limit bucket. |\n| `standard` | Explicitly opt into the interactive rate limit bucket (same as omitting the header). |\n\n**Note:** This is an open enum. New values may be added in future releases. Integrators **must** implement handling for unknown values to ensure forward compatibility.", "x-extensible-enum": ["background", "standard"] } } }, "headers": { "PartnerCorrelationIdResponse": { "description": "An echo of the `Partner-Correlation-Id` request header. Absent when the request did not send one.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, "KlarnaCorrelationId": { "description": "A unique identifier Klarna assigns to this request. Quote it when reporting a problem to Klarna so the request can be traced.", "schema": { "type": "string", "format": "uuid", "minLength": 0, "maxLength": 36 } }, "KlarnaServiceLevelCategory": { "description": "The service level objective (SLO) category that applies to this response, as a lower_snake_case category key. Each category has its own response time and availability targets. Klarna may add categories, so accept values that are not listed.", "schema": { "type": "string", "minLength": 0, "maxLength": 64, "description": "\n\n**Open Enum - values** ([what is an open enum?](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/integration-resilience/data-types/#open-enums)):\n\n| Value | Description |\n|-------|-------------|\n| `identity_read` | Operations that check whether a customer has an existing Klarna account or retrieve details of a customer token issued in the account linking flow. |\n| `disputes` | Operations that enable access to all dispute-related functionalities, including retrieval, updates, and resolution. |\n| `identity_operation` | Operations that revoke or update a customer token issued in the account linking flow. |\n| `account_management_onboarding` | Operations that facilitate the onboarding of a new partner account with Klarna. |\n| `account_management_operation` | Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion. |\n| `customer_token_charge` | Operations that process payments for tokenized customers, including recurring and on-demand transactions. |\n| `messaging_payment_personalization` | Operations that support personalized payment messaging, including customized options and descriptors. |\n| `messaging_placement_read` | Operations that provide access to retrieve details about available messaging placements for Klarna services. |\n| `payment_transaction_read` | Operations that read payment transactions, such as retrieving payment transaction details. |\n| `payment_transaction_operation` | Operations that support the creation and modification of payment transactions, including submission and updates. |\n| `payment_request` | Operations that handle all aspects of a Payment Request, including creation, retrieval, updates, and deletion. |\n| `payment_confirmation` | Operations that allow the completion of a Payment Request. |\n| `settlements` | Operations that provide access to settlement-related functionalities, including retrieval and reconciliation. |\n\n**Note:** This is an open enum. New values may be added in future releases. Integrators **must** implement handling for unknown values to ensure forward compatibility.", "x-extensible-enum": ["identity_read", "disputes", "identity_operation", "account_management_onboarding", "account_management_operation", "customer_token_charge", "messaging_payment_personalization", "messaging_placement_read", "payment_transaction_read", "payment_transaction_operation", "payment_request", "payment_confirmation", "settlements"] } } } }, "servers": [{ "url": "https://api-global.klarna.com", "description": "Production environment" }, { "url": "https://api-global.test.klarna.com", "description": "Test environment" }], "webhooks": {} } }; function _createMdxContent(props) { const {ApiSpecs} = { ..._provideComponents(), ...props.components }; if (!ApiSpecs) _missingMdxReference("ApiSpecs", true); return _jsx(ApiSpecs, { ...apiSpecs }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = { ..._provideComponents(), ...props.components }; return MDXLayout ? _jsx(MDXLayout, { ...props, children: _jsx(_createMdxContent, { ...props }) }) : _createMdxContent(props); } return { apiSpecs, default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }