"use strict"; const {jsx: _jsx} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const apiSpecs = { "name": "klarna-management-api", "title": "Management", "type": "klarna-network", "intendedFor": "partner_through_ap", "version": "v2", "release": "future", "spec": { "openapi": "3.1.1", "info": { "title": "Klarna Partner Management API", "description": "The Management API provides comprehensive capabilities for managing partner accounts and their associated data. It enables full control over account resources, allowing for the creation, updating, and deletion of data objects as needed.", "version": "v2/future" }, "security": [{ "klarna_api_key": [] }], "tags": [{ "name": "API Keys", "description": "Klarna API keys are authentication credentials used to securely connect to Klarna’s APIs. They allow your application to communicate with Klarna services, such as for handling payments, orders or refunds. Learn more about [Account Security in Integration Guidelines](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/connection-configuration/manage-your-api-credentials/)" }, { "name": "Client Identifiers", "description": "The **Client Identifiers API** allows the *authenticated* **Partner Account** to create, read, update and disable its client identifiers.\nA client identifier is the public `clientId` a browser or mobile integration presents when it initializes the Web SDK. Unlike an API key it carries no secret, so it is safe to expose in client-side code.\n" }, { "name": "Client Certificates", "description": "The **Client Certificates API** allows the *authenticated* **Partner Account** to create, read, update and revoke the client certificates it authenticates with, and to control whether mTLS authorization is enforced on its requests.\nA certificate is issued for either mTLS authentication or JWT signing. A partner account may hold at most ten certificates that are active or pending at any one time.\n" }, { "name": "IP Restrictions", "description": "The **IP Restrictions API** allows the *authenticated* **Partner Account** to restrict API access to a set of known IP ranges.\nThe allowlist accepts both IPv4 and IPv6 ranges and can be replaced wholesale or appended to. Enforcement is managed separately from the list, so a partner can assemble an allowlist before it takes effect.\n" }, { "name": "Allowed Client Origins", "description": "The **Allowed Client Origins API** allows the *authenticated* **Partner Account** to list, create, read, and delete allowed origin resources that control which client origins are permitted to load the Web SDK. Each origin is a resource identified by a KRN with its own state. Acquiring Partners can also manage allowed client origins on behalf of their Partner Accounts.\n" }], "x-tagGroups": [{ "name": "Security Management", "tags": ["API Keys", "Client Identifiers", "Client Certificates", "IP Restrictions", "Allowed Client Origins"] }], "components": { "securitySchemes": { "klarna_api_key": { "in": "header", "name": "Authorization", "type": "apiKey", "description": "Use the Klarna API key as HTTP Basic Authentication credentials" } }, "schemas": { "CredentialIdentifier": { "type": "string", "description": "A unique identifier assigned to a created credential. Used to reference the credential in Klarna's systems and APIs.\n", "x-validation-info": "Opaque string with size constraints", "maxLength": 100, "minLength": 5, "example": "krn:network:global:live:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5" }, "CredentialsStatus": { "type": "string", "description": "Status of the credential.\nSome types of credentials might have additional detailed status information.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ENABLED` | Indicates that the credential is valid and can be used. |\n| `DISABLED` | Indicates that the credential is inactive and cannot be used. |\n", "example": "ENABLED", "enum": ["ENABLED", "DISABLED"] }, "LastUsedAt": { "type": "string", "format": "date-time", "description": "Date and time when the credential was last used. This field is only present if a credential has been actively used to authenticate a request in an API call.", "example": "2025-01-01T00:00:00Z", "minLength": 20, "maxLength": 50 }, "EditablePublicCredentialData": { "type": "object", "properties": { "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" } } }, "CredentialType": { "type": "string", "description": "Indicates the type of credential to be created.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CLIENT` | A `clientId` which can be used by the Web SDK. |\n| `API` | An api-key. |\n| `CLIENT_CERT` | |\n| `SFTP` | |\n", "x-validation-info": "Validation against the enum, CLIENT or API", "example": "API", "enum": ["CLIENT", "API", "CLIENT_CERT", "SFTP"] }, "EnvironmentType": { "type": "string", "description": "Indicates the environment for which the credentials should be created,\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `LIVE` | |\n| `TEST` | |\n| `DEV` | |\n", "example": "TEST", "enum": ["LIVE", "TEST", "DEV"] }, "ExistingApiCredentials": { "description": "API credentials", "properties": { "credential_id": { "$ref": "#/components/schemas/CredentialIdentifier" }, "status": { "$ref": "#/components/schemas/CredentialsStatus" }, "last_used_at": { "$ref": "#/components/schemas/LastUsedAt" }, "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "type": { "$ref": "#/components/schemas/CredentialType" }, "environment": { "$ref": "#/components/schemas/EnvironmentType" } }, "type": "object", "required": ["type", "environment", "credential_id", "status"] }, "CredentialsSecret": { "type": "string", "minLength": 0, "maxLength": 180, "example": "klarna_test_api_a1234567N243N1htM05kRDhaA35DFzUoMz9MbXhwT1gsYWFhNWN331hNzEtODgzZC00NWMzLTlkNDAtMzA3NGI3ODgzYWMwLDEsUldMdWs522d5621tuelJIVXV5S1FTVldRM21rVitEUVNONjBwY3F238def223fs2G", "description": "This field will contain the API key when requesting credentials for the `type = API`" }, "CreatedApiCredentials": { "description": "API credentials", "properties": { "credential_id": { "$ref": "#/components/schemas/CredentialIdentifier" }, "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "type": { "$ref": "#/components/schemas/CredentialType" }, "environment": { "$ref": "#/components/schemas/EnvironmentType" }, "secret": { "type": "object", "description": "Secret properties associated with a credential. Generally just returned the first time after the creation of the credential", "properties": { "secret": { "$ref": "#/components/schemas/CredentialsSecret" } }, "required": ["secret"] }, "status": { "$ref": "#/components/schemas/CredentialsStatus" } }, "type": "object", "required": ["type", "environment", "credential_id", "secret", "status"], "example": { "credential_id": "krn:network:global:live:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5", "description": "API Credentials", "type": "API", "environment": "TEST", "secret": { "secret": "klarna_test_api_a1234567N243N1htM05kRDhaA35DFzUoMz9MbXhwT1gsYWFhNWN331hNzEtODgzZC00NWMzLTlkNDAtMzA3NGI3ODgzYWMwLDEsUldMdWs522d5621tuelJIVXV5S1FTVldRM21rVitEUVNONjBwY3F238def223fs2G" }, "status": "ENABLED" } }, "ExistingClientCredentials": { "description": "Web SDK credentials", "properties": { "credential_id": { "$ref": "#/components/schemas/CredentialIdentifier" }, "identity": { "description": "Object containing all data associated with the identity elements of the credential", "type": "object", "properties": { "client_id": { "description": "The clientId required to instantiate the Klarna Web SDK", "type": "string", "minLength": 0, "maxLength": 180 } }, "required": ["client_id"] }, "status": { "$ref": "#/components/schemas/CredentialsStatus" }, "last_used_at": { "$ref": "#/components/schemas/LastUsedAt" }, "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "type": { "$ref": "#/components/schemas/CredentialType" }, "environment": { "$ref": "#/components/schemas/EnvironmentType" } }, "type": "object", "required": ["type", "environment", "credential_id", "identity", "status"] }, "ClientCertificateState": { "type": "string", "description": "State of the certificate.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `VALID` | mTLS certificate authentication is valid |\n| `REVOKED` | mTLS certificate has been revoked |\n| `EXPIRED` | mTLS certificate validity time is expired |\n", "enum": ["VALID", "REVOKED", "EXPIRED"] }, "ClientCertificateUsageType": { "type": "string", "description": "The usage type of the client certificate\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `MTLS` | |\n| `JWT_SIGNING` | |\n", "x-validation-info": "Validation that is MTLS or JWT_SIGNING", "example": "MTLS", "enum": ["MTLS", "JWT_SIGNING"] }, "ExistingClientCertificateCredentials": { "description": "Client Certificate Credentials", "properties": { "credential_id": { "$ref": "#/components/schemas/CredentialIdentifier" }, "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "type": { "$ref": "#/components/schemas/CredentialType" }, "environment": { "$ref": "#/components/schemas/EnvironmentType" }, "identity": { "description": "Object containing all data associated with the identity elements of the credential", "type": "object", "properties": { "serial_number": { "description": "The clientId required to instantiate the Klarna Web SDK", "type": "string", "minLength": 0 } }, "required": ["serial_number"] }, "config": { "type": "object", "description": "Configuration properties of the credential", "properties": { "expiration_date": { "type": "string", "minLength": 0, "format": "date-time", "description": "Date when the certificate expires" }, "certificate_state": { "$ref": "#/components/schemas/ClientCertificateState" }, "usage": { "$ref": "#/components/schemas/ClientCertificateUsageType" } }, "required": ["expiration_date", "certificate_state"] }, "status": { "$ref": "#/components/schemas/CredentialsStatus" } }, "type": "object", "required": ["type", "environment", "credential_id", "identity", "status"] }, "ClientCertificateCreateParameters": { "type": "object", "properties": { "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "config": { "type": "object", "description": "Configuration properties of the credential", "x-validation-info": "Validation that config contains the required properties", "properties": { "usage": { "type": "string", "description": "The usage type of the client certificate\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `MTLS` | |\n| `JWT_SIGNING` | |\n", "x-validation-info": "Validation that is MTLS or JWT_SIGNING", "example": "MTLS", "enum": ["MTLS", "JWT_SIGNING"] }, "certificate_signing_request": { "type": "string", "minLength": 0, "description": "The CSR to be signed by Klarna", "example": "-----BEGIN CERTIFICATE REQUEST-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA ... \n-----END CERTIFICATE REQUEST-----" } }, "required": ["usage", "certificate_signing_request"] } }, "description": "Parameters required to create a client certificate", "required": ["config"] }, "ClientCertificateString": { "type": "string", "minLength": 0, "maxLength": 2000, "example": "-----BEGIN CERTIFICATE-----\\nMIICRTCCAeugAwIBAgIUe6qaOZb4EzHXoo/j9DFEBpM8MC8wCgYIKoZIzj0EAwIw\\nQzELMAkGA1UEBhMCU0UxFzAVBgNVBAoMDktsYXJuYSBCYW5rIEFCMRswGQYDVQQD\\nDBJnbG9iYWwgYXBpIGdhdGV3YXkwHhcNMjQwNzMwMTM1NDIwWhcNMzQwNzI4MTM1\\nNDIwWjB1MQswCQYDVQQGEwJFVTETMBEGA1UECAwKS2FybHNrcm9uYTERMA8GA1UE\\nBwwIQmxla2luZ2UxDzANBgNVBAoMBktsYXJuYTEeMBwGA1UECwwVS2xhcm5hJ3Mg\\nQXdlc29tZSBUZWFtMQ0wCwYDVQQDDAR0ZXN0MFkwEwYHKoZIzj0CAQYIKoZIzj0D\\nAQcDQgAEfYVA8o8JhsbVKyL60j5Ie1wlrYueyrkCBf884oZ3/ZK/C97MEx0wPUou\\nbQG4lUu7Elxh7v1ZLw1s70qc1Vb0S6OBijCBhzBFBgNVHREEPjA8gjprcm46cGFy\\ndG5lci1jcmVkZW50aWFsLXNlcnZpY2U6Y3JlZGVudGlhbC1ncm91cDpkcHA6SzEx\\nMTExMB0GA1UdDgQWBBRygoTD/nuTYJMe1wPWISQYj2IWDTAfBgNVHSMEGDAWgBSZ\\ndHhqsERQFJJMr9TKKoiBz5TemTAKBggqhkjOPQQDAgNIADBFAiEAkTmgITBEt7NY\\nFu40guvnnS2nirMiSOLAqTHRZoqc3wYCIGyVJa3zHvTPNvL2NXfQpjd9Uy3A+tC0\\\\nrcfZgk/egfkA\\n-----END CERTIFICATE-----", "description": "Stringified PEM encoded client certificate. This field will be returned when requesting a client certificate of type MTLS or JWT_SIGNING." }, "CreatedClientCertificateCredentials": { "description": "Client Certificate Credentials", "properties": { "credential_id": { "$ref": "#/components/schemas/CredentialIdentifier" }, "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "type": { "$ref": "#/components/schemas/CredentialType" }, "environment": { "$ref": "#/components/schemas/EnvironmentType" }, "identity": { "description": "Object containing all data associated with the identity elements of the credential", "type": "object", "properties": { "serial_number": { "description": "The clientId required to instantiate the Klarna Web SDK", "type": "string", "minLength": 0 } }, "required": ["serial_number"] }, "config": { "type": "object", "description": "Configuration properties of the credential", "properties": { "expiration_date": { "type": "string", "format": "date-time", "description": "Date when the certificate expires", "minLength": 0 }, "certificate_state": { "$ref": "#/components/schemas/ClientCertificateState" }, "usage": { "$ref": "#/components/schemas/ClientCertificateUsageType" } }, "required": ["expiration_date", "certificate_state", "usage"] }, "status": { "$ref": "#/components/schemas/CredentialsStatus" }, "secret": { "type": "object", "description": "Issued client certificate. Stringified PEM encoded certificate.", "properties": { "certificate": { "$ref": "#/components/schemas/ClientCertificateString" } }, "required": ["certificate"] } }, "type": "object", "required": ["type", "environment", "credential_id", "identity", "secret"] }, "ClientCertificateRevokedFrom": { "type": "string", "format": "date-time", "minLength": 0, "description": "Date when the certificate expires", "example": "2021-12-31T23:59:59Z", "x-validation-info": "Check that it's a date and time in ISO 8601 format." }, "ClientCertificateRevokeParameters": { "type": "object", "properties": { "revoked_from": { "$ref": "#/components/schemas/ClientCertificateRevokedFrom" } }, "required": ["revoked_from"] }, "ClientCertificateRevokeStatus": { "description": "Client Certificate Credentials", "properties": { "credential_id": { "$ref": "#/components/schemas/CredentialIdentifier" }, "description": { "type": "string", "description": "Description provided by the partner when creating a set of credentials", "example": "Test API Credentials", "pattern": "^[a-zA-Z0-9\\-:;., _]{0,100}$", "x-validation-info": "Validation against the length" }, "type": { "$ref": "#/components/schemas/CredentialType" }, "environment": { "$ref": "#/components/schemas/EnvironmentType" }, "identity": { "description": "Object containing all data associated with the identity elements of the credential", "type": "object", "properties": { "serial_number": { "description": "The clientId required to instantiate the Klarna Web SDK", "type": "string", "minLength": 0 } }, "required": ["serial_number"] }, "config": { "type": "object", "description": "Configuration properties of the credential", "properties": { "expiration_date": { "type": "string", "minLength": 0, "format": "date-time", "description": "Date when the certificate expires" }, "certificate_state": { "$ref": "#/components/schemas/ClientCertificateState" }, "usage": { "$ref": "#/components/schemas/ClientCertificateUsageType" }, "revoked_from": { "$ref": "#/components/schemas/ClientCertificateRevokedFrom" } }, "required": ["expiration_date", "certificate_state", "revoked_from"] }, "status": { "$ref": "#/components/schemas/CredentialsStatus" } }, "type": "object", "required": ["type", "environment", "credential_id", "identity", "status", "config"] }, "PartnerIpAllowListOperationMode": { "type": "string", "description": "IP restriction operation mode that defines how restrictions are applied.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `NOT_ENABLED` | IP restriction feature is not enabled. |\n| `REPORTING` | Does not enforce IP restriction; Klarna reports status as a response header. |\n| `ENFORCED` | Enforces IP validation, requests not from allowed IPs are rejected. |\n", "enum": ["NOT_ENABLED", "REPORTING", "ENFORCED"] }, "PartnerIpAllowListEnforcementModeNotEnabled": { "type": "object", "required": ["enforcement_mode"], "properties": { "enforcement_mode": { "$ref": "#/components/schemas/PartnerIpAllowListOperationMode" } }, "description": "IP restriction operation mode set to NOT_ENABLED." }, "PartnerIpAllowListEnforcementModeInResponseNotEnabled": { "type": "object", "required": ["enforcement_mode"], "properties": { "enforcement_mode": { "$ref": "#/components/schemas/PartnerIpAllowListOperationMode" } }, "description": "IP restriction operation mode set to NOT_ENABLED." }, "PartnerIpAllowListEnforcedFrom": { "type": "string", "format": "date-time", "example": "2021-12-31T23:59:59Z", "description": "Timestamp indicating when IP restriction enforcement will begin.", "minLength": 20, "maxLength": 20 }, "PartnerIpAllowListEnforcementModeInResponseReporting": { "type": "object", "required": ["enforcement_mode"], "properties": { "enforcement_mode": { "$ref": "#/components/schemas/PartnerIpAllowListOperationMode" }, "enforced_from": { "$ref": "#/components/schemas/PartnerIpAllowListEnforcedFrom" } }, "description": "IP restriction operation mode set to REPORTING." }, "PartnerIpAllowListEnforcementModeInResponseEnforced": { "type": "object", "required": ["enforcement_mode"], "properties": { "enforcement_mode": { "$ref": "#/components/schemas/PartnerIpAllowListOperationMode" }, "enforced_from": { "$ref": "#/components/schemas/PartnerIpAllowListEnforcedFrom" } }, "description": "IP restriction operation mode set to ENFORCED." }, "PartnerIpAllowListEnforcementStatus": { "type": "object", "description": "Current status of IP restriction enforcement.", "required": ["enforcement_mode"], "anyOf": [{ "$ref": "#/components/schemas/PartnerIpAllowListEnforcementModeInResponseNotEnabled" }, { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementModeInResponseReporting" }, { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementModeInResponseEnforced" }], "discriminator": { "propertyName": "enforcement_mode", "mapping": { "NOT_ENABLED": "#/components/schemas/PartnerIpAllowListEnforcementModeInResponseNotEnabled", "REPORTING": "#/components/schemas/PartnerIpAllowListEnforcementModeInResponseReporting", "ENFORCED": "#/components/schemas/PartnerIpAllowListEnforcementModeInResponseEnforced" } } }, "PartnerIpAllowListEnforcementModeReporting": { "type": "object", "required": ["enforcement_mode"], "properties": { "enforcement_mode": { "$ref": "#/components/schemas/PartnerIpAllowListOperationMode" } }, "description": "IP restriction operation mode set to REPORTING." }, "PartnerIpAllowListEnforcementType": { "type": "string", "description": "Type of IP restriction enforcement timing.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `NOW` | Enforcement takes effect within 5 minutes. `enforced_from` is ignored. |\n| `SCHEDULED` | Enforcement takes effect at a specified future date and time. |\n", "example": "SCHEDULED", "enum": ["NOW", "SCHEDULED"] }, "PartnerIpAllowListEnforcementModeEnforced": { "type": "object", "required": ["enforcement_mode", "enforcement_type"], "properties": { "enforcement_mode": { "$ref": "#/components/schemas/PartnerIpAllowListOperationMode" }, "enforcement_type": { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementType" }, "enforced_from": { "type": "string", "format": "date-time", "example": "2021-12-31T23:59:59Z", "description": "Timestamp indicating when IP restriction enforcement will begin.", "minLength": 20, "maxLength": 20, "x-validation-info": "The timestamp must be a datetime in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ). The timestamp cannot be in the past and must be at most 3 months in the future. Enforcement takes up to 5 minutes from the configured timestamp.\n" } }, "description": "IP restriction operation mode set to ENFORCED." }, "PartnerIpAllowListEnforcementParameters": { "description": "Parameters for configuring IP restriction enforcement.", "type": "object", "required": ["enforcement_mode"], "anyOf": [{ "$ref": "#/components/schemas/PartnerIpAllowListEnforcementModeNotEnabled" }, { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementModeReporting" }, { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementModeEnforced" }], "discriminator": { "propertyName": "enforcement_mode", "mapping": { "NOT_ENABLED": "#/components/schemas/PartnerIpAllowListEnforcementModeNotEnabled", "REPORTING": "#/components/schemas/PartnerIpAllowListEnforcementModeReporting", "ENFORCED": "#/components/schemas/PartnerIpAllowListEnforcementModeEnforced" } } }, "AllowedOriginIdentifier": { "type": "string", "description": "Klarna Resource Name (KRN) of the allowed origin resource. The environment segment is `live` in production and `test` in playground/staging.", "x-validation-info": "The identifier must be a KRN previously returned by the API. The value must exist within Klarna's systems and be accessible with the credentials being used.", "maxLength": 255, "minLength": 50, "example": "krn:network:global:live:account:allowed-origin:206bbb83-9b6e-46fa-940d-337153c04a58" }, "AllowedOriginValue": { "description": "The full allowed client origin as resolved by Klarna, including the scheme (http or https) and an optional port. Klarna determines the scheme; Partners do not supply it as input. Klarna returns a bare wildcard input (*) as https://* (non-production only).\n", "type": "string", "minLength": 8, "maxLength": 2048, "pattern": "^https?://(\\*|((\\*\\.|([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)*)[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+|localhost)(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?)$", "x-validation-info": "The resolved origin returned by the API. Always includes a scheme (http:// or https://) and an optional port suffix (:1–:65535) when present. A bare wildcard input (*) is returned as https://* (non-production only). Paths, query parameters, and fragments are never included.\n", "example": "https://shop.example.com" }, "AllowedOriginState": { "type": "string", "description": "Indicates whether the origin is currently allowed to load the Web SDK.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ALLOWED` | Klarna accepts traffic from this origin. |\n| `BLOCKED` | The origin exists but Klarna does not currently permit it — for example, when Klarna has suspended the origin due to a policy violation or Klarna is verifying the origin. Partners can delete and re-create the origin to attempt remediation. |\n", "x-validation-info": "Accepted values are `ALLOWED` and `BLOCKED` only. `ALLOWED` indicates the origin is active and permitted to load the Web SDK. `BLOCKED` indicates the origin is currently suspended or pending verification and is not permitted.\n", "example": "ALLOWED", "enum": ["ALLOWED", "BLOCKED"] }, "AllowedOriginResource": { "description": "An allowed client origin resource associated with the account.", "type": "object", "required": ["origin_id", "origin", "state"], "properties": { "origin_id": { "$ref": "#/components/schemas/AllowedOriginIdentifier" }, "origin": { "$ref": "#/components/schemas/AllowedOriginValue" }, "state": { "$ref": "#/components/schemas/AllowedOriginState" } }, "example": { "origin_id": "krn:network:global:live:account:allowed-origin:206bbb83-9b6e-46fa-940d-337153c04a58", "origin": "https://shop.example.com", "state": "ALLOWED" } }, "Link": { "type": "object", "description": "A URI to a resource", "required": ["href"], "properties": { "href": { "type": "string", "minLength": 1, "pattern": "^(https?:\\/\\/[^\\s\\/]+)?\\/[^\\s]*$", "example": "/v1/settlement/payouts?size=20&starting_after=Fvt0G2tMGTuGx", "description": "A relative path or full URL to the resource" }, "method": { "type": "string", "example": "GET", "description": "The HTTP method to use when accessing the resource. Omitting this field implies GET.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `GET` | |\n| `POST` | |\n| `PUT` | |\n| `DELETE` | |\n| `PATCH` | |\n| `OPTIONS` | |\n| `HEAD` | |\n| `TRACE` | |\n| `CONNECT` | |\n", "enum": ["GET", "POST", "PUT", "DELETE", "PATCH", "OPTIONS", "HEAD", "TRACE", "CONNECT"] }, "rel": { "type": "string", "minLength": 0, "example": "Get the next page of results", "description": "A descriptive relation indicating the link's purpose or relationship to the current resource" } } }, "PaginationResponse": { "type": "object", "description": "A paginated response will return this object with information about the size and links to any next and previous pages.", "required": ["count"], "properties": { "last_item": { "type": "string", "minLength": 0, "example": "Fvt0G2tMGTuGx", "description": "Cursor referring to last item in the returned results. Can be used for getting the next page together with \"starting_after\". Omitted if there are no more items.\n" }, "first_item": { "type": "string", "minLength": 0, "example": "Bxp4Z3sWFXmKq", "description": "Cursor referring to first item in the returned results. Can be used for getting the previous page together with \"ending_before\". May be omitted if there is no previous page or stepping back is not supported.\n" }, "count": { "type": "integer", "format": "int32", "example": 20, "description": "The number of returned items." }, "total": { "type": "integer", "format": "int32", "example": 1025, "description": "The total number of items available." }, "_links": { "type": "object", "description": "HATEOAS links to any next and/or previous pages in a pagination context. Not every operation provides links. Where they are provided, each link is omitted when there is no page in that direction or navigating that way is not supported, and when neither link is present the object may be omitted or empty.\n", "properties": { "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" } } } } }, "AllowedOriginListResponse": { "description": "Paginated list of allowed client origin resources configured for the account. The response includes standard pagination fields for forward compatibility; Klarna currently returns all origins in a single page.\n", "type": "object", "required": ["origins", "pagination"], "properties": { "origins": { "description": "The allowed client origin entries returned for this page of results.", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/AllowedOriginResource" } }, "pagination": { "$ref": "#/components/schemas/PaginationResponse" } }, "example": { "origins": [{ "origin_id": "krn:network:global:live:account:allowed-origin:f7e8d9c0-b1a2-3456-cdef-7890abcdef12", "origin": "http://localhost:3000", "state": "ALLOWED" }, { "origin_id": "krn:network:global:live:account:allowed-origin:206bbb83-9b6e-46fa-940d-337153c04a58", "origin": "https://example.com", "state": "ALLOWED" }, { "origin_id": "krn:network:global:live:account:allowed-origin:a1b2c3d4-e5f6-7890-abcd-ef1234567890", "origin": "https://shop.example.com", "state": "ALLOWED" }], "pagination": { "count": 3 } } }, "KlarnaIdempotencyKey": { "type": "string", "minLength": 1, "maxLength": 255, "description": "A partner-generated key that makes this request safe to retry. Klarna replays the original response when the same key is resubmitted with the same body, so a network error or timeout can be retried without creating a second resource. Use a fresh value per logical request, ideally a UUID v4 or v7." }, "AllowedOrigin": { "description": "An allowed client origin containing the host and an optional port. A bare wildcard (*) matches all origins but Klarna accepts it only in non-production environments; Klarna rejects it in production.\n", "type": "string", "minLength": 1, "maxLength": 1024, "pattern": "^(\\*|((\\*\\.|([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?\\.)*)[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(\\.[a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+|localhost)(:(6553[0-5]|655[0-2]\\d|65[0-4]\\d{2}|6[0-4]\\d{3}|[1-5]\\d{4}|[1-9]\\d{0,3}))?)$", "x-validation-info": "Accepts an origin with an optional port. Supported formats: bare wildcard (*) to match all origins (non-production only), wildcard subdomain (*.example.com), fully-qualified domain name (shop.example.com), and localhost. Each DNS label must be RFC 1035 LDH-valid (letters, digits, and hyphens; no leading or trailing hyphen) and allows up to 63 characters; this includes punycode/IDN labels (xn--...). An optional port suffix (:1–:65535) is permitted. Schemes (http/https), paths, query parameters, and fragments are not allowed.\n", "example": "shop.example.com" }, "CreateAllowedOriginRequest": { "description": "Request body for creating an allowed client origin. The origin must be a host with an optional port and without a scheme; Klarna accepts wildcard subdomain patterns.", "type": "object", "required": ["origin"], "properties": { "origin": { "$ref": "#/components/schemas/AllowedOrigin" } }, "example": { "origin": "new-shop.example.com" } }, "IpAllowList": { "description": "List of IP ranges (both IPv4 and IPv6) that a partner is allowed to use to access the API.", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "minLength": 2, "maxLength": 43, "pattern": "^(((25[0-5]|2[0-4][0-9]|1?[0-9]{1,2})\\.){3}(25[0-5]|2[0-4][0-9]|1?[0-9]{1,2})(/(3[0-2]|[12][0-9]|[8-9]))|((?=.*::)(?!.*::.*::)(::)?([0-9a-fA-F]{1,4}(:|::)){0,6}([0-9a-fA-F]{1,4})?|([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4})(/(12[0-8]|1[01][0-9]|[5-9][0-9]|4[8-9])))$", "x-validation-info": "This pattern validates IPv4 and IPv6 addresses, with subnet masks. It ensures IPv4 addresses have valid 0-255 octets and CIDRs from /8 to /32. IPv6 is supported in full or compressed form with CIDRs from /48 to /128, while also preventing multiple \"::\" sequences. The pattern avoids invalid formats like 999.999.999.999 or malformed IPv6 blocks.\n" }, "example": ["8.8.8.8/32", "1.1.1.0/24", "2001:4860:4860::8888/128"] }, "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 } } } }, "requestBodies": {}, "responses": {}, "parameters": { "PaginationSize": { "name": "size", "in": "query", "description": "Limits the number of items to be returned. If omitted, the default page size will be used.", "required": false, "example": 20, "schema": { "type": "integer", "format": "int32" } }, "PaginationStartingAfter": { "name": "starting_after", "in": "query", "description": "A cursor used in pagination, referring to a specific item. The `last_item` returned from a previous call can be used here. The next page will list items after this item. Omit it to get the first page.\n", "required": false, "example": "Zpq6F3mDYtwK8", "schema": { "type": "string", "minLength": 1 } }, "PaginationEndingBefore": { "name": "ending_before", "in": "query", "description": "A cursor used in pagination, referring to a specific item. The `first_item` returned from a previous call can be used here. The next page will list items up until, but not including, this item. Cannot be used together with `starting_after`; omit both to get the first page.\n", "required": false, "example": "Zpq6F3mDYtwK8", "schema": { "type": "string", "minLength": 1 } }, "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": { "KlarnaLocationReference": { "description": "The URL to the created resource.", "schema": { "type": "string", "maxLength": 1024, "minLength": 0 } }, "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 } }, "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 } }, "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"] } } }, "examples": {} }, "servers": [{ "url": "https://api-global.klarna.com", "description": "Production environment" }, { "url": "https://api-global.test.klarna.com", "description": "Test environment" }], "paths": { "/v2/account/integration/credentials/api-key": { "post": { "tags": ["API Keys"], "summary": "Create an API Key", "operationId": "createCredentialsApi", "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.

Create a new API-key credential.

\n \n Operation ID:\n A unique identifier for the operation.\n \n createCredentialsApi\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditablePublicCredentialData" }, "example": { "description": "Production API Credentials" } } } }, "responses": { "201": { "description": "Credential created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedApiCredentials" }, "example": { "credential_id": "krn:network:global:live:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5", "description": "Production API Credentials", "type": "API", "environment": "LIVE", "secret": { "secret": "klarna_live_api_a1234567N243N1htM05kRDhaA35DFzUoMz9MbXhwT1gsYWFhNWN331hNzEtODgzZC00NWMzLTlkNDAtMzA3NGI3ODgzYWMwLDEsUldMdWs522d5621tuelJIVXV5S1FTVldRM21rVitEUVNONjBwY3F238def223fs2G" }, "status": "ENABLED" } } }, "headers": { "Location": { "$ref": "#/components/headers/KlarnaLocationReference" }, "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": { "tags": ["API Keys"], "summary": "List all API Keys", "operationId": "getCredentialsApi", "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.

List all credentials associated with the current partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n getCredentialsApi\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "responses": { "200": { "description": "Credentials found", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "description": "List of credentials", "items": { "$ref": "#/components/schemas/ExistingApiCredentials" } } } }, "example": { "credentials": [{ "credential_id": "krn:network:global:test:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5", "status": "ENABLED", "description": "Test API Credentials", "type": "API", "environment": "TEST", "last_used_at": "2025-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/account/integration/credentials/api-key/{credential_id}": { "get": { "tags": ["API Keys"], "operationId": "readCredentialApi", "summary": "Read an API Key", "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.

Read all details from a Credential

\n \n Operation ID:\n A unique identifier for the operation.\n \n readCredentialApi\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Credential details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingApiCredentials" }, "example": { "credential_id": "krn:network:global:test:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5", "status": "ENABLED", "description": "Test API Credentials", "type": "API", "environment": "TEST", "last_used_at": "2025-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" } } } } }, "patch": { "tags": ["API Keys"], "operationId": "updateCredentialApi", "summary": "Update an API Key", "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.

Update details of a Credential.

\n \n Operation ID:\n A unique identifier for the operation.\n \n updateCredentialApi\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditablePublicCredentialData" }, "example": { "description": "Test API Credentials" } } } }, "responses": { "200": { "description": "Credential was updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingApiCredentials" } } }, "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" } } } } }, "delete": { "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "tags": ["API Keys"], "summary": "Disable an API Key", "operationId": "deleteCredentialApi", "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.

Disable a Credential. If the credential is already disabled, the operation succeeds without any changes.

\n \n Operation ID:\n A unique identifier for the operation.\n \n deleteCredentialApi\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "responses": { "204": { "description": "Credential deactivated with success", "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" } } } } } }, "/v2/account/integration/credentials/client-identifier": { "post": { "tags": ["Client Identifiers"], "summary": "Create a Client Identifier", "operationId": "createCredentialsClient", "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.

Create a new credential

\n \n Operation ID:\n A unique identifier for the operation.\n \n createCredentialsClient\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditablePublicCredentialData" }, "example": { "description": "Production Client Identifier" } } } }, "responses": { "201": { "description": "Credential created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingClientCredentials" }, "example": { "credential_id": "krn:network:global:live:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5", "identity": { "client_id": "klarna_live_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ" }, "status": "ENABLED", "description": "Production Client Identifier", "type": "CLIENT", "environment": "LIVE" } } }, "headers": { "Location": { "$ref": "#/components/headers/KlarnaLocationReference" }, "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": { "tags": ["Client Identifiers"], "summary": "List all Client Identifiers", "operationId": "getCredentialsClient", "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.

List all credentials associated with the current partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n getCredentialsClient\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "responses": { "200": { "description": "Credentials found", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "description": "List of credentials", "items": { "$ref": "#/components/schemas/ExistingClientCredentials" } } } }, "example": { "credentials": [{ "credential_id": "krn:network:global:test:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5", "identity": { "client_id": "klarna_test_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ" }, "status": "ENABLED", "description": "Test Client ID Credentials", "type": "CLIENT", "environment": "TEST", "last_used_at": "2025-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/account/integration/credentials/client-identifier/{credential_id}": { "get": { "tags": ["Client Identifiers"], "operationId": "readCredentialClient", "summary": "Read a Client Identifier", "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.

Read all details from a Credential

\n \n Operation ID:\n A unique identifier for the operation.\n \n readCredentialClient\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Credential details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingClientCredentials" }, "example": { "credential_id": "krn:network:global:test:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5", "identity": { "client_id": "klarna_test_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ" }, "status": "ENABLED", "description": "Test Client ID credential", "type": "CLIENT", "environment": "TEST", "last_used_at": "2025-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" } } } } }, "patch": { "tags": ["Client Identifiers"], "operationId": "updateCredentialClient", "summary": "Update a Client Identifier", "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.

Update details of a Credential.

\n \n Operation ID:\n A unique identifier for the operation.\n \n updateCredentialClient\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditablePublicCredentialData" } } } }, "responses": { "200": { "description": "Credential was updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingClientCredentials" }, "example": { "credential_id": "krn:network:global:test:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5", "identity": { "client_id": "klarna_test_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ" }, "status": "ENABLED", "description": "Test Client ID credential", "type": "CLIENT", "environment": "TEST" } } }, "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" } } } } }, "delete": { "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "tags": ["Client Identifiers"], "summary": "Disable a Client Identifier", "operationId": "deleteCredentialClient", "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.

Disable a Credential. If the credential is already disabled, the operation succeeds without any changes.

\n \n Operation ID:\n A unique identifier for the operation.\n \n deleteCredentialClient\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "responses": { "204": { "description": "Credential deactivated with success", "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" } } } } } }, "/v2/account/integration/credentials/client-certificate": { "post": { "tags": ["Client Certificates"], "summary": "Create a client certificate", "operationId": "createCredentialsClientCertificate", "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 client certificate.\nA maximum of 10 client certificates can be created per partner account.\nIf there are already 10 client certificates that are either active or pending, the request will return a 400 status code.

\n \n Operation ID:\n A unique identifier for the operation.\n \n createCredentialsClientCertificate\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_mtls-certificate\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

", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCertificateCreateParameters" } } } }, "responses": { "201": { "description": "Client certificate created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedClientCertificateCredentials" }, "example": { "credential_id": "krn:network:global:live:credential:client_cert:298342987AB9832983893983", "description": "Test client certificate", "type": "CLIENT_CERT", "environment": "LIVE", "identity": { "serial_number": "298342987AB9832983893983" }, "config": { "expiration_date": "2019-08-24T14:15:22Z", "certificate_state": "VALID", "usage": "MTLS" }, "secret": { "certificate": "-----BEGIN CERTIFICATE-----\nMIICRTCCAeugAwIBAgIUe6qaOZb4EzHXoo/j9DFEBpM8MC8wCgYIKoZIzj0EAwIw\nQzELMAkGA1UEBhMCU0UxFzAVBgNVBAoMDktsYXJuYSBCYW5rIEFCMRswGQYDVQQD\nDBJnbG9iYWwgYXBpIGdhdGV3YXkwHhcNMjQwNzMwMTM1NDIwWhcNMzQwNzI4MTM1\nNDIwWjB1MQswCQYDVQQGEwJFVTETMBEGA1UECAwKS2FybHNrcm9uYTERMA8GA1UE\nBwwIQmxla2luZ2UxDzANBgNVBAoMBktsYXJuYTEeMBwGA1UECwwVS2xhcm5hJ3Mg\nQXdlc29tZSBUZWFtMQ0wCwYDVQQDDAR0ZXN0MFkwEwYHKoZIzj0CAQYIKoZIzj0D\nAQcDQgAEfYVA8o8JhsbVKyL60j5Ie1wlrYueyrkCBf884oZ3/ZK/C97MEx0wPUou\nbQG4lUu7Elxh7v1ZLw1s70qc1Vb0S6OBijCBhzBFBgNVHREEPjA8gjprcm46cGFy\ndG5lci1jcmVkZW50aWFsLXNlcnZpY2U6Y3JlZGVudGlhbC1ncm91cDpkcHA6SzEx\nMTExMB0GA1UdDgQWBBRygoTD/nuTYJMe1wPWISQYj2IWDTAfBgNVHSMEGDAWgBSZ\ndHhqsERQFJJMr9TKKoiBz5TemTAKBggqhkjOPQQDAgNIADBFAiEAkTmgITBEt7NY\nFu40guvnnS2nirMiSOLAqTHRZoqc3wYCIGyVJa3zHvTPNvL2NXfQpjd9Uy3A+tC0\nrcfZgk/egfkA\n-----END CERTIFICATE-----" }, "status": "ENABLED" } } }, "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": { "tags": ["Client Certificates"], "summary": "List all current client certificates", "operationId": "listCredentialsClientCertificate", "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.

Returns all client certificates for the current partner account.

\n \n Operation ID:\n A unique identifier for the operation.\n \n listCredentialsClientCertificate\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_mtls-certificate\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

", "responses": { "200": { "description": "List of client certificates", "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "array", "description": "List of credentials", "items": { "$ref": "#/components/schemas/ExistingClientCertificateCredentials" } } } }, "example": { "credentials": [{ "credential_id": "krn:network:global:test:credential:client_cert:892489249828924892", "description": "Test client certificate credential", "type": "CLIENT_CERT", "environment": "TEST", "identity": { "serial_number": "892489249828924892" }, "config": { "expiration_date": "2028-08-24T14:15:22Z", "certificate_state": "VALID", "usage": "MTLS" }, "status": "ENABLED" }] } } }, "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/account/integration/credentials/client-certificate/{credential_id}": { "get": { "tags": ["Client Certificates"], "summary": "Read the data for a client certificate", "operationId": "readCredentialsClientCertificate", "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.

Returns the full details of a client certificate, including serial number, expiration date, certificate state, and usage type.

\n \n Operation ID:\n A unique identifier for the operation.\n \n readCredentialsClientCertificate\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_mtls-certificate\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Read the data for a client certificate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingClientCertificateCredentials" }, "example": { "credential_id": "krn:network:global:test:credential:client_cert:892489249828924892", "description": "Test client certificate credential", "type": "CLIENT_CERT", "environment": "TEST", "identity": { "serial_number": "892489249828924892" }, "config": { "expiration_date": "2028-08-24T14:15:22Z", "certificate_state": "VALID", "usage": "MTLS" }, "status": "ENABLED" } } }, "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" } } } } }, "patch": { "tags": ["Client Certificates"], "summary": "Update a Client Certificate", "operationId": "updateCredentialsClientCertificate", "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 the description of a client certificate.

\n \n Operation ID:\n A unique identifier for the operation.\n \n updateCredentialsClientCertificate\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_mtls-certificate\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditablePublicCredentialData" }, "example": { "description": "Updated description of client certificate" } } } }, "responses": { "200": { "description": "Client certificate updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExistingClientCertificateCredentials" }, "example": { "credential_id": "krn:network:global:live:credential:client_cert:8349083298234394539", "description": "Updated description of client certificate", "type": "CLIENT_CERT", "environment": "LIVE", "identity": { "serial_number": "8349083298234394539" }, "config": { "expiration_date": "2028-08-24T14:15:22Z", "certificate_state": "VALID", "usage": "MTLS" }, "status": "ENABLED" } } }, "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" } } } } } }, "/v2/account/integration/credentials/client-certificate/{credential_id}/revoke": { "post": { "tags": ["Client Certificates"], "summary": "Revoke a Client Certificate", "operationId": "revokeCredentialsClientCertificate", "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.

Revokes a client certificate, the certificate being targeted cannot be the one currently in use and a 400 status code is returned.

\n \n Operation ID:\n A unique identifier for the operation.\n \n revokeCredentialsClientCertificate\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_mtls-certificate\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

", "parameters": [{ "name": "credential_id", "in": "path", "required": true, "description": "Identifier of the **Credential**", "schema": { "$ref": "#/components/schemas/CredentialIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCertificateRevokeParameters" } } } }, "responses": { "200": { "description": "Client certificate revoked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientCertificateRevokeStatus" }, "example": { "credential_id": "krn:network:global:live:credential:client_cert:2C8A1053F979D1E8C96A3A9357AE7D1E", "description": "Live client certificate", "type": "CLIENT_CERT", "environment": "LIVE", "identity": { "serial_number": "2C8A1053F979D1E8C96A3A9357AE7D1E" }, "config": { "expiration_date": "2019-08-24T14:15:22Z", "revoked_from": "2021-12-31T23:59:59Z", "usage": "MTLS", "certificate_state": "REVOKED" }, "status": "DISABLED" } } }, "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" } } } } } }, "/v2/account/integration/inbound-restrictions/ip": { "get": { "tags": ["IP Restrictions"], "summary": "Read IP restriction enforcement status", "operationId": "readIpRestrictionEnforcementStatus", "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.

Read the status of IP restriction enforcement for an account. There are three modes:

NOT_ENABLED: IP restriction feature is not enabled for the account.
REPORTING: Does not enforce IP restriction, Klarna reports IP validation status as a response header.
ENFORCED: Enforces IP validation, Klarna rejects requests not from allowed IPs.

\n \n Operation ID:\n A unique identifier for the operation.\n \n readIpRestrictionEnforcementStatus\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_ip-restriction\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

", "responses": { "200": { "description": "Read IP restriction enforcement status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementStatus" }, "example": { "enforcement_mode": "ENFORCED", "enforced_from": "2021-12-31T23:59:59Z" } } }, "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": { "tags": ["IP Restrictions"], "summary": "Manage IP restriction enforcement", "operationId": "manageIpRestrictionEnforcement", "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.

Manage IP restriction enforcement for an account.

There are three enforcement modes available:

NOT_ENABLED: IP restriction feature is not enabled.
REPORTING: Monitors IP validation without blocking requests; Klarna reports status in response headers.
ENFORCED: Actively blocks requests from unauthorized IPs.

Recommended transition path:

Start with NOT_ENABLED (default state)
Switch to REPORTING to monitor IP validation without blocking
Switch to ENFORCED once confident the IP allowlist is correctly configured

When setting enforcement mode to ENFORCED, you must also specify:

enforcement_type: When enforcement takes effect (NOW for immediate, SCHEDULED for future)
enforced_from: Required only when enforcement_type is SCHEDULED; timestamp in ISO 8601 format

Notes:

Enforcement takes up to 5 minutes from the configured timestamp.
If the account has no configured IPs, the request returns a 400 status code to prevent account lockout.

\n \n Operation ID:\n A unique identifier for the operation.\n \n manageIpRestrictionEnforcement\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_ip-restriction\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

", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementParameters" }, "example": { "enforcement_mode": "ENFORCED", "enforced_from": "2021-12-31T23:59:59Z", "enforcement_type": "SCHEDULED" } } } }, "responses": { "200": { "description": "IP restriction enforcement status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PartnerIpAllowListEnforcementStatus" }, "example": { "enforcement_mode": "ENFORCED", "enforced_from": "2021-12-31T23:59:59Z" } } }, "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/account/integration/inbound-restrictions/origins": { "get": { "tags": ["Allowed Client Origins"], "summary": "List allowed client origins", "operationId": "listAllowedOrigins", "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.

List all allowed client origin resources configured for the account, regardless of their current state. Klarna returns results in ascending alphabetical order of the resolved origin value. Klarna returns an empty list if no allowed origins are configured for the account.

An account can have at most 100 allowed origins, so Klarna returns all results in a single page under normal usage. Klarna accepts pagination parameters for forward compatibility.

\n \n Operation ID:\n A unique identifier for the operation.\n \n listAllowedOrigins\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "$ref": "#/components/parameters/PaginationSize" }, { "$ref": "#/components/parameters/PaginationStartingAfter" }, { "$ref": "#/components/parameters/PaginationEndingBefore" }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "List of allowed client origin resources", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedOriginListResponse" }, "examples": { "Multiple origins": { "value": { "origins": [{ "origin_id": "krn:network:global:live:account:allowed-origin:f7e8d9c0-b1a2-3456-cdef-7890abcdef12", "origin": "http://localhost:3000", "state": "ALLOWED" }, { "origin_id": "krn:network:global:live:account:allowed-origin:206bbb83-9b6e-46fa-940d-337153c04a58", "origin": "https://example.com", "state": "ALLOWED" }, { "origin_id": "krn:network:global:live:account:allowed-origin:a1b2c3d4-e5f6-7890-abcd-ef1234567890", "origin": "https://shop.example.com", "state": "ALLOWED" }], "pagination": { "count": 3 } } }, "Intermediate page": { "value": { "origins": [{ "origin_id": "krn:network:global:live:account:allowed-origin:f7e8d9c0-b1a2-3456-cdef-7890abcdef12", "origin": "http://localhost:3000", "state": "ALLOWED" }], "pagination": { "count": 1, "last_item": "krn:network:global:live:account:allowed-origin:f7e8d9c0-b1a2-3456-cdef-7890abcdef12" } } } } } }, "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" } } } } }, "post": { "tags": ["Allowed Client Origins"], "summary": "Create an allowed client origin", "operationId": "createAllowedOrigin", "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.

Create a new allowed client origin for the account. Provide the origin as a host with an optional port — do not include the scheme. Klarna resolves localhost to http:// and all other origins to https://, and returns the scheme-prefixed form in the response.

Klarna rejects the request if the origin is already present in the allowlist, returning a 409 Conflict error. On conflict, call listAllowedOrigins to retrieve the existing resource and match against the scheme-prefixed form when filtering the list. If you are not using a Klarna-Idempotency-Key, you may treat a 409 Conflict as a successful terminal outcome — the origin was already created.

If you provide a Klarna-Idempotency-Key header, Klarna returns the original 201 Created response for the lifetime of the key when the same key is resubmitted with the same request body, rather than creating a duplicate resource or returning 409 Conflict. If the same key is resubmitted with a different request body, Klarna returns 409 Conflict with error_code: RESOURCE_CONFLICT indicating an idempotency-key mismatch — this signals a programming error in key reuse and must not be treated as a successful creation.

\n \n Operation ID:\n A unique identifier for the operation.\n \n createAllowedOrigin\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "Klarna-Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/KlarnaIdempotencyKey" }, "description": "

