"use strict"; const {jsx: _jsx} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const apiSpecs = { "name": "klarna-product-api-identity", "title": "Identity", "type": "klarna-network", "intendedFor": "acquiring_partner", "version": "v2", "release": "r2604", "spec": { "openapi": "3.0.0", "info": { "title": "Klarna Partner Product API - Identity", "version": "v2/r2604" }, "security": [{ "klarna_api_key": [] }], "paths": { "/v2/accounts/{partner_account_id}/identity/customer-token/introspect": { "post": { "summary": "Introspect a customer token issued in the account linking flow.\n", "description": "

Early ReleaseFeature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users

Acquiring PartnerAcquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.

Introspect a customer token issued in the account linking flow to obtain more information regarding the token.

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that provide read access to verify if a customer has an existing Klarna account or to retrieve details from an account linking token.Read-Only Identity\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 does not directly impact the core purchasing process in real-time and enables supplemental or secondary featuresTier 2 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 Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage partner accounts and additional partner operations that are not related to onboarding.Partner Management\n

", "operationId": "tokenIntrospect", "tags": ["Identity API"], "parameters": [{ "name": "partner_account_id", "in": "path", "required": true, "description": "Identifier of the **Partner Account** the action is done on behalf of", "schema": { "$ref": "#/components/schemas/PartnerAccountIdentifier" } }, { "name": "Klarna-Customer-Token", "in": "header", "required": true, "x-validation-info": "Must be a valid customer token", "schema": { "$ref": "#/components/schemas/CustomerToken" } }, { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, a valid JSON object string literal, to improve troubleshooting. [Read more here](https://docs.klarna.com/api/kn/integration-resilience/#tagging)\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"] } } } }, { "in": "header", "name": "Partner-Correlation-Id", "required": false, "schema": { "description": "An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.", "type": "string", "minLength": 1, "maxLength": 255 } }], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "Customer token introspection response.", "properties": { "status": { "type": "string", "description": "The status of the customer token.", "enum": ["ACTIVE", "REVOKED"] }, "scopes": { "type": "array", "maxItems": 30, "description": "The scopes of the requested `customer_token`. The scopes define the permissions of the token.\n* `payment:customer_not_present` - Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present.\n* `payment:customer_present` - Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up.\n* `customer:login` - Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer.\n", "items": { "type": "string", "enum": ["payment:customer_not_present", "payment:customer_present", "customer:login"] } }, "issued_at": { "type": "number", "description": "The timestamp when the token was issued." }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } }, "required": ["status", "scopes", "issued_at"] }, "examples": { "An active customer token issued with payment:customer_present scope": { "$ref": "#/components/examples/Customer_token_instrospection_response_for_active_customer_present" }, "A revoked customer token issued with payment:customer_present scope": { "$ref": "#/components/examples/Customer_token_instrospection_response_for_revoked_customer_present" } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/TemporarilyUnavailable" } } } }, "/v2/accounts/{partner_account_id}/identity/customer-token/revoke": { "post": { "summary": "Revoke a customer token issued in the account linking flow.\n", "description": "

Early ReleaseFeature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users

Acquiring PartnerAcquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.

Revoke a customer token issued in the account linking flow, so that any subsequent payment requests using the token are rejected.

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that allow the revocation or updates of a customer token issued during the account linking process.Identity\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 Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to manage partner accounts and additional partner operations that are not related to onboarding.Partner Management\n

", "operationId": "tokenRevoke", "tags": ["Identity API"], "parameters": [{ "name": "partner_account_id", "in": "path", "required": true, "description": "Identifier of the **Partner Account** the action is done on behalf of", "schema": { "$ref": "#/components/schemas/PartnerAccountIdentifier" } }, { "name": "Klarna-Customer-Token", "in": "header", "required": true, "x-validation-info": "Must be a valid customer token or purchase token ID", "schema": { "oneOf": [{ "$ref": "#/components/schemas/CustomerToken" }, { "$ref": "#/components/schemas/PurchaseTokenId" }] } }, { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, a valid JSON object string literal, to improve troubleshooting. [Read more here](https://docs.klarna.com/api/kn/integration-resilience/#tagging)\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"] } } } }, { "in": "header", "name": "Partner-Correlation-Id", "required": false, "schema": { "description": "An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.", "type": "string", "minLength": 1, "maxLength": 255 } }], "callbacks": { "identity.customer-token.state-change.revoked": { "klarna-webhook": { "description": "Webhook notification delivered when a customer token has been successfully revoked on Klarna's side.", "post": { "summary": "Webhook: Customer-token revoked", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/identity.customer-token.state-change.revoked" }, "examples": { "Customer token revoked webhook": { "$ref": "#/components/examples/Identity_customer_token_revoked_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "description": "Customer token revocation response.", "properties": { "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "examples": { "A successful revocation response": { "$ref": "#/components/examples/Customer_token_revocation_response" } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/TemporarilyUnavailable" } } } }, "/v2/identity/sdk-tokens": { "post": { "tags": ["Identity API"], "operationId": "generateIdentitySdkToken", "summary": "Generate SDK token", "description": "

DeprecatedFeature is deprecated and will soon be decommissioned.

Acquiring PartnerAcquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.

Deprecated: This operation is deprecated and will be removed.\nUse the /network/session/tokens endpoint to generate a Klarna network session token for SDK initialization and customer personalization.\nWhy: Klarna is moving to network session tokens for unified session management.\nMigration: Replace calls to /identity/sdk-tokens with /network/session/tokens and update your SDK initialization to use the klarna network session token.

\n \n Operation ID:\n A unique identifier for the operation.\n \n generateIdentitySdkToken\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 Ratelimit Category:\n The Ratelimit Category.\n \n Includes crucial actions for capturing payment transactions.Payment Transaction Capture\n

", "deprecated": true, "parameters": [{ "name": "Klarna-Customer-Token", "in": "header", "required": true, "x-validation-info": "Must be a valid customer token or purchase token ID", "schema": { "oneOf": [{ "$ref": "#/components/schemas/CustomerToken" }, { "$ref": "#/components/schemas/PurchaseTokenId" }] } }, { "name": "Klarna-Integration-Metadata", "in": "header", "description": "Metadata about the integrator and originators of the request, a valid JSON object string literal, to improve troubleshooting. [Read more here](https://docs.klarna.com/api/kn/integration-resilience/#tagging)\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"] } } } }, { "in": "header", "name": "Partner-Correlation-Id", "required": false, "schema": { "description": "An optional alpha numerical String that the partner can use to correlate. This value will be returned in the response.", "type": "string", "minLength": 1, "maxLength": 255 } }], "responses": { "201": { "description": "SDK token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDKTokenResponse" } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalServerError" }, "503": { "$ref": "#/components/responses/TemporarilyUnavailable" } } } } }, "components": { "securitySchemes": { "klarna_api_key": { "in": "header", "name": "Authorization", "type": "apiKey", "description": "Use the Klarna API key as HTTP Basic Authentication credentials" } }, "schemas": { "CustomerToken": { "type": "string", "description": "Returned if Account Linking or payment tokenization was requested.\n\nThe customer token represents the tokenized customer and allows you to act\non behalf of the customer. You must persist this token in your system associated with the customer\naccount. To de-duplicate customers, you should use the `customer_id` as the unique identifier.\n", "maxLength": 1024, "minLength": 1, "example": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "x-validation-info": "Validation on the length (max length 1024) and the format of the string." }, "CustomerTokenReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Partner reference to the customer token created on Klarna side.\nThis will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.\n", "example": "partner_customer_token_1234" }, "ParameterError": { "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" } } }, "InputErrorValidationError": { "type": "object", "required": ["error_id", "error_code", "error_type", "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, "enum": ["VALIDATION_ERROR"] }, "error_type": { "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "enum": ["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": { "$ref": "#/components/schemas/ParameterError" } } }, "description": "An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.\n" }, "InputErrorContentTypeError": { "type": "object", "required": ["error_id", "error_code", "error_type", "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, "enum": ["INVALID_CONTENT_TYPE"] }, "error_type": { "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "enum": ["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 } }, "description": "The input does not conform to the expected content type syntax. For example invalid JSON.\n" }, "AccessErrorUnauthorized": { "type": "object", "required": ["error_id", "error_code", "error_type", "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, "enum": ["UNAUTHORIZED"] }, "error_type": { "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "enum": ["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 } }, "description": "The presented credentials failed authentication.\n" }, "AccessErrorRateLimited": { "type": "object", "required": ["error_id", "error_code", "error_type", "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, "enum": ["RATE_LIMITED"] }, "error_type": { "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "enum": ["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 } }, "description": "The request was rate limited.\n\nAll requests from this client are temporarily rate limited.\n" }, "TechnicalErrorInternalError": { "type": "object", "required": ["error_id", "error_code", "error_type", "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, "enum": ["INTERNAL_ERROR", "SERVER_CONFIGURATION_ERROR"] }, "error_type": { "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "enum": ["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 } }, "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" }, "TechnicalErrorTemporaryUnavailable": { "type": "object", "required": ["error_id", "error_code", "error_type", "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, "enum": ["TEMPORARY_UNAVAILABLE"] }, "error_type": { "description": "The type of error.", "type": "string", "minLength": 0, "maxLength": 64, "enum": ["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 } }, "description": "The system is temporarily unavailable to process the request.\n\nThe request may be retried without modification after a delay.\n" }, "PurchaseTokenId": { "type": "string", "description": "Payload parameter utilized in the Identity API for revoking legacy One Klarna Tokens (purchase tokens).\n\nThe One Klarna Token represents a customer's consent, allowing a merchant to charge their Klarna account\nor enabling Klarna to charge the customer's payment method or funding source without the customer being\nphysically present.\n", "minLength": 0, "example": "cd5262a5-9041-4453-a8dc-8dd63975d66d", "x-validation-info": "Validation on the format of the string." }, "WebhookHeaderKlarnaSignature": { "type": "string", "minLength": 0, "maxLength": 255, "example": "2bb80d537b1da3e38bd30361aa855686bde0ba1611657e8d211d0d71fb4f177e", "description": "HMAC-SHA256 signature over the HTTP request body signed with the key identified by `Klarna-Signing-Key-ID`. \n\nThe signature is calculated over the full HTTP request body.\n\n `computedHexDigest = HMAC_SHA256_HexDigest(request.body, getSecretKey(request.headers[\"Klarna-Signing-Key-ID\"]))`\n\nCompare the computed signature with the value of the `Klarna-Signature` header. If they match, the request is coming\nfrom Klarna and you can process the webhook. If they do not match, you should reject the request.\n" }, "WebhookHeaderKlarnaSigningKeyID": { "type": "string", "minLength": 0, "maxLength": 255, "description": "The key used to sign the webhook.", "example": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5" }, "WebhookMetadata": { "type": "object", "description": "The metadata of the webhook event.\n", "required": ["event_type", "event_version", "event_id", "occurred_at", "webhook_id", "recipient_account_id", "subject_account_id", "live"], "properties": { "event_id": { "type": "string", "minLength": 0, "maxLength": 255, "example": "28ac927f-5ba7-4589-8bf7-1c8ada082343", "description": "The unique identifier of the delivered event." }, "event_type": { "type": "string", "description": "The event type of the webhook.", "minLength": 0, "maxLength": 255 }, "event_version": { "type": "string", "minLength": 0, "maxLength": 255, "example": "v2", "description": "The version of the payload event schema." }, "occurred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the event occurred. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "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" }, "subject_account_id": { "type": "string", "description": "The unique identifier of the account for which the event has occurred.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "recipient_account_id": { "type": "string", "description": "The unique identifier of the account that has configured the webhook and receives the notification.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "product_instance_id": { "type": "string", "description": "The unique identifier of the product instance.", "example": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "minLength": 0, "maxLength": 255 }, "webhook_id": { "type": "string", "description": "The unique identifier of the webhook that triggered the notification.", "example": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "minLength": 0, "maxLength": 255 }, "live": { "type": "boolean", "description": "A boolean flag indicating whether the event is generated in a production environment.", "example": true } } }, "identity.customer-token.state-change.revoked": { "type": "object", "description": "The common payload of a customer token revocation event.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "type": "object", "description": "The payload of the customer token revocation event.\n", "required": ["customer_token"], "properties": { "customer_token": { "type": "string", "description": "Returned if Account Linking or payment tokenization was requested.\n\nThe customer token represents the tokenized customer and allows you to act\non behalf of the customer. You must persist this token in your system associated with the customer\naccount. To de-duplicate customers, you should use the `customer_id` as the unique identifier.\n", "maxLength": 1024, "minLength": 1, "example": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "x-validation-info": "The identifier representing a tokenized customer that allows partners to act on behalf of the customer. The format can be either a UUID (legacy purchase token) or a KRN (customer token)." }, "customer_token_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Partner reference to the customer token created on Klarna side.\nThis will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.\n", "example": "partner_customer_token_1234", "x-validation-info": "Partner reference to the customer token created on Klarna side." } } } } }, "SDKToken": { "type": "string", "minLength": 1, "maxLength": 8192, "description": "

Early ReleaseFeature under development, may not be fully available and is subject to change as we continue building the service in partnership with early users

Acquiring PartnerAcquiring Partners integrate Klarna’s payment solutions into their own platforms or services, enabling their connected Partners to offer Klarna to end customers.

The SDK token can be used when initializing Web SDK or Mobile SDK in order to personalize customer experience.\n", "example": "hbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9zaG9wcGluZ19zZXNzaW9uX2lkIjoia3JuOnNob3BwaW5nOmV1MTpzZ" }, "SDKTokenResponse": { "type": "object", "description": "The response object for the SDK token.\n", "additionalProperties": false, "properties": { "sdk_token": { "$ref": "#/components/schemas/SDKToken" } } }, "PartnerAccountIdentifier": { "description": "Unique identifier assigned by Klarna to the onboarded partner.", "example": "krn:partner:global:account:live:LWT2XJSE", "x-validation-info": "The identifier must exist within Klarna's systems and be accessible with the credentials being used.", "type": "string", "minLength": 1, "maxLength": 255 } }, "responses": { "Forbidden": { "description": "Unauthorized access to the resource customer token.", "content": { "application/json": { "examples": { "Unauthorized access to the resource customer token": { "value": { "error_id": "1653c9db-454b-4222-8265-4c7ca209f630", "error_code": "OPERATION_FORBIDDEN", "error_type": "RESOURCE_ERROR", "error_message": "Unauthorized access to the resource customer token" } } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "NotFound": { "description": "Resource customer token does not exist.", "content": { "application/json": { "examples": { "Resource customer token does not exist": { "value": { "error_id": "1653c9db-454b-4222-8265-4c7ca209f630", "error_code": "RESOURCE_NOT_FOUND", "error_type": "RESOURCE_ERROR", "error_message": "Resource customer token does not exist" } } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "Conflict": { "description": "Resource customer token has been revoked.", "content": { "application/json": { "examples": { "Resource customer has been revoked": { "value": { "error_id": "1653c9db-454b-4222-8265-4c7ca209f630", "error_code": "CUSTOMER_TOKEN_REVOKED", "error_type": "RESOURCE_ERROR", "error_message": "Resource customer token has been revoked" } } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "BadRequest": { "description": "Bad Request, there was an error in the input of the request.\nThe request can not be retried without modifications.\n", "content": { "application/json": { "schema": { "description": "Bad Request, the request contained a validation error or the input did not conform to the expected content type syntax.\n", "oneOf": [{ "$ref": "#/components/schemas/InputErrorValidationError" }, { "$ref": "#/components/schemas/InputErrorContentTypeError" }], "discriminator": { "propertyName": "error_code", "mapping": { "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError", "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError" } } }, "examples": { "Invalid content type": { "value": { "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a", "error_type": "INPUT_ERROR", "error_code": "INVALID_CONTENT_TYPE", "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n" } }, "Validation error": { "description": "The request contained a validation error.\n", "value": { "error_id": "4e2f6b5e-df81-40e6-83d5-f34f68d4e2f4", "error_type": "INPUT_ERROR", "error_code": "VALIDATION_ERROR", "error_message": "An input parameter failed input validation.\nPlease refer to validation_errors for more details.\n", "validation_errors": [{ "parameter": "order_lines[0].total_line_amount", "reason": "Value must be greater than or equal to 0", "doc_url": "https://docs.klarna.com/payments/#orderlines" }, { "parameter": "shipping.address.country", "reason": "Value \"XX\" is not a valid country", "doc_url": "https://docs.klarna.com/payments/#shipping" }] } } } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "Unauthorized": { "description": "Unauthorized, the request was not authorized.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "RateLimited": { "description": "Too Many Requests, the request was rate limited.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "InternalServerError": { "description": "Internal Server Error, there was an unexpected error in the API.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorInternalError" }, "example": { "error_id": "3f2b1a67-df45-43e3-9e76-4b8f9e8f8c8d", "error_type": "TECHNICAL_ERROR", "error_code": "INTERNAL_ERROR", "error_message": "Something went wrong at Klarna, if the error persists please reach out to your support contact and include this message.\n" } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } }, "TemporarilyUnavailable": { "description": "Service Temporarily Unavailable, the system is temporarily unavailable to process the request.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" }, "example": { "error_id": "c72b7d19-8a29-4e1b-b3cf-2c7e96d9a4d5", "error_type": "TECHNICAL_ERROR", "error_code": "TEMPORARY_UNAVAILABLE", "error_message": "The system is temporarily unavailable to process the request. Please try again after some time.\n" } } }, "headers": { "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" } } } }, "parameters": {}, "headers": { "KlarnaCorrelationId": { "description": "UUID v4 that uniquely identifies the request.", "schema": { "type": "string", "format": "uuid", "minLength": 0, "maxLength": 36 } }, "PartnerCorrelationIdResponse": { "description": "An echo of the Partner-Correlation-Id header that was sent with the request.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 } } }, "examples": { "Customer_token_instrospection_response_for_active_customer_present": { "value": { "status": "ACTIVE", "scopes": ["payment:customer_present", "customer:login"], "issued_at": 1723791546323, "customer_token_reference": "partner_customer_token_1234" } }, "Customer_token_instrospection_response_for_revoked_customer_present": { "value": { "status": "REVOKED", "scopes": ["payment:customer_present", "customer:login"], "issued_at": 1723791546323, "customer_token_reference": "partner_customer_token_1234" } }, "Customer_token_revocation_response": { "value": { "customer_token_reference": "partner_customer_token_1234" } }, "Identity_customer_token_revoked_webhook": { "value": { "metadata": { "event_type": "identity.customer-token.state-change.revoked", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "customer_token": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "customer_token_reference": "partner-token-reference-1234" } } } } }, "servers": [{ "url": "https://api-global.klarna.com", "description": "Production environment" }, { "url": "https://api-global.test.klarna.com", "description": "Test environment" }], "tags": [] } }; 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."); }