Early ReleaseOperations in our Early release process are actively developed by Klarna and haven't reached general availability yet.
As a Partner, you can rely on them as soon as you've agreed on their use with Klarna.
Klarna reserves the right to change the API contract for early release features, and will support partners through any operational impact.

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

" }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "description": "Allowed client origin to create.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAllowedOriginRequest" }, "example": { "origin": "new-shop.example.com" } } } }, "responses": { "201": { "description": "Allowed client origin created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedOriginResource" }, "example": { "origin_id": "krn:network:global:live:account:allowed-origin:206bbb83-9b6e-46fa-940d-337153c04a58", "origin": "https://new-shop.example.com", "state": "ALLOWED" } } }, "headers": { "Location": { "$ref": "#/components/headers/KlarnaLocationReference" }, "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" } } } } } }, "/v2/account/integration/inbound-restrictions/origins/{origin_id}": { "get": { "tags": ["Allowed Client Origins"], "summary": "Read an allowed client origin", "operationId": "readAllowedOrigin", "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.

Read a specific allowed client origin resource by its identifier. Klarna returns the origin URL, its KRN, and current state. Klarna returns a 404 Not Found response if the identifier does not exist or is not accessible with the current credentials.

\n \n Operation ID:\n A unique identifier for the operation.\n \n readAllowedOrigin\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "origin_id", "in": "path", "required": true, "description": "Identifier of the allowed origin resource", "schema": { "$ref": "#/components/schemas/AllowedOriginIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Allowed client origin resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllowedOriginResource" }, "example": { "origin_id": "krn:network:global:live:account:allowed-origin:206bbb83-9b6e-46fa-940d-337153c04a58", "origin": "https://shop.example.com", "state": "ALLOWED" } } }, "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" } } } } }, "delete": { "tags": ["Allowed Client Origins"], "summary": "Delete an allowed client origin", "operationId": "deleteAllowedOrigin", "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.

Delete a specific allowed client origin from the account by its identifier. Klarna returns 204 No Content on successful removal. If the resource does not exist, Klarna returns 404 Not Found.

\n \n Operation ID:\n A unique identifier for the operation.\n \n deleteAllowedOrigin\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_credential\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

", "parameters": [{ "name": "origin_id", "in": "path", "required": true, "description": "Identifier of the allowed origin resource", "schema": { "$ref": "#/components/schemas/AllowedOriginIdentifier" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "204": { "description": "Allowed client origin deleted", "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" } } } } } }, "/v2/account/integration/inbound-restrictions/ip/allowlist": { "get": { "tags": ["IP Restrictions"], "summary": "List all configured allowed IP ranges", "operationId": "getAllowedIps", "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.

List all IP ranges (both IPv4 and IPv6) that a partner is allowed to use to access the API.

\n \n Operation ID:\n A unique identifier for the operation.\n \n getAllowedIps\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_ip-restriction\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

", "responses": { "200": { "description": "List of allowed IP ranges", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowList" }, "example": ["8.8.8.8/32", "1.1.1.0/24", "2001:4860:4860::8888/128"] } }, "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" }] }, "put": { "tags": ["IP Restrictions"], "summary": "Set allowed IP ranges", "operationId": "setIpAllowList", "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.

Configure IP ranges (both IPv4 and IPv6) from which a partner can access the API. This operation is blocked when IP restriction enforcement is active to prevent accidental account lockout.
\n
- To modify existing IP ranges, first disable enforcement mode, then update the list using PUT or POST endpoints. Once changes are complete, enforcement can be re-enabled.
\n

\n \n Operation ID:\n A unique identifier for the operation.\n \n setIpAllowList\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_ip-restriction\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

", "requestBody": { "description": "List of allowed IP ranges to configure. Using an empty list removes IP range restrictions.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowList" }, "example": ["8.8.8.8/32", "1.1.1.0/24", "2001:4860:4860::8888/128"] } } }, "responses": { "200": { "description": "List of added or updated allowed IP ranges", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowList" }, "example": ["8.8.8.8/32", "1.1.1.0/24", "2001:4860:4860::8888/128"] } }, "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" }] }, "post": { "tags": ["IP Restrictions"], "summary": "Append allowed IP ranges", "operationId": "appendAllowedIps", "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.

Append new IP ranges to the existing list of allowed IPs for accessing the API. This operation only allows adding new IPs; it does not allow modifying or removing existing IPs. If IP restriction enforcement is active, this operation can still be used to add new IPs to the list. The response will return the complete updated list of allowed IPs.

\n \n Operation ID:\n A unique identifier for the operation.\n \n appendAllowedIps\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 Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n account_ip-restriction\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

", "requestBody": { "description": "List of allowed IP ranges to append.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowList" }, "example": ["1.2.3.4/24", "2001:db8::1/128"] } } }, "responses": { "200": { "description": "List of allowed IP ranges after appending new entries", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IpAllowList" }, "example": ["8.8.8.8/24", "1.2.3.4/24", "2001:db8::1/128"] } }, "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" }] } } } } }; 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."); }