"use strict"; const {jsx: _jsx} = arguments[0]; const {useMDXComponents: _provideComponents} = arguments[0]; const apiSpecs = { "name": "klarna-product-api-payment", "title": "Payment", "type": "klarna-network", "intendedFor": "partner_through_klarna", "version": "v2", "release": "stable", "spec": { "openapi": "3.1.1", "info": { "title": "Klarna Partner Product API - Payment", "description": "Full set of resources to manage the end-to-end lifecycle of a payment.", "version": "v2/stable" }, "security": [{ "klarna_api_key": [] }], "tags": [{ "name": "Payment Authorize API", "description": "The Payment Authorize API allows you to authorize payment transactions.\n" }, { "name": "Payment Request API", "description": "The Payment Request API allows you to create and manage payment requests for one-off purchases.\n" }, { "name": "Payment Transaction API", "description": "The Payment Transaction API allows you to manage the lifecycle of an authorized payment transaction.\n\nThrough this API you can capture, refund, reauthorize and void a transaction, manage the individual captures\nand refunds it produces, read the chargebacks raised against it, and create, read and cancel its pending\nadjustments.\n" }, { "name": "Payment Presentation API", "description": "This API enables partners to effectively present Klarna as a payment method by including a header, subheader, badge, and payment button, ensuring a clear and flexible integration.\n" }, { "name": "Card Settlements API", "description": "The Card Settlements API allows you to settle a payment transaction over card rails.\n\nThrough this API you can create, read, adjust and void a card settlement, and simulate the card network\nevents a settlement produces so that an integration can be exercised end to end before going live.\n" }], "components": { "securitySchemes": { "klarna_api_key": { "in": "header", "name": "Authorization", "type": "apiKey", "description": "Use the Klarna API key as HTTP Basic Authentication credentials" } }, "schemas": { "SinglePaymentRequestBody": { "title": "Payment Request", "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "acquiring_config": { "type": "object", "x-validation-info": "Validation that the valid acquiring config provided", "description": "Acquiring config of the payment\n", "oneOf": [{ "$ref": "#/components/schemas/PaymentAcquiringConfigurationAcquiringAccount" }, { "$ref": "#/components/schemas/PaymentAcquiringConfigurationAccount" }] }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" } } }, "PaymentRequestBody": { "type": "object", "description": "Payment request for a one-off purchase\n", "required": ["currency"], "oneOf": [{ "$ref": "#/components/schemas/SinglePaymentRequestBody" }] }, "UpdatePaymentRequestBody": { "title": "Payment Request", "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "acquiring_config": { "type": "object", "x-validation-info": "Validation that the valid acquiring config provided", "description": "Acquiring config of the payment\n", "oneOf": [{ "$ref": "#/components/schemas/PaymentAcquiringConfigurationAcquiringAccount" }, { "$ref": "#/components/schemas/PaymentAcquiringConfigurationAccount" }] }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" } }, "description": "Payment request for a one-off purchase\n" }, "PaymentAuthorizeRequestBody": { "oneOf": [{ "$ref": "#/components/schemas/SinglePaymentAuthorizeRequestBody" }] }, "SinglePaymentAuthorizeRequestBody": { "x-validation-info": "Validates that `request_payment_transaction` is present when `request_card_settlement` is provided.", "type": "object", "title": "Authorize Payment Request", "description": "Request for authorization of a payment transaction and/or issuing a customer token. It is required that at least one of the `request_customer_token` field and the `request_payment_transaction` field must be provided.\n", "required": ["currency"], "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "interoperability_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "Provide additional interoperability data to enable custom features or data exchange supported by your Integrating Partner.\nKlarna accepts this passthrough field in a structured JSON format and forwards it to relevant systems for interoperability.\n Data shared in this field may complement structured datapoints provided in supplementary_purchase_data.\n Ensure the value is between 1 and 10240 characters in length (inclusive).\n Treat this value as an opaque string—do not validate or infer its structure.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json", "deprecated": true }, "klarna_network_data": { "$ref": "#/components/schemas/KlarnaNetworkData" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/PaymentAuthorizeRequestCustomerToken" }, "request_payment_transaction": { "$ref": "#/components/schemas/RequestPaymentTransaction" }, "request_card_settlement": { "type": "object", "description": "Request a card settlement for the payment transaction being authorized. The card is\nreturned under `card_settlement_response`.\n\nProvide the `encryption_key_id` of the key Klarna encrypts the card data with.\n\nThe authorization and the card settlement are a single outcome. If the card cannot be\nissued, the payment transaction is not authorized: the result is `DECLINED` with\n`result_reason` `CARD_SETTLEMENT_ISSUANCE_FAILED`.\n\nA payment transaction that requires a step-up is not authorized and no card is issued:\n`card_settlement_response.result` is `STEP_UP_REQUIRED`, matching the payment transaction\nresult. The customer completes the step-up in the purchase flow launched from\n`payment_request.state_context.customer_interaction`. When the payment request reaches\n`COMPLETED`, authorize again with its `state_context.klarna_network_session_token` in\n`Klarna-Network-Session-Token`, the same `request_card_settlement`, and a fresh\n`Klarna-Idempotency-Key`. The stepped-up authorization created no card settlement, so the\nfollow-up authorization leaves one settlement in total even when it carries the same\n`card_settlement_reference`.\n\nEach payment transaction has at most one card settlement.\n\n`card_settlement_reference` is your own correlation reference, not an idempotency key.\nKlarna does not enforce uniqueness on it: reusing one across authorizations creates\nmultiple card settlements sharing that reference.\n", "properties": { "card_settlement_reference": { "$ref": "#/components/schemas/CardSettlementReference" }, "encryption_key_id": { "$ref": "#/components/schemas/CardSettlementCardEncryptionKeyId" } }, "required": ["encryption_key_id"] }, "step_up_config": { "$ref": "#/components/schemas/PaymentRequestAuthorizeStepUpConfiguration" }, "acquiring_config": { "$ref": "#/components/schemas/PaymentAcquiringConfigurationAuthorize" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" }, "point_of_transaction": { "$ref": "#/components/schemas/PointOfTransaction" } } }, "PaymentRequestAuthorizeStepUpConfiguration": { "x-validation-info": "Validation that customer_interaction_config is provided", "description": "Configuration properties for enabling the customer-present step-up flow\n", "required": ["customer_interaction_config"], "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" } } }, "PaymentAcquiringConfigurationAuthorize": { "description": "Acquiring config of the payment\n", "oneOf": [{ "$ref": "#/components/schemas/PaymentAccountReferenceWithAcquiringAccount" }, { "$ref": "#/components/schemas/PaymentAccountIdentifier" }, { "$ref": "#/components/schemas/DefaultPaymentAccount" }] }, "PaymentAccountReferenceWithAcquiringAccount": { "type": "object", "required": ["payment_acquiring_account_id", "payment_account_reference"], "properties": { "payment_acquiring_account_id": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifier" }, "payment_account_reference": { "$ref": "#/components/schemas/PaymentAccountReference" }, "settlement_currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "The currency that will be used to settle the Payment Transaction.\nThe value should conform to ISO 4217 format. Defaults to `currency`\nwhen not provided.\n" } } }, "PaymentAccountIdentifier": { "type": "object", "required": ["payment_account_id"], "properties": { "payment_account_id": { "$ref": "#/components/schemas/products-payment.model_PaymentAccountIdentifier" }, "settlement_currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "The currency that will be used to settle the Payment Transaction.\nThe value should conform to ISO 4217 format. Defaults to `currency`\nwhen not provided.\n" } } }, "DefaultPaymentAccount": { "type": "object", "properties": { "settlement_currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "The currency that will be used to settle the Payment Transaction.\nThe value should conform to ISO 4217 format. Defaults to `currency`\nwhen not provided.\n" } } }, "PaymentAcquiringConfigurationAcquiringAccount": { "type": "object", "required": ["payment_acquiring_account_id", "payment_account_reference"], "properties": { "payment_acquiring_account_id": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifier" }, "payment_account_reference": { "$ref": "#/components/schemas/PaymentAccountReference" } } }, "PaymentAcquiringConfigurationAccount": { "type": "object", "required": ["payment_account_id"], "properties": { "payment_account_id": { "$ref": "#/components/schemas/products-payment.model_PaymentAccountIdentifier" } } }, "PaymentAuthorizeResponseBody": { "type": "object", "properties": { "payment_transaction_response": { "anyOf": [{ "$ref": "#/components/schemas/PaymentTransactionResponseBody" }] }, "customer_token_response": { "$ref": "#/components/schemas/CustomerTokenResponseBody" }, "card_settlement_response": { "type": "object", "description": "The outcome of the card settlement requested with `request_card_settlement`.\n", "oneOf": [{ "$ref": "#/components/schemas/CardSettlementResponseIssued" }, { "$ref": "#/components/schemas/CardSettlementResponseStepUp" }, { "$ref": "#/components/schemas/CardSettlementResponseFailed" }], "discriminator": { "propertyName": "result", "mapping": { "ISSUED": "#/components/schemas/CardSettlementResponseIssued", "STEP_UP_REQUIRED": "#/components/schemas/CardSettlementResponseStepUp", "FAILED": "#/components/schemas/CardSettlementResponseFailed" } } }, "payment_request": { "anyOf": [{ "$ref": "#/components/schemas/PaymentRequestAuthorizeResponse" }] }, "interoperability_response_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "This field is included in the response if `interoperability_data` was provided by your Integrating Partner in the initial payment request.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json", "deprecated": true }, "klarna_network_response_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "This field is included in the response if `klarna_network_data` was provided by your Integrating Partner in the initial payment request.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentTransactionResponseBody": { "title": "Payment Transaction Response", "description": "The request for a payment transaction can result in one of the following outcomes:\n\n - **Successful Authorization** (result `APPROVED`) : The authorization was approved, and the response body includes the Payment Transaction object.\n\n - **Declined** (result: `DECLINED`) : The authorization was declined.\n\n - **Step-Up Flow Activation** (result: `STEP_UP_REQUIRED`) : The authorization was declined, and a step-up authentication flow has been activated. The response body includes the `state_context`, which provides the distribution URL where the customer must be redirected for payment authorization.\n", "type": "object", "anyOf": [{ "$ref": "#/components/schemas/PaymentTransactionResponseApproved" }, { "$ref": "#/components/schemas/PaymentTransactionResponseStepUp" }, { "$ref": "#/components/schemas/PaymentTransactionResponseDeclined" }], "discriminator": { "propertyName": "result", "mapping": { "APPROVED": "#/components/schemas/PaymentTransactionResponseApproved", "STEP_UP_REQUIRED": "#/components/schemas/PaymentTransactionResponseStepUp", "DECLINED": "#/components/schemas/PaymentTransactionResponseDeclined" } } }, "CustomerTokenResponseBody": { "description": "Customer token response\n", "type": "object", "anyOf": [{ "$ref": "#/components/schemas/CustomerTokenResponseApproved" }, { "$ref": "#/components/schemas/CustomerTokenResponseNotApproved" }], "discriminator": { "propertyName": "result", "mapping": { "APPROVED": "#/components/schemas/CustomerTokenResponseApproved", "DECLINED": "#/components/schemas/CustomerTokenResponseNotApproved", "STEP_UP_REQUIRED": "#/components/schemas/CustomerTokenResponseNotApproved" } } }, "CardSettlementResponseIssued": { "type": "object", "description": "Card settlement outcome with result `ISSUED`, carrying the card and its settlement.\n", "required": ["result", "card", "card_settlement_id", "payment_transaction_id"], "properties": { "result": { "type": "string", "description": "The outcome of the card settlement request.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ISSUED` | A card settlement was issued; its card is returned in `card`. |\n| `STEP_UP_REQUIRED` | The payment transaction requires a step-up, so no card settlement was issued. |\n| `FAILED` | No card settlement was issued; `result_reason` carries the reason. |\n", "const": "ISSUED", "enum": ["ISSUED", "STEP_UP_REQUIRED", "FAILED"] }, "card": { "$ref": "#/components/schemas/SettlementCard" }, "card_settlement_id": { "$ref": "#/components/schemas/CardSettlementId" }, "card_settlement_reference": { "$ref": "#/components/schemas/CardSettlementReference" }, "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" } }, "title": "Card Settlement Issued" }, "CardSettlementResponseStepUp": { "type": "object", "description": "Card settlement outcome with result `STEP_UP_REQUIRED`, carrying no card.\n", "required": ["result"], "properties": { "result": { "type": "string", "description": "The outcome of the card settlement request.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ISSUED` | A card settlement was issued; its card is returned in `card`. |\n| `STEP_UP_REQUIRED` | The payment transaction requires a step-up, so no card settlement was issued. |\n| `FAILED` | No card settlement was issued; `result_reason` carries the reason. |\n", "const": "STEP_UP_REQUIRED", "enum": ["ISSUED", "STEP_UP_REQUIRED", "FAILED"] } }, "title": "Card Settlement Step-Up Required" }, "CardSettlementResponseFailed": { "type": "object", "description": "Card settlement outcome with result `FAILED`, carrying the reason no card was issued.\n", "required": ["result", "result_reason"], "properties": { "result": { "type": "string", "description": "The outcome of the card settlement request.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ISSUED` | A card settlement was issued; its card is returned in `card`. |\n| `STEP_UP_REQUIRED` | The payment transaction requires a step-up, so no card settlement was issued. |\n| `FAILED` | No card settlement was issued; `result_reason` carries the reason. |\n", "const": "FAILED", "enum": ["ISSUED", "STEP_UP_REQUIRED", "FAILED"] }, "result_reason": { "$ref": "#/components/schemas/CardSettlementFailureReason" } }, "title": "Card Settlement Failed" }, "PaymentTransactionResponseApproved": { "type": "object", "required": ["result", "payment_transaction"], "description": "Payment transaction response with result `APPROVED`\n", "properties": { "result": { "$ref": "#/components/schemas/PaymentAuthorizationResult" }, "payment_transaction": { "$ref": "#/components/schemas/PaymentRequestTransaction" } } }, "PaymentTransactionResponseStepUp": { "type": "object", "required": ["result"], "description": "Payment transaction response with result `STEP_UP_REQUIRED`\n", "properties": { "result": { "$ref": "#/components/schemas/PaymentAuthorizationResult" }, "result_reason": { "$ref": "#/components/schemas/ResultReason" } } }, "PaymentTransactionResponseDeclined": { "type": "object", "required": ["result"], "description": "Payment transaction response with result `DECLINED`\n", "properties": { "result": { "$ref": "#/components/schemas/PaymentAuthorizationResult" }, "result_reason": { "$ref": "#/components/schemas/ResultReason" } } }, "ResultReason": { "type": "string", "minLength": 1, "maxLength": 99, "example": "PAYMENT_TOKEN_PARTNER_ACCOUNT_MISMATCH", "description": "Indicates the reason the request was not approved. This is an open enum. Handle unknown values gracefully, as Klarna may add new values in the future.\n\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| `KLARNA_NETWORK_SESSION_TOKEN_NOT_FOUND` | The provided Klarna network session token could not be found. |\n| `KLARNA_NETWORK_SESSION_TOKEN_EXPIRED` | The provided Klarna network session token is no longer valid because its expiration time has passed. |\n| `KLARNA_NETWORK_SESSION_PARTNER_ACCOUNT_MISMATCH` | The partner account on the authorize request that uses Klarna network session token does not match the partner account on the completed payment request. |\n| `PAYMENT_TOKEN_PARTNER_ACCOUNT_MISMATCH` | The partner account on the authorize request does not match the partner account on the completed payment request. |\n| `CURRENCY_MISMATCH` | The currency in the authorization request does not match the currency in the original payment request. |\n| `AMOUNT_MISMATCH` | The amount in the authorization request does not match the amount in the original payment request. |\n| `PAYMENT_TOKEN_NOT_FOUND` | The provided payment token could not be found. |\n| `PAYMENT_TOKEN_EXPIRED` | The provided payment token is no longer valid because its expiration time has passed. |\n| `PAYMENT_DECLINED` | The payment was declined by Klarna or an issuing bank. |\n| `CUSTOMER_TOKEN_OWNER_MISMATCH` | The requestor is not the owner for the provided customer token. |\n| `CUSTOMER_TOKEN_SCOPE_MISMATCH` | The provided customer token does not contain the required scope. |\n| `CUSTOMER_TOKEN_REVOKED` | The provided customer token has been revoked. |\n| `CUSTOMER_TOKEN_NOT_FOUND` | The provided customer token could not be found. |\n| `CARD_SETTLEMENT_ISSUANCE_FAILED` | A card settlement requested with `request_card_settlement` could not be issued. |\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": ["KLARNA_NETWORK_SESSION_TOKEN_NOT_FOUND", "KLARNA_NETWORK_SESSION_TOKEN_EXPIRED", "KLARNA_NETWORK_SESSION_PARTNER_ACCOUNT_MISMATCH", "PAYMENT_TOKEN_PARTNER_ACCOUNT_MISMATCH", "CURRENCY_MISMATCH", "AMOUNT_MISMATCH", "PAYMENT_TOKEN_NOT_FOUND", "PAYMENT_TOKEN_EXPIRED", "PAYMENT_DECLINED", "CUSTOMER_TOKEN_OWNER_MISMATCH", "CUSTOMER_TOKEN_SCOPE_MISMATCH", "CUSTOMER_TOKEN_REVOKED", "CUSTOMER_TOKEN_NOT_FOUND", "CARD_SETTLEMENT_ISSUANCE_FAILED"] }, "CustomerTokenResponseApproved": { "type": "object", "required": ["result", "customer_token"], "description": "Customer token response with result `APPROVED`\n", "properties": { "result": { "$ref": "#/components/schemas/PaymentAuthorizationResult" }, "customer_token": { "$ref": "#/components/schemas/CustomerToken" }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "CustomerTokenResponseNotApproved": { "type": "object", "required": ["result"], "description": "Customer token response with result `DECLINED` or `STEP_UP_REQUIRED`\n", "properties": { "result": { "$ref": "#/components/schemas/PaymentAuthorizationResult" } } }, "PaymentRequestAuthorizeResponse": { "type": "object", "description": "The base properties of a Payment Request. This field is only returned if the `payment_transaction_response.result` is `STEP_UP_REQUIRED`\n", "properties": { "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_context": { "required": ["customer_interaction"], "description": "State specific context for the `SUBMITTED` state.\n", "properties": { "customer_interaction": { "$ref": "#/components/schemas/PaymentCustomerInteraction" } } }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" } }, "title": "Payment Request Authorize Response", "required": ["payment_request_id", "state", "expires_at", "created_at", "updated_at", "currency", "customer_interaction_config"] }, "PaymentRequestResponseBody": { "type": "object", "anyOf": [{ "$ref": "#/components/schemas/SinglePaymentRequestResponseBody" }] }, "SinglePaymentRequestResponseBody": { "title": "Payment Request Response", "description": "Payment Request response\n", "type": "object", "anyOf": [{ "$ref": "#/components/schemas/SinglePaymentRequestStateSubmitted" }, { "$ref": "#/components/schemas/SinglePaymentRequestStateInProgress" }, { "$ref": "#/components/schemas/SinglePaymentRequestStateCompleted" }, { "$ref": "#/components/schemas/SinglePaymentRequestStateDeclined" }], "discriminator": { "propertyName": "state", "mapping": { "SUBMITTED": "#/components/schemas/SinglePaymentRequestStateSubmitted", "IN_PROGRESS": "#/components/schemas/SinglePaymentRequestStateInProgress", "COMPLETED": "#/components/schemas/SinglePaymentRequestStateCompleted", "DECLINED": "#/components/schemas/SinglePaymentRequestStateDeclined" } } }, "CanceledPaymentRequestResponseBody": { "type": "object", "anyOf": [{ "$ref": "#/components/schemas/CanceledSinglePaymentRequestResponseBody" }] }, "CanceledSinglePaymentRequestResponseBody": { "title": "Payment Request Response", "description": "Payment Request response\n", "type": "object", "anyOf": [{ "$ref": "#/components/schemas/SinglePaymentRequestStateCanceled" }], "discriminator": { "propertyName": "state", "mapping": { "CANCELED": "#/components/schemas/SinglePaymentRequestStateCanceled" } } }, "SinglePaymentRequestStateSubmitted": { "type": "object", "description": "Payment Request in state `SUBMITTED`\n", "properties": { "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" }, "state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_context": { "required": ["customer_interaction"], "description": "State specific context for the `SUBMITTED` state.\n", "properties": { "customer_interaction": { "$ref": "#/components/schemas/PaymentCustomerInteraction" } } } }, "required": ["payment_request_id", "state", "state_context", "expires_at", "created_at", "updated_at", "currency"] }, "SinglePaymentRequestStateInProgress": { "type": "object", "description": "Payment Request in state `IN_PROGRESS`\n", "properties": { "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" }, "state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_context": { "description": "State specific context for the `IN_PROGRESS` state.\n", "type": "object", "properties": { "customer_interaction": { "$ref": "#/components/schemas/PaymentCustomerInteraction" } } } }, "required": ["payment_request_id", "state", "expires_at", "created_at", "updated_at", "currency"] }, "SinglePaymentRequestStateCompleted": { "type": "object", "description": "Payment Request in state `COMPLETED`\n", "properties": { "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" }, "state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_context": { "description": "State specific context for the `COMPLETED` state.\n", "type": "object", "properties": { "klarna_network_session_token": { "$ref": "#/components/schemas/KlarnaNetworkSessionToken" }, "payment_token": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The payment token represents a customer approval for payment.\n\nIt is issued when a Klarna Payment Request is completed.\n", "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)", "example": "krn:payment:eu1:payment-token:e15432a5-ebcc-45bc-934c-e61399db597b", "deprecated": true }, "interoperability_token": { "type": "string", "maxLength": 8192, "minLength": 1, "description": "The interoperability token enables continuity of customer journey across domains and services. If you are an Acquiring Partner, you receive this token from your merchant.\n", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaG9wcGluZ19zZXNzaW9uX2lkIjoia3JuOnNob3BwaW5nOmV1MTpzZXNzaW9uOjBlOTIyN2MwLTBjNDAtNDdkZi04YzEwLTQwMTRmYzFiZDJiZCIsInN0YXR1cyI6IlBBWU1FTlRfUFJFUEFSRUQiLCJ2ZXJzaW9uIjoxLCJjcmVhdGVkX2F0IjoiMjAyNC0wMS0wMVQxMjowMDowMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMS0wMVQxMjowMDowMFoifQ.1y87kuEKnETy_UCHbTMXx1p4mViZE816okcVmfHFZoo", "deprecated": true }, "klarna_customer": { "$ref": "#/components/schemas/KlarnaCustomer" }, "shipping": { "$ref": "#/components/schemas/CollectedShipping" } } } }, "required": ["payment_request_id", "state", "state_context", "expires_at", "created_at", "updated_at", "currency"] }, "SinglePaymentRequestStateCanceled": { "type": "object", "description": "Payment Request in state `CANCELED`\n", "properties": { "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" }, "state": { "$ref": "#/components/schemas/CanceledPaymentRequestState" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_context": { "description": "There is no specific context for the `CANCELED` state.\n", "type": "object" } }, "required": ["payment_request_id", "state", "expires_at", "created_at", "updated_at", "currency"] }, "SinglePaymentRequestStateDeclined": { "type": "object", "description": "Payment Request in state `DECLINED`\n", "properties": { "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "customer_interaction_config": { "$ref": "#/components/schemas/CustomerInteractionConfig" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" }, "state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "state_context": { "description": "There is no specific context for the `DECLINED` state.\n", "type": "object" } }, "required": ["payment_request_id", "state", "expires_at", "created_at", "updated_at", "currency"] }, "ShippingConfig": { "description": "Configure how the shipping collection form will behave in the purchase flow. Without the shipping config, no shipping collection form will be displayed.\n", "type": "object", "required": ["mode"], "properties": { "mode": { "type": "string", "description": "Configure if the shipping details should be collected from the customer.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `EDITABLE` | the shipping details will be collected from the customer and will be available under `stateContext.shipping` when the payment request is in state `COMPLETED`. If you enable this, you must read back and honour the shipping address returned in the payment request response.\n |\n| `READ_ONLY` | the customer can only see the shipping details that are provided in the `supplementaryPurchaseData.shipping[0]` object without the ability to change them. The `READ_ONLY` mode will be supported in a future release. Setting it won't have any effect.\n |\n", "enum": ["EDITABLE", "READ_ONLY"] }, "supported_countries": { "$ref": "#/components/schemas/SupportedShippingCountries" } } }, "CustomerInteractionConfig": { "description": "Payment initiation methods that describes how to launch the purchase flow.\n", "type": "object", "required": ["method"], "anyOf": [{ "$ref": "#/components/schemas/PaymentCustomerInteractionMethodHandover" }, { "$ref": "#/components/schemas/PaymentCustomerInteractionMethodQrCode" }], "discriminator": { "propertyName": "method", "mapping": { "HANDOVER": "#/components/schemas/PaymentCustomerInteractionMethodHandover", "QR_CODE": "#/components/schemas/PaymentCustomerInteractionMethodQrCode" } }, "x-validation-info": "Validates that required fields are provided based on the customer interaction method" }, "PaymentAuthorizeRequestCustomerToken": { "x-validation-info": "Validate that the field `scopes` is present", "type": "object", "description": "Request a customer account linking to be set up, effectively returning a token called\n`customer_token` on successful confirmation of the payment request.\nThe generated token allows the token owner to act on-behalf of the customer.\n\nThe generated token will be available under `customer_token_response` when the request is in state `COMPLETED`\n", "required": ["scopes"], "properties": { "scopes": { "type": "array", "maxItems": 1, "description": "The scopes of the requested customer token. The scopes define the permissions of the token.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment:customer_not_present` | Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present. |\n| `payment:customer_present` | Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up. |\n| `customer:login` | Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer. |\n", "items": { "type": "string", "enum": ["payment:customer_not_present", "payment:customer_present", "customer:login"], "description": "\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment:customer_not_present` | Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present. |\n| `payment:customer_present` | Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up. |\n| `customer:login` | Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer. |\n" } }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "RequestCustomerToken": { "x-validation-info": "Validate that the field `scopes` is present", "type": "object", "description": "Request a customer account linking to be set up, effectively returning a token called\n`customer_token` on successful confirmation of the payment request.\nThe generated token allows the token owner to act on-behalf of the customer.\n\nThe generated token will be available under `state_context.klarna_customer.customer_token` when the request is in state `COMPLETED`\n", "required": ["scopes"], "properties": { "scopes": { "type": "array", "maxItems": 1, "description": "The scopes of the requested customer token. The scopes define the permissions of the token.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment:customer_not_present` | Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present. |\n| `payment:customer_present` | Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up. |\n| `customer:login` | Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer. |\n", "items": { "type": "string", "enum": ["payment:customer_not_present", "payment:customer_present", "customer:login"], "description": "\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `payment:customer_not_present` | Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present. |\n| `payment:customer_present` | Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up. |\n| `customer:login` | Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer. |\n" } }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "RequestPaymentTransaction": { "type": "object", "description": "Represents a request to authorize a payment transaction.\n", "x-validation-info": "Validates that the `amount` is present if `request_payment_transaction` is provided.", "anyOf": [{ "$ref": "#/components/schemas/RequestPaymentTransactionCaptureNow" }, { "$ref": "#/components/schemas/RequestPaymentTransactionCaptureLater" }] }, "RequestPaymentTransactionCaptureNow": { "type": "object", "required": ["amount"], "properties": { "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "capture": { "$ref": "#/components/schemas/PaymentTransactionCapture" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "payment_capture_reference": { "$ref": "#/components/schemas/PaymentCaptureReference" } } }, "RequestPaymentTransactionCaptureLater": { "type": "object", "required": ["amount"], "properties": { "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "capture": { "$ref": "#/components/schemas/PaymentTransactionCapture" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" } } }, "SupportedShippingCountries": { "type": "array", "default": [], "description": "Partner's supported shipping countries (ISO 3166-1 alpha-2)\n", "items": { "type": "string", "example": "US", "description": "Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.\nThe system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.\n\nAllowed countries:\n `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AN`, `AO`, `AQ`\n `AR`, `AS`, `AT`, `AU`, `AW`, `AX`, `AZ`, `BA`, `BB`, `BD`\n `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BL`, `BM`, `BN`, `BO`\n `BQ`, `BR`, `BS`, `BT`, `BV`, `BW`, `BY`, `BZ`, `CA`, `CC`\n `CD`, `CF`, `CG`, `CH`, `CI`, `CK`, `CL`, `CM`, `CN`, `CO`\n `CR`, `CU`, `CV`, `CW`, `CX`, `CY`, `CZ`, `DE`, `DJ`, `DK`\n `DM`, `DO`, `DZ`, `EC`, `EE`, `EG`, `EH`, `ER`, `ES`, `ET`\n `FI`, `FJ`, `FK`, `FM`, `FO`, `FR`, `GA`, `GB`, `GD`, `GE`\n `GF`, `GG`, `GH`, `GI`, `GL`, `GM`, `GN`, `GP`, `GQ`, `GR`\n `GS`, `GT`, `GU`, `GW`, `GY`, `HK`, `HM`, `HN`, `HR`, `HT`\n `HU`, `ID`, `IE`, `IL`, `IM`, `IN`, `IO`, `IQ`, `IR`, `IS`\n `IT`, `JE`, `JM`, `JO`, `JP`, `KE`, `KG`, `KH`, `KI`, `KM`\n `KN`, `KP`, `KR`, `KW`, `KY`, `KZ`, `LA`, `LB`, `LC`, `LI`\n `LK`, `LR`, `LS`, `LT`, `LU`, `LV`, `LY`, `MA`, `MC`, `MD`\n `ME`, `MF`, `MG`, `MH`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`\n `MQ`, `MR`, `MS`, `MT`, `MU`, `MV`, `MW`, `MX`, `MY`, `MZ`\n `NA`, `NC`, `NE`, `NF`, `NG`, `NI`, `NL`, `NO`, `NP`, `NR`\n `NU`, `NZ`, `OM`, `PA`, `PE`, `PF`, `PG`, `PH`, `PK`, `PL`\n `PM`, `PN`, `PR`, `PS`, `PT`, `PW`, `PY`, `QA`, `RE`, `RO`\n `RS`, `RU`, `RW`, `SA`, `SB`, `SC`, `SD`, `SE`, `SG`, `SH`\n `SI`, `SJ`, `SK`, `SL`, `SM`, `SN`, `SO`, `SR`, `SS`, `ST`\n `SV`, `SX`, `SY`, `SZ`, `TC`, `TD`, `TF`, `TG`, `TH`, `TJ`\n `TK`, `TL`, `TM`, `TN`, `TO`, `TR`, `TT`, `TV`, `TW`, `TZ`\n `UA`, `UG`, `UM`, `US`, `UY`, `UZ`, `VA`, `VC`, `VE`, `VG`\n `VI`, `VN`, `VU`, `WF`, `WS`, `XK`, `YE`, `YT`, `ZA`, `ZM`\n `ZW`\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." } }, "PaymentTransactionAuthorizedResponseBody": { "type": "object", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "original_authorization_amount", "remaining_authorization_amount", "payment_captures", "payment_refunds", "payment_chargebacks", "payment_funding", "payment_pricing", "settlement_currency", "state_reason"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/PaymentTransactionSupplementaryPurchaseData" }, "payment_captures": { "type": "array", "description": "List of payment captures.", "items": { "$ref": "#/components/schemas/PaymentCaptureResponseBody" } }, "payment_refunds": { "description": "List of payment refunds.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentRefundResponseBody" } }, "payment_chargebacks": { "description": "List of payment chargebacks.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargebackResponseBody" } }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "updated_at": { "$ref": "#/components/schemas/PaymentTransactionUpdatedAt" }, "original_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionOriginalAuthorizationAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "payment_funding": { "$ref": "#/components/schemas/PaymentTransactionFunding" }, "payment_pricing": { "$ref": "#/components/schemas/PaymentPricing" }, "settlement_currency": { "$ref": "#/components/schemas/SettlementCurrency" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckoutTransactionApiResponse" }, "point_of_transaction": { "type": "object", "x-validation-info": "Validates that data is passed in correct format.", "description": "Information about the most granular location data about the purchase", "properties": { "type": { "$ref": "#/components/schemas/PointOfTransactionType" } }, "required": ["type"], "discriminator": { "propertyName": "type", "mapping": { "WEBSITE": "#/components/schemas/PointOfTransactionForWebsite", "TERMINAL": "#/components/schemas/PointOfTransactionForTerminal", "MOBILE_APP": "#/components/schemas/PointOfTransactionForMobileApp" } }, "oneOf": [{ "$ref": "#/components/schemas/PointOfTransactionForWebsite" }, { "$ref": "#/components/schemas/PointOfTransactionForTerminal" }, { "$ref": "#/components/schemas/PointOfTransactionForMobileApp" }] }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionAuthorizedStateReason" } } }, "PaymentTransactionCompletedResponseBody": { "type": "object", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "original_authorization_amount", "remaining_authorization_amount", "payment_captures", "payment_refunds", "payment_chargebacks", "payment_funding", "payment_pricing", "settlement_currency", "state_reason", "previous_state"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/PaymentTransactionSupplementaryPurchaseData" }, "payment_captures": { "type": "array", "description": "List of payment captures.", "items": { "$ref": "#/components/schemas/PaymentCaptureResponseBody" } }, "payment_refunds": { "description": "List of payment refunds.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentRefundResponseBody" } }, "payment_chargebacks": { "description": "List of payment chargebacks.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargebackResponseBody" } }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "updated_at": { "$ref": "#/components/schemas/PaymentTransactionUpdatedAt" }, "original_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionOriginalAuthorizationAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "payment_funding": { "$ref": "#/components/schemas/PaymentTransactionFunding" }, "payment_pricing": { "$ref": "#/components/schemas/PaymentPricing" }, "settlement_currency": { "$ref": "#/components/schemas/SettlementCurrency" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckoutTransactionApiResponse" }, "point_of_transaction": { "type": "object", "x-validation-info": "Validates that data is passed in correct format.", "description": "Information about the most granular location data about the purchase", "properties": { "type": { "$ref": "#/components/schemas/PointOfTransactionType" } }, "required": ["type"], "discriminator": { "propertyName": "type", "mapping": { "WEBSITE": "#/components/schemas/PointOfTransactionForWebsite", "TERMINAL": "#/components/schemas/PointOfTransactionForTerminal", "MOBILE_APP": "#/components/schemas/PointOfTransactionForMobileApp" } }, "oneOf": [{ "$ref": "#/components/schemas/PointOfTransactionForWebsite" }, { "$ref": "#/components/schemas/PointOfTransactionForTerminal" }, { "$ref": "#/components/schemas/PointOfTransactionForMobileApp" }] }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionCompletedStateReason" } } }, "PaymentTransactionExpiredResponseBody": { "type": "object", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "original_authorization_amount", "remaining_authorization_amount", "payment_captures", "payment_refunds", "payment_chargebacks", "payment_funding", "payment_pricing", "settlement_currency", "state_reason", "previous_state"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/PaymentTransactionSupplementaryPurchaseData" }, "payment_captures": { "type": "array", "description": "List of payment captures.", "items": { "$ref": "#/components/schemas/PaymentCaptureResponseBody" } }, "payment_refunds": { "description": "List of payment refunds.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentRefundResponseBody" } }, "payment_chargebacks": { "description": "List of payment chargebacks.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargebackResponseBody" } }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "updated_at": { "$ref": "#/components/schemas/PaymentTransactionUpdatedAt" }, "original_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionOriginalAuthorizationAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "payment_funding": { "$ref": "#/components/schemas/PaymentTransactionFunding" }, "payment_pricing": { "$ref": "#/components/schemas/PaymentPricing" }, "settlement_currency": { "$ref": "#/components/schemas/SettlementCurrency" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckoutTransactionApiResponse" }, "point_of_transaction": { "type": "object", "x-validation-info": "Validates that data is passed in correct format.", "description": "Information about the most granular location data about the purchase", "properties": { "type": { "$ref": "#/components/schemas/PointOfTransactionType" } }, "required": ["type"], "discriminator": { "propertyName": "type", "mapping": { "WEBSITE": "#/components/schemas/PointOfTransactionForWebsite", "TERMINAL": "#/components/schemas/PointOfTransactionForTerminal", "MOBILE_APP": "#/components/schemas/PointOfTransactionForMobileApp" } }, "oneOf": [{ "$ref": "#/components/schemas/PointOfTransactionForWebsite" }, { "$ref": "#/components/schemas/PointOfTransactionForTerminal" }, { "$ref": "#/components/schemas/PointOfTransactionForMobileApp" }] }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionExpiredStateReason" } } }, "PaymentTransactionClosedResponseBody": { "type": "object", "required": ["payment_transaction_id", "state", "previous_state", "state_reason", "created_at"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_funding": { "$ref": "#/components/schemas/PaymentTransactionFunding" }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionClosedStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" } } }, "PaymentCaptureRequestBody": { "type": "object", "properties": { "capture_amount": { "$ref": "#/components/schemas/PaymentCaptureAmount" }, "remaining_authorization": { "type": "string", "x-validation-info": "Validation against the enum of possible values.", "default": "RELEASE", "example": "RELEASE", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Specifies the action to take on any remaining authorization left after the capture operation. Defaults to `RELEASE` if not provided.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `KEEP` | Retain the remaining authorization for future captures, if any. |\n| `RELEASE` | Release the remaining authorization in conjunction with the capture. |\n", "enum": ["KEEP", "RELEASE"] }, "payment_capture_reference": { "$ref": "#/components/schemas/PaymentCaptureReference" }, "supplementary_capture_data": { "$ref": "#/components/schemas/SupplementaryCaptureData" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseDataForCapture" }, "klarna_network_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "Provide additional data to enable custom features or data exchange supported by your Integrating Partner.\nKlarna accepts this passthrough field in a structured JSON format and forwards it to relevant systems for interoperability.\n Data shared in this field may complement structured datapoints provided in supplementary_purchase_data.\n Ensure the value is between 1 and 10240 characters in length (inclusive).\n Treat this value as an opaque string—do not validate or infer its structure.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentCaptureResponseBody": { "type": "object", "required": ["payment_capture_id", "capture_amount", "captured_at"], "properties": { "payment_capture_id": { "$ref": "#/components/schemas/PaymentCaptureId" }, "payment_capture_reference": { "$ref": "#/components/schemas/PaymentCaptureReference" }, "capture_amount": { "$ref": "#/components/schemas/PaymentCaptureAmount" }, "captured_at": { "$ref": "#/components/schemas/PaymentCapturedAt" }, "supplementary_capture_data": { "$ref": "#/components/schemas/SupplementaryCaptureData" }, "klarna_network_response_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "This field is included in the response if `klarna_network_data` was provided by your Integrating Partner in the capture request.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentCaptureRefundRequestBody": { "type": "object", "required": ["refund_amount"], "properties": { "refund_amount": { "type": "integer", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "The amount of the refund including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500.\n\nInvariant: `refund_amount = sum(line_items[].total_amount)`\n\nConstraint: `refund_amount <= sum(captures[payment_capture_id].capture_amount) - sum(refunds[payment_capture_id].refund_amount)`\n" }, "payment_refund_reference": { "$ref": "#/components/schemas/PaymentRefundReference" }, "supplementary_refund_data": { "$ref": "#/components/schemas/SupplementaryRefundData" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseDataForRefund" }, "klarna_network_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "Provide additional data to enable custom features or data exchange supported by your Integrating Partner.\nKlarna accepts this passthrough field in a structured JSON format and forwards it to relevant systems for interoperability.\n Data shared in this field may complement structured datapoints provided in supplementary_purchase_data.\n Ensure the value is between 1 and 10240 characters in length (inclusive).\n Treat this value as an opaque string—do not validate or infer its structure.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentTransactionRefundRequestBody": { "type": "object", "required": ["refund_amount"], "properties": { "refund_amount": { "type": "integer", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "The amount of the refund including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500.\n\nInvariant: `refund_amount = sum(line_items[].total_amount)`\n\nConstraint: `refund_amount <= sum(captures[].capture_amount) - sum(refunds[].refund_amount)`\n" }, "payment_refund_reference": { "$ref": "#/components/schemas/PaymentRefundReference" }, "supplementary_refund_data": { "$ref": "#/components/schemas/SupplementaryRefundData" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseDataForRefund" }, "klarna_network_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "Provide additional data to enable custom features or data exchange supported by your Integrating Partner.\nKlarna accepts this passthrough field in a structured JSON format and forwards it to relevant systems for interoperability.\n Data shared in this field may complement structured datapoints provided in supplementary_purchase_data.\n Ensure the value is between 1 and 10240 characters in length (inclusive).\n Treat this value as an opaque string—do not validate or infer its structure.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentCaptureRefundedResponseBody": { "type": "object", "required": ["payment_capture_id", "payment_refund_id", "refund_amount", "refunded_at"], "properties": { "payment_capture_id": { "$ref": "#/components/schemas/PaymentRefundCaptureId" }, "payment_refund_id": { "$ref": "#/components/schemas/PaymentRefundId" }, "refund_amount": { "$ref": "#/components/schemas/PaymentRefundAmount" }, "payment_refund_reference": { "$ref": "#/components/schemas/PaymentRefundReference" }, "refunded_at": { "$ref": "#/components/schemas/PaymentRefundedAt" }, "supplementary_refund_data": { "$ref": "#/components/schemas/SupplementaryRefundData" }, "klarna_network_response_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "This field is included in the response if `klarna_network_data` was provided by your Integrating Partner in the refund request.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentTransactionRefundedResponseBody": { "$ref": "#/components/schemas/PaymentRefundBase" }, "PaymentRefundResponseBody": { "type": "object", "properties": { "payment_capture_id": { "$ref": "#/components/schemas/PaymentRefundCaptureId" }, "payment_refund_id": { "$ref": "#/components/schemas/PaymentRefundId" }, "refund_amount": { "$ref": "#/components/schemas/PaymentRefundAmount" }, "payment_refund_reference": { "$ref": "#/components/schemas/PaymentRefundReference" }, "refunded_at": { "$ref": "#/components/schemas/PaymentRefundedAt" }, "supplementary_refund_data": { "$ref": "#/components/schemas/SupplementaryRefundData" }, "klarna_network_response_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "This field is included in the response if `klarna_network_data` was provided by your Integrating Partner in the refund request.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } }, "required": ["payment_refund_id", "refund_amount", "refunded_at"] }, "PaymentRefundBase": { "type": "object", "required": ["payment_refund_id", "refund_amount", "refunded_at"], "properties": { "payment_refund_id": { "$ref": "#/components/schemas/PaymentRefundId" }, "refund_amount": { "$ref": "#/components/schemas/PaymentRefundAmount" }, "payment_refund_reference": { "$ref": "#/components/schemas/PaymentRefundReference" }, "refunded_at": { "$ref": "#/components/schemas/PaymentRefundedAt" }, "supplementary_refund_data": { "$ref": "#/components/schemas/SupplementaryRefundData" }, "klarna_network_response_data": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "This field is included in the response if `klarna_network_data` was provided by your Integrating Partner in the refund request.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" } } }, "PaymentChargebackResponseBody": { "oneOf": [{ "$ref": "#/components/schemas/DisputePaymentChargeback" }, { "$ref": "#/components/schemas/DefaultPaymentChargeback" }], "discriminator": { "propertyName": "chargeback_reason", "mapping": { "DISPUTE": "#/components/schemas/DisputePaymentChargeback", "DISPUTE_ARBITRATION_LOST": "#/components/schemas/DisputePaymentChargeback", "CUSTOMER_PAYMENT_DEFAULT": "#/components/schemas/DefaultPaymentChargeback" } } }, "DisputePaymentChargeback": { "type": "object", "required": ["payment_dispute_id", "payment_chargeback_id", "chargeback_amount", "chargeback_reason", "chargeback_at"], "properties": { "payment_dispute_id": { "$ref": "#/components/schemas/PaymentDisputeId" }, "payment_chargeback_id": { "$ref": "#/components/schemas/PaymentChargebackId" }, "chargeback_amount": { "$ref": "#/components/schemas/PaymentChargebackAmount" }, "chargeback_reason": { "$ref": "#/components/schemas/PaymentChargebackReason" }, "chargeback_at": { "$ref": "#/components/schemas/PaymentChargebackAt" }, "payment_capture_id": { "$ref": "#/components/schemas/PaymentCaptureId" } } }, "DefaultPaymentChargeback": { "type": "object", "required": ["payment_chargeback_id", "chargeback_amount", "chargeback_reason", "chargeback_at"], "properties": { "payment_chargeback_id": { "$ref": "#/components/schemas/PaymentChargebackId" }, "chargeback_amount": { "$ref": "#/components/schemas/PaymentChargebackAmount" }, "chargeback_reason": { "type": "string", "description": "The chargeback was raised because the customer settlement period passed and the payment defaulted.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `DISPUTE` | The payment chargeback originates from a payment dispute raised by the customer. |\n| `DISPUTE_ARBITRATION_LOST` | Deprecated - use `DISPUTE` instead. It identifies the same dispute-driven chargeback, but is named after an outcome that is not known when the chargeback is raised. Keep accepting it until it is removed. |\n| `CUSTOMER_PAYMENT_DEFAULT` | The period defined for customer settlement has passed, and the payment has defaulted. The payment transaction is deemed nullified, and any captured authorization has been reverted through a payment chargeback. |\n", "const": "CUSTOMER_PAYMENT_DEFAULT", "enum": ["DISPUTE", "DISPUTE_ARBITRATION_LOST", "CUSTOMER_PAYMENT_DEFAULT"] }, "chargeback_at": { "$ref": "#/components/schemas/PaymentChargebackAt" }, "payment_capture_id": { "$ref": "#/components/schemas/PaymentCaptureId" }, "line_items": { "$ref": "#/components/schemas/PaymentChargebackLineItems" } } }, "UpdatePaymentTransactionRequestBody": { "type": "object", "properties": { "supplementary_purchase_data": { "$ref": "#/components/schemas/PaymentTransactionSupplementaryPurchaseDataUpdate" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" } } }, "ReauthorizePaymentTransactionRequestBody": { "type": "object", "properties": { "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "supplementary_purchase_data": { "type": "object", "description": "Supplementary information for the purchase that helps reduce the risk of fraud, enhances transparency, and improves the customer's post-purchase experience.", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" }, "line_items": { "$ref": "#/components/schemas/PaymentTransactionLineItems" }, "shipping": { "$ref": "#/components/schemas/PaymentTransactionShipping" } } }, "extension_days": { "type": "integer", "format": "int64", "description": "The number of days by which the payment authorization period will be extended. If the transaction is expired, the `extension_days` are added to the current date. Otherwise, the `extension_days` are added to the current `expires_at` date.\n\nThe new expiration date is calculated using the formula `max(current_date, expires_at) + extension_days`.\n\nA payment transaction cannot have an authorization period longer than `360 days`, and any attempt to extend beyond that period will be rejected.\n\nConstraint: `max(current_date, expires_at) + expiration_days <= created_at + '360 days'`\n", "example": 7, "minimum": 1, "maximum": 180 } } }, "ReauthorizePaymentTransactionResponseBody": { "type": "object", "required": ["result", "payment_transaction"], "properties": { "result": { "$ref": "#/components/schemas/PaymentReauthorizationResult" }, "payment_transaction": { "type": "object", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "original_authorization_amount", "remaining_authorization_amount", "payment_captures", "payment_refunds", "payment_chargebacks", "payment_funding", "payment_pricing", "settlement_currency", "state_reason"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/PaymentTransactionSupplementaryPurchaseData" }, "payment_captures": { "type": "array", "description": "List of payment captures.", "items": { "$ref": "#/components/schemas/PaymentCaptureResponseBody" } }, "payment_refunds": { "description": "List of payment refunds.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentRefundResponseBody" } }, "payment_chargebacks": { "description": "List of payment chargebacks.", "type": "array", "items": { "$ref": "#/components/schemas/PaymentChargebackResponseBody" } }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "updated_at": { "$ref": "#/components/schemas/PaymentTransactionUpdatedAt" }, "original_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionOriginalAuthorizationAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "payment_funding": { "$ref": "#/components/schemas/PaymentTransactionFunding" }, "payment_pricing": { "$ref": "#/components/schemas/PaymentPricing" }, "settlement_currency": { "$ref": "#/components/schemas/SettlementCurrency" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckoutTransactionApiResponse" }, "point_of_transaction": { "type": "object", "x-validation-info": "Validates that data is passed in correct format.", "description": "Information about the most granular location data about the purchase", "properties": { "type": { "$ref": "#/components/schemas/PointOfTransactionType" } }, "required": ["type"], "discriminator": { "propertyName": "type", "mapping": { "WEBSITE": "#/components/schemas/PointOfTransactionForWebsite", "TERMINAL": "#/components/schemas/PointOfTransactionForTerminal", "MOBILE_APP": "#/components/schemas/PointOfTransactionForMobileApp" } }, "oneOf": [{ "$ref": "#/components/schemas/PointOfTransactionForWebsite" }, { "$ref": "#/components/schemas/PointOfTransactionForTerminal" }, { "$ref": "#/components/schemas/PointOfTransactionForMobileApp" }] }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionAuthorizedStateReason" } }, "description": "Represents the latest state of the payment transaction after processing the reauthorize operation.\n\nIf the status is `REJECTED`, it will reflect the latest state of the Payment Transaction prior to the reauthorization attempt.\n" } } }, "KlarnaNetworkSessionToken": { "type": "string", "maxLength": 8192, "minLength": 1, "x-validation-info": "String between 1 and 8192 characters representing a Klarna network session token", "description": "A short-lived, network-scoped bearer credential that represents an active Klarna Network session.\nUsed to securely link interactions across Payments, Express Checkout, Sign-in with Klarna, On-site Messaging, and Prequalification.\nAlso used for securely transferring a session context between a Partner and an Acquiring Partner.\n", "example": "krn:network:eu1:live:session-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a" }, "CustomerToken": { "type": "string", "description": "Returned if Account Linking or payment tokenization was requested.\n\nThe customer token represents the tokenized customer and allows you to act\non behalf of the customer. You must persist this token in your system associated with the customer\naccount. To de-duplicate customers, you should use the `customer_id` as the unique identifier.\n", "maxLength": 1024, "minLength": 1, "example": "krn:partner:us1:live:identity:customer-token:vVQGmYzlfsQ16dko3jcwY5lV8hBgKs9a", "x-validation-info": "Validation on the length (max length 1024) and the format of the string." }, "Currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "PaymentAmount": { "type": "integer", "format": "int64", "example": 2000, "minimum": 1, "maximum": 2147483647, "x-validation-info": "Validation that it is 10 digits max, up to 2^31-1. That is >= 0. Validation that is equal to line_items.total_amount.", "description": "Total amount of a one-off purchase, including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500.\nThis is the amount that Klarna will charge the customer for a one-off purchase. Should not include any amounts for subscriptions.\n" }, "PaymentRequestReference": { "type": "string", "minLength": 1, "maxLength": 255, "example": "partner-payment-reference-12345", "x-validation-info": "Validation for the length", "description": "Reference to the payment session or equivalent resource created on your side.\nThis will be exposed in payment request webhooks (`payment.request.*`) for the purpose of correlating your resource with the Klarna Payment Request.\n" }, "PurchaseReference": { "type": "string", "example": "merchant-order-9876", "minLength": 1, "maxLength": 255, "x-validation-info": "Validation for the length", "description": "Used for storing the customer-facing order number. It will be displayed to customers on the Klarna app and other communications.\nIf you are a Partner with Klarna, this can be the same as `payment_transaction_reference`. If you are an Acquiring Partner, this is the reference your Partner generated for their customer order.\n" }, "GivenName": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the given name (first name) of the person associated with the transaction.\nKlarna uses this value for customer communication, fraud assessment, and delivery validation.\nEnsure the name is accurate and matches the individual's legal or commonly used identity.\n", "x-validation-info": "Validation of length", "example": "John" }, "FamilyName": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the family name (last name) of the person associated with the transaction.\nKlarna uses this value for customer communication, fraud assessment, and delivery validation.\nEnsure the name is complete and correctly reflects the recipient's or customer's identity.\n", "x-validation-info": "Validation of length", "example": "Doe" }, "Email": { "type": "string", "format": "email", "minLength": 6, "maxLength": 254, "description": "E-mail address.\n\nRegex:\n\n```\n^[!#$%&'*+\\-/0-9=?A-Z^_`a-z{|}~](\\.?[!#$%&'*+\\-/0-9=?A-Z^_`a-z{|}~])*@[a-zA-Z0-9](-*\\.?[a-zA-Z0-9])*\\.[a-zA-Z](-?[a-zA-Z0-9])+$\n```\n\nThis pattern is portable across JavaScript, PCRE, Python and Go (RE2):\nit uses no lookarounds, backreferences or engine-specific Unicode script\nclasses. It requires a dotted domain with an alphabetic top-level label\nand rejects leading, trailing or consecutive dots in the local part. The\nlocal part (max 64 characters) and total length (6–254 characters) are\nenforced by `format`, `minLength` and `maxLength`.\n", "x-validation-info": "Validation that the format is correct", "example": "john.doe@klarna.com" }, "Timestamp": { "type": "string", "format": "date-time", "description": "Timestamp in ISO 8601 with timezone\nValid examples:\n- 2025-06-24T05:51\n- 2025-06-24T05:51:48Z\n- 2025-06-24T05:51:48.1Z\n- 2025-06-24T05:51:48.12Z\n- 2025-06-24T05:51:48.123Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PhoneLocal": { "type": "string", "maxLength": 99, "description": "Provide the phone number in local format.\nEnsure the number includes at least one digit and only contains valid characters: +, digits, spaces, parentheses, periods, or hyphens. The system validates format based on the customer's country. Treat the number as an opaque string, do not parse or transform its structure.\n", "x-validation-info": "Validation that the format is correct for a given country.", "example": "844-552-7621", "pattern": "^(?=.*\\d)[+\\d\\s().-]{1,99}$" }, "StreetAddress1": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the first line of the street address, including the primary information, such as street name and number. \nTreat the value as an opaque string, do not validate or infer its structure.\n", "example": "800 N. High St" }, "StreetAddress2": { "minLength": 1, "maxLength": 99, "type": "string", "description": "Provide the second line of the street address if additional address details are needed.\nKlarna uses this field to capture supplementary information such as apartment, suite, or unit numbers.\nTreat the value as an opaque string, do not validate or infer its format. This field is optional and supports extended address data.\n", "example": "Ste. 400" }, "PostalCode": { "type": "string", "minLength": 1, "maxLength": 10, "example": "43215", "description": "Provide the postal code formatted according to the rules of the specified country.\nTreat the postal code as an opaque string, do not parse or validate its format beyond country-specific requirements.\n" }, "City": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Provide the city or town name for the address indicated.\nTreat the city name as an opaque string, do not validate or infer its structure.\n", "example": "Columbus" }, "Region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country. Mandatory for US and AU market. Validations according to ISO 3166-2 format, e.g. US-OH, US-NJ, AU-ACT, etc.", "example": "US-OH" }, "Country": { "type": "string", "example": "US", "description": "Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.\nThe system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "AllowedCountry": { "type": "string", "example": "US", "description": "Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.\nThe system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.\n\nAllowed countries:\n `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AN`, `AO`, `AQ`\n `AR`, `AS`, `AT`, `AU`, `AW`, `AX`, `AZ`, `BA`, `BB`, `BD`\n `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BL`, `BM`, `BN`, `BO`\n `BQ`, `BR`, `BS`, `BT`, `BV`, `BW`, `BY`, `BZ`, `CA`, `CC`\n `CD`, `CF`, `CG`, `CH`, `CI`, `CK`, `CL`, `CM`, `CN`, `CO`\n `CR`, `CU`, `CV`, `CW`, `CX`, `CY`, `CZ`, `DE`, `DJ`, `DK`\n `DM`, `DO`, `DZ`, `EC`, `EE`, `EG`, `EH`, `ER`, `ES`, `ET`\n `FI`, `FJ`, `FK`, `FM`, `FO`, `FR`, `GA`, `GB`, `GD`, `GE`\n `GF`, `GG`, `GH`, `GI`, `GL`, `GM`, `GN`, `GP`, `GQ`, `GR`\n `GS`, `GT`, `GU`, `GW`, `GY`, `HK`, `HM`, `HN`, `HR`, `HT`\n `HU`, `ID`, `IE`, `IL`, `IM`, `IN`, `IO`, `IQ`, `IR`, `IS`\n `IT`, `JE`, `JM`, `JO`, `JP`, `KE`, `KG`, `KH`, `KI`, `KM`\n `KN`, `KP`, `KR`, `KW`, `KY`, `KZ`, `LA`, `LB`, `LC`, `LI`\n `LK`, `LR`, `LS`, `LT`, `LU`, `LV`, `LY`, `MA`, `MC`, `MD`\n `ME`, `MF`, `MG`, `MH`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`\n `MQ`, `MR`, `MS`, `MT`, `MU`, `MV`, `MW`, `MX`, `MY`, `MZ`\n `NA`, `NC`, `NE`, `NF`, `NG`, `NI`, `NL`, `NO`, `NP`, `NR`\n `NU`, `NZ`, `OM`, `PA`, `PE`, `PF`, `PG`, `PH`, `PK`, `PL`\n `PM`, `PN`, `PR`, `PS`, `PT`, `PW`, `PY`, `QA`, `RE`, `RO`\n `RS`, `RU`, `RW`, `SA`, `SB`, `SC`, `SD`, `SE`, `SG`, `SH`\n `SI`, `SJ`, `SK`, `SL`, `SM`, `SN`, `SO`, `SR`, `SS`, `ST`\n `SV`, `SX`, `SY`, `SZ`, `TC`, `TD`, `TF`, `TG`, `TH`, `TJ`\n `TK`, `TL`, `TM`, `TN`, `TO`, `TR`, `TT`, `TV`, `TW`, `TZ`\n `UA`, `UG`, `UM`, `US`, `UY`, `UZ`, `VA`, `VC`, `VE`, `VG`\n `VI`, `VN`, `VU`, `WF`, `WS`, `XK`, `YE`, `YT`, `ZA`, `ZM`\n `ZW`\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "NationalIdentificationUS": { "type": "object", "description": "US Social Security Number (SSN)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "SSN in 9 digit format", "pattern": "^[0-9]{3}-[0-9]{2}-[0-9]{4}|[0-9]{9}$", "example": "999-99-9999" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["US"] } } }, "NationalIdentificationDK": { "type": "object", "description": "Danish Personal Identification Number (\"Det Centrale Personregister - CPR\")", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Personal Identification Number in 10 digit format (DDMMYY-SSSS)", "pattern": "^[0-9]{6}-[0-9]{4}$", "example": "010212-0566" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["DK"] } } }, "NationalIdentificationES": { "type": "object", "description": "Spanish National Identity Document (Documento Nacional de Identidad - DNI)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "National Identity Document 9 digit format (SSSSSSSSA)", "pattern": "^[0-9]{8}[A-Z]{1}$", "example": "12345678Z" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["ES"] } } }, "NationalIdentificationFI": { "type": "object", "description": "Finnish Personal Identity Code (Henkilötunnus - HETU)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Personal Identity Code in 11 digit format (DDMMYYCZZZQ)", "pattern": "^[0-9]{6}[A+-][0-9]{3}[0-9A-Z]{1}$", "example": "190122-829F" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["FI"] } } }, "NationalIdentificationIT": { "type": "object", "description": "Italian Fiscal Code (Codice Fiscale - CF)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Fiscal Code in 16 digit format (LLLLLLYYMMDDSSSC)", "pattern": "^[0-9A-Z]{6}[0-9]{2}[ABCDEHLMPRST]{1}[0-9]{2}[A-Z]{1}[0-9]{3}[A-Z]{1}$", "example": "MRTMTT25D09F205Z" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["IT"] } } }, "NationalIdentificationNO": { "type": "object", "description": "Norwegian National Identity Number (Fødselsnummer - NIN)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "National Identity Number in 11 digit format (DDMMYYIIIKK)", "pattern": "^[0-9]{6}[0-9]{5}$", "example": "01021205667" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["NO"] } } }, "NationalIdentificationSE": { "type": "object", "description": "Swedish Personal Identity Number (\"Personnummer\" - PNO)", "required": ["country", "number"], "properties": { "number": { "type": "string", "description": "Personal Identity Number in 12 digit format (YYYYMMDD-SSSS)", "pattern": "^[0-9]{8}-[0-9]{4}$", "example": "19811218-9876" }, "country": { "type": "string", "description": "Country code (ISO 3166-1 alpha-2) of the format of the `number` field", "enum": ["SE"] } } }, "DateOfBirth": { "type": "string", "description": "Date of birth of the person on the format YYYY-MM-DD", "x-validation-info": "Validation that the value is of the right format and the date is not in the future.", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "1970-01-01" }, "CustomerAccountLogin": { "type": "object", "description": "A customer account login event, including the authentication method used and when it occurred.", "properties": { "device_identifier": { "type": "string", "description": "Identifier for the device used during login.", "minLength": 1, "maxLength": 2048 }, "login_methods": { "type": "array", "maxItems": 3, "description": "Authentication methods used for this login event.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `EMAIL_BY_LINK` | |\n| `EMAIL_BY_OTP` | |\n| `PASSCODE` | |\n| `PASSWORD` | |\n| `PHONE_BY_LINK` | |\n| `PHONE_MATCH` | |\n| `SMS_BY_OTP` | |\n| `SNA` | |\n| `WEBAUTHN_PASSKEY` | |\n", "items": { "type": "string", "description": "An authentication method used for this login event.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `EMAIL_BY_LINK` | |\n| `EMAIL_BY_OTP` | |\n| `PASSCODE` | |\n| `PASSWORD` | |\n| `PHONE_BY_LINK` | |\n| `PHONE_MATCH` | |\n| `SMS_BY_OTP` | |\n| `SNA` | |\n| `WEBAUTHN_PASSKEY` | |\n", "enum": ["EMAIL_BY_LINK", "EMAIL_BY_OTP", "PASSCODE", "PASSWORD", "PHONE_BY_LINK", "PHONE_MATCH", "SMS_BY_OTP", "SNA", "WEBAUTHN_PASSKEY"] } }, "occurred_at": { "type": "string", "format": "date-time", "description": "Timestamp of when the login event occurred in ISO 8601 with timezone, e.g. 2026-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } } }, "CustomerAccountLastLogin": { "type": "object", "description": "Last login of the customer into the account.", "properties": { "device_identifier": { "type": "string", "description": "Identifier for the device used during login.", "minLength": 1, "maxLength": 2048 }, "login_methods": { "type": "array", "maxItems": 3, "description": "Authentication methods used for this login event.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `EMAIL_BY_LINK` | |\n| `EMAIL_BY_OTP` | |\n| `PASSCODE` | |\n| `PASSWORD` | |\n| `PHONE_BY_LINK` | |\n| `PHONE_MATCH` | |\n| `SMS_BY_OTP` | |\n| `SNA` | |\n| `WEBAUTHN_PASSKEY` | |\n", "items": { "type": "string", "description": "An authentication method used for this login event.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `EMAIL_BY_LINK` | |\n| `EMAIL_BY_OTP` | |\n| `PASSCODE` | |\n| `PASSWORD` | |\n| `PHONE_BY_LINK` | |\n| `PHONE_MATCH` | |\n| `SMS_BY_OTP` | |\n| `SNA` | |\n| `WEBAUTHN_PASSKEY` | |\n", "enum": ["EMAIL_BY_LINK", "EMAIL_BY_OTP", "PASSCODE", "PASSWORD", "PHONE_BY_LINK", "PHONE_MATCH", "SMS_BY_OTP", "SNA", "WEBAUTHN_PASSKEY"] } }, "occurred_at": { "type": "string", "format": "date-time", "description": "Timestamp of when the login event occurred in ISO 8601 with timezone, e.g. 2026-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } } }, "CustomerAccountPurchaseHistory": { "type": "object", "description": "Purchase history of the customer with the merchant.", "properties": { "number_of_purchases": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The number of purchases the customer has made with the merchant in the last 12 month" }, "number_of_paid_purchases": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The number of successfully paid purchases the customer has made with the merchant in the last 12 month" }, "number_of_disputed_purchases": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "The number of disputes the customer has made with the merchant in the last 12 month" }, "total_amount": { "type": "integer", "format": "int64", "description": "Accumulated amount of payments done in minor currency units.", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "currency": { "$ref": "#/components/schemas/Currency" }, "payment_method": { "type": "string", "description": "The payment method used by the customer\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CREDIT_CARD` | |\n| `DIRECT_DEBIT` | |\n| `MOBILE_WALLET` | |\n| `NON_KLARNA_CREDIT` | |\n| `OTHER` | |\n", "enum": ["CREDIT_CARD", "DIRECT_DEBIT", "MOBILE_WALLET", "NON_KLARNA_CREDIT", "OTHER"] }, "first_purchase_at": { "type": "string", "format": "date-time", "description": "The date when the customer made the first payment in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "last_purchase_at": { "type": "string", "format": "date-time", "description": "The date when the customer made the last payment in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } } }, "CustomerAccount": { "type": "object", "description": "Information about the customer's account with the merchant. This information may be used by Klarna for fraud assessment and will not be not persisted on placed orders.", "properties": { "account_identifier": { "type": "string", "example": "acc_stripe_1234", "description": "A unique identifier for the customer's account with the merchant. This may be for example a customer number or a loyalty program number.", "minLength": 1, "maxLength": 255 }, "loyalty_level": { "type": "string", "description": "Indicates level of loyalty within the merchant loyalty program.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `LOW` | |\n| `MEDIUM` | |\n| `HIGH` | |\n", "enum": ["LOW", "MEDIUM", "HIGH"] }, "created_at": { "type": "string", "format": "date-time", "description": "The date when the customer's account with the merchant was created in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z.", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "Last date when the customer's account with the merchant was modified in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z.", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "last_login": { "$ref": "#/components/schemas/CustomerAccountLastLogin" }, "purchase_history": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAccountPurchaseHistory" } }, "device_purchase_history": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAccountPurchaseHistory" } }, "login_history": { "type": "array", "maxItems": 32, "description": "Recent customer login events, in reverse chronological order. Klarna uses this data to assess account activity patterns.\n", "items": { "$ref": "#/components/schemas/CustomerAccountLogin" } } } }, "CustomerDeviceGeolocation": { "type": "object", "description": "The geographical location of the device during verification", "properties": { "country": { "$ref": "#/components/schemas/AllowedCountry" }, "latitude": { "type": "number", "example": 40.7128, "description": "The latitude coordinate in which the device was located in during verification." }, "longitude": { "type": "number", "example": 74.006, "description": "The longitude coordinate in which the device was located in during verification." } } }, "CustomerDevice": { "type": "object", "description": "The device used by the customer during the session", "properties": { "app_identifier": { "type": "string", "example": "com.example.merchant", "description": "Identifier for the app the session was browsed on.", "minLength": 1, "maxLength": 255 }, "device_identifier": { "type": "string", "example": "Operating System: Windows 10 Browser: Chrome 91.0.4430.212 Screen Resolution: 1920x1080 Installed Plugins: Adobe Flash Player 32.0.0.465, Java 8 Update 291 Timezone: UTC+02:00 Language: English (United States)", "description": "Identifier for the device the session was browsed on", "minLength": 1, "maxLength": 2048 }, "user_agent": { "type": "string", "example": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.212 Safari/537.36", "description": "User agent of the device at the time of the session.", "minLength": 1, "maxLength": 2048 }, "ip_address": { "type": "string", "format": "ip_address", "description": "IP address of the device at the time of the session.", "pattern": "^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$|^(([a-fA-F]|[a-fA-F][a-fA-F0-9\\-]*[a-fA-F0-9])\\.)*([A-Fa-f]|[A-Fa-f][A-Fa-f0-9\\-]*[A-Fa-f0-9])$|^(?:(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){6})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:::(?:(?:(?:[0-9a-fA-F]{1,4})):){5})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){4})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,1}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){3})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,2}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:(?:[0-9a-fA-F]{1,4})):){2})(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,3}(?:(?:[0-9a-fA-F]{1,4})))?::(?:(?:[0-9a-fA-F]{1,4})):)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,4}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9]))\\.){3}(?:(?:25[0-5]|(?:[1-9]|1[0-9]|2[0-4])?[0-9])))))))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,5}(?:(?:[0-9a-fA-F]{1,4})))?::)(?:(?:[0-9a-fA-F]{1,4})))|(?:(?:(?:(?:(?:(?:[0-9a-fA-F]{1,4})):){0,6}(?:(?:[0-9a-fA-F]{1,4})))?::)))))$", "example": "192.168.1.1", "x-validation-info": "Validation that is a valid IP address." }, "geolocation": { "$ref": "#/components/schemas/CustomerDeviceGeolocation" } } }, "Customer": { "type": "object", "description": "This object provides information about the customer based on their previous interactions with the merchant.\nThese data points may be used by Klarna to simplify sign-up and during fraud assessment, as well as for underwriting purposes to provide an enhanced experience to returning customers.\nThis information will not be persisted on created Payment Transactions.\n", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" }, "email": { "$ref": "#/components/schemas/Email" }, "email_last_verified_at": { "type": "string", "format": "date-time", "description": "Date of the most recent email verification done in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "phone": { "$ref": "#/components/schemas/PhoneLocal" }, "phone_last_verified_at": { "type": "string", "format": "date-time", "description": "Date of the most recent phone verification done in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "address": { "type": "object", "description": "Domicile address of the customer (billing address). Klarna will only use this as an indicator for fraud and to simplify sign-up. The address will not be used for underwriting and will not be persisted on created Payment Transactions. Klarna will also not assume that this is the shipping address of the customer, to send Klarna the shipping address of the customer, you must populate the shipping object.", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "$ref": "#/components/schemas/Region" }, "country": { "$ref": "#/components/schemas/AllowedCountry" } } }, "national_identification": { "type": "object", "description": "The national identification details", "x-validation-info": "Check that is an object", "oneOf": [{ "$ref": "#/components/schemas/NationalIdentificationUS" }, { "$ref": "#/components/schemas/NationalIdentificationDK" }, { "$ref": "#/components/schemas/NationalIdentificationES" }, { "$ref": "#/components/schemas/NationalIdentificationFI" }, { "$ref": "#/components/schemas/NationalIdentificationIT" }, { "$ref": "#/components/schemas/NationalIdentificationNO" }, { "$ref": "#/components/schemas/NationalIdentificationSE" }], "required": ["country", "number"], "discriminator": { "propertyName": "country", "mapping": { "US": "#/components/schemas/NationalIdentificationUS", "DK": "#/components/schemas/NationalIdentificationDK", "ES": "#/components/schemas/NationalIdentificationES", "FI": "#/components/schemas/NationalIdentificationFI", "IT": "#/components/schemas/NationalIdentificationIT", "NO": "#/components/schemas/NationalIdentificationNO", "SE": "#/components/schemas/NationalIdentificationSE" } } }, "date_of_birth": { "type": "string", "description": "The date of birth of the customer", "x-validation-info": "Validation that the value is of the right format and the date is not in the future.", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "1970-01-01" }, "customer_account": { "$ref": "#/components/schemas/CustomerAccount" }, "customer_device": { "$ref": "#/components/schemas/CustomerDevice" } } }, "ShippingType": { "type": "string", "description": "Specify the type of shipping the customer selected during the payment request.\nKlarna uses this value to inform delivery expectations and support accurate fraud assessment and post-purchase communication.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `TO_DOOR` | Delivery to door |\n| `TO_CURB` | Curb-side delivery |\n| `TO_MAILBOX` | Best-effort mailbox delivery |\n| `PICKUP_BOX` | Pickup at an unmanned designated pickup locker/box |\n| `PICKUP_POINT` | Pickup at a manned pickup point |\n| `PICKUP_STORE` | Pickup in-store |\n| `PICKUP_WAREHOUSE` | Pickup at warehouse |\n| `DIGITAL_EMAIL` | Digital delivery via email |\n| `DIGITAL_DOWNLOAD` | Digital delivery via download |\n| `DIGITAL_OTHER` | Other digital delivery |\n| `PHYSICAL_OTHER` | Other physical delivery |\n", "example": "TO_DOOR", "enum": ["TO_DOOR", "TO_CURB", "TO_MAILBOX", "PICKUP_BOX", "PICKUP_POINT", "PICKUP_STORE", "PICKUP_WAREHOUSE", "DIGITAL_EMAIL", "DIGITAL_DOWNLOAD", "DIGITAL_OTHER", "PHYSICAL_OTHER"] }, "ShippingTypeAttribute": { "type": "string", "description": "Additional services/attribute to the shipping type.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `SIGNATURE_REQUIRED` | Mandatory signature is required at delivery |\n| `IDENTIFICATION_REQUIRED` | Mandatory identification is required at delivery |\n| `CONTACTLESS_DELIVERY` | Contactless delivery |\n| `LEAVE_AT_DOOR` | Parcel may be left at door |\n| `LEAVE_AT_CURB` | Parcel may be left at curb |\n| `LEAVE_WITH_NEIGHBOUR` | |\n| `EXPRESS` | Express delivery |\n| `TRACKED` | Tracked delivery |\n| `UNTRACKED` | Untracked delivery |\n", "example": "SIGNATURE_REQUIRED", "enum": ["SIGNATURE_REQUIRED", "IDENTIFICATION_REQUIRED", "CONTACTLESS_DELIVERY", "LEAVE_AT_DOOR", "LEAVE_AT_CURB", "LEAVE_WITH_NEIGHBOUR", "EXPRESS", "TRACKED", "UNTRACKED"] }, "ShippingCarrier": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The company responsible for the delivery.\nProvide the name of the company responsible for delivering the shipment.\nKlarna uses this information to support tracking, customer communication, and fraud assessment.\nTreat the value as an opaque string, do not assume or validate its format.\n", "example": "DHL" }, "ShippingNonRequired": { "description": "Information about the shipping address and shipping option.\n", "type": "object", "properties": { "shipping_option": { "description": "Provide the shipping option selected by the customer on the Partner's store.\nKlarna uses this value to confirm shipping preferences and display the correct delivery method during the payment flow.\nTreat this value as an opaque string and do not validate or infer its structure.\n", "type": "object", "required": ["shipping_type"], "properties": { "shipping_type": { "$ref": "#/components/schemas/ShippingType" }, "shipping_type_attributes": { "type": "array", "description": "Provide additional attributes that describe specific services related to the selected shipping type.\nKlarna uses these attributes to refine delivery details and enhance fraud assessment.\nUse this field if the shipping type alone does not fully describe the delivery service. \nTreat attribute values as opaque strings, do not validate or interpret their format.\n", "items": { "$ref": "#/components/schemas/ShippingTypeAttribute" } }, "shipping_carrier": { "$ref": "#/components/schemas/ShippingCarrier" } } }, "shipping_reference": { "minLength": 1, "maxLength": 255, "type": "string", "description": "Unique reference to this shipping address.\nRequired if the payment request contains multiple shipping objects.\n\nThis can be any string, and *does not* have to correspond to a delivery or tracking number.\n", "example": "DHL-123456" }, "recipient": { "description": "Provide the full name of the person or entity receiving the shipment.\nKlarna uses this information to support customer communication, and fraud assessment.\nEnsure the information matches the intended delivery recipient details.\n", "type": "object", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" }, "email": { "$ref": "#/components/schemas/Email" }, "phone": { "$ref": "#/components/schemas/PhoneLocal" }, "attention": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Attention string for the recipient" } } }, "address": { "description": "Postal address.", "type": "object", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "$ref": "#/components/schemas/Region" }, "country": { "$ref": "#/components/schemas/AllowedCountry" } } } } }, "LineItemReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Provide a unique reference for this line item to correlate it with your system’s internal records.\nKlarna includes this reference in responses to help you track and reconcile line items.\n", "example": "cart-item-1234" }, "LineItem": { "type": "object", "required": ["name", "quantity", "total_amount"], "properties": { "name": { "type": "string", "description": "Provide a customer-facing description of the item to clarify what the customer purchased or is being refunded for.\nKlarna displays this description in customer communications, such as receipts and refund confirmations.\nEnsure the value is a clear and concise string that accurately represents the item. Avoid internal codes or technical terms.\nThe string must not contain HTML, CSS or JavaScript. Requests containing such elements will be rejected.\n", "example": "Black fountain pen", "minLength": 1, "maxLength": 1024 }, "quantity": { "type": "integer", "description": "Specify the number of identical items being bought to calculate the total amount for the item line.\nKlarna multiplies this value by the unit price to determine the item’s total cost.\nEnsure the value is a positive integer representing the exact count of the item.\n", "example": 2, "minimum": 1 }, "total_amount": { "type": "integer", "format": "int64", "description": "Specify the total amount to charge or credit the customer to reflect the final line item value, including surcharges and deductions.\n Klarna uses this value to calculate the total payment or refund amount.\n Ensure the value is in minor currency units (e.g., 2500 for USD 25). Use a negative value to credit the customer (e.g., for discounts, vouchers, or gift cards), and a positive value to charge.\n", "example": 2000, "maximum": 2147483648 }, "total_tax_amount": { "type": "integer", "format": "int64", "description": "Specify how much of the total_amount is attributed to sales tax to clarify the tax portion of the item value.\nKlarna uses this value for taxation reporting and may calculate the implied tax rate for display purposes using the formula: tax_rate = total_tax_amount / (total_amount - total_tax_amount)\nEnsure the value is in the corresponding currency minor units.\n\n- Set to 0 to indicate that the total_amount excludes sales tax.\n- Set to the same value as total_amount for sales-tax-only items.\n- If omitted, Klarna assumes no taxation.\n", "example": 0, "minimum": 0, "maximum": 2147483648 }, "unit_price": { "type": "integer", "format": "int64", "description": "Provide the individual price per item in minor currency units to define the cost of a single unit when it differs from total_amount / quantity.\nKlarna uses this value to represent per-item pricing and improve accuracy in price breakdowns on customer communications.\nEnsure the value is in the corresponding currency minor units (e.g., 500 for USD 5).\n", "example": 1000, "minimum": -2147483648, "maximum": 2147483648 }, "product_url": { "type": "string", "minLength": 1, "maxLength": 4096, "description": "Provide the full URL to the product page to allow the customer to access more information about the item.\nKlarna includes this link in relevant customer-facing surfaces, such as post-purchase emails or order summaries.\nEnsure the value is a valid and complete URL, beginning with https://, and points directly to the product page on your online store.\n", "example": "https://merchant.example/product/pencil-3270220049012.html" }, "image_url": { "type": "string", "minLength": 1, "maxLength": 4096, "description": "Provide a link to a high-resolution image of the product to visually represent the item in customer-facing interfaces.\nKlarna displays this image in order confirmations, Klarna app, and other customer touchpoints.\nEnsure the value is a valid and accessible URL, preferably using https://, and points to a clear, high-quality image.\n", "example": "https://merchant.example/images/pencil-3270220049012.png" }, "product_identifier": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Provide a unique identifier of the item, such as Global Trade Item Number (GTIN), Universal Product Code (UPC) or International Standard Book Number (ISBN) to support fraud assessment, acceptance optimization, and customer experience enhancements.\nKlarna uses this identifier to match product details and assess the transaction more accurately.\nIf you cannot provide a global unique identifier, you may submit a SKU reference instead.\n", "example": "3270220049012" }, "line_item_reference": { "$ref": "#/components/schemas/LineItemReference" }, "shipping_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Provide a reference to the shipping address for this item to specify the delivery destination.\nEnsure the value exactly matches a valid shipping object reference present in the request payload.\n", "example": "shipping-recipient-1234" }, "line_item_metadata": { "type": "object", "description": "Provide additional metadata for the line item to store custom information relevant to your system.\n", "properties": { "categories": { "type": "array", "description": "Provide an ordered list of human-readable category names to represent the item’s category hierarchy from general to specific.\n Klarna uses this information to improve product classification, fraud assessment, and customer experience.\n Ensure the value is an array of up to 10 strings, each representing a distinct level in the category path, listed from top-level to most specific.\n", "items": { "type": "string", "minLength": 1, "maxLength": 1024 }, "minItems": 1, "maxItems": 10, "example": ["Electronics", "Computers", "Laptops"] } } }, "subscription_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Defines which subscription this item relates to. If present, then it must match the reference field of a subscription object within the same payload.\n", "example": "PREMIUM_INDIVIDUAL" } } }, "Price": { "type": "integer", "format": "int64", "example": 20000, "minimum": 0, "maximum": 2147483647, "description": "Value in minor local currency units", "x-validation-info": "Field price must be a number between 0 and 2147483647 (inclusive)" }, "TravelPassenger": { "type": "object", "description": "Travel passenger details.\n", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" } } }, "TravelInsurance": { "type": "object", "description": "Travel insurance details.\n", "properties": { "insurance_type": { "description": "Type of insurance\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CANCELATION` | |\n| `BANKRUPTCY` | |\n| `MEDICAL` | |\n| `BAGGAGE` | |\n| `EMERGENCY` | |\n", "type": "string", "enum": ["CANCELATION", "BANKRUPTCY", "MEDICAL", "BAGGAGE", "EMERGENCY"] }, "insurance_company_name": { "description": "Name of the company providing the insurance", "type": "string", "minLength": 1, "maxLength": 255, "x-validation-info": "Field insurance_company_name must be between 1 and 255 characters in length (inclusive)" }, "price": { "type": "integer", "format": "int64", "example": 20000, "minimum": 0, "maximum": 2147483647, "description": "Price of insurance in minor local currency units", "x-validation-info": "Field price must be a number between 0 and 2147483647 (inclusive)" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" } } }, "AffiliateName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Name of associated or partner company for the service", "x-validation-info": "Field affiliate_name must be between 1 and 255 characters in length (inclusive)" }, "AirReservationDetails": { "description": "Travel reservation details for air travel including passengers, itinerary, and insurance.\n", "required": ["travel_type"], "type": "object", "properties": { "travel_type": { "type": "string", "description": "Type of transportation", "enum": ["AIR"] }, "reservation_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Refers to the airline booking reference code", "x-validation-info": "Field reservation_reference must be between 1 and 255 characters in length (inclusive)" }, "departure": { "type": "object", "description": "Departure details", "properties": { "departure_airport": { "type": "string", "description": "3-letter IATA Airport Code of departure", "example": "ARN", "pattern": "^[A-Z]{3}$", "x-validation-info": "Field must be all uppercase and 3 characters in length" }, "departs_at": { "type": "string", "format": "date-time", "description": "Date and time of departure in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "city": { "type": "string", "minLength": 1, "maxLength": 99, "description": "City of departure", "example": "Columbus" }, "country": { "type": "string", "example": "US", "description": "2 letter country of departure", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." } } }, "arrival": { "type": "object", "description": "Arrival details", "properties": { "arrival_airport": { "type": "string", "description": "3-letter IATA Airport Code of arrival", "example": "OSL", "pattern": "^[A-Z]{3}$", "x-validation-info": "Field must be all uppercase and 3 characters in length" }, "city": { "type": "string", "minLength": 1, "maxLength": 99, "description": "City of arrival", "example": "Columbus" }, "country": { "type": "string", "example": "US", "description": "2 letter country of arrival", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." } } }, "carrier_name": { "type": "string", "description": "2-letter Airline code", "example": "IB", "pattern": "^[A-Z0-9]{2}$", "x-validation-info": "Field carrier_name must have only alphanumeric characters in uppercase and must be 2 characters in length" }, "price": { "$ref": "#/components/schemas/Price" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "ticket_class": { "type": "string", "description": "Indicated ticket class\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ECONOMY` | |\n| `PREMIUM_ECONOMY` | |\n| `BUSINESS` | |\n| `FIRST_CLASS` | |\n", "enum": ["ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS"] }, "passengers": { "type": "array", "description": "List of passengers that this reservation applies to", "items": { "$ref": "#/components/schemas/TravelPassenger" } }, "insurances": { "type": "array", "description": "List of insurances for this reservation", "items": { "$ref": "#/components/schemas/TravelInsurance" } }, "affiliate_name": { "$ref": "#/components/schemas/AffiliateName" } } }, "CarrierName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Name of carrier company", "x-validation-info": "Field carrier_name must be between 1 and 255 characters in length (inclusive)" }, "BusTrainFerryReservationDetails": { "type": "object", "description": "Travel reservation details for bus, train, or ferries including passengers, itinerary, and insurance.\n", "required": ["travel_type"], "properties": { "travel_type": { "type": "string", "description": "Type of transportation\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `BUS` | |\n| `TRAIN` | |\n| `FERRY` | |\n| `ROUND_TRIP` | |\n", "enum": ["BUS", "TRAIN", "FERRY", "ROUND_TRIP"] }, "departure": { "type": "object", "description": "Departure details", "properties": { "departure_location": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Identifier name or reference for the origin location", "x-validation-info": "Field departure_location must be between 1 and 255 characters in length (inclusive)" }, "departs_at": { "type": "string", "format": "date-time", "description": "Date and time of departure in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "address": { "type": "object", "description": "Address of the departure location", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } } } }, "arrival": { "type": "object", "description": "Arrival details", "properties": { "arrival_location": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Identifier name or reference for the arrival location", "x-validation-info": "Field arrival_location must be between 1 and 255 characters in length (inclusive)" }, "address": { "type": "object", "description": "Address of the arrival location", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } } } }, "carrier_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Name of transportation company", "x-validation-info": "Field carrier_name must be between 1 and 255 characters in length (inclusive)" }, "price": { "$ref": "#/components/schemas/Price" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "ticket_class": { "type": "string", "description": "Indicates ticket class\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ECONOMY` | |\n| `PREMIUM_ECONOMY` | |\n| `BUSINESS` | |\n| `FIRST_CLASS` | |\n", "enum": ["ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS"] }, "passengers": { "type": "array", "description": "List of passengers that this reservation applies to", "items": { "$ref": "#/components/schemas/TravelPassenger" } }, "insurances": { "type": "array", "description": "List of insurances for this reservation", "items": { "$ref": "#/components/schemas/TravelInsurance" } }, "affiliate_name": { "$ref": "#/components/schemas/AffiliateName" } } }, "Driver": { "type": "object", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" }, "date_of_birth": { "$ref": "#/components/schemas/DateOfBirth" } } }, "CarRentalInsurance": { "type": "object", "description": "Travel insurance details.\n", "properties": { "insurance_type": { "description": "Type of insurance\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `LIABILITY_SUPPLEMENT` | |\n| `LOSS_DAMAGE_WAIVER` | |\n| `PARTIAL_DAMAGE_WAIVER` | |\n| `PERSONAL_ACCIDENT` | |\n| `PERSONAL_EFFECTS` | |\n", "type": "string", "enum": ["LIABILITY_SUPPLEMENT", "LOSS_DAMAGE_WAIVER", "PARTIAL_DAMAGE_WAIVER", "PERSONAL_ACCIDENT", "PERSONAL_EFFECTS"] }, "insurance_company_name": { "description": "Name of the company providing the insurance", "type": "string", "minLength": 1, "maxLength": 255, "x-validation-info": "Field insurance_company_name must be between 1 and 255 characters in length (inclusive)" }, "price": { "type": "integer", "format": "int64", "example": 20000, "minimum": 0, "maximum": 2147483647, "description": "Price of insurance in minor local currency units", "x-validation-info": "Field price must be a number between 0 and 2147483647 (inclusive)" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" } } }, "CarRentalReservationDetails": { "description": "Travel reservation details for car travel including drivers, itinerary, and insurance.\n", "required": ["travel_type"], "type": "object", "properties": { "travel_type": { "type": "string", "description": "Type of transportation", "enum": ["CAR"] }, "carrier_name": { "$ref": "#/components/schemas/CarrierName" }, "departure": { "type": "object", "description": "Departure details", "properties": { "address": { "type": "object", "description": "Address of the pick-up location", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } }, "departs_at": { "type": "string", "format": "date-time", "description": "Start time of rental in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } } }, "arrival": { "type": "object", "description": "Arrival details", "properties": { "address": { "type": "object", "description": "Address of the drop-off location", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } }, "arrives_at": { "type": "string", "format": "date-time", "description": "End time of rental in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } } }, "price": { "$ref": "#/components/schemas/Price" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "car_class": { "type": "string", "description": "Type of car\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ECONOMY` | |\n| `PREMIUM_ECONOMY` | |\n| `BUSINESS` | |\n| `FIRST_CLASS` | |\n", "enum": ["ECONOMY", "PREMIUM_ECONOMY", "BUSINESS", "FIRST_CLASS"] }, "drivers": { "type": "array", "description": "List of drivers that this reservation applies to", "items": { "$ref": "#/components/schemas/Driver" } }, "insurances": { "type": "array", "description": "List of insurances for this reservation", "items": { "$ref": "#/components/schemas/CarRentalInsurance" } }, "affiliate_name": { "$ref": "#/components/schemas/AffiliateName" } } }, "TravelReservationDetails": { "description": "Travel reservation details.\n", "oneOf": [{ "$ref": "#/components/schemas/AirReservationDetails" }, { "$ref": "#/components/schemas/BusTrainFerryReservationDetails" }, { "$ref": "#/components/schemas/CarRentalReservationDetails" }], "discriminator": { "propertyName": "travel_type", "mapping": { "AIR": "#/components/schemas/AirReservationDetails", "BUS": "#/components/schemas/BusTrainFerryReservationDetails", "TRAIN": "#/components/schemas/BusTrainFerryReservationDetails", "FERRY": "#/components/schemas/BusTrainFerryReservationDetails", "ROUND_TRIP": "#/components/schemas/BusTrainFerryReservationDetails", "CAR": "#/components/schemas/CarRentalReservationDetails" } } }, "Guest": { "type": "object", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" } } }, "Host": { "type": "object", "description": "The host that this reservation applies to", "properties": { "host_reference": { "type": "string", "description": "Unique identifier for the host/lodging for booking platforms", "minLength": 1, "maxLength": 255, "x-validation-info": "Field host_reference must be between 1 and 255 characters in length (inclusive)" }, "host_type": { "type": "string", "description": "Type of host\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `RENTAL_AGENCY` | |\n| `OWNER` | |\n| `HOTEL` | |\n| `HOSTEL` | |\n", "enum": ["RENTAL_AGENCY", "OWNER", "HOTEL", "HOSTEL"] }, "country_of_domicile": { "type": "string", "example": "US", "description": "2 letter country of host residency for physical person or country of registration in the case of business entities", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "registered_at": { "type": "string", "format": "date-time", "description": "Timestamp associated to the host registration in the booking platform in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "number_of_reservations": { "type": "integer", "description": "Number of bookings recorded for a host in the last 12 months", "minimum": 0, "maximum": 2147483647, "x-validation-info": "Field number_of_reservations must be a number between 0 and 2147483647 (inclusive)" } } }, "LodgingInsurance": { "type": "object", "description": "Travel insurance details.\n", "properties": { "insurance_type": { "description": "Type of insurance\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CANCELATION` | |\n| `BANKRUPTCY` | |\n| `MEDICAL` | |\n| `EMERGENCY` | |\n", "type": "string", "enum": ["CANCELATION", "BANKRUPTCY", "MEDICAL", "EMERGENCY"] }, "insurance_company_name": { "description": "Name of the company providing the insurance", "type": "string", "minLength": 1, "maxLength": 255, "x-validation-info": "Field insurance_company_name must be between 1 and 255 characters in length (inclusive)" }, "price": { "type": "integer", "format": "int64", "example": 20000, "minimum": 0, "maximum": 2147483647, "description": "Price of insurance in minor local currency units", "x-validation-info": "Field price must be a number between 0 and 2147483647 (inclusive)" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" } } }, "LodgingReservationDetails": { "description": "Describes one or more lodging reservation/s including guests and room types.\n", "type": "object", "properties": { "lodging_name": { "type": "string", "minLength": 1, "maxLength": 255, "example": "Any Hotel", "description": "Name of the lodging, typically hotel, hotel or apartment complex name", "x-validation-info": "Field lodging_name must be between 1 and 255 characters in length (inclusive)" }, "address": { "type": "object", "description": "Address of the lodging", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } }, "starts_at": { "type": "string", "format": "date-time", "description": "Start time of stay in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "ends_at": { "type": "string", "format": "date-time", "description": "End time of stay in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "number_of_spaces": { "description": "Number of spaces booked in the reservation", "type": "integer", "example": 1, "minimum": 1, "maximum": 2147483647, "x-validation-info": "Field number_of_spaces must be a number between 1 and 2147483647 (inclusive)" }, "price": { "$ref": "#/components/schemas/Price" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "lodging_type": { "type": "string", "description": "Type of lodging\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ROOM` | |\n| `APARTMENT` | |\n| `HOUSE` | |\n| `CABANA` | |\n| `VILLA` | |\n| `STANDARD` | |\n| `SUITE` | |\n| `PENTHOUSE` | |\n", "enum": ["ROOM", "APARTMENT", "HOUSE", "CABANA", "VILLA", "STANDARD", "SUITE", "PENTHOUSE"] }, "guests": { "type": "array", "description": "List of guests that this reservation applies to", "items": { "$ref": "#/components/schemas/Guest" } }, "host": { "$ref": "#/components/schemas/Host" }, "insurances": { "type": "array", "description": "List of insurances for this reservation", "items": { "$ref": "#/components/schemas/LodgingInsurance" } }, "affiliate_name": { "$ref": "#/components/schemas/AffiliateName" } } }, "InsuranceDetails": { "type": "object", "description": "Travel insurance details.\n", "properties": { "insurance_type": { "description": "Type of insurance\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CANCELATION` | |\n| `BANKRUPTCY` | |\n| `MEDICAL` | |\n| `EMERGENCY` | |\n", "type": "string", "enum": ["CANCELATION", "BANKRUPTCY", "MEDICAL", "EMERGENCY"] }, "insurance_company_name": { "description": "Name of the company providing the insurance", "type": "string", "minLength": 1, "maxLength": 255, "x-validation-info": "Field insurance_company_name must be between 1 and 255 characters in length (inclusive)" }, "price": { "type": "integer", "format": "int64", "example": 20000, "minimum": 0, "maximum": 2147483647, "description": "Price of insurance in minor local currency units", "x-validation-info": "Field price must be a number between 0 and 2147483647 (inclusive)" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" } } }, "Voucher": { "type": "object", "description": "Describes detailed information about the voucher.\n", "properties": { "voucher_name": { "description": "Indicates the name or reference to identify the voucher", "type": "string", "example": "Gift Card", "minLength": 1, "maxLength": 255, "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)" }, "voucher_type": { "description": "Type of the voucher\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `GIFT_CARD` | |\n| `DISCOUNT` | |\n| `DIGITAL_PRODUCT` | |\n| `PHYSICAL_PRODUCT` | |\n| `SERVICES` | |\n", "type": "string", "enum": ["GIFT_CARD", "DISCOUNT", "DIGITAL_PRODUCT", "PHYSICAL_PRODUCT", "SERVICES"] }, "voucher_company": { "description": "Indicates the issuer/ provider of the voucher", "type": "string", "example": "Gift card company", "minLength": 1, "maxLength": 255, "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)" }, "starts_at": { "type": "string", "format": "date-time", "description": "Start time of voucher validity in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "ends_at": { "type": "string", "format": "date-time", "description": "End time of voucher validity in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "affiliate_name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Name of associated or partner company for the voucher\n", "x-validation-info": "Field affiliate_name must be between 1 and 255 characters in length (inclusive)" } } }, "Vouchers": { "description": "Details about a voucher used, such as a gift card or discount code.\n", "type": "array", "items": { "$ref": "#/components/schemas/Voucher" } }, "EventInsurance": { "type": "object", "description": "Travel insurance details.\n", "properties": { "insurance_type": { "description": "Type of insurance\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CANCELATION` | |\n| `BANKRUPTCY` | |\n| `MEDICAL` | |\n| `EMERGENCY` | |\n", "type": "string", "enum": ["CANCELATION", "BANKRUPTCY", "MEDICAL", "EMERGENCY"] }, "insurance_company_name": { "description": "Name of the company providing the insurance", "type": "string", "minLength": 1, "maxLength": 255, "x-validation-info": "Field insurance_company_name must be between 1 and 255 characters in length (inclusive)" }, "price": { "type": "integer", "format": "int64", "example": 20000, "minimum": 0, "maximum": 2147483647, "description": "Price of insurance in minor local currency units", "x-validation-info": "Field price must be a number between 0 and 2147483647 (inclusive)" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" } } }, "EventReservation": { "type": "object", "description": "Describes detailed information about event reservation.\n", "properties": { "event_name": { "description": "Name of the event", "type": "string", "example": "Magical concert", "minLength": 1, "maxLength": 255, "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)" }, "event_company_name": { "description": "Company selling the ticket", "type": "string", "example": "Las Vegas Events", "minLength": 1, "maxLength": 255, "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)" }, "event_type": { "description": "Type of the event\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `CONCERT` | |\n| `FESTIVAL` | |\n| `TOUR` | |\n| `IN_PERSON_EDUCATION` | |\n| `DIGITAL_EDUCATION` | |\n| `SPORT` | |\n| `CONFERENCE` | |\n| `EXPO` | |\n", "type": "string", "enum": ["CONCERT", "FESTIVAL", "TOUR", "IN_PERSON_EDUCATION", "DIGITAL_EDUCATION", "SPORT", "CONFERENCE", "EXPO"] }, "starts_at": { "type": "string", "format": "date-time", "description": "Start time of the event in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "ends_at": { "type": "string", "format": "date-time", "description": "End time of the event in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "venue_name": { "description": "Name of the venue where the event takes place", "type": "string", "example": "Las Vegas Sphere", "minLength": 1, "maxLength": 255, "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)" }, "access_controlled_venue": { "description": "Indicates if the tickets are digitally checked when entering the venue", "type": "boolean" }, "address": { "type": "object", "description": "Address of the event", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } }, "affiliate_name": { "$ref": "#/components/schemas/AffiliateName" }, "insurances": { "type": "array", "description": "List of insurances for this event", "items": { "$ref": "#/components/schemas/EventInsurance" } } } }, "EventReservations": { "description": "Details of the event reservation, such as a concert or a sporting event.\n", "type": "array", "items": { "$ref": "#/components/schemas/EventReservation" } }, "SubscriptionInterval": { "type": "string", "description": "Billing plan interval. The interval of which the customer is receiving goods or services.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `DAY` | |\n| `WEEK` | |\n| `MONTH` | |\n| `YEAR` | |\n", "example": "MONTH", "enum": ["DAY", "WEEK", "MONTH", "YEAR"] }, "SubscriptionIntervalFrequency": { "type": "integer", "minimum": 1, "description": "Defines the billing plan interval frequency.\n\nA weekly billing plan would set interval to WEEK and interval_frequency to 1.\n\nA billing plan every second month would set interval to MONTH and interval_frequency to 2.\n\nA billing plan twice per month would set interval to WEEK and interval_frequency to 2\n" }, "BillingPlan": { "description": "The Billing plan defines the billing interval and amount.\n\nThe Billing plan should correspond to the renewal period of the subscription, or\nthe period of which the customer is receiving goods or services.\n\nThe billing plan allows you to specify various billing frequencies.\n", "type": "object", "required": ["billing_amount", "from", "interval", "interval_frequency"], "properties": { "billing_amount": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 2147483647, "description": "Defines the charge amount for the specified billing plan. This value should be in positive minor-units.\n\nThe billing_amount will be used to display the amount the customer will pay for their billing plan in the upcoming billing cycle and for Klarna to make a better risk assessment.\n" }, "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "from": { "type": "string", "description": "Defines the date when the customer will be charged for the billing plan. this field will be used to display the date when the charge for this billing plan will happen for the customer.\n\n10 days before the from, Klarna will set the subscription into renewal state and initiate customer communications in case the customer has foreseen payment issues such as no payment method on file or an expiring funding source to increase retention.\n\nMust be in the future.\n", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$", "example": "1970-01-01" }, "interval": { "$ref": "#/components/schemas/SubscriptionInterval" }, "interval_frequency": { "$ref": "#/components/schemas/SubscriptionIntervalFrequency" } } }, "Subscription": { "type": "object", "required": ["subscription_reference"], "properties": { "subscription_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Reference to this subscription, the same reference must be passed in to charge the subscription. For subscriptions without free trial, the first subscription charge should be reflected in the `supplementary_purchase_data.line_items` and in the `amount`.\n\nThe reference does not have to be unique per customer and can refer to a subscription plan, for example \"PREMIUM_MONTHLY\".\n" }, "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The name of the subscription.\n" }, "free_trial": { "type": "string", "description": "Indicator if the subscription has a free trial.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ACTIVE` | The subscription has a free trial |\n| `INACTIVE` | The subscription does not have a free trial |\n", "example": "ACTIVE", "enum": ["ACTIVE", "INACTIVE"] }, "billing_plans": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPlan" }, "description": "List of billing plans for the subscription.\n\nThe billing plan allows you to specify various billing frequencies.\n" } } }, "MarketplaceSellerDetails": { "type": "object", "description": "Details of the marketplace seller", "properties": { "marketplace_seller_reference": { "type": "string", "description": "Unique identifier assigned to the selling/delivering merchant within the marketplace", "minLength": 1, "maxLength": 255 }, "marketplace_seller_name": { "type": "string", "description": "Name of the selling/delivering merchant", "minLength": 1, "maxLength": 255 }, "marketplace_seller_address": { "type": "object", "description": "Address of the selling/delivering merchant", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "type": "string", "minLength": 1, "maxLength": 99, "description": "State/county/province/region formatted according to country.", "example": "US-OH" }, "country": { "$ref": "#/components/schemas/Country" } } }, "product_category": { "type": "string", "description": "Category of the product\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `ACCESSORIES` | |\n| `APPLIANCES` | |\n| `APPS_AND_GAMES` | |\n| `ARTS_CRAFTS_AND_SEWING` | |\n| `AUTOMOTIVE` | |\n| `BABY` | |\n| `BABY_CLOTHING` | |\n| `BAGS_AND_PURSES` | |\n| `BEAUTY` | |\n| `BOOKS` | |\n| `CDS_AND_VINYL` | |\n| `CELL_PHONES_AND_ACCESSORIES` | |\n| `COLLECTIBLES_AND_FINE_ARTS` | |\n| `DIGITAL_MUSIC` | |\n| `ELECTRONICS` | |\n| `GROCERY_AND_GOURMET_FOOD` | |\n| `HANDMADE` | |\n| `HEALTH_AND_PERSONAL_CARE` | |\n| `HOME_AND_KITCHEN` | |\n| `INDUSTRIAL_AND_SCIENTIFIC` | |\n| `LUGGAGE_AND_TRAVEL_GEAR` | |\n| `MAGAZINE_SUBSCRIPTIONS` | |\n| `MEN_CLOTHING` | |\n| `MUSICAL_INSTRUMENTS` | |\n| `OFFICE_PRODUCTS` | |\n| `PATIO_LAWN_AND_GARDEN` | |\n| `PET_SUPPLIES` | |\n| `SHOES` | |\n| `SOFTWARE` | |\n| `SPORTS_AND_OUTDOORS` | |\n| `TOOLS_AND_HOME_IMPROVEMENT` | |\n| `TOYS_AND_GAMES` | |\n| `VIDEO_GAMES` | |\n| `WOMEN_CLOTHING` | |\n", "enum": ["ACCESSORIES", "APPLIANCES", "APPS_AND_GAMES", "ARTS_CRAFTS_AND_SEWING", "AUTOMOTIVE", "BABY", "BABY_CLOTHING", "BAGS_AND_PURSES", "BEAUTY", "BOOKS", "CDS_AND_VINYL", "CELL_PHONES_AND_ACCESSORIES", "COLLECTIBLES_AND_FINE_ARTS", "DIGITAL_MUSIC", "ELECTRONICS", "GROCERY_AND_GOURMET_FOOD", "HANDMADE", "HEALTH_AND_PERSONAL_CARE", "HOME_AND_KITCHEN", "INDUSTRIAL_AND_SCIENTIFIC", "LUGGAGE_AND_TRAVEL_GEAR", "MAGAZINE_SUBSCRIPTIONS", "MEN_CLOTHING", "MUSICAL_INSTRUMENTS", "OFFICE_PRODUCTS", "PATIO_LAWN_AND_GARDEN", "PET_SUPPLIES", "SHOES", "SOFTWARE", "SPORTS_AND_OUTDOORS", "TOOLS_AND_HOME_IMPROVEMENT", "TOYS_AND_GAMES", "VIDEO_GAMES", "WOMEN_CLOTHING"] }, "line_item_references": { "type": "array", "description": "References to line items for purchases with multiples subsellers associated", "items": { "type": "string", "minLength": 1, "maxLength": 255 } }, "seller_registered_at": { "type": "string", "format": "date-time", "description": "The date when the seller's account with the marketplace was created in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "seller_updated_at": { "type": "string", "format": "date-time", "description": "Last date when the seller's account with the marketplace was modified in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "seller_last_login_at": { "type": "string", "format": "date-time", "description": "Last date of the seller's login into the account in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "shipping_references": { "type": "array", "description": "References to shipping addresses for purchases with multiples subsellers associated", "items": { "type": "string", "minLength": 1, "maxLength": 255 } }, "seller_rating": { "type": "string", "description": "Current seller rating. Marketplace may have numeric rankings, these should be mapped into the supported values.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `VERY_HIGH` | |\n| `HIGH` | |\n| `MEDIUM` | |\n| `LOW` | |\n| `VERY_LOW` | |\n", "enum": ["VERY_HIGH", "HIGH", "MEDIUM", "LOW", "VERY_LOW"] }, "number_of_transactions": { "type": "integer", "description": "Number of transactions the sub-seller did in the last 12 months", "minimum": 0 }, "volume_of_transactions": { "type": "integer", "format": "int64", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "Accumulated amount of sales transactions made by the sub-merchant or sub-seller within the past 12 months in the payment currency. Should be in minor currency units" } } }, "AdditionalSupplementaryPurchaseData": { "type": "string", "minLength": 1, "maxLength": 10240, "description": "This field should be used for any additional data relevant to the purchase.\n\nThe data should be provided in the form of a serialized JSON object in string format, containing both mandatory `content` and `content_type` fields.\nThe `content_type` must be a valid type supported by Klarna.\n\nThe structure within the `additional_data` field should be formatted as follows:\n\n```\n \"{\\\"content\\\":{\\\"customer_account_info\\\":[{\\\"unique_account_identifier\\\":\\\"test@gmail.com\\\",\n \\\"account_registration_date\\\":\\\"2017-02-13T10:49:20Z\\\",\\\"account_last_modified\\\":\\\"2019-03-13T11:45:27Z\\\"}]},\n \\\"content_type\\\":\\\"application/vnd.klarna.internal.emd-v2+json\\\"}\"\n```\n\nNote: Generate the serialized JSON without whitespace.\n", "example": "\"{\\\"content\\\":{\\\"customer_account_info\\\":[{\\\"unique_account_identifier\\\":\\\"test@gmail.com\\\",\\\"account_registration_date\\\":\\\"2017-02-13T10:49:20Z\\\",\\\"account_last_modified\\\":\\\"2019-03-13T11:45:27Z\\\"}]},\\\"content_type\\\":\\\"application/vnd.klarna.internal.emd-v2+json\\\"}\"\n", "x-validation-info": "Field additional_data must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" }, "Amount": { "type": "integer", "format": "int64", "description": "Numeric without decimals. Minor currency units (e.g. cent, öre) following ISO 4217, must use with Currency.", "example": 599 }, "MerchantCategoryCode": { "description": "The Merchant Category Code (MCC) is a four-digit number that is used to classify the type of goods or services\noffered by a business. The pattern only enforces the four-digit numeric format. Klarna separately validates that\nthe value is one of the currently supported MCCs.\n\n\n\nRefer to [Merchant category codes](https://docs.klarna.com/acquirer/klarna-direct/payment-authorization/authorization-resources/merchant-category-codes/) for the supported set.\n", "type": "string", "pattern": "^[0-9]{4}$", "x-validation-info": "Validation that the value is 4 digit numeric \"\\\\d{4}\"", "example": "5411" }, "SupplementaryPurchaseData": { "type": "object", "description": "**Provide** additional details about the transaction **to help** reduce fraud risk and enhance transparency. **Include** only the specific fields you wish to update within `supplementary_purchase_data` in update requests. Klarna processes the supplementary data and uses it for fraud detection and customer communication. Klarna replaces existing field values with new data when fields are present in the request and retains other field values unchanged. **To remove** fields, specify empty arrays or objects such as `\"subscriptions\": []` or `\"ondemand_service\": {}`.\n", "x-validation-info": "Validation that it is an object.", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" }, "customer": { "$ref": "#/components/schemas/Customer" }, "shipping": { "type": "array", "description": "Shipping information for the purchase. This data is used for fraud detection and customer communication.\nIf the purchase contains multiple shipments with different recipients, you must provide one shipping object per shipment.\n", "items": { "$ref": "#/components/schemas/ShippingNonRequired" } }, "line_items": { "type": "array", "description": "Detailed line item information of the purchase.\nThis data is used for fraud detection and customer communication.", "items": { "$ref": "#/components/schemas/LineItem" } }, "travel_reservations": { "type": "array", "description": "**Provide** supplementary travel details such as airline ticket information and car rental details **to enhance** fraud detection accuracy. **Use** this field when processing travel-related purchases that require detailed reservation information. Klarna analyzes the travel data to assess transaction risk and improve payment processing. **This field is mandatory** for travel industry transactions.\n", "items": { "$ref": "#/components/schemas/TravelReservationDetails" } }, "lodging_reservations": { "type": "array", "description": "**Provide** supplementary lodging details such as hotel booking information **to improve** transaction verification and fraud detection. **Use** this field when processing accommodation-related purchases. Klarna analyzes the lodging data to validate the transaction and assess risk patterns. Klarna uses this information to enhance payment security and customer experience. **This field is mandatory** for hotel and other lodging related transactions.\n", "items": { "$ref": "#/components/schemas/LodgingReservationDetails" } }, "insurances": { "type": "array", "description": "**Provide** supplementary insurance details **to enhance** fraud detection and transaction verification. **Use** this field when the purchase includes insurance products or coverage options. Klarna processes the insurance information to assess transaction legitimacy and improve risk management. Klarna uses this data to provide better transaction insights and customer protection. **This field is mandatory** for insurance related transactions.\n", "items": { "$ref": "#/components/schemas/InsuranceDetails" } }, "vouchers": { "$ref": "#/components/schemas/Vouchers" }, "event_reservations": { "$ref": "#/components/schemas/EventReservations" }, "subscriptions": { "description": "Subscription management information. Information passed in here will be used to update the subscription information. Mandatory when charging specific subscriptions.", "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "ondemand_service": { "type": "object", "description": "On-demand management information. Mandatory when charging a specific on-demand token.", "properties": { "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "average_amount": { "type": "integer", "format": "int64", "description": "Your average amount value, in minor currency units.\nYou can use a value across your customer base, or segment based on customer type, country, etc.\n", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "minimum_amount": { "type": "integer", "format": "int64", "description": "The lowest or minimum value you may charge a customer per purchase.\nYou can use a value across your customer base, or segment based on customer type, country, etc.\n", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "maximum_amount": { "type": "integer", "format": "int64", "description": "The maximum value you may charge a customer per purchase..\nYou can use a value across your customer base, or segment based on customer type, country, etc.\n", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "purchase_interval": { "type": "string", "description": "Cycle interval. The interval of which the customer is making purchases on your service.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `DAY` | |\n| `WEEK` | |\n| `MONTH` | |\n| `YEAR` | |\n", "example": "MONTH", "enum": ["DAY", "WEEK", "MONTH", "YEAR"] }, "purchase_interval_frequency": { "type": "integer", "minimum": 1, "description": "A weekly charge would set interval to WEEK and interval_frequency to 1.\nA charge every second month would set interval to MONTH and interval_frequency to 2.\nA charge twice per month would set interval to WEEK and interval_frequency to 2\n" } } }, "marketplace_sellers": { "type": "array", "description": "Details of the marketplace sellers involved in the transaction.", "items": { "$ref": "#/components/schemas/MarketplaceSellerDetails" } }, "additional_data": { "$ref": "#/components/schemas/AdditionalSupplementaryPurchaseData" } } }, "CustomerTokenReference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Partner reference to the customer token created on Klarna side.\nThis will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.\n", "example": "partner_customer_token_1234" }, "PaymentCustomerInteractionMode": { "type": "string", "description": "Payment initiation method that describes how to launch the purchase flow.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `HANDOVER` | The purchase flow will be launched using the URL found in `state_context.customer_interaction.payment_request_url`. |\n| `QR_CODE` | The purchase flow will be launched using the QR URL or QR image found under `state_context.customer_interaction`. |\n| `HEADLESS` | |\n", "enum": ["HANDOVER", "QR_CODE"] }, "InteractionExpiryTimestamp": { "type": "object", "required": ["timestamp"], "properties": { "timestamp": { "$ref": "#/components/schemas/Timestamp" } } }, "Duration": { "type": "string", "format": "", "example": "PT48H", "minLength": 2, "maxLength": 25, "description": "Duration in ISO 8601 format.\nValid examples:\n - PT15M (for 15 minutes)\n - PT1H (for 1 hour)\n - P1D (for 1 day)\n - PT48H (for 48 hours)\n", "x-validation-info": "Validates that the timestamp is ISO 8601 - duration format e.g PT48H (for 48 hours)." }, "InteractionExpiryDuration": { "type": "object", "required": ["duration"], "properties": { "duration": { "$ref": "#/components/schemas/Duration" } } }, "PaymentRedirectUrl": { "type": "string", "description": "Payment flow redirection URL\n\nThe customer will always be redirected to this URL on a successful authorization. If client-side web SDK is in use with FlowInteractionMode REDIRECT, the customer will also be redirected to this URL on a failed authorization.\n\nAny payment request update event handlers will run before redirection.\n\nThe URL supports placeholders variables, the variables will be replaced with the corresponding value before redirection. Placeholders are always encapsulated within single curly brackets ({}).\nAvailable placeholders for the success redirection URL:\n\n* `{klarna.payment_request.id}` - Replaced with the request id\n* `{klarna.payment_request.state}` Replaced with the state of the request\n* `{klarna.payment_request.interoperability_token}` - Replaced with the interoperability token\n* `{klarna.payment_request.payment_request_reference}` - Replaced with your payment reference\n* `{klarna.payment_request.payment_token}` - Replaced with the payment token\n\nThe values are all URL safe, or URL encoded before substitution.\nExample If you set this to `https://partner.example/klarna-redirect?klarna_complete={klarna.payment_request.payment_token}` and the payment token is `cd227fcd-21ee-4903-89ed-bd694144009e` then\nthe full redirection URL will be `https://partner.example/klarna-redirect?klarna_complete=cd227fcd-21ee-4903-89ed-bd694144009e`\n", "x-validation-info": "Validation against the regex", "pattern": "^https:\\/\\/[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,64}\\b(([-a-zA-Z0-9()!@:%_\\+.~#?&\\/\\/=]*)(\\{[-a-zA-Z0-9._]+\\})?)*(&[-a-zA-Z0-9()!@:%_\\+.~#?&\\/\\/=]*)*$", "example": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" }, "AppReturnUrl": { "type": "string", "description": "Mobile application return URL (app scheme with no action deeplink).\n\nThe customer will be redirected to this URL after third party redirects or redirects to the Klarna Application.\nIt is expected to open the integrating mobile application in it's last state (no state changes or deeplink navigations).\n", "x-validation-info": "Validation against a regex that it is a valid mobile app return url", "pattern": "^(?![Hh][Tt][Tt][Pp][Ss]?:)[a-zA-Z][a-zA-Z0-9+.-]*://([a-zA-Z0-9][a-zA-Z0-9._-]*[a-zA-Z0-9])?(/[a-zA-Z0-9._~-]*)*(\\?[a-zA-Z0-9._~&=-]*)?$", "example": "myapp://test" }, "PaymentCustomerInteractionMethodHandover": { "type": "object", "required": ["method", "return_url"], "properties": { "method": { "$ref": "#/components/schemas/PaymentCustomerInteractionMode" }, "interaction_expiry": { "x-validation-info": "Must be between 15 minutes and 48 hours from the time of the payment request creation", "description": "Use this field to customize when the payment request expires. The resulting expiration timestamp is reflected in the payment request `expires_at`.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter `expires_at`, the payment request will no longer be approved;\nand no transactions can be created.\n", "oneOf": [{ "$ref": "#/components/schemas/InteractionExpiryTimestamp" }, { "$ref": "#/components/schemas/InteractionExpiryDuration" }] }, "return_url": { "$ref": "#/components/schemas/PaymentRedirectUrl" }, "app_return_url": { "$ref": "#/components/schemas/AppReturnUrl" } }, "description": "Customer interaction with method `HANDOVER`\n" }, "PaymentCustomerInteractionMethodQrCode": { "type": "object", "required": ["method"], "properties": { "method": { "$ref": "#/components/schemas/PaymentCustomerInteractionMode" }, "interaction_expiry": { "x-validation-info": "Must be between 15 minutes and 48 hours from the time of the payment request creation", "description": "Use this field to customize when the payment request expires. The resulting expiration timestamp is reflected in the payment request `expires_at`.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter `expires_at`, the payment request will no longer be approved;\nand no transactions can be created.\n", "oneOf": [{ "$ref": "#/components/schemas/InteractionExpiryTimestamp" }, { "$ref": "#/components/schemas/InteractionExpiryDuration" }] } }, "description": "Customer interaction with method `QR_CODE`\n" }, "Locale": { "type": "string", "minLength": 5, "maxLength": 16, "example": "en-US", "x-validation-info": "Validation that locale contain {language}-{region} syntax.", "description": "Preferred locale, in IETF BCP 47 format.\n\nSupported locales\n- `en-AU`\n- `de-AT`\n- `en-AT`\n- `nl-BE`\n- `fr-BE`\n- `en-BE`\n- `en-CA`\n- `fr-CA`\n- `cs-CZ`\n- `en-CZ`\n- `da-DK`\n- `en-DK`\n- `fi-FI`\n- `sv-FI`\n- `en-FI`\n- `fr-FR`\n- `en-FR`\n- `de-DE`\n- `en-DE`\n- `el-GR`\n- `en-GR`\n- `hu-HU`\n- `en-HU`\n- `en-IE`\n- `it-IT`\n- `en-IT`\n- `en-MX`\n- `es-MX`\n- `nl-NL`\n- `en-NL`\n- `en-NZ`\n- `nb-NO`\n- `en-NO`\n- `pl-PL`\n- `en-PL`\n- `pt-PT`\n- `en-PT`\n- `ro-RO`\n- `en-RO`\n- `es-ES`\n- `en-ES`\n- `sv-SE`\n- `en-SE`\n- `de-CH`\n- `fr-CH`\n- `it-CH`\n- `en-CH`\n- `en-GB`\n- `en-US`\n- `es-US`\n" }, "PaymentOptionId": { "x-validation-info": "Field must be between 1 and 1000 characters in length (inclusive)", "type": "string", "minLength": 1, "maxLength": 1000, "description": "Identifier for the payment option returned by the Payment Presentation API. Supports preselection and one-click payment authorizations with customer tokens.\n" }, "PaymentTransactionFundingType": { "type": "string", "description": "The funding type of the payment transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `GUARANTEED` | The funding of the payment transaction is guaranteed by Klarna. |\n| `NON_GUARANTEED` | The funding of the payment transaction is not guaranteed by Klarna. The transaction will not be considered complete until the funds are collected. If customer funding does not occur, any captures made by the partner will be charged back, and the transaction will be considered closed. |\n", "enum": ["GUARANTEED", "NON_GUARANTEED"] }, "PaymentAcquiringAccountIdentifier": { "description": "Unique account identifier assigned by Klarna to the Acquiring Account.", "example": "krn:partner:global:payment-acquiring-account:live:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "x-validation-info": "There is a validation about the presence of the partner_account_id and if it has the right credentials to perform the action.", "type": "string", "minLength": 1, "maxLength": 255 }, "PaymentAccountReference": { "type": "string", "maxLength": 255, "description": "A unique string reference for the payment account, used by the Acquiring Partner to identify the payment account without relying on Klarna-generated IDs. Used to identify the partner account for the partners themselves. The value will be shown as shared by the integrator on certain Klarna surfaces, such as the Merchant Portal, but will never be used for customer interactions.\nIn case of support request or errands, the reference may be used to look-up the payment account.\n", "x-validation-info": "Alphanumeric string, must be unique for all payment accounts created by the integrator.", "example": "payment_account_ref", "minLength": 1 }, "products-payment.model_PaymentAccountIdentifier": { "description": "Unique payment account identifier assigned by Klarna", "x-validation-info": "Validates that the resource exists. There is no validation for the KRN format.", "example": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "type": "string", "minLength": 1 }, "StoreIdentifier": { "description": "A unique identifier assigned by Klarna to an existing store. Used to reference the store in Klarna's systems and APIs.\n", "example": "krn:partner:global:account:stores:88c175c8-b578-4392-8e61-015c1b5df613", "x-validation-info": "The existence of the resource is validated, but there is no validation for the format.", "type": "string", "minLength": 0 }, "PointOfCheckoutWithStoreId": { "type": "object", "description": "Point of checkout with store id", "required": ["store_id"], "properties": { "store_id": { "$ref": "#/components/schemas/StoreIdentifier" } } }, "StoreReference": { "type": "string", "minLength": 0, "maxLength": 255, "description": "The reference assigned by the partner to the store.\n", "x-validation-info": "String must be present and up to 255 characters.", "example": "999888777" }, "PointOfCheckoutWithStoreReference": { "type": "object", "description": "Point of checkout with store reference", "required": ["store_reference"], "properties": { "store_reference": { "$ref": "#/components/schemas/StoreReference" } } }, "StoreType": { "description": "The type of store supported by the Management API. Determines the channel through which the merchant interacts with customers.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `WEBSITE` | |\n| `PHYSICAL_STORE` | |\n| `MOBILE_APP` | |\n", "type": "string", "x-validation-info": "String must be part of the enum list.", "enum": ["WEBSITE", "PHYSICAL_STORE", "MOBILE_APP"] }, "Address": { "type": "object", "description": "Postal address", "x-validation-info": "Validation that is an object.", "required": ["street_address", "city", "country"], "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "$ref": "#/components/schemas/Region" }, "country": { "$ref": "#/components/schemas/Country" } } }, "PointOfCheckout": { "x-validation-info": "Validates that either store_id, store_reference or store are sent for onboarded shops. If more than one is sent - request will be rejected.", "description": "Information about where the payment was made. To ensure that a payment is recognized as an in-store, please provide the `store_id` or `store_reference` corresponding to a pre-onboarded store with the type set to `PHYSICAL_STORE`.", "oneOf": [{ "$ref": "#/components/schemas/PointOfCheckoutWithStoreId" }, { "$ref": "#/components/schemas/PointOfCheckoutWithStoreReference" }] }, "PaymentTransactionId": { "type": "string", "example": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0", "maxLength": 255, "minLength": 1, "x-validation-info": "Validation for the length", "description": "Unique identifier for a created Payment Transaction. This identifier can be used to manage the Payment Transaction through the Payment Transaction API.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentRequestId": { "type": "string", "example": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "maxLength": 255, "minLength": 1, "description": "The unique identifier for the payment request.\nThis is the identifier you will use to reference the payment request in subsequent API calls.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentRequestState": { "type": "string", "description": "The current state of the Payment Request.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `SUBMITTED` | The payment request has been submitted to Klarna. |\n| `IN_PROGRESS` | The customer is actively in the payment flow. |\n| `COMPLETED` | The customer has approved the payment request. For a one-time payment, call `POST /payment/authorize` with the issued Klarna network session token to create a payment transaction. |\n| `DECLINED` | The payment request has been declined (final state). |\n", "enum": ["SUBMITTED", "IN_PROGRESS", "COMPLETED", "DECLINED"] }, "PaymentRequestStateReason": { "type": "string", "description": "The reason field may be used to determine why the payment request is in its current state.\n\n* `PURCHASE_FLOW_ABORTED` - The customer dropped out of the purchase flow, or could not complete it. For example, the customer closed the Klarna window, went back to the partner site, had no payment option matching `supported_payment_funding_types`, or could not pass the holder name verification requested in `payment_funding_source_holder_name_verification`.\n* `TECHNICAL_ERROR` - Klarna failed to start the purchase flow due to internal error.\n* `PARTNER_CANCELED` - The partner has canceled the payment request. Payment request state should be set to `CANCELED`.\n* `PAYMENT_DECLINED` - The payment was declined by Klarna or an issuing bank.\n", "example": "TECHNICAL_ERROR", "enum": ["PURCHASE_FLOW_ABORTED", "TECHNICAL_ERROR", "PARTNER_CANCELED", "PAYMENT_DECLINED", null] }, "CustomerInteractionUrl": { "type": "string", "description": "One-time use link that you can redirect the customer to", "x-validation-info": "Validation against the regex that is a valid url", "pattern": "https?:\\/\\/[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,64}\\b([-a-zA-Z0-9()!@:%_\\+.~#?&\\/\\/=]*)" }, "PaymentCustomerInteractionHandoverMethod": { "type": "object", "required": ["method", "payment_request_url"], "properties": { "method": { "$ref": "#/components/schemas/PaymentCustomerInteractionMode" }, "interaction_expiry": { "x-validation-info": "Must be between 15 minutes and 48 hours from the time of the payment request creation", "description": "Use this field to customize when the payment request expires. The resulting expiration timestamp is reflected in the payment request `expires_at`.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter `expires_at`, the payment request will no longer be approved;\nand no transactions can be created.\n", "oneOf": [{ "$ref": "#/components/schemas/InteractionExpiryTimestamp" }, { "$ref": "#/components/schemas/InteractionExpiryDuration" }] }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "payment_request_url": { "$ref": "#/components/schemas/CustomerInteractionUrl" } }, "description": "Methods of distributing the payment request to the customer when using the `HANDOVER` method\n" }, "QrCode": { "type": "object", "required": ["image_url", "target_url"], "description": "Pre-generated SVG QR code that you can display to the customer.\n", "properties": { "image_url": { "type": "string", "minLength": 0, "description": "The URL to the QR code image, which can be used to display the QR code to the customer." }, "target_url": { "type": "string", "minLength": 0, "description": "The URL that the QR code points to, which directs the customer to the target resource when scanned." } } }, "PaymentCustomerInteractionQRMethod": { "type": "object", "required": ["method"], "properties": { "method": { "$ref": "#/components/schemas/PaymentCustomerInteractionMode" }, "interaction_expiry": { "x-validation-info": "Must be between 15 minutes and 48 hours from the time of the payment request creation", "description": "Use this field to customize when the payment request expires. The resulting expiration timestamp is reflected in the payment request `expires_at`.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter `expires_at`, the payment request will no longer be approved;\nand no transactions can be created.\n", "oneOf": [{ "$ref": "#/components/schemas/InteractionExpiryTimestamp" }, { "$ref": "#/components/schemas/InteractionExpiryDuration" }] }, "qr_code": { "$ref": "#/components/schemas/QrCode" } }, "description": "Methods of distributing the payment request to the customer when using the `QR_CODE` method\n" }, "PaymentCustomerInteraction": { "type": "object", "description": "Methods of distributing the payment request to the customer.\n", "required": ["method"], "anyOf": [{ "$ref": "#/components/schemas/PaymentCustomerInteractionHandoverMethod" }, { "$ref": "#/components/schemas/PaymentCustomerInteractionQRMethod" }], "discriminator": { "propertyName": "method", "mapping": { "HANDOVER": "#/components/schemas/PaymentCustomerInteractionHandoverMethod", "QR_CODE": "#/components/schemas/PaymentCustomerInteractionQRMethod" } } }, "payment.model_PaymentToken": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The payment token represents a customer approval for payment.\n\nIt is issued when a Klarna Payment Request is completed.\n", "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)", "example": "krn:payment:eu1:payment-token:e15432a5-ebcc-45bc-934c-e61399db597b" }, "InteroperabilityToken": { "type": "string", "maxLength": 8192, "minLength": 1, "description": "The interoperability token enables continuity of customer journey across domains and services. If you are an Acquiring Partner, you receive this token from your merchant.\n", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaG9wcGluZ19zZXNzaW9uX2lkIjoia3JuOnNob3BwaW5nOmV1MTpzZXNzaW9uOjBlOTIyN2MwLTBjNDAtNDdkZi04YzEwLTQwMTRmYzFiZDJiZCIsInN0YXR1cyI6IlBBWU1FTlRfUFJFUEFSRUQiLCJ2ZXJzaW9uIjoxLCJjcmVhdGVkX2F0IjoiMjAyNC0wMS0wMVQxMjowMDowMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMS0wMVQxMjowMDowMFoifQ.1y87kuEKnETy_UCHbTMXx1p4mViZE816okcVmfHFZoo" }, "CustomerId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Unique identifier of Klarna Customer account.", "example": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz" }, "SupportedCountry": { "type": "string", "example": "US", "description": "Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.\nThe system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.\n\nSupported countries\n `AT`, `BE`, `CA`, `CH`, `CZ`, `DE`, `DK`, `ES`, `FI`, `FR`\n `GB`, `GR`, `HU`, `IE`, `IT`, `MX`, `NL`, `NO`, `NZ`, `PL`\n `PT`, `RO`, `SE`, `US`\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "KlarnaCustomer": { "type": "object", "description": "Details of the Klarna customer profile and customer token associated with the payment authorization.\n", "properties": { "customer_token": { "$ref": "#/components/schemas/CustomerToken" }, "customer_token_reference": { "$ref": "#/components/schemas/CustomerTokenReference" } } }, "ShippingRecipient": { "type": "object", "description": "Provide the full name of the person or entity receiving the shipment.\nKlarna uses this information to support customer communication, and fraud assessment.\nEnsure the information matches the intended delivery recipient details.\n", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" }, "email": { "$ref": "#/components/schemas/Email" }, "phone": { "$ref": "#/components/schemas/PhoneLocal" }, "attention": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Attention string for the recipient" } }, "required": ["given_name", "family_name"] }, "CollectedShipping": { "type": "object", "description": "Shipping information collected from the customer by Klarna.\n", "properties": { "recipient": { "$ref": "#/components/schemas/ShippingRecipient" }, "address": { "description": "The shipping address as collected from the customer by Klarna.\n", "type": "object", "required": ["street_address", "city", "country"], "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "$ref": "#/components/schemas/Region" }, "country": { "$ref": "#/components/schemas/SupportedCountry" } } } } }, "CanceledPaymentRequestState": { "type": "string", "enum": ["CANCELED"], "description": "The current state of the canceled Payment Request.\n\n* `CANCELED` - The payment request has been canceled (final state).\n" }, "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." }, "KlarnaNetworkData": { "type": "string", "maxLength": 10240, "minLength": 1, "description": "Provide additional data to enable custom features or data exchange supported by your Integrating Partner.\nKlarna accepts this passthrough field in a structured JSON format and forwards it to relevant systems for interoperability.\n Data shared in this field may complement structured datapoints provided in supplementary_purchase_data.\n Ensure the value is between 1 and 10240 characters in length (inclusive).\n Treat this value as an opaque string—do not validate or infer its structure.\n", "x-validation-info": "Field must be between 1 and 10240 characters in length (inclusive)", "format": "serialized-json" }, "PaymentTransactionCapture": { "type": "string", "description": "Specifies when the transaction should be captured.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `NOW` | Marks the transaction for immediate auto-capture. |\n| `LATER` | Default option, the transaction is processed without immediate capture. |\n", "enum": ["NOW", "LATER"] }, "PaymentTransactionReference": { "type": "string", "minLength": 1, "maxLength": 255, "example": "partner-transaction-reference-4567", "x-validation-info": "Validation for the length", "description": "Reference to the payment or equivalent resource created on your side.\nThis will be exposed in the Payment Transaction webhooks for the purpose of correlating your resource with the Klarna Payment Transaction. It will also be included in settlement reports for the purpose of reconciliation.\n" }, "PaymentCaptureReference": { "type": "string", "minLength": 1, "maxLength": 255, "example": "partner-capture-reference-1234", "description": "Reference to the capture or equivalent resource created on your side.\nThis will be exposed in the Payment Transaction webhooks and included in the settlement file.\n" }, "CardSettlementReference": { "type": "string", "minLength": 1, "maxLength": 255, "example": "partner-card-settlement-12345", "x-validation-info": "Validation for the length", "description": "Reference to the card settlement or equivalent resource created on your side.\n" }, "CardSettlementCardEncryptionKeyId": { "type": "string", "minLength": 1, "maxLength": 255, "example": "9f13c4e2-1b7a-4c55-8d90-6e2f7a3b4c5d", "description": "The identifier of the card settlement encryption key to encrypt the issued\ncard data with. Use the `encryption_key_id` of an active key.\n" }, "PointOfTransactionForWebsite": { "type": "object", "title": "Point of Transaction for Website", "required": ["referrers"], "properties": { "referrers": { "type": "array", "description": "A list of previous referrers to the order. Represent URLs for tracking the purchase flow. Referrers should not be used for affiliates.", "x-validation-info": "Validation that the objects within the array have the right shape", "items": { "type": "string", "minLength": 1, "maxLength": 2048 } } } }, "PointOfTransactionForTerminal": { "type": "object", "title": "Point of Transaction for Terminal", "required": ["terminal_reference"], "properties": { "terminal_reference": { "type": "string", "minLength": 1, "maxLength": 128, "description": "A terminal reference.", "x-validation-info": "Validation that the element is a string" } } }, "PointOfTransactionForMobileApp": { "type": "object", "title": "Point of Transaction for Mobile App", "required": ["platform"], "properties": { "platform": { "type": "string", "description": "The platform on which the mobile application is registered.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `IOS` | |\n| `ANDROID` | |\n", "example": "IOS", "enum": ["IOS", "ANDROID"] }, "bundle_names": { "type": "array", "maxItems": 100, "description": "The bundle names for the mobile application.", "x-validation-info": "Validation that the objects within the array have the right shape", "items": { "type": "string", "minLength": 1, "maxLength": 2048 } } } }, "PointOfTransactionType": { "description": "The type of supported point of transaction.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `WEBSITE` | |\n| `TERMINAL` | |\n| `MOBILE_APP` | |\n", "type": "string", "x-validation-info": "String must be part of the enum list.", "enum": ["WEBSITE", "TERMINAL", "MOBILE_APP"] }, "PointOfTransaction": { "type": "object", "x-validation-info": "Validates that data is passed in correct format.", "description": "Information about the most granular location data about the purchase", "properties": { "type": { "$ref": "#/components/schemas/PointOfTransactionType" } }, "required": ["type"], "discriminator": { "propertyName": "type", "mapping": { "WEBSITE": "#/components/schemas/PointOfTransactionForWebsite", "TERMINAL": "#/components/schemas/PointOfTransactionForTerminal", "MOBILE_APP": "#/components/schemas/PointOfTransactionForMobileApp" } }, "oneOf": [{ "$ref": "#/components/schemas/PointOfTransactionForWebsite" }, { "$ref": "#/components/schemas/PointOfTransactionForTerminal" }, { "$ref": "#/components/schemas/PointOfTransactionForMobileApp" }] }, "PaymentAuthorizationResult": { "type": "string", "description": "The result of the authorization attempt\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `APPROVED` | |\n| `DECLINED` | |\n| `STEP_UP_REQUIRED` | |\n", "enum": ["APPROVED", "DECLINED", "STEP_UP_REQUIRED"] }, "PaymentRequestTransactionState": { "type": "string", "description": "The current state of the Payment Transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `AUTHORIZED` | The payment transaction has been authorized and waiting for further actions such as capture, refund, void, or expiration. |\n| `COMPLETED` | The payment transaction has been completed and no remaining authorization amount is left to be captured. |\n", "enum": ["AUTHORIZED", "COMPLETED"] }, "SettlementCurrency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "The currency that will be used to settle the Payment Transaction.\nThe value should conform to ISO 4217 format.\n" }, "FixedFee": { "type": "object", "description": "Applicable fixed fee for the payment. The value is negative when representing an incentive.\nIt is present as per the currency applicable for the fixed fee for that transaction.\n", "required": ["amount", "currency"], "properties": { "amount": { "$ref": "#/components/schemas/Amount" }, "currency": { "$ref": "#/components/schemas/Currency" } } }, "Percentage": { "type": "integer", "format": "int64", "example": 150, "description": "Percentage points representing the percent value multiplied by 100. For example, 1.5% is represented as 150.\n" }, "VariableFee": { "type": "object", "description": "Variable fee is the percentage of the payment amount. The value is negative when representing an incentive.\n", "required": ["percentage"], "properties": { "percentage": { "$ref": "#/components/schemas/Percentage" } } }, "ChargeUnit": { "type": "string", "enum": ["CAPTURE"], "description": "This field specifies the point in the payment flow at which the rate is calculated\n* `CAPTURE` - indicates that the rate is applied at each capture event during the transaction flow\n" }, "ApplicableRateV2": { "type": "object", "description": "Applicable rate for the payment\n", "required": ["fixed_fee", "variable_fee", "unit"], "properties": { "fixed_fee": { "$ref": "#/components/schemas/FixedFee" }, "variable_fee": { "$ref": "#/components/schemas/VariableFee" }, "unit": { "$ref": "#/components/schemas/ChargeUnit" } } }, "PricePlanId": { "type": "string", "minLength": 1, "example": "krn:partner:global:payment:price-plan:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "description": "Applied price plan id\n" }, "PaymentProgramId": { "type": "string", "minLength": 1, "example": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "description": "Applied payment program id\n" }, "PricingPaymentCategory": { "type": "string", "description": "A categorization of the payment transaction used to calculate the final pricing of that transaction.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `DIGITAL` | |\n| `PHYSICAL` | |\n", "enum": ["DIGITAL", "PHYSICAL"] }, "EvaluationParameters": { "type": "object", "description": "Pricing evaluation parameters\n", "required": ["price_plan_id", "evaluated_at", "pricing_payment_category", "payment_program_id"], "properties": { "price_plan_id": { "$ref": "#/components/schemas/PricePlanId" }, "payment_program_id": { "$ref": "#/components/schemas/PaymentProgramId" }, "customer_country": { "$ref": "#/components/schemas/Country" }, "partner_country": { "type": "string", "example": "US", "description": "The country where the partner is registered.\n", "pattern": "^[A-Za-z]{2}$", "x-validation-info": "Country code must be in ISO 3166-1 alpha-2 format." }, "customer_pricing_region": { "type": "string", "example": "NCE", "description": "Coarse-grained pricing region derived from the customer billing country.\nUse this field when keying pricing logic off a stable regional grouping,\nrather than the specific `customer_country` value.\nThe `ROW` value of this field is the fallback for customer billing countries that\ndo not map to a specific pricing region. It is unrelated to the Rest of World market\ngroupings, such as `ROW1` and `ROW2`, returned in `payment_pricing.pricing_country_group`.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `NCE` | North and Central Europe |\n| `SEE` | South and Eastern Europe |\n| `GBI` | Great Britain and Ireland |\n| `APAC` | Asia Pacific |\n| `NA` | North America |\n| `LATAM` | Latin America |\n| `ROW` | Rest of the World |\n", "enum": ["NCE", "SEE", "GBI", "APAC", "NA", "LATAM", "ROW"] }, "merchant_category_code": { "$ref": "#/components/schemas/MerchantCategoryCode" }, "evaluated_at": { "type": "string", "format": "date-time", "description": "The timestamp in UTC when the pricing was evaluated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "pricing_payment_category": { "$ref": "#/components/schemas/PricingPaymentCategory" } } }, "PaymentPricing": { "type": "object", "description": "Payment pricing details\n", "required": ["applicable_rate", "evaluation_parameters"], "properties": { "applicable_rate": { "$ref": "#/components/schemas/ApplicableRateV2" }, "evaluation_parameters": { "$ref": "#/components/schemas/EvaluationParameters" } } }, "PaymentFundingInitialState": { "type": "string", "description": "The funding state of the payment transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `PENDING` | The process of collecting funds from the customer has been initiated but is still pending. |\n| `FUNDED` | Customer funds have been secured, and a payout is guaranteed. |\n", "enum": ["PENDING", "FUNDED"] }, "PaymentFunding": { "type": "object", "description": "Funding details of the payment transaction.\n", "required": ["type", "state"], "properties": { "type": { "$ref": "#/components/schemas/PaymentTransactionFundingType" }, "state": { "$ref": "#/components/schemas/PaymentFundingInitialState" } } }, "PaymentCaptureId": { "type": "string", "example": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1", "minLength": 0, "maxLength": 255, "description": "Unique identifier for a created Payment Capture.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentRequestCaptureId": { "type": "string", "example": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1", "minLength": 0, "maxLength": 255, "description": "Unique identifier for a Payment Capture that is created when `config.capture` is enabled. This identifier can be used to manage the Payment Capture through the Payment Transaction API.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentCaptures": { "type": "array", "description": "Payment Capture(s) created. The field is only returned when `request_payment_transaction.capture` is set to `NOW`.\n", "items": { "type": "object", "properties": { "payment_capture_id": { "$ref": "#/components/schemas/PaymentRequestCaptureId" } } } }, "ExistingPaymentAccountIdentifiersOnly": { "description": "The Partner Payment Account associated with this transaction", "type": "object", "properties": { "payment_account_id": { "$ref": "#/components/schemas/products-payment.model_PaymentAccountIdentifier" }, "payment_account_reference": { "$ref": "#/components/schemas/PaymentAccountReference" } } }, "PaymentAcquiringAccountReference": { "description": "Reference for the Acquiring Account.", "type": "string", "minLength": 0, "maxLength": 255, "example": "M123786123412", "x-validation-info": "Unique alphanumeric string with maximum length." }, "PaymentAcquiringAccountIdentifiersOnly": { "description": "The Acquiring Account associated with this transaction.", "type": "object", "properties": { "payment_acquiring_account_id": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifier" }, "payment_acquiring_account_reference": { "$ref": "#/components/schemas/PaymentAcquiringAccountReference" } } }, "PaymentRequestTransaction": { "type": "object", "description": "The Payment Transaction object represents a single payment transaction.\n", "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_capture_reference": { "$ref": "#/components/schemas/PaymentCaptureReference" }, "state": { "$ref": "#/components/schemas/PaymentRequestTransactionState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_pricing": { "$ref": "#/components/schemas/PaymentPricing" }, "payment_funding": { "$ref": "#/components/schemas/PaymentFunding" }, "payment_captures": { "$ref": "#/components/schemas/PaymentCaptures" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the transaction. May differ from the custom expiration date provided. After this timestamp, the transaction cannot be captured.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } } }, "SettlementCard": { "description": "An issued card with the PCI data encrypted in JWE format\n", "required": ["pci_data", "holder", "brand", "currency"], "type": "object", "properties": { "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency of the issued card amount" }, "card_amount": { "type": "integer", "example": 100, "minimum": 1, "description": "Amount of the issued card in the specified currency. The value will be in non-negative minor units" }, "pci_data": { "type": "string", "minLength": 1, "maxLength": 2048, "description": "PCI data encrypted with a merchant random key, encoded in JWE format.\nOnce decrypted, pci_data will adhere with the following schema:\n```\n {\n \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"pan\": {\n \"type\": \"string\",\n \"pattern\": \"^[0-9]{16}$\",\n \"description\": \"Primary Account Number - 16 digits of the card\"\n },\n \"expiry_date\": {\n \"type\": \"string\",\n \"pattern\": \"^(0[1-9]|1[0-2])/[0-9]{2}$\",\n \"description\": \"Card Expiration date in the MM/YY format\"\n },\n \"cvv\": {\n \"type\": \"integer\",\n \"description\": \"Card Verification Value (3-digit code)\"\n }\n },\n \"required\": [\"pan\", \"expiry_date\", \"cvv\"]\n }\n```\nThe following is an example:\n```\n {\n \"pan\": \"4111111111111111\",\n \"expiry_date\": \"05/28\",\n \"cvv\": 322\n }\n```\n" }, "holder": { "type": "string", "minLength": 0, "maxLength": 255, "description": "Name of the card holder of the issued card" }, "brand": { "type": "string", "minLength": 0, "maxLength": 255, "description": "Brand of the issued card" } } }, "CardSettlementId": { "type": "string", "minLength": 1, "example": "krn:partner:us1:payment:card-settlement:5cd46f7e-573d-4b02-bab8-1f1c0e343291", "x-validation-info": "Validation that the value is a valid `payment:card-settlement` KRN.", "description": "The identifier of the settlement created for the card creation." }, "CardSettlementFailureReason": { "type": "string", "minLength": 1, "maxLength": 99, "example": "ISSUANCE_UNAVAILABLE", "description": "The reason no card settlement was issued. Handle unknown values gracefully, as values may be added.\n\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| `TRANSACTION_NOT_AUTHORIZED` | The payment transaction was declined, so there was no transaction to issue a card against. |\n| `NOT_ENABLED` | The partner account is not enabled for card settlements. |\n| `ENCRYPTION_KEY_NOT_FOUND` | The card settlement encryption key the request names is not registered. |\n| `ENCRYPTION_KEY_REVOKED` | The card settlement encryption key the request names is revoked. |\n| `TRANSACTION_NOT_ISSUABLE` | The payment transaction cannot back a card settlement. |\n| `ISSUANCE_UNAVAILABLE` | Card issuance did not complete. |\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": ["TRANSACTION_NOT_AUTHORIZED", "NOT_ENABLED", "ENCRYPTION_KEY_NOT_FOUND", "ENCRYPTION_KEY_REVOKED", "TRANSACTION_NOT_ISSUABLE", "ISSUANCE_UNAVAILABLE"] }, "Shipping": { "description": "Information about the shipping address and shipping option.\n", "type": "object", "properties": { "shipping_option": { "description": "Provide the shipping option selected by the customer on the Partner's store.\nKlarna uses this value to confirm shipping preferences and display the correct delivery method during the payment flow.\nTreat this value as an opaque string and do not validate or infer its structure.\n", "type": "object", "required": ["shipping_type"], "properties": { "shipping_type": { "$ref": "#/components/schemas/ShippingType" }, "shipping_type_attributes": { "type": "array", "description": "Provide additional attributes that describe specific services related to the selected shipping type.\nKlarna uses these attributes to refine delivery details and enhance fraud assessment.\nUse this field if the shipping type alone does not fully describe the delivery service. \nTreat attribute values as opaque strings, do not validate or interpret their format.\n", "items": { "$ref": "#/components/schemas/ShippingTypeAttribute" } }, "shipping_carrier": { "$ref": "#/components/schemas/ShippingCarrier" } } }, "shipping_reference": { "minLength": 1, "maxLength": 255, "type": "string", "description": "Unique reference to this shipping address.\nRequired if the payment request contains multiple shipping objects.\n\nThis can be any string, and *does not* have to correspond to a delivery or tracking number.\n", "example": "DHL-123456" }, "recipient": { "description": "Provide the full name of the person or entity receiving the shipment.\nKlarna uses this information to support customer communication, and fraud assessment.\nEnsure the information matches the intended delivery recipient details.\n", "type": "object", "properties": { "given_name": { "$ref": "#/components/schemas/GivenName" }, "family_name": { "$ref": "#/components/schemas/FamilyName" }, "email": { "$ref": "#/components/schemas/Email" }, "phone": { "$ref": "#/components/schemas/PhoneLocal" }, "attention": { "type": "string", "minLength": 1, "maxLength": 99, "description": "Attention string for the recipient" } }, "required": ["given_name", "family_name"] }, "address": { "description": "Postal address.", "type": "object", "properties": { "street_address": { "$ref": "#/components/schemas/StreetAddress1" }, "street_address2": { "$ref": "#/components/schemas/StreetAddress2" }, "postal_code": { "$ref": "#/components/schemas/PostalCode" }, "city": { "$ref": "#/components/schemas/City" }, "region": { "$ref": "#/components/schemas/Region" }, "country": { "$ref": "#/components/schemas/AllowedCountry" } }, "required": ["street_address", "city", "country"] } }, "required": ["recipient", "address"] }, "PaymentTransactionShipping": { "type": "array", "description": "Shipping information for the purchase. This data is used for fraud detection and customer communication.\n\nIf the purchase contains multiple shipments with different recipients, you must provide one shipping object per shipment.\n", "x-validation-info": "The validation checks ensure that when sending shipping data, empty objects or missing required fields within the shipping array result in errors. Specifically, errors are triggered if recipient or address fields are missing, if the address details such as city, street address, country, or recipient's family name and given name are absent, and if a shipping option object lacks a shipping type.", "items": { "$ref": "#/components/schemas/Shipping" } }, "PaymentTransactionLineItem": { "type": "object", "required": ["name", "quantity", "total_amount"], "properties": { "name": { "type": "string", "description": "Provide a customer-facing description of the item to clarify what the customer purchased or is being refunded for.\nKlarna displays this description in customer communications, such as receipts and refund confirmations.\nEnsure the value is a clear and concise string that accurately represents the item. Avoid internal codes or technical terms.\nThe string must not contain HTML, CSS or JavaScript. Requests containing such elements will be rejected.\n", "example": "Black fountain pen", "minLength": 1, "maxLength": 1024 }, "quantity": { "type": "integer", "description": "Specify the number of identical items being bought to calculate the total amount for the item line.\nKlarna multiplies this value by the unit price to determine the item’s total cost.\nEnsure the value is a positive integer representing the exact count of the item.\n", "example": 2, "minimum": 1 }, "total_amount": { "type": "integer", "format": "int64", "description": "Specify the total amount to charge or credit the customer to reflect the final line item value, including surcharges and deductions.\n Klarna uses this value to calculate the total payment or refund amount.\n Ensure the value is in minor currency units (e.g., 2500 for USD 25). Use a negative value to credit the customer (e.g., for discounts, vouchers, or gift cards), and a positive value to charge.\n", "example": 2000, "maximum": 2147483648 }, "total_tax_amount": { "type": "integer", "format": "int64", "description": "Specify how much of the total_amount is attributed to sales tax to clarify the tax portion of the item value.\nKlarna uses this value for taxation reporting and may calculate the implied tax rate for display purposes using the formula: tax_rate = total_tax_amount / (total_amount - total_tax_amount)\nEnsure the value is in the corresponding currency minor units.\n\n- Set to 0 to indicate that the total_amount excludes sales tax.\n- Set to the same value as total_amount for sales-tax-only items.\n- If omitted, Klarna assumes no taxation.\n", "example": 0, "minimum": 0, "maximum": 2147483648 }, "unit_price": { "type": "integer", "format": "int64", "description": "Provide the individual price per item in minor currency units to define the cost of a single unit when it differs from total_amount / quantity.\nKlarna uses this value to represent per-item pricing and improve accuracy in price breakdowns on customer communications.\nEnsure the value is in the corresponding currency minor units (e.g., 500 for USD 5).\n", "example": 1000, "minimum": -2147483648, "maximum": 2147483648 }, "product_url": { "type": "string", "minLength": 1, "maxLength": 4096, "description": "Provide the full URL to the product page to allow the customer to access more information about the item.\nKlarna includes this link in relevant customer-facing surfaces, such as post-purchase emails or order summaries.\nEnsure the value is a valid and complete URL, beginning with https://, and points directly to the product page on your online store.\n", "example": "https://merchant.example/product/pencil-3270220049012.html" }, "image_url": { "type": "string", "minLength": 1, "maxLength": 4096, "description": "Provide a link to a high-resolution image of the product to visually represent the item in customer-facing interfaces.\nKlarna displays this image in order confirmations, Klarna app, and other customer touchpoints.\nEnsure the value is a valid and accessible URL, preferably using https://, and points to a clear, high-quality image.\n", "example": "https://merchant.example/images/pencil-3270220049012.png" }, "product_identifier": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Provide a unique identifier of the item, such as Global Trade Item Number (GTIN), Universal Product Code (UPC) or International Standard Book Number (ISBN) to support fraud assessment, acceptance optimization, and customer experience enhancements.\nKlarna uses this identifier to match product details and assess the transaction more accurately.\nIf you cannot provide a global unique identifier, you may submit a SKU reference instead.\n", "example": "3270220049012" }, "line_item_reference": { "$ref": "#/components/schemas/LineItemReference" }, "shipping_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Provide a reference to the shipping address for this item to specify the delivery destination.\nEnsure the value exactly matches a valid shipping object reference present in the request payload.\n", "example": "shipping-recipient-1234" }, "line_item_metadata": { "type": "object", "description": "Provide additional metadata for the line item to store custom information relevant to your system.\n", "properties": { "categories": { "type": "array", "description": "Provide an ordered list of human-readable category names to represent the item’s category hierarchy from general to specific.\n Klarna uses this information to improve product classification, fraud assessment, and customer experience.\n Ensure the value is an array of up to 10 strings, each representing a distinct level in the category path, listed from top-level to most specific.\n", "items": { "type": "string", "minLength": 1, "maxLength": 1024 }, "minItems": 1, "maxItems": 10, "example": ["Electronics", "Computers", "Laptops"] } } }, "subscription_reference": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Defines which subscription this item relates to. If present, then it must match the reference field of a subscription object within the same payload.\n", "example": "PREMIUM_INDIVIDUAL" } }, "description": "Payment Transaction line items" }, "PaymentTransactionLineItems": { "type": "array", "description": "Detailed line item information of the purchase.\nThis data is used for fraud detection and customer communication.", "x-validation-info": "Validation that the objects within the array have the right shape", "items": { "$ref": "#/components/schemas/PaymentTransactionLineItem" } }, "PaymentTransactionSupplementaryPurchaseData": { "type": "object", "description": "Supplementary information for the purchase that helps reduce the risk of fraud, enhances transparency, and improves the customer's post-purchase experience.", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" }, "customer": { "$ref": "#/components/schemas/Customer" }, "shipping": { "$ref": "#/components/schemas/PaymentTransactionShipping" }, "line_items": { "$ref": "#/components/schemas/PaymentTransactionLineItems" }, "travel_reservations": { "type": "array", "description": "Supplementary travel details, such as airline ticket details, car rental details, etc. Mandatory for travel industries", "items": { "$ref": "#/components/schemas/TravelReservationDetails" } }, "lodging_reservations": { "type": "array", "description": "Supplementary lodging details, such as hotel booking details.", "items": { "$ref": "#/components/schemas/LodgingReservationDetails" } }, "insurances": { "type": "array", "description": "Supplementary insurance details", "items": { "$ref": "#/components/schemas/InsuranceDetails" } }, "vouchers": { "$ref": "#/components/schemas/Vouchers" }, "event_reservations": { "$ref": "#/components/schemas/EventReservations" }, "subscriptions": { "description": "Subscription management information.", "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "marketplace_sellers": { "type": "array", "description": "Details of the marketplace sellers involved in the transaction.", "items": { "$ref": "#/components/schemas/MarketplaceSellerDetails" } }, "ondemand_service": { "type": "object", "description": "On-demand management information.", "properties": { "currency": { "type": "string", "example": "USD", "pattern": "^[A-Za-z]{3}$", "x-validation-info": "There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency.", "description": "Currency in ISO 4217 format.\n" }, "average_amount": { "type": "integer", "format": "int64", "description": "Your average amount value, in minor currency units.\nYou can use a value across your customer base, or segment based on customer type, country, etc.\n", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "minimum_amount": { "type": "integer", "format": "int64", "description": "The lowest or minimum value you may charge a customer per purchase.\nYou can use a value across your customer base, or segment based on customer type, country, etc.\n", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "maximum_amount": { "type": "integer", "format": "int64", "description": "The maximum value you may charge a customer per purchase..\nYou can use a value across your customer base, or segment based on customer type, country, etc.\n", "example": 2000, "minimum": 0, "maximum": 2147483647 }, "purchase_interval": { "type": "string", "description": "Cycle interval. The interval of which the customer is making purchases on your service.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `DAY` | |\n| `WEEK` | |\n| `MONTH` | |\n| `YEAR` | |\n", "example": "MONTH", "enum": ["DAY", "WEEK", "MONTH", "YEAR"] }, "purchase_interval_frequency": { "type": "integer", "minimum": 1, "description": "A weekly charge would set interval to WEEK and interval_frequency to 1.\nA charge every second month would set interval to MONTH and interval_frequency to 2.\nA charge twice per month would set interval to WEEK and interval_frequency to 2\n" } } } } }, "PaymentCaptureAmount": { "type": "integer", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "The amount of the capture including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500.\nIf not specified, a capture for the `remaining_authorization_amount` will be performed.\nIf capture_amount > remaining_authorization_amount then a Reauthorization will be done before the capture. Note that the reauthorization operation is subject to a second risk assessment and may be rejected.\n\nInvariant: `capture_amount = sum(line_items[].total_amount)`\n" }, "PaymentCapturedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the payment capture is created. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PaymentCaptureLineItems": { "type": "array", "description": "Detailed line item information of the capture.\nThis data is used for customer communication.", "x-validation-info": "Validation that the objects within the array have the right shape", "items": { "$ref": "#/components/schemas/PaymentTransactionLineItem" } }, "TrackingNumber": { "type": "string", "minLength": 1, "maxLength": 100, "description": "Shipping company specific tracking number of a shipment.\n", "example": "1234-5678-9011" }, "TrackingUrl": { "type": "string", "description": "Shipping company specific tracking URL of a shipment.\n", "x-validation-info": "Validation against the regex that is a valid url", "pattern": "https?:\\/\\/[-a-zA-Z0-9@:%._\\+~#=]{1,256}\\.[a-zA-Z0-9()]{1,64}\\b([-a-zA-Z0-9()!@:%_\\+.~#?&\\/\\/=]*)", "minLength": 1, "maxLength": 1024, "example": "https://www.dhl.com/en/express/tracking.html?AWB=1234-5678-9011" }, "Shipment": { "type": "object", "description": "Payment Transaction Shipment", "properties": { "delivery": { "type": "object", "description": "Detailed tracking information of the delivery", "properties": { "tracking_number": { "$ref": "#/components/schemas/TrackingNumber" }, "tracking_url": { "$ref": "#/components/schemas/TrackingUrl" }, "shipping_carrier": { "$ref": "#/components/schemas/ShippingCarrier" }, "shipping_type": { "$ref": "#/components/schemas/ShippingType" }, "shipping_type_attribute": { "$ref": "#/components/schemas/ShippingTypeAttribute" }, "estimated_delivery_date": { "type": "string", "format": "date", "description": "The estimated delivery date in ISO 8601 format e.g. 2024-01-01", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]$", "example": "2024-01-01" } } }, "return": { "type": "object", "description": "Detailed tracking information of the return", "properties": { "tracking_number": { "$ref": "#/components/schemas/TrackingNumber" }, "tracking_url": { "$ref": "#/components/schemas/TrackingUrl" }, "shipping_carrier": { "$ref": "#/components/schemas/ShippingCarrier" }, "shipping_type": { "$ref": "#/components/schemas/ShippingType" }, "shipping_type_attribute": { "$ref": "#/components/schemas/ShippingTypeAttribute" }, "estimated_delivery_date": { "type": "string", "format": "date", "description": "The estimated delivery date in ISO 8601 format e.g. 2024-01-01", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]$", "example": "2024-01-01" } } } } }, "Shipments": { "type": "array", "description": "Detailed shipment information.\nThis data is used for customer communication.", "items": { "$ref": "#/components/schemas/Shipment" } }, "SupplementaryCaptureData": { "type": "object", "description": "Supplementary information for the capture that enhances transparency and improves the customer's post-purchase experience.", "properties": { "line_items": { "$ref": "#/components/schemas/PaymentCaptureLineItems" }, "shipments": { "$ref": "#/components/schemas/Shipments" } } }, "PaymentRefundCaptureId": { "type": "string", "example": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1", "minLength": 0, "maxLength": 255, "description": "Unique identifier of a Payment Capture which the refund should be allocated to.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentRefundId": { "type": "string", "example": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:refund:1", "minLength": 0, "maxLength": 255, "description": "Unique identifier for a created Payment Refund.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentRefundAmount": { "type": "integer", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "Provide the total amount to refund to the customer, including tax and any discounts, to process the refund accurately.\nKlarna validates that this amount equals the sum of line_items[].total_amount and does not exceed the remaining refundable amount, calculated as sum(captures[].capture_amount) - sum(refunds[].refund_amount).\nEnsure the value is a non-negative integer representing the amount in the currency’s minor units (e.g., 2500 for USD 25).\n" }, "PaymentRefundReference": { "type": "string", "minLength": 1, "maxLength": 255, "example": "partner-refund-reference-1234", "x-validation-info": "Validation for the length", "description": "Provide a reference to the refund or equivalent resource from your system to track the refund across systems.\nThe server includes this reference in Klarna webhooks and the settlement file for reconciliation and reporting.\nTreat this as an opaque string—you must not assume any specific format or structure. Ensure the value is unique within your refund records.\n" }, "PaymentRefundedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the payment refund is created. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PaymentRefundLineItems": { "type": "array", "description": "Detailed line item information of the refund.\nThis data is used for customer communication.", "x-validation-info": "Validation that the objects within the array have the right shape", "items": { "$ref": "#/components/schemas/PaymentTransactionLineItem" } }, "SupplementaryRefundData": { "type": "object", "description": "Object that includes additional information about the refund transanction to enhance customer’s post-purchase experience.\nKlarna presents these details to the customer in the payment method post-purchase communications or other touchpoints available.\n", "properties": { "purchase_refund_reference": { "type": "string", "example": "merchant-order-9876", "minLength": 1, "maxLength": 255, "x-validation-info": "Validation for the length", "description": "Customer facing reference for the refund.\n" }, "line_items": { "$ref": "#/components/schemas/PaymentRefundLineItems" } } }, "PaymentDisputeId": { "type": "string", "minLength": 1, "maxLength": 255, "description": "Unique identifier for the payment dispute", "example": "krn:network:eu1:test:payment:dispute:1234567890" }, "PaymentChargebackId": { "type": "string", "example": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:chargeback:1", "minLength": 0, "maxLength": 255, "description": "Unique identifier for a created Payment Chargeback.\n\nYou should not make any assumption about the format of this identifier, you should treat it as an opaque string.\n" }, "PaymentChargebackAmount": { "type": "integer", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "The amount of the chargeback created. The value should be in minor units. Eg: 25 Dollars should be 2500.\n" }, "PaymentChargebackReason": { "type": "string", "description": "The reason for the Payment Chargeback created.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `DISPUTE` | The payment chargeback originates from a payment dispute raised by the customer. |\n| `DISPUTE_ARBITRATION_LOST` | Deprecated - use `DISPUTE` instead. It identifies the same dispute-driven chargeback, but is named after an outcome that is not known when the chargeback is raised. Keep accepting it until it is removed. |\n| `CUSTOMER_PAYMENT_DEFAULT` | The period defined for customer settlement has passed, and the payment has defaulted. The payment transaction is deemed nullified, and any captured authorization has been reverted through a payment chargeback. |\n", "enum": ["DISPUTE", "DISPUTE_ARBITRATION_LOST", "CUSTOMER_PAYMENT_DEFAULT"] }, "PaymentChargebackAt": { "type": "string", "format": "date-time", "description": "The timestamp when the payment chargeback is created. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PaymentChargebackLineItems": { "type": "array", "maxItems": 100, "description": "Detailed line item information of the chargeback.", "items": { "$ref": "#/components/schemas/PaymentTransactionLineItem" } }, "PaymentTransactionState": { "type": "string", "description": "The current state of the Payment Transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `AUTHORIZED` | The payment transaction has been authorized and waiting for further actions such as capture, refund, void, or expiration. |\n| `COMPLETED` | The payment transaction has been completed and no remaining authorization amount is left to be captured. |\n| `EXPIRED` | The payment transaction has expired without being completed. The payment transaction can be re-authorized within 7 days before it reaches the end of its life, after which pertinent details become inaccessible. |\n| `CLOSED` | The payment transaction has reached its end of life, and pertinent details become inaccessible. At this state, no further operations can be executed. |\n", "enum": ["AUTHORIZED", "COMPLETED", "EXPIRED", "CLOSED"] }, "PaymentTransactionNonTerminalState": { "type": "string", "description": "The state of the Payment Transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `AUTHORIZED` | The payment has been authorized and waiting for further actions such as capture, refund, void, or expiration. |\n| `COMPLETED` | The payment transaction has been completed and no remaining authorization amount is left to be captured. |\n| `EXPIRED` | The payment transaction has expired without being completed. The payment transaction can be re-authorized within 7 days before it reaches the end of its life, after which pertinent details become inaccessible. |\n", "enum": ["AUTHORIZED", "COMPLETED", "EXPIRED"] }, "PaymentTransactionExpiresAt": { "type": "string", "format": "date-time", "description": "Point in time when the payment transaction will expire.\n\nAn expired payment transaction cannot be updated or completed.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PaymentTransactionCreatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the payment transaction was created. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PaymentTransactionUpdatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the payment transaction was updated. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "PaymentTransactionOriginalAuthorizationAmount": { "type": "integer", "format": "int64", "example": 2000, "minimum": 1, "maximum": 2147483647, "x-validation-info": "Validation that it is 10 digits max, up to 2^31-1. That is >= 0. Validation that is equal to line_items.total_amount.", "description": "The original authorization amount of the purchase before any updates made.\nThe value is in non-negative minor units. Eg: 25 Dollars should be 2500.\n" }, "PaymentTransactionRemainingAuthorizationAmount": { "type": "integer", "format": "int64", "example": 2000, "minimum": 0, "maximum": 2147483647, "description": "The remaining authorization amount of the purchase that is left to capture.\nThe value is in non-negative minor units. Eg: 25 Dollars should be 2500.\n" }, "PaymentTransactionFundingState": { "type": "string", "description": "The funding state of the payment transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `PENDING` | The process of collecting funds from the customer has been initiated but is still pending. |\n| `FUNDED` | Customer funds have been secured, and a payout is guaranteed. |\n| `EXPIRED` | The process to collect funds from the customer has expired, and any previously captured amounts will be charged back. |\n", "enum": ["PENDING", "FUNDED", "EXPIRED"] }, "PaymentTransactionFunding": { "type": "object", "description": "Funding details of the payment transaction.\n", "required": ["type", "state"], "properties": { "type": { "$ref": "#/components/schemas/PaymentTransactionFundingType" }, "state": { "$ref": "#/components/schemas/PaymentTransactionFundingState" } } }, "WebsiteDataForPointOfCheckoutTransactionResponse": { "description": "Store type information. Contains the type field indicating whether this is a WEBSITE, PHYSICAL_STORE, or MOBILE_APP.", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/StoreType" }, "url": { "type": "string", "maxLength": 4096, "description": "The applicable base domain URL for the website. Klarna adds this URL to the list of allowed client identifier URLs.", "x-validation": "Validation against the regex that is a valid http or https url", "pattern": "^(https?://)(?!\\d{1,3}(?:\\.\\d{1,3}){3}(?::\\d{1,5})?(?:[/?#]|$))(?:[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-Z]{2,63}|xn--[a-zA-Z0-9-]{0,58}[a-zA-Z0-9])(?::\\d{1,5})?(?:/[^?#\\s]*(?:\\?[^#\\s]*)?(?:#\\S*)?)?$", "example": "https://example.com" } }, "required": ["type", "url"], "title": "Website" }, "PhysicalStoreDataForPointOfCheckoutTransactionResponse": { "description": "Store type information. Contains the type field indicating whether this is a WEBSITE, PHYSICAL_STORE, or MOBILE_APP.", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/StoreType" }, "address": { "$ref": "#/components/schemas/Address" } }, "required": ["type", "address"], "title": "Physical Store" }, "MobileAppDataForPointOfCheckoutTransactionResponse": { "description": "Mobile-app-specific fields for a store, including platform and bundle names.", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/StoreType" }, "platform": { "type": "string", "description": "The platform on which the mobile application is registered.\n\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `IOS` | |\n| `ANDROID` | |\n", "example": "IOS", "enum": ["IOS", "ANDROID"] }, "bundle_names": { "type": "array", "maxItems": 100, "items": { "type": "string", "minLength": 0, "maxLength": 2048 }, "description": "The bundle names for the mobile application.", "example": ["com.JohnDoeMobile"] } }, "required": ["type", "platform"], "title": "Mobile App" }, "StoreDataForPointOfCheckoutTransactionResponse": { "description": "Details of the Store where the payment was made. Contains the Store type and type-specific fields (address for physical stores, URL for websites, platform and bundle names for mobile apps).\n", "type": "object", "properties": { "type": { "$ref": "#/components/schemas/StoreType" } }, "required": ["type"], "discriminator": { "propertyName": "type", "mapping": { "WEBSITE": "#/components/schemas/WebsiteDataForPointOfCheckoutTransactionResponse", "PHYSICAL_STORE": "#/components/schemas/PhysicalStoreDataForPointOfCheckoutTransactionResponse", "MOBILE_APP": "#/components/schemas/MobileAppDataForPointOfCheckoutTransactionResponse" } }, "oneOf": [{ "$ref": "#/components/schemas/WebsiteDataForPointOfCheckoutTransactionResponse" }, { "$ref": "#/components/schemas/PhysicalStoreDataForPointOfCheckoutTransactionResponse" }, { "$ref": "#/components/schemas/MobileAppDataForPointOfCheckoutTransactionResponse" }] }, "PointOfCheckoutTransactionApiResponse": { "type": "object", "description": "Information about where the payment was made.\nstore_reference is always present. store_id is present when the Store has been onboarded in Klarna's systems. store is present when detailed Store information (type, address/URL/platform) is available.\n", "required": ["store_reference"], "properties": { "store_reference": { "$ref": "#/components/schemas/StoreReference" }, "store_id": { "$ref": "#/components/schemas/StoreIdentifier" }, "store": { "$ref": "#/components/schemas/StoreDataForPointOfCheckoutTransactionResponse" } } }, "PaymentTransactionAuthorizedStateReason": { "type": "string", "description": "The reason field may be used to determine why the payment transaction is in its current state.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `AUTHORIZED` | The payment transaction has been authorized and open to completion. |\n| `REAUTHORIZED` | The payment transaction has been re-authorized and open to completion. |\n", "example": "REAUTHORIZED", "enum": ["AUTHORIZED", "REAUTHORIZED"] }, "PaymentTransactionCompletedStateReason": { "type": "string", "description": "The reason field may be used to determine why the payment transaction is in its current state.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `FULLY_CAPTURED` | The funds corresponding to the full authorization amount have been successfully captured. |\n| `PARTIALLY_CAPTURED` | The payment transaction has expired before being fully captured. Any remaining authorization is then released. |\n| `FINAL_CAPTURED` | The payment transaction has been captured, and any remaining authorized amount has been automatically released. The payment transaction is deemed to be completed. |\n| `VOIDED` | The payment transaction has been nullified after being partially captured. Any remaining authorization is released, and the payment transaction is deemed to be completed. |\n| `REAUTHORIZED` | The payment transaction has been reauthorized with updated details (amount, line items, or shipping information) or to extend the authorization period. This status indicates that the original authorization has been replaced with a new authorization following a successful risk assessment. |\n", "example": "FULLY_CAPTURED", "enum": ["FULLY_CAPTURED", "PARTIALLY_CAPTURED", "FINAL_CAPTURED", "VOIDED", "REAUTHORIZED"] }, "PaymentTransactionExpiredStateReason": { "type": "string", "description": "The reason field may be used to determine why the payment transaction is in its current state.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `EXPIRED` | The payment transaction has been expired. |\n", "example": "EXPIRED", "enum": ["EXPIRED"] }, "PaymentTransactionClosedStateReason": { "type": "string", "description": "The reason field may be used to determine why the payment transaction is in its current state.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `END_OF_LIFE` | Payment transaction is completed and reached to the end of life after 3 years. |\n| `EXPIRED` | The payment transaction has not been captured and has surpassed the 7-day grace period following expiry. |\n| `CUSTOMER_PAYMENT_DEFAULT` | The period defined for customer settlement has passed, and the payment has defaulted. |\n| `VOIDED` | The payment transaction has been nullified prior to any capture. |\n", "example": "END_OF_LIFE", "enum": ["END_OF_LIFE", "EXPIRED", "CUSTOMER_PAYMENT_DEFAULT", "VOIDED"] }, "PaymentTransactionSupplementaryPurchaseDataUpdate": { "type": "object", "description": "Supplementary information for the purchase that helps reduce the risk of fraud, enhances transparency, and improves the customer's post-purchase experience.", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" } } }, "PaymentReauthorizationResult": { "type": "string", "description": "The result of the reauthorization attempt for the payment transaction.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `AUTHORIZED` | The payment transaction has been successfully reauthorized and is awaiting further actions. |\n| `REJECTED` | The reauthorize operation has been rejected by Klarna's risk and fraud decisioning. This could happen if the reauthorization attempt was for a higher amount, making the customer appear not creditworthy, or if the provided details were suspicious for potential fraud. |\n", "enum": ["AUTHORIZED", "REJECTED"] }, "SupplementaryPurchaseDataForCapture": { "type": "object", "description": "Updates to the transaction's supplementary purchase data supplied as part of a capture operation.\n", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" } } }, "SupplementaryPurchaseDataForRefund": { "type": "object", "description": "Updates to the transaction's supplementary purchase data supplied as part of a refund operation.\n", "properties": {} }, "WebhookHeaderKlarnaSignature": { "type": "string", "minLength": 0, "maxLength": 255, "example": "2bb80d537b1da3e38bd30361aa855686bde0ba1611657e8d211d0d71fb4f177e", "description": "HMAC-SHA256 signature over the HTTP request body signed with the key identified by `Klarna-Signing-Key-ID`. \n\nThe signature is calculated over the full HTTP request body.\n\n `computedHexDigest = HMAC_SHA256_HexDigest(request.body, getSecretKey(request.headers[\"Klarna-Signing-Key-ID\"]))`\n\nCompare the computed signature with the value of the `Klarna-Signature` header. If they match, the request is coming\nfrom Klarna and you can process the webhook. If they do not match, you should reject the request.\n" }, "WebhookHeaderKlarnaSigningKeyID": { "type": "string", "minLength": 0, "maxLength": 255, "description": "The key used to sign the webhook.", "example": "krn:partner:global:notification:signing-key:120e5b7e-dee8-43ca-9858-dca726e639b5" }, "WebhookMetadata": { "type": "object", "description": "The metadata of the webhook event.\n", "required": ["event_type", "event_version", "event_id", "occurred_at", "webhook_id", "recipient_account_id", "subject_account_id", "live"], "properties": { "event_id": { "type": "string", "minLength": 0, "maxLength": 255, "example": "28ac927f-5ba7-4589-8bf7-1c8ada082343", "description": "The unique identifier of the delivered event." }, "event_type": { "type": "string", "description": "The event type of the webhook.", "minLength": 0, "maxLength": 255 }, "event_version": { "type": "string", "minLength": 0, "maxLength": 255, "example": "v2", "description": "The version of the payload event schema." }, "occurred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the event occurred. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "subject_account_id": { "type": "string", "description": "The unique identifier of the account for which the event has occurred.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "recipient_account_id": { "type": "string", "description": "The unique identifier of the account that has configured the webhook and receives the notification.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "product_instance_id": { "type": "string", "description": "The unique identifier of the product instance.", "example": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "minLength": 0, "maxLength": 255 }, "webhook_id": { "type": "string", "description": "The unique identifier of the webhook that triggered the notification.", "example": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "minLength": 0, "maxLength": 255 }, "live": { "type": "boolean", "description": "A boolean flag indicating whether the event is generated in a production environment.", "example": true } } }, "PaymentWebhookMetadata": { "type": "object", "description": "Webhook metadata for Product API events. This schema extends the common webhook metadata with\nproduct-specific fields.\n\nIn addition to the standard event metadata (event type, version, identifiers, timestamps, and\naccount information), Product API webhooks can include an optional **payment_account_id**. Klarna\npopulates this field when the event is associated with a specific payment account. Partners can use\nit to route webhook notifications to the correct payment account context in multi-account integrations\nand to determine which configuration or handler should process the webhook.\n", "required": ["event_type", "event_version", "event_id", "occurred_at", "webhook_id", "recipient_account_id", "subject_account_id", "live"], "properties": { "event_id": { "type": "string", "minLength": 0, "maxLength": 255, "example": "28ac927f-5ba7-4589-8bf7-1c8ada082343", "description": "The unique identifier of the delivered event." }, "event_type": { "type": "string", "description": "The event type of the webhook.", "minLength": 0, "maxLength": 255 }, "event_version": { "type": "string", "minLength": 0, "maxLength": 255, "example": "v2", "description": "The version of the payload event schema." }, "occurred_at": { "type": "string", "format": "date-time", "description": "The timestamp when the event occurred. In ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "subject_account_id": { "type": "string", "description": "The unique identifier of the account for which the event has occurred.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "recipient_account_id": { "type": "string", "description": "The unique identifier of the account that has configured the webhook and receives the notification.", "example": "krn:partner:global:account:live:LWT2XJSE", "minLength": 0, "maxLength": 255 }, "product_instance_id": { "type": "string", "description": "The unique identifier of the product instance.", "example": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "minLength": 0, "maxLength": 255 }, "webhook_id": { "type": "string", "description": "The unique identifier of the webhook that triggered the notification.", "example": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "minLength": 0, "maxLength": 255 }, "live": { "type": "boolean", "description": "A boolean flag indicating whether the event is generated in a production environment.", "example": true }, "payment_account_id": { "$ref": "#/components/schemas/products-payment.model_PaymentAccountIdentifier" } } }, "PaymentRequestStateForWebhook": { "type": "string", "description": "The current state of the Payment Request.\n\n**Enum values:**\n\n| Value | Description |\n|-------|-------------|\n| `SUBMITTED` | The payment request has been submitted to Klarna. |\n| `IN_PROGRESS` | The customer is actively in the payment flow. |\n| `COMPLETED` | The customer has approved the payment request. For a one-time payment, call `POST /payment/authorize` with the issued Klarna network session token to create a payment transaction. |\n| `CANCELED` | The payment request has been canceled (final state). |\n| `EXPIRED` | The payment request has expired (final state). |\n| `DECLINED` | The payment request has been declined (final state). |\n", "enum": ["SUBMITTED", "IN_PROGRESS", "COMPLETED", "CANCELED", "EXPIRED", "DECLINED"] }, "payment.request.state-change.submitted": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "description": "`SUBMITTED` is the initial state of a Payment Request.", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] }, "payment.request.state-change.in-progress": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "description": "The payment request is in progress. The customer has entered the payment flow.\n", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] }, "payment.request.state-change.completed": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "klarna_network_session_token": { "$ref": "#/components/schemas/KlarnaNetworkSessionToken" }, "payment_token": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The payment token represents a customer approval for payment.\n\nIt is issued when a Klarna Payment Request is completed.\n", "x-validation-info": "Field must be between 1 and 255 characters in length (inclusive)", "example": "krn:payment:eu1:payment-token:e15432a5-ebcc-45bc-934c-e61399db597b", "deprecated": true }, "interoperability_token": { "type": "string", "maxLength": 8192, "minLength": 1, "description": "The interoperability token enables continuity of customer journey across domains and services. If you are an Acquiring Partner, you receive this token from your merchant.\n", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaG9wcGluZ19zZXNzaW9uX2lkIjoia3JuOnNob3BwaW5nOmV1MTpzZXNzaW9uOjBlOTIyN2MwLTBjNDAtNDdkZi04YzEwLTQwMTRmYzFiZDJiZCIsInN0YXR1cyI6IlBBWU1FTlRfUFJFUEFSRUQiLCJ2ZXJzaW9uIjoxLCJjcmVhdGVkX2F0IjoiMjAyNC0wMS0wMVQxMjowMDowMFoiLCJ1cGRhdGVkX2F0IjoiMjAyNC0wMS0wMVQxMjowMDowMFoifQ.1y87kuEKnETy_UCHbTMXx1p4mViZE816okcVmfHFZoo", "deprecated": true }, "shipping": { "$ref": "#/components/schemas/CollectedShipping" }, "klarna_customer": { "$ref": "#/components/schemas/KlarnaCustomer" } }, "description": "The payment token and customer token is only present when the payment request has the state `COMPLETED`.\n", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] }, "payment.request.state-change.canceled": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "description": "The payment request has been canceled.\n", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] }, "payment.request.state-change.expired": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "description": "The payment request has expired.\n", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] }, "payment.request.state-change.declined": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" } }, "description": "The payment request has been declined.\n", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] }, "payment.request.state-change": { "type": "object", "description": "The payment request state change webhook is triggered when the state of a payment request changes.\n", "properties": { "metadata": { "$ref": "#/components/schemas/PaymentWebhookMetadata" }, "payload": { "description": "The payload of the payment request state change webhook.\n", "anyOf": [{ "$ref": "#/components/schemas/payment.request.state-change.submitted" }, { "$ref": "#/components/schemas/payment.request.state-change.in-progress" }, { "$ref": "#/components/schemas/payment.request.state-change.completed" }, { "$ref": "#/components/schemas/payment.request.state-change.canceled" }, { "$ref": "#/components/schemas/payment.request.state-change.expired" }, { "$ref": "#/components/schemas/payment.request.state-change.declined" }], "discriminator": { "propertyName": "state", "mapping": { "SUBMITTED": "#/components/schemas/payment.request.state-change.submitted", "IN_PROGRESS": "#/components/schemas/payment.request.state-change.in-progress", "COMPLETED": "#/components/schemas/payment.request.state-change.completed", "CANCELED": "#/components/schemas/payment.request.state-change.canceled", "EXPIRED": "#/components/schemas/payment.request.state-change.expired", "DECLINED": "#/components/schemas/payment.request.state-change.declined" } } } } }, "payment.request.updated": { "type": "object", "description": "The payment request updated webhook is triggered when the payment request is patched.\n", "properties": { "metadata": { "$ref": "#/components/schemas/PaymentWebhookMetadata" }, "payload": { "type": "object", "properties": { "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "currency": { "$ref": "#/components/schemas/Currency" }, "state": { "$ref": "#/components/schemas/PaymentRequestStateForWebhook" }, "state_reason": { "$ref": "#/components/schemas/PaymentRequestStateReason" }, "previous_state": { "$ref": "#/components/schemas/PaymentRequestState" }, "payment_request_id": { "$ref": "#/components/schemas/PaymentRequestId" }, "expires_at": { "type": "string", "format": "date-time", "description": "The expiration time of the payment request.\n\nIf `customer_interaction_config.interaction_expiry` is provided, `expires_at` is computed using that value.\nIf not provided, the default expiration is 3 hours from the time of creation.\n\nAfter this timestamp the payment request has expired and can no longer be used.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "created_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was created.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_at": { "type": "string", "format": "date-time", "description": "The timestamp when the payment request was updated.\n", "pattern": "^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]:[0-5][0-9](:[0-5][0-9]){0,1}(.[0-9]{0,3})?Z{0,1}$", "example": "2024-01-01T12:00:00Z", "x-validation-info": "Validates that the timestamp is ISO 8601 - UTC time" }, "updated_fields": { "title": "Payment Request", "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "acquiring_config": { "type": "object", "x-validation-info": "Validation that the valid acquiring config provided", "description": "Acquiring config of the payment\n", "oneOf": [{ "$ref": "#/components/schemas/PaymentAcquiringConfigurationAcquiringAccount" }, { "$ref": "#/components/schemas/PaymentAcquiringConfigurationAccount" }] }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" } }, "description": "The new values of the updated fields.\n" }, "previous_fields": { "title": "Payment Request", "type": "object", "properties": { "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "payment_request_reference": { "$ref": "#/components/schemas/PaymentRequestReference" }, "supplementary_purchase_data": { "$ref": "#/components/schemas/SupplementaryPurchaseData" }, "request_customer_token": { "$ref": "#/components/schemas/RequestCustomerToken" }, "payment_option_id": { "$ref": "#/components/schemas/PaymentOptionId" }, "shipping_config": { "$ref": "#/components/schemas/ShippingConfig" }, "acquiring_config": { "type": "object", "x-validation-info": "Validation that the valid acquiring config provided", "description": "Acquiring config of the payment\n", "oneOf": [{ "$ref": "#/components/schemas/PaymentAcquiringConfigurationAcquiringAccount" }, { "$ref": "#/components/schemas/PaymentAcquiringConfigurationAccount" }] }, "point_of_checkout": { "$ref": "#/components/schemas/PointOfCheckout" } }, "description": "The previous values of the updated fields.\n" } }, "description": "The payload of the payment request updated webhook.\n", "required": ["payment_request_id", "state", "currency", "updated_at", "created_at", "expires_at"] } } }, "payment.transaction.updated.payload": { "type": "object", "description": "The payload of a payment transaction updated webhook.\n", "required": ["payment_transaction_id", "state", "updated_at"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "updated_at": { "$ref": "#/components/schemas/PaymentTransactionUpdatedAt" }, "updated_fields": { "type": "object", "description": "The new values of the updated fields.\n", "properties": { "supplementary_purchase_data": { "type": "object", "description": "Supplementary information for the purchase that helps reduce the risk of fraud, enhances transparency, and improves the customer's post-purchase experience.", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" } } }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" } } }, "previous_fields": { "type": "object", "description": "The previous values of the updated fields.\n", "properties": { "supplementary_purchase_data": { "type": "object", "description": "Supplementary information for the purchase that helps reduce the risk of fraud, enhances transparency, and improves the customer's post-purchase experience.", "properties": { "purchase_reference": { "$ref": "#/components/schemas/PurchaseReference" } } }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" } } } } }, "payment.transaction.updated": { "type": "object", "description": "The payment transaction updated webhook.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "$ref": "#/components/schemas/payment.transaction.updated.payload" } } }, "payment.transaction.state-change.authorized": { "type": "object", "description": "The payment transaction has been authorized and waiting for further actions such as capture, refund, void, or expiration.\n", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "remaining_authorization_amount", "state_reason"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "customer_id": { "$ref": "#/components/schemas/CustomerId" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionAuthorizedStateReason" } } }, "payment.transaction.state-change.completed": { "type": "object", "description": "The payment transaction has been completed and no remaining authorization amount is left to be captured.\n", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "remaining_authorization_amount", "state_reason"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "customer_id": { "$ref": "#/components/schemas/CustomerId" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionCompletedStateReason" } } }, "payment.transaction.state-change.expired": { "type": "object", "description": "The payment transaction has expired without being completed. The payment transaction can be re-authorized within 7 days before it reaches the end of its life, after which pertinent details become inaccessible.\n", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "remaining_authorization_amount", "state_reason"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "customer_id": { "$ref": "#/components/schemas/CustomerId" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionExpiredStateReason" } } }, "payment.transaction.state-change.closed": { "type": "object", "description": "The payment transaction has reached its end of life, and pertinent details become inaccessible. At this state, no further operations can be executed.\n", "required": ["payment_transaction_id", "currency", "amount", "state", "created_at", "expires_at", "remaining_authorization_amount", "state_reason"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "state": { "$ref": "#/components/schemas/PaymentTransactionState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionNonTerminalState" }, "currency": { "$ref": "#/components/schemas/Currency" }, "amount": { "$ref": "#/components/schemas/PaymentAmount" }, "remaining_authorization_amount": { "$ref": "#/components/schemas/PaymentTransactionRemainingAuthorizationAmount" }, "customer_id": { "$ref": "#/components/schemas/CustomerId" }, "created_at": { "$ref": "#/components/schemas/PaymentTransactionCreatedAt" }, "expires_at": { "$ref": "#/components/schemas/PaymentTransactionExpiresAt" }, "payment_account": { "$ref": "#/components/schemas/ExistingPaymentAccountIdentifiersOnly" }, "payment_acquiring_account": { "$ref": "#/components/schemas/PaymentAcquiringAccountIdentifiersOnly" }, "state_reason": { "$ref": "#/components/schemas/PaymentTransactionClosedStateReason" } } }, "payment.transaction.state-change": { "type": "object", "description": "The payment transaction state change webhook is triggered when the state of a payment transaction changes.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "description": "The payload of the payment transaction state change webhook.\n", "anyOf": [{ "$ref": "#/components/schemas/payment.transaction.state-change.authorized" }, { "$ref": "#/components/schemas/payment.transaction.state-change.completed" }, { "$ref": "#/components/schemas/payment.transaction.state-change.expired" }, { "$ref": "#/components/schemas/payment.transaction.state-change.closed" }], "discriminator": { "propertyName": "state", "mapping": { "AUTHORIZED": "#/components/schemas/payment.transaction.state-change.authorized", "COMPLETED": "#/components/schemas/payment.transaction.state-change.completed", "EXPIRED": "#/components/schemas/payment.transaction.state-change.expired", "CLOSED": "#/components/schemas/payment.transaction.state-change.closed" } } } } }, "payment.transaction.captured.payload": { "type": "object", "description": "The payload of a payment transaction captured webhook.\n", "required": ["payment_transaction_id", "payment_capture_id", "capture_amount", "captured_at"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_capture_id": { "$ref": "#/components/schemas/PaymentCaptureId" }, "capture_amount": { "$ref": "#/components/schemas/PaymentCaptureAmount" }, "payment_capture_reference": { "$ref": "#/components/schemas/PaymentCaptureReference" }, "captured_at": { "$ref": "#/components/schemas/PaymentCapturedAt" } } }, "payment.transaction.captured": { "type": "object", "description": "The payment transaction captured webhook.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "$ref": "#/components/schemas/payment.transaction.captured.payload" } } }, "payment.transaction.refunded.payload": { "type": "object", "description": "The payload of a payment transaction refunded webhook.\n", "required": ["payment_transaction_id", "payment_refund_id", "refund_amount", "refunded_at"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_refund_id": { "$ref": "#/components/schemas/PaymentRefundId" }, "payment_capture_id": { "$ref": "#/components/schemas/PaymentCaptureId" }, "refund_amount": { "$ref": "#/components/schemas/PaymentRefundAmount" }, "payment_refund_reference": { "$ref": "#/components/schemas/PaymentRefundReference" }, "refunded_at": { "$ref": "#/components/schemas/PaymentRefundedAt" } } }, "payment.transaction.refunded": { "type": "object", "description": "The payment transaction refunded webhook.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "$ref": "#/components/schemas/payment.transaction.refunded.payload" } } }, "payment.transaction.chargeback.payload.base": { "type": "object", "description": "The base payload of a payment transaction chargeback webhook.\n", "required": ["payment_transaction_id", "payment_chargeback_id", "chargeback_amount", "chargeback_at"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_chargeback_id": { "$ref": "#/components/schemas/PaymentChargebackId" }, "chargeback_amount": { "$ref": "#/components/schemas/PaymentChargebackAmount" }, "chargeback_reason": { "$ref": "#/components/schemas/PaymentChargebackReason" }, "chargeback_at": { "$ref": "#/components/schemas/PaymentChargebackAt" } } }, "payment.transaction.chargeback.payload.dispute": { "type": "object", "required": ["payment_dispute_id", "payment_transaction_id", "payment_chargeback_id", "chargeback_amount", "chargeback_at"], "properties": { "payment_dispute_id": { "$ref": "#/components/schemas/PaymentDisputeId" }, "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_chargeback_id": { "$ref": "#/components/schemas/PaymentChargebackId" }, "chargeback_amount": { "$ref": "#/components/schemas/PaymentChargebackAmount" }, "chargeback_reason": { "$ref": "#/components/schemas/PaymentChargebackReason" }, "chargeback_at": { "$ref": "#/components/schemas/PaymentChargebackAt" } }, "description": "The dispute payload of a payment transaction chargeback webhook.\n" }, "payment.transaction.chargeback.payload": { "type": "object", "description": "The payload of a payment transaction chargeback webhook.\n", "anyOf": [{ "$ref": "#/components/schemas/payment.transaction.chargeback.payload.dispute" }, { "$ref": "#/components/schemas/payment.transaction.chargeback.payload.base" }], "discriminator": { "propertyName": "chargeback_reason", "mapping": { "DISPUTE": "#/components/schemas/payment.transaction.chargeback.payload.dispute", "DISPUTE_ARBITRATION_LOST": "#/components/schemas/payment.transaction.chargeback.payload.dispute", "CUSTOMER_PAYMENT_DEFAULT": "#/components/schemas/payment.transaction.chargeback.payload.base" } } }, "payment.transaction.chargeback": { "type": "object", "description": "The payment transaction chargeback webhook.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "$ref": "#/components/schemas/payment.transaction.chargeback.payload" } } }, "PaymentTransactionFundingPending": { "type": "object", "description": "The funding details of the payment transaction when the funding state is `PENDING`.\n", "required": ["type", "state"], "properties": { "type": { "$ref": "#/components/schemas/PaymentTransactionFundingType" }, "state": { "$ref": "#/components/schemas/PaymentTransactionFundingState" } } }, "PaymentTransactionFundingNonTerminalState": { "type": "string", "enum": ["PENDING"], "description": "The funding state of the payment transaction.\n* `PENDING` - The process of collecting funds from the customer has been initiated but is still pending.\n" }, "PaymentTransactionFundingExpired": { "type": "object", "description": "The funding details of the payment transaction when the funding state is `EXPIRED`.\n", "required": ["type", "state"], "properties": { "type": { "$ref": "#/components/schemas/PaymentTransactionFundingType" }, "state": { "$ref": "#/components/schemas/PaymentTransactionFundingState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionFundingNonTerminalState" } } }, "PaymentTransactionFundingFunded": { "type": "object", "description": "The funding details of the payment transaction when the funding state is `FUNDED`.\n", "required": ["type", "state", "previous_state"], "properties": { "type": { "$ref": "#/components/schemas/PaymentTransactionFundingType" }, "state": { "$ref": "#/components/schemas/PaymentTransactionFundingState" }, "previous_state": { "$ref": "#/components/schemas/PaymentTransactionFundingNonTerminalState" } } }, "payment.funding.state-change.payload": { "type": "object", "description": "The payload of a payment transaction chargeback webhook.\n", "required": ["payment_transaction_id", "payment_funding"], "properties": { "payment_transaction_id": { "$ref": "#/components/schemas/PaymentTransactionId" }, "payment_transaction_reference": { "$ref": "#/components/schemas/PaymentTransactionReference" }, "payment_funding": { "type": "object", "oneOf": [{ "$ref": "#/components/schemas/PaymentTransactionFundingPending" }, { "$ref": "#/components/schemas/PaymentTransactionFundingExpired" }, { "$ref": "#/components/schemas/PaymentTransactionFundingFunded" }], "discriminator": { "propertyName": "state", "mapping": { "PENDING": "#/components/schemas/PaymentTransactionFundingPending", "EXPIRED": "#/components/schemas/PaymentTransactionFundingExpired", "FUNDED": "#/components/schemas/PaymentTransactionFundingFunded" } } } } }, "payment.funding.state-change": { "type": "object", "description": "The payment transaction funding state has been changed.\n", "properties": { "metadata": { "$ref": "#/components/schemas/WebhookMetadata" }, "payload": { "$ref": "#/components/schemas/payment.funding.state-change.payload" } } }, "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 } } }, "ResourceErrorCustomerTokenRevoked": { "type": "object", "description": "The customer token referenced by the resource has been revoked.\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": "CUSTOMER_TOKEN_REVOKED" }, "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 customer token has been revoked" }, "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 } } }, "InputErrorIdempotencyKeyMismatch": { "type": "object", "description": "The Klarna-Idempotency-Key was reused with a different request body.\nThis signals a programming error in key reuse and must not be treated as a successful creation.\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": "IDEMPOTENCY_KEY_MISMATCH" }, "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 Klarna-Idempotency-Key has already been used with a different request body." }, "doc_url": { "description": "Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.\n", "type": "string", "minLength": 0, "maxLength": 2048 } } } }, "parameters": { "KlarnaCustomerToken": { "name": "Klarna-Customer-Token", "in": "header", "required": false, "description": "A token identifying a customer who has been tokenized with Klarna, letting you act on that customer's behalf. Treat it as an opaque string: do not parse it or assume a format.", "schema": { "$ref": "#/components/schemas/CustomerToken" } }, "KlarnaNetworkSessionToken": { "name": "Klarna-Network-Session-Token", "in": "header", "required": false, "description": "Identifies the Klarna Network session this request belongs to. Send a previously issued token to continue an existing session.", "schema": { "$ref": "#/components/schemas/KlarnaNetworkSessionToken" } }, "KlarnaIdempotencyKey": { "name": "Klarna-Idempotency-Key", "in": "header", "required": false, "schema": { "$ref": "#/components/schemas/KlarnaIdempotencyKey" } }, "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"] } } }, "examples": { "Minimum_payment_request": { "description": "Minimum payment request for a 10 USD purchase", "value": { "currency": "USD", "amount": 1000, "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Payment_with_line_items": { "description": "Payment with minimal line items", "value": { "currency": "USD", "amount": 2000, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000 }] }, "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Payment_with_full_line_items_and_shipping": { "description": "Payment request including lines items and shipping information.\nTax is specified as a separate line item.\n", "value": { "currency": "USD", "amount": 2100, "supplementary_purchase_data": { "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" } }] }, "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Payment_with_line_items_-_sales_tax_per_line_item": { "description": "Illustrates how to specify sales tax per line item, rather than as a separate line item.\n", "value": { "currency": "EUR", "amount": 2100, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "total_tax_amount": 100, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }] }, "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Payment_with_full_shipping_information": { "description": "Payment request including detailed delivery information.\n", "value": { "currency": "USD", "amount": 2100, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel", "email": "klara.angel@klarna.com", "phone": "844-552-7621" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" }, "shipping_option": { "shipping_type": "TO_DOOR", "shipping_type_attributes": ["SIGNATURE_REQUIRED"], "shipping_carrier": "DHL" } }] }, "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Payment_with_split-shipment": { "description": "Payment request with split shipments\n", "value": { "currency": "USD", "amount": 3100, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890", "shipping_reference": "shipment-recipient-e8fdc4f5" }, { "name": "Leather Notebook", "quantity": 1, "total_amount": 1000, "product_url": "https://merchant.example/product/leather-nodebook-718103150491", "image_url": "https://merchant.example/image/718103150491.png", "product_identifier": "718103150491", "shipping_reference": "shipment-recipient-33442f63" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "shipping_reference": "shipment-recipient-e8fdc4f5", "recipient": { "given_name": "Klara", "family_name": "Angel", "email": "klara.angel@klarna.com", "phone": "844-552-7621" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" }, "shipping_option": { "shipping_type": "TO_DOOR", "shipping_type_attributes": ["SIGNATURE_REQUIRED"], "shipping_carrier": "DHL" } }, { "shipping_reference": "shipment-recipient-33442f63", "recipient": { "given_name": "Klara", "family_name": "Joyce", "email": "klara.joyce@klarna.us", "phone": "844-552-7621" }, "address": { "street_address": "18 W 18th St", "street_address2": "9th Floor", "postal_code": "10011", "city": "New York", "region": "US-NY", "country": "US" }, "shipping_option": { "shipping_type": "PICKUP_POINT", "shipping_type_attributes": ["IDENTIFICATION_REQUIRED"], "shipping_carrier": "UPS" } }] }, "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Payment_with_discount": { "description": "Illustrates how to specify a discount on the payment.\n", "value": { "currency": "USD", "amount": 1900, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000 }, { "name": "Holiday sale 10% off", "quantity": 1, "total_amount": -200 }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }] }, "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Payment_for_car_rental_with_travel_reservations": { "description": "Payment request for a car rental with additional details such as departure, arrival and drivers.\n", "value": { "currency": "USD", "amount": 25300, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Car Rental 1 day, Columbus", "quantity": 1, "total_amount": 25300 }], "travel_reservations": [{ "travel_type": "CAR", "carrier_name": "ABC Car Rentals", "departure": { "address": { "street_address": "123 Main Street", "street_address2": "Suite 300", "postal_code": "12345", "city": "Columbus", "region": "US-OH", "country": "US" }, "departs_at": "2024-01-01T12:00:00Z" }, "arrival": { "address": { "street_address": "123 Main Street", "street_address2": "Suite 300", "postal_code": "12345", "city": "Columbus", "region": "US-OH", "country": "US" }, "arrives_at": "2024-01-03T10:00:00Z" }, "price": 25300, "currency": "USD", "car_class": "ECONOMY", "drivers": [{ "given_name": "Klara", "family_name": "Angel", "date_of_birth": "1990-05-15" }, { "given_name": "Jane", "family_name": "Doe", "date_of_birth": "1985-08-20" }], "insurances": [{ "insurance_type": "LIABILITY_SUPPLEMENT", "insurance_company_name": "Insurance Inc", "price": 100, "currency": "USD" }, { "insurance_type": "LOSS_DAMAGE_WAIVER", "insurance_company_name": "Insurance Inc", "price": 200, "currency": "USD" }], "affiliate_name": "Affiliate Car Rentals" }] }, "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Full_Payment_Request": { "description": "Full Payment Request", "value": { "currency": "USD", "amount": 2000, "payment_request_reference": "partner-payref-1234", "supplementary_purchase_data": { "purchase_reference": "merchant-purchase-reference-5655fd06-38aa-4df5-83dc-527e11c1936d", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 3998, "unit_price": 1999, "total_tax_amount": 694, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890", "line_item_reference": "cart-item-1234", "shipping_reference": "shipment-recipient-e8fdc4f5" }, { "name": "Leather Notebook", "quantity": 3, "total_amount": 10797, "unit_price": 3599, "total_tax_amount": 1874, "product_url": "https://merchant.example/product/leather-notebook-718103150491", "image_url": "https://merchant.example/image/718103150491.png", "product_identifier": "718103150491", "line_item_reference": "cart-item-2314", "shipping_reference": "shipment-recipient-33442f63" }, { "name": "Holiday sale 20% off", "quantity": 1, "total_amount": -2959 }], "shipping": [{ "shipping_reference": "shipment-recipient-e8fdc4f5", "recipient": { "given_name": "Mock", "family_name": "Mock", "email": "customer@email.de", "phone": "+49017614284340", "attention": "Mock" }, "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" }, "shipping_option": { "shipping_type": "TO_DOOR", "shipping_type_attributes": ["SIGNATURE_REQUIRED"], "shipping_carrier": "DHL" } }], "customer": { "given_name": "Mock", "family_name": "Mock", "email": "customer@email.de", "email_last_verified_at": "2023-05-14T11:25:53Z", "phone": "+49017614284340", "phone_last_verified_at": "2024-05-12T19:09:13Z", "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" }, "national_identification": { "number": "999-99-9999", "country": "US" }, "date_of_birth": "1990-01-01", "customer_account": { "account_identifier": "4720c095-8fab-4228-9d98-6689d16a72e7", "loyalty_level": "HIGH", "created_at": "2023-05-14T11:25:53Z", "updated_at": "2024-05-12T19:10:32Z", "last_login": { "occurred_at": "2024-01-01T12:00:00Z", "login_methods": ["WEBAUTHN_PASSKEY", "PASSWORD"] }, "purchase_history": [{ "number_of_purchases": 10, "number_of_paid_purchases": 10, "number_of_disputed_purchases": 2, "total_amount": 100000, "currency": "EUR", "payment_method": "CREDIT_CARD", "first_purchase_at": "2023-05-14T11:32:51Z", "last_purchase_at": "2024-05-12T19:15:21Z" }], "device_purchase_history": [{ "number_of_purchases": 10, "number_of_paid_purchases": 10, "number_of_disputed_purchases": 2, "total_amount": 100000, "currency": "EUR", "payment_method": "CREDIT_CARD", "first_purchase_at": "2023-05-14T11:32:51Z", "last_purchase_at": "2024-05-12T19:15:21Z" }] }, "customer_device": { "app_identifier": "bd5b6731-0560-4010-ac6c-82bd8b869ed5", "device_identifier": "27601d59-6cdf-4a3d-a58a-76a6e07d0cc1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36", "ip_address": "192.168.1.1", "geolocation": { "country": "NL", "latitude": 52.364530592679166, "longitude": 4.905691191365506 } } }, "travel_reservations": [{ "travel_type": "AIR", "reservation_reference": "1739883914401", "departure": { "departure_airport": "AMS", "departs_at": "2024-01-01T12:00:00Z", "city": "Amsterdam", "country": "NL" }, "arrival": { "arrival_airport": "CDG", "city": "Paris", "country": "FR" }, "carrier_name": "KL", "price": 11836, "currency": "EUR", "ticket_class": "ECONOMY", "passengers": [{ "given_name": "Mock", "family_name": "Mock" }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }, { "travel_type": "BUS", "departure": { "departure_location": "Berlin", "departs_at": "2024-01-01T12:00:00Z", "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" } }, "arrival": { "arrival_location": "Paris", "address": { "street_address": "33 rue lafayette", "street_address2": "Str. 2", "postal_code": "75009", "city": "Paris", "region": "Île-de-France", "country": "FR" } }, "carrier_name": "Flixbus", "price": 11836, "currency": "EUR", "ticket_class": "ECONOMY", "passengers": [{ "given_name": "Mock", "family_name": "Mock" }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }, { "travel_type": "CAR", "carrier_name": "Eurostar", "departure": { "departs_at": "2024-01-01T12:00:00Z", "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" } }, "arrival": { "address": { "street_address": "33 rue lafayette", "street_address2": "Str. 2", "postal_code": "75009", "city": "Paris", "region": "Île-de-France", "country": "FR" }, "arrives_at": "2024-01-02T12:00:00Z" }, "price": 11836, "currency": "EUR", "car_class": "ECONOMY", "drivers": [{ "given_name": "Mock", "family_name": "Mock", "date_of_birth": "1990-01-01" }], "insurances": [{ "insurance_type": "LIABILITY_SUPPLEMENT", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }], "lodging_reservations": [{ "lodging_name": "Hotel ABC", "address": { "street_address": "33 rue lafayette", "street_address2": "Str. 2", "postal_code": "75009", "city": "Paris", "region": "Île-de-France", "country": "FR" }, "starts_at": "2025-01-31T12:00:00Z", "ends_at": "2025-01-31T19:00:00Z", "number_of_spaces": 1, "price": 11836, "currency": "EUR", "lodging_type": "ROOM", "guests": [{ "given_name": "Mock", "family_name": "Mock" }], "host": { "host_reference": "90560f0a-9d4d-4d7c-9c0a-ed9909826c71", "host_type": "HOTEL", "country_of_domicile": "FR", "registered_at": "2024-01-01T12:00:00Z", "number_of_reservations": 100 }, "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "event_reservations": [{ "event_name": "Random Event", "event_company_name": "Random Company event", "event_type": "CONCERT", "starts_at": "2025-01-31T12:00:00Z", "ends_at": "2025-01-31T19:00:00Z", "venue_name": "Random Arena", "access_controlled_venue": true, "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" }, "affiliate_name": "Random affiliate name", "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }] }], "ondemand_service": { "currency": "USD", "average_amount": 20000, "minimum_amount": 20000, "maximum_amount": 20000, "purchase_interval": "MONTH", "purchase_interval_frequency": 1 }, "vouchers": [{ "voucher_name": "Test Voucher", "voucher_type": "GIFT_CARD", "voucher_company": "Voucher Company", "starts_at": "2025-01-31T12:00:00Z", "ends_at": "2025-01-31T19:00:00Z", "affiliate_name": "Test affiliate" }], "marketplace_sellers": [{ "marketplace_seller_reference": "seller123", "marketplace_seller_name": "John's Electronics", "marketplace_seller_address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" }, "product_category": "ELECTRONICS", "line_item_references": ["itemref001", "itemref002"], "seller_registered_at": "2023-01-01T12:00:00Z", "seller_updated_at": "2023-06-01T12:00:00Z", "seller_last_login_at": "2023-08-01T13:30:00Z", "shipping_references": ["shipref001", "shipref002"], "seller_rating": "HIGH", "number_of_transactions": 150, "volume_of_transactions": 300000 }], "subscriptions": [{ "subscription_reference": "PREMIUM_MONTHLY", "name": "Test Subscription", "billing_plans": [{ "billing_amount": 1000, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] }, "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" }, "payment_option_id": "cGF5bWVudC1jYXRlZ29yeTovL1BBWV9MQVRFUj90PTE3MjQ4NDU1NzIzMDc=" } }, "On_demand_without_initial_purchase": { "description": "Tokenize the customer so that you can charge them at a later time for on-demand usage\n", "value": { "currency": "USD", "request_customer_token": { "scopes": ["payment:customer_present"] }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "ondemand_service": { "minimum_amount": 100, "maximum_amount": 15000, "average_amount": 3500, "purchase_interval": "WEEK", "purchase_interval_frequency": 1 } }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "On_demand_with_initial_purchase": { "description": "Tokenize the customer so that you can charge them at a later time for on-demand usage and create a transaction for an initial purchase\n", "value": { "currency": "USD", "amount": 2500, "request_customer_token": { "scopes": ["payment:customer_present"] }, "supplementary_purchase_data": { "purchase_reference": "purchase_reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 1, "total_amount": 2500 }], "ondemand_service": { "average_amount": 3500, "minimum_amount": 100, "maximum_amount": 15000, "purchase_interval": "WEEK", "purchase_interval_frequency": 1 } }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } }, "Subscription_with_free_trial": { "description": "Enables customers to initiate a subscription with a free trial period.\n\nNo immediate charges are applied, allowing for a customer-friendly introduction to the service.\n", "value": { "currency": "USD", "request_customer_token": { "scopes": ["payment:customer_not_present"] }, "supplementary_purchase_data": { "purchase_reference": "purchase_reference-5678", "subscriptions": [{ "subscription_reference": "PREMIUM_INDIVIDUAL", "name": "Premium individual", "free_trial": "ACTIVE", "billing_plans": [{ "billing_amount": 999, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Subscriptions_without_free_trial": { "description": "Enables customers to initiate a subscription without a free trial period.\n\nAn immediate charge is applied.\n", "value": { "currency": "USD", "amount": 999, "request_customer_token": { "scopes": ["payment:customer_not_present"] }, "supplementary_purchase_data": { "purchase_reference": "purchase_reference-5678", "line_items": [{ "name": "Music Service subscription", "quantity": 1, "total_amount": 999, "subscription_reference": "PREMIUM_INDIVIDUAL" }], "subscriptions": [{ "subscription_reference": "PREMIUM_INDIVIDUAL", "name": "Premium individual", "free_trial": "INACTIVE", "billing_plans": [{ "billing_amount": 999, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Mixed_Payment_with_storing_payment_details": { "description": "Simplifies purchasing a product (e.g., event ticket) and activating an on-demand service to charge other items at a later time (e.g., insurance)\nvia Klarna.\n", "value": { "currency": "USD", "amount": 40000, "request_customer_token": { "scopes": ["payment:customer_not_present"] }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Event Ticket", "quantity": 1, "total_amount": 40000 }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "Allianz", "price": 0, "currency": "USD" }] }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Mixed_Payment_for_Subscription_with_free_trial": { "description": "Simplifies purchasing an product (e.g., Video Game) and simultaneously activating a subscription (e.g., Video Game Pass)\nwith free trial via Klarna.\n", "value": { "currency": "USD", "amount": 40000, "request_customer_token": { "scopes": ["payment:customer_not_present"] }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Video Game Console", "quantity": 1, "total_amount": 40000 }], "subscriptions": [{ "subscription_reference": "GAME_PASS", "name": "Video Game Pass", "free_trial": "ACTIVE", "billing_plans": [{ "billing_amount": 999, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Mixed_Payment_for_Subscription_without_free_trial": { "description": "Simplifies purchasing a product (e.g., Video Game) and simultaneously activating a subscription (e.g., Video Game Pass)\nvia Klarna.\n", "value": { "currency": "USD", "amount": 40999, "request_customer_token": { "scopes": ["payment:customer_not_present"] }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Video Game Console", "quantity": 1, "total_amount": 40000 }, { "name": "Video Game Pass", "quantity": 1, "total_amount": 999, "subscription_reference": "GAME_PASS" }], "subscriptions": [{ "subscription_reference": "GAME_PASS", "name": "Video Game Pass", "free_trial": "INACTIVE", "billing_plans": [{ "billing_amount": 999, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] }, "payment_request_reference": "partner-payment-reference-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Payment_with_an_existing_store_using_Klarna_store_id": { "description": "Payment with an existing store using Klarna store id", "value": { "currency": "USD", "amount": 1000, "customer_interaction_config": { "method": "QR_CODE" }, "point_of_checkout": { "store_id": "krn:partner:global:account:website:5dc47183-5dbc-48f6-8132-0680be9ba6e6" } } }, "Payment_with_an_existing_store_using_Klarna_store_reference": { "description": "Payment with an existing store using store reference", "value": { "currency": "USD", "amount": 1000, "customer_interaction_config": { "method": "QR_CODE" }, "point_of_checkout": { "store_reference": "partner-storeref-1234" } } }, "Submitted_payment_request": { "value": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "currency": "USD", "amount": 1000, "state": "SUBMITTED", "state_context": { "customer_interaction": { "method": "HANDOVER", "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_url": "https://pay.klarna.com/l/ZjW2Xipgh0tjbrBGD7hzJM" } }, "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Submitted_payment_request_with_point_of_checkout": { "value": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "currency": "USD", "amount": 1000, "state": "SUBMITTED", "state_context": { "customer_interaction": { "method": "QR_CODE", "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_url": "https://pay.klarna.com/l/ZjW2Xipgh0tjbrBGD7hzJM" } }, "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "customer_interaction_config": { "method": "QR_CODE" }, "point_of_checkout": { "store_reference": "partner-storeref-1234" } } }, "In-progress_payment_request": { "value": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "currency": "USD", "amount": 1000, "state": "IN_PROGRESS", "previous_state": "SUBMITTED", "state_context": { "customer_interaction": { "method": "HANDOVER", "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_url": "https://pay.klarna.com/l/ZjW2Xipgh0tjbrBGD7hzJM" } }, "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Payment_request_completed": { "description": "Shows a Payment Request that has been completed.\n\nThe payment request was created with `collect_customer_profile`.\n\nThe `klarna_network_session_token` is returned in the `state_context` object.\n", "value": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "state": "COMPLETED", "previous_state": "IN_PROGRESS", "currency": "USD", "amount": 1000, "state_context": { "klarna_network_session_token": "krn:network:eu1:live:session-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" }, "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Payment_request_that_was_canceled_by_the_customer": { "description": "Shows a payment request that was started, but then canceled by the customer.\n", "value": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "state": "SUBMITTED", "state_reason": "PURCHASE_FLOW_ABORTED", "currency": "USD", "amount": 1000, "state_context": { "customer_interaction": { "method": "HANDOVER", "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_url": "https://pay.klarna.com/l/ZjW2Xipgh0tjbrBGD7hzJM" } }, "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Canceled_payment_request": { "description": "Shows a canceled payment request.\n", "value": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "state": "CANCELED", "state_reason": "PARTNER_CANCELED", "currency": "USD", "amount": 1000, "state_context": {}, "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } }, "Authorize_supporting_step_up": { "description": "Authorizing a payment of a previously created payment request with step up supported.", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } } }, "Minimal_payment_authorization": { "description": "Minimal payment authorization of a previously created payment request.\n", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000 } } }, "Authorize_supporting_step_up_with_supplementary_purchase_data": { "description": "Authorizing a payment of a previously created payment request. Step up with supplementary purchase data supported", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "supplementary_purchase_data": { "purchase_reference": "order-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "unit_price": 1000, "total_amount": 2000 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel", "email": "klara.angel@klarna.com", "phone": "844-552-7621" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" }, "shipping_option": { "shipping_type": "TO_DOOR", "shipping_type_attributes": ["SIGNATURE_REQUIRED"], "shipping_carrier": "DHL" } }] }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } } }, "Authorize_a_subscription": { "description": "Charge a customer for a previously created subscription for a customer that is not present.\n", "value": { "currency": "USD", "request_payment_transaction": { "amount": 999, "payment_transaction_reference": "partner-transaction-reference-1234" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Premium individual", "quantity": 1, "total_amount": 999, "subscription_reference": "PREMIUM_INDIVIDUAL" }], "subscriptions": [{ "subscription_reference": "PREMIUM_INDIVIDUAL", "name": "Premium individual", "free_trial": "INACTIVE", "billing_plans": [{ "billing_amount": 999, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] } } }, "Full_payment_authorization": { "description": "Authorizing a payment of a previously created payment request. Step up with supplementary purchase data supported", "value": { "currency": "USD", "klarna_network_data": "{\"content_type\": \"application/vnd.klarna.example+json\",\"content\": {\"payment_request\": {\"supplementary_purchase_data\": {\"purchase_reference\": \"merchant-purchase-reference-5655fd06-38aa-4df5-83dc-527e11c1936d\",\"line_items\": [{\"name\": \"Black fountain pen\",\"quantity\": 2,\"total_amount\": 3998,\"unit_price\": 1999,\"total_tax_amount\": 694,\"product_url\": \"https://merchant.example/product/black-fountain-pen-1234567890\",\"image_url\": \"https://merchant.example/image/1234567890.png\",\"product_identifier\": \"1234567890\",\"reference\": \"cart-item-1234\",\"shipping_reference\": \"shipment-recipient-e8fdc4f5\"}],\"shipping\": [{\"shipping_reference\": \"shipment-recipient-e8fdc4f5\",\"recipient\": {\"given_name\": \"Mock\",\"family_name\": \"Mock\",\"email\": \"customer@email.de\",\"phone\": \"+49017614284340\"},\"address\": {\"street_address\": \"Neue Schönhauser Str. 2\",\"postal_code\": \"10178\",\"city\": \"Berlin\",\"country\": \"DE\"},\"shipping_option\": {\"shipping_type\": \"TO_DOOR\",\"shipping_type_attributes\": [\"SIGNATURE_REQUIRED\"],\"shipping_carrier\": \"DHL\"}}]}}}}", "supplementary_purchase_data": { "purchase_reference": "merchant-purchase-reference-5655fd06-38aa-4df5-83dc-527e11c1936d", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 3998, "unit_price": 1999, "total_tax_amount": 694, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890", "line_item_reference": "cart-item-1234", "shipping_reference": "shipment-recipient-e8fdc4f5" }, { "name": "Leather Notebook", "quantity": 3, "total_amount": 10797, "unit_price": 3599, "total_tax_amount": 1874, "product_url": "https://merchant.example/product/leather-notebook-718103150491", "image_url": "https://merchant.example/image/718103150491.png", "product_identifier": "718103150491", "line_item_reference": "cart-item-2314", "shipping_reference": "shipment-recipient-33442f63" }, { "name": "Holiday sale 20% off", "quantity": 1, "total_amount": -2959 }], "shipping": [{ "shipping_reference": "shipment-recipient-e8fdc4f5", "recipient": { "given_name": "Mock", "family_name": "Mock", "email": "customer@email.de", "phone": "+49017614284340", "attention": "Mock" }, "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" }, "shipping_option": { "shipping_type": "TO_DOOR", "shipping_type_attributes": ["SIGNATURE_REQUIRED"], "shipping_carrier": "DHL" } }], "customer": { "given_name": "Mock", "family_name": "Mock", "email": "customer@email.de", "email_last_verified_at": "2023-05-14T11:25:53Z", "phone": "+49017614284340", "phone_last_verified_at": "2024-05-12T19:09:13Z", "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" }, "national_identification": { "number": "999-99-9999", "country": "US" }, "date_of_birth": "1990-01-01", "customer_account": { "account_identifier": "4720c095-8fab-4228-9d98-6689d16a72e7", "loyalty_level": "HIGH", "created_at": "2023-05-14T11:25:53Z", "updated_at": "2024-05-12T19:10:32Z", "last_login": { "occurred_at": "2024-01-01T12:00:00Z", "login_methods": ["WEBAUTHN_PASSKEY", "PASSWORD"] }, "purchase_history": [{ "number_of_purchases": 10, "number_of_paid_purchases": 10, "number_of_disputed_purchases": 2, "total_amount": 100000, "currency": "EUR", "payment_method": "CREDIT_CARD", "first_purchase_at": "2023-05-14T11:32:51Z", "last_purchase_at": "2024-05-12T19:15:21Z" }], "device_purchase_history": [{ "number_of_purchases": 10, "number_of_paid_purchases": 10, "number_of_disputed_purchases": 2, "total_amount": 100000, "currency": "EUR", "payment_method": "CREDIT_CARD", "first_purchase_at": "2023-05-14T11:32:51Z", "last_purchase_at": "2024-05-12T19:15:21Z" }] }, "customer_device": { "app_identifier": "bd5b6731-0560-4010-ac6c-82bd8b869ed5", "device_identifier": "27601d59-6cdf-4a3d-a58a-76a6e07d0cc1", "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36", "ip_address": "192.168.1.1", "geolocation": { "country": "NL", "latitude": 52.364530592679166, "longitude": 4.905691191365506 } } }, "travel_reservations": [{ "travel_type": "AIR", "reservation_reference": "1739883914401", "departure": { "departure_airport": "AMS", "departs_at": "2024-01-01T12:00:00Z", "city": "Amsterdam", "country": "NL" }, "arrival": { "arrival_airport": "CDG", "city": "Paris", "country": "FR" }, "carrier_name": "KL", "price": 11836, "currency": "EUR", "ticket_class": "ECONOMY", "passengers": [{ "given_name": "Mock", "family_name": "Mock" }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }, { "travel_type": "BUS", "departure": { "departure_location": "Berlin", "departs_at": "2024-01-01T12:00:00Z", "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" } }, "arrival": { "arrival_location": "Paris", "address": { "street_address": "33 rue lafayette", "street_address2": "Str. 2", "postal_code": "75009", "city": "Paris", "region": "Île-de-France", "country": "FR" } }, "carrier_name": "Flixbus", "price": 11836, "currency": "EUR", "ticket_class": "ECONOMY", "passengers": [{ "given_name": "Mock", "family_name": "Mock" }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }, { "travel_type": "CAR", "carrier_name": "Eurostar", "departure": { "departs_at": "2024-01-01T12:00:00Z", "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" } }, "arrival": { "address": { "street_address": "33 rue lafayette", "street_address2": "Str. 2", "postal_code": "75009", "city": "Paris", "region": "Île-de-France", "country": "FR" }, "arrives_at": "2024-01-02T12:00:00Z" }, "price": 11836, "currency": "EUR", "car_class": "ECONOMY", "drivers": [{ "given_name": "Mock", "family_name": "Mock", "date_of_birth": "1990-01-01" }], "insurances": [{ "insurance_type": "LIABILITY_SUPPLEMENT", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }], "lodging_reservations": [{ "lodging_name": "Hotel ABC", "address": { "street_address": "33 rue lafayette", "street_address2": "Str. 2", "postal_code": "75009", "city": "Paris", "region": "Île-de-France", "country": "FR" }, "starts_at": "2025-01-31T12:00:00Z", "ends_at": "2025-01-31T19:00:00Z", "number_of_spaces": 1, "price": 11836, "currency": "EUR", "lodging_type": "ROOM", "guests": [{ "given_name": "Mock", "family_name": "Mock" }], "host": { "host_reference": "90560f0a-9d4d-4d7c-9c0a-ed9909826c71", "host_type": "HOTEL", "country_of_domicile": "FR", "registered_at": "2024-01-01T12:00:00Z", "number_of_reservations": 100 }, "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "affiliate_name": "booking.com" }], "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }], "event_reservations": [{ "event_name": "Random Event", "event_company_name": "Random Company event", "event_type": "CONCERT", "starts_at": "2025-01-31T12:00:00Z", "ends_at": "2025-01-31T19:00:00Z", "venue_name": "Random Arena", "access_controlled_venue": true, "address": { "street_address": "Neue Schönhauser Str. 2", "street_address2": "Str. 2", "postal_code": "10178", "city": "Berlin", "region": "Berlin", "country": "DE" }, "affiliate_name": "Random affiliate name", "insurances": [{ "insurance_type": "CANCELATION", "insurance_company_name": "AON", "price": 10, "currency": "EUR" }] }], "ondemand_service": { "currency": "USD", "average_amount": 20000, "minimum_amount": 20000, "maximum_amount": 20000, "purchase_interval": "MONTH", "purchase_interval_frequency": 1 }, "vouchers": [{ "voucher_name": "Test Voucher", "voucher_type": "GIFT_CARD", "voucher_company": "Voucher Company", "starts_at": "2025-01-31T12:00:00Z", "ends_at": "2025-01-31T19:00:00Z", "affiliate_name": "Test affiliate" }], "marketplace_sellers": [{ "marketplace_seller_reference": "seller123", "marketplace_seller_name": "John's Electronics", "marketplace_seller_address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "US-OH", "country": "US" }, "product_category": "ELECTRONICS", "line_item_references": ["itemref001", "itemref002"], "seller_registered_at": "2023-01-01T12:00:00Z", "seller_updated_at": "2023-06-01T12:00:00Z", "seller_last_login_at": "2023-08-01T13:30:00Z", "shipping_references": ["shipref001", "shipref002"], "seller_rating": "HIGH", "number_of_transactions": 150, "volume_of_transactions": 300000 }], "subscriptions": [{ "subscription_reference": "PREMIUM_MONTHLY", "name": "Test Subscription", "billing_plans": [{ "billing_amount": 1000, "from": "2025-01-31", "interval": "MONTH", "interval_frequency": 1 }] }] }, "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234", "payment_capture_reference": "partner-capture-reference-1234", "capture": "NOW" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?payref={klarna.payment_request.payment_request_reference}" } } } }, "Authorize_payment_with_existing_store_using_klarna_store_id": { "description": "Authorizing a payment with Klarna store id", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "QR_CODE" } }, "point_of_checkout": { "store_id": "krn:partner:global:account:website:5dc47183-5dbc-48f6-8132-0680be9ba6e6" }, "point_of_transaction": { "type": "WEBSITE", "referrers": ["https://test-ref.tracking.example.com"] } } }, "Authorize_payment_with_an_existing_store_using_store_reference": { "description": "Authorizing a payment with store reference", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "QR_CODE" } }, "point_of_checkout": { "store_reference": "partner-storeref-1234" }, "point_of_transaction": { "type": "TERMINAL", "terminal_reference": "partner-terminalref-1234" } } }, "Authorize_payment_with_website_details": { "description": "Authorizing payment with website details", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } }, "point_of_checkout": { "store_reference": "partner-storeref-1234" }, "point_of_transaction": { "type": "WEBSITE", "referrers": ["https://test-ref.tracking.example.com"] } } }, "Authorize_payment_with_mobile_app_details": { "description": "Authorizing payment with mobile app details", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } }, "point_of_checkout": { "store_reference": "partner-storeref-1234" }, "point_of_transaction": { "type": "MOBILE_APP", "platform": "IOS", "bundle_names": ["com.example.MyMobileApp"] } } }, "Authorize_in_store_payment_with_terminal_details": { "description": "Authorizing an in-store payment with terminal details", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "step_up_config": { "payment_request_reference": "partner-payref-1234", "customer_interaction_config": { "method": "QR_CODE" } }, "point_of_checkout": { "store_reference": "partner-storeref-1234" }, "point_of_transaction": { "type": "TERMINAL", "terminal_reference": "partner-terminalref-1234" } } }, "Authorize_payment_with_card_settlement": { "description": "Authorizing a payment and requesting a card settlement for it in the same call. The\nauthorization only stands if the card is issued.\n", "value": { "currency": "USD", "request_payment_transaction": { "amount": 2000, "payment_transaction_reference": "partner-transaction-reference-1234" }, "request_card_settlement": { "card_settlement_reference": "partner-card-settlement-12345", "encryption_key_id": "9f13c4e2-1b7a-4c55-8d90-6e2f7a3b4c5d" } } }, "Authorization_approved": { "description": "Shows an approved payment authorization response\n", "value": { "payment_transaction_response": { "result": "APPROVED", "payment_transaction": { "payment_transaction_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0", "payment_transaction_reference": "partner-transaction-reference-1234", "amount": 1000, "currency": "USD", "state": "COMPLETED", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL", "customer_pricing_region": "NCE" } }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1" }], "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" } } } } }, "Authorization_declined": { "description": "Shows a declined payment authorization response\n", "value": { "payment_transaction_response": { "result": "DECLINED", "result_reason": "PAYMENT_DECLINED" } } }, "Authorization_resulting_in_step_up_flow": { "description": "Shows a payment authorization response that triggers the step up flow\n", "value": { "payment_transaction_response": { "result": "STEP_UP_REQUIRED" }, "payment_request": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payment-reference-1234", "state": "SUBMITTED", "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "state_context": { "customer_interaction": { "method": "HANDOVER", "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_url": "https://pay.klarna.com/eu/requests/96bc1457-7712-2a03-b1de-7733e1416ed4/start" } }, "currency": "USD", "amount": 1000, "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } } }, "Authorization_response_with_store_reference": { "description": "Shows a payment authorization response containing store reference from point of checkout that triggers the step up flow\n", "value": { "payment_transaction_response": { "result": "STEP_UP_REQUIRED" }, "payment_request": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payment-reference-1234", "state": "SUBMITTED", "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "state_context": { "customer_interaction": { "method": "QR_CODE", "qr_code": { "image_url": "https://pay.klarna.com/qr/zzz.png", "target_url": "https://pay.klarna.com/qr/zzz" } } }, "currency": "USD", "amount": 1000, "customer_interaction_config": { "method": "QR_CODE" }, "point_of_checkout": { "store_reference": "partner-storeref-1234" } } } }, "Authorization_response_with_store_id": { "description": "Shows a payment authorization response containing store id from point of checkout that triggers the step up flow\n", "value": { "payment_transaction_response": { "result": "STEP_UP_REQUIRED" }, "payment_request": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payment-reference-1234", "state": "SUBMITTED", "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "state_context": { "customer_interaction": { "method": "QR_CODE" } }, "currency": "USD", "amount": 1000, "customer_interaction_config": { "method": "QR_CODE" }, "point_of_checkout": { "store_id": "krn:partner:global:account:website:5dc47183-5dbc-48f6-8132-0680be9ba6e6" } } } }, "Authorization_approved_consumer_fx": { "description": "Shows an approved payment authorization response for a transaction settling in a different currency than it was made in\n", "value": { "payment_transaction_response": { "result": "APPROVED", "payment_transaction": { "payment_transaction_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0", "payment_transaction_reference": "partner-transaction-reference-1234", "amount": 1000, "currency": "SEK", "state": "COMPLETED", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "SEK" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "SE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL", "customer_pricing_region": "NCE" } }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1" }], "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" } } } } }, "Authorization_approved_with_card_settlement_issued": { "description": "Shows an approved payment authorization response with the requested card settlement issued.\n", "value": { "payment_transaction_response": { "result": "APPROVED", "payment_transaction": { "payment_transaction_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0", "payment_transaction_reference": "partner-transaction-reference-1234", "amount": 2000, "currency": "USD", "state": "COMPLETED" } }, "card_settlement_response": { "result": "ISSUED", "card_settlement_id": "krn:partner:eu1:payment:card-settlement:5cd46f7e-573d-4b02-bab8-1f1c0e343291", "card_settlement_reference": "partner-card-settlement-12345", "payment_transaction_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0", "card": { "currency": "USD", "card_amount": 2000, "pci_data": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIn0..", "holder": "John Doe", "brand": "VISA" } } } }, "Authorization_step_up_with_card_settlement_requested": { "description": "Shows a payment authorization that triggers the step-up flow with a card settlement\nrequested. The card settlement result matches the payment transaction result.\n", "value": { "payment_transaction_response": { "result": "STEP_UP_REQUIRED" }, "card_settlement_response": { "result": "STEP_UP_REQUIRED" }, "payment_request": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payment-reference-1234", "state": "SUBMITTED", "expires_at": "2024-01-02T13:00:00Z", "created_at": "2024-01-01T12:00:00Z", "updated_at": "2024-01-01T13:00:00Z", "state_context": { "customer_interaction": { "method": "HANDOVER", "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_url": "https://pay.klarna.com/eu/requests/96bc1457-7712-2a03-b1de-7733e1416ed4/start" } }, "currency": "USD", "amount": 2000, "customer_interaction_config": { "method": "HANDOVER", "return_url": "https://partner.example/klarna-redirect?id={klarna.payment_request.id}" } } } }, "Authorization_declined_card_settlement_required": { "description": "Shows a payment authorization declined because the card settlement could not be issued.\nNo authorization is held against the customer.\n", "value": { "payment_transaction_response": { "result": "DECLINED", "result_reason": "CARD_SETTLEMENT_ISSUANCE_FAILED" }, "card_settlement_response": { "result": "FAILED", "result_reason": "ISSUANCE_UNAVAILABLE" } } }, "Payment_transaction_authorized": { "description": "Shows a payment transaction that has been created but not yet acted upon.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "currency": "USD", "amount": 2100, "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_authorized_with_price_cap_applied": { "description": "Shows a payment transaction that has been created but not yet acted upon.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "currency": "USD", "amount": 2100, "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_partially_captured": { "description": "Shows a payment transaction that has been partially captured and is open to further operations such as capture, refund, update, or void.\n", "value": { "payment_transaction_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162", "currency": "EUR", "amount": 15000, "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }, { "name": "Custom Berlin Wall Art Skateboard", "quantity": 1, "total_amount": 10000, "product_url": "https://merchant.example/product/custom-berlin-wall-art-skateboard-5566778899", "image_url": "https://merchant.example/image/5566778899.png", "product_identifier": "5566778899" }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "Kurfürstendamm 100", "postal_code": "10709", "city": "Berlin", "region": "Berlin", "country": "DE" } }] }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_capture_reference": "capture-reference-123", "capture_amount": 5000, "captured_at": "2024-01-02T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] } }], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-02T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 15000, "remaining_authorization_amount": 10000, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_fully_captured": { "description": "Shows a payment transaction that has been fully captured.\n", "value": { "payment_transaction_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162", "currency": "EUR", "amount": 15000, "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }, { "name": "Custom Berlin Wall Art Skateboard", "quantity": 1, "total_amount": 10000, "product_url": "https://merchant.example/product/custom-berlin-wall-art-skateboard-5566778899", "image_url": "https://merchant.example/image/5566778899.png", "product_identifier": "5566778899" }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "Kurfürstendamm 100", "postal_code": "10709", "city": "Berlin", "region": "Berlin", "country": "DE" } }] }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_capture_reference": "capture-reference-123", "capture_amount": 5000, "captured_at": "2024-01-02T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] } }, { "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:2", "payment_capture_reference": "capture-reference-456", "capture_amount": 10000, "captured_at": "2024-01-05T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Custom Berlin Wall Art Skateboard", "quantity": 1, "total_amount": 10000, "product_url": "https://merchant.example/product/custom-berlin-wall-art-skateboard-5566778899", "image_url": "https://merchant.example/image/5566778899.png", "product_identifier": "5566778899" }], "shipments": [{ "delivery": { "tracking_number": "DHL998877665", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL998877665&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-07" }, "return": { "tracking_number": "DHL544332211", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL544332211&brand=DHL", "shipping_carrier": "DHL" } }] } }], "payment_refunds": [], "payment_chargebacks": [], "state": "COMPLETED", "state_reason": "FULLY_CAPTURED", "previous_state": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-05T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 15000, "remaining_authorization_amount": 0, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_voided_and_completed": { "description": "Shows a payment transaction that has been partially captured and completed upon a void operation. Any remaining authorization has been released.\n", "value": { "payment_transaction_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 15000, "currency": "EUR", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }, { "name": "Custom Berlin Wall Art Skateboard", "quantity": 1, "total_amount": 10000, "product_url": "https://merchant.example/product/custom-berlin-wall-art-skateboard-5566778899", "image_url": "https://merchant.example/image/5566778899.png", "product_identifier": "5566778899" }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "Kurfürstendamm 100", "postal_code": "10709", "city": "Berlin", "region": "Berlin", "country": "DE" } }] }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_capture_reference": "capture-reference-123", "capture_amount": 5000, "captured_at": "2024-01-02T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] } }], "payment_refunds": [], "payment_chargebacks": [], "state": "COMPLETED", "state_reason": "VOIDED", "previous_state": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-02T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 15000, "remaining_authorization_amount": 0, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_voided_and_closed": { "description": "Shows a payment transaction that has not been captured and has been closed upon a void operation.", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "state": "CLOSED", "state_reason": "VOIDED", "previous_state": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z" } }, "Payment_transaction_partially_captured_and_7_days_grace_period_passed_upon_expiration": { "description": "Shows a payment transaction that has been partially captured, and the 7-days grace period has passed upon expiration.\nAny remaining authorization is released, and the payment transaction is considered to be completed.\n", "value": { "payment_transaction_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 15000, "currency": "EUR", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }, { "name": "Custom Berlin Wall Art Skateboard", "quantity": 1, "total_amount": 10000, "product_url": "https://merchant.example/product/custom-berlin-wall-art-skateboard-5566778899", "image_url": "https://merchant.example/image/5566778899.png", "product_identifier": "5566778899" }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "Kurfürstendamm 100", "postal_code": "10709", "city": "Berlin", "region": "Berlin", "country": "DE" } }] }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_capture_reference": "capture-reference-123", "capture_amount": 5000, "captured_at": "2024-01-02T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] } }], "payment_refunds": [], "payment_chargebacks": [], "state": "COMPLETED", "state_reason": "PARTIALLY_CAPTURED", "previous_state": "EXPIRED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-27T13:00:00Z", "expires_at": "2024-01-20T13:00:00Z", "original_authorization_amount": 15000, "remaining_authorization_amount": 0, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_final_captured": { "description": "Shows a payment transaction that has been captured, and remaining authorization has been automatically released.\n", "value": { "payment_transaction_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 5000, "currency": "EUR", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }, { "name": "Custom Berlin Wall Art Skateboard", "quantity": 1, "total_amount": 10000, "product_url": "https://merchant.example/product/custom-berlin-wall-art-skateboard-5566778899", "image_url": "https://merchant.example/image/5566778899.png", "product_identifier": "5566778899" }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "Kurfürstendamm 100", "postal_code": "10709", "city": "Berlin", "region": "Berlin", "country": "DE" } }] }, "payment_captures": [{ "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_capture_reference": "capture-reference-123", "capture_amount": 5000, "captured_at": "2024-01-02T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] } }], "payment_refunds": [], "payment_chargebacks": [], "state": "COMPLETED", "state_reason": "FINAL_CAPTURED", "previous_state": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-27T13:00:00Z", "expires_at": "2024-01-20T13:00:00Z", "original_authorization_amount": 15000, "remaining_authorization_amount": 0, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 100, "currency": "USD" }, "variable_fee": { "percentage": 120 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_expired": { "description": "Shows a payment transaction that has expired and where no prior capture has occurred.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "EXPIRED", "state_reason": "EXPIRED", "previous_state": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-29T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_reauthorized_upon_expiration": { "description": "Shows a payment transaction that has been re-authorized after expiry.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "REAUTHORIZED", "previous_state": "EXPIRED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-15T13:00:00Z", "expires_at": "2024-01-22T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_completed_and_closed": { "description": "Shows a payment transaction that has been completed and closed upon reaching the end of its life.", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "state": "CLOSED", "state_reason": "END_OF_LIFE", "previous_state": "COMPLETED", "created_at": "2024-01-01T13:00:00Z" } }, "Payment_transaction_not_captured_and_closed_following_the_expiry": { "description": "Shows a payment transaction that has not been captured and was closed following the 7-day grace period after expiry.", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "state": "CLOSED", "state_reason": "EXPIRED", "previous_state": "EXPIRED", "created_at": "2024-01-01T13:00:00Z" } }, "Payment_transaction_non_guaranteed_full_collection_pending": { "description": "Shows a payment transaction that is non guaranteed with consumer funds pending.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "payment_funding": { "type": "NON_GUARANTEED", "state": "PENDING" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_non_guaranteed_full_collection_collected": { "description": "Shows a payment transaction that is non guaranteed with consumer funds collected.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "payment_funding": { "type": "NON_GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Payment_transaction_non_guaranteed_full_collection_closed": { "description": "Shows a payment transaction that is non guaranteed with consumer funds failed to be collected.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "NON_GUARANTEED", "state": "EXPIRED" }, "state": "CLOSED", "previous_state": "AUTHORIZED", "state_reason": "CUSTOMER_PAYMENT_DEFAULT", "created_at": "2024-01-01T13:00:00Z" } }, "Payment_transaction_non_guaranteed_full_collection_closed_with_chargeback": { "description": "Shows a payment transaction that is non guaranteed with consumer funds failed to be collected and the already captured amount being charged back.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "NON_GUARANTEED", "state": "EXPIRED" }, "state": "CLOSED", "previous_state": "COMPLETED", "state_reason": "CUSTOMER_PAYMENT_DEFAULT", "created_at": "2024-01-01T13:00:00Z" } }, "Payment_transaction_authorized_with_consumer_fx": { "description": "Shows a payment transaction that settles in a different currency than it was made in, and that has been created but not yet acted upon.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "currency": "USD", "amount": 2100, "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "settlement_currency": "GBP", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "US", "partner_country": "GB", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Update_purchase_reference_and_payment_transaction_reference": { "description": "Update purchase reference and payment transaction reference\n", "value": { "supplementary_purchase_data": { "purchase_reference": "new-merchant-order-reference-5678" }, "payment_transaction_reference": "new-payment-transaction-reference-1234" } }, "Payment_transaction_updated": { "description": "Shows a payment transaction that has been updated prior to completion.\n", "value": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "new-payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "supplementary_purchase_data": { "purchase_reference": "new-merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-02T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } }, "Reauthorize_payment_transaction_with_new_amount_and_line_items": { "description": "Reauthorize payment transaction with new payment amount and line items\n", "value": { "amount": 4200, "supplementary_purchase_data": { "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 4000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 200, "total_tax_amount": 200 }] } } }, "Reauthorize_payment_transaction_to_extend_authorization_period": { "description": "Reauthorize payment transaction to extend the authorization period\n", "value": { "extension_days": 7 } }, "Payment_transaction_reauthorized": { "description": "Shows a payment transaction that has been reauthorized and waiting for further actions.\n", "value": { "result": "AUTHORIZED", "payment_transaction": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 4200, "currency": "USD", "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 4000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 200, "total_tax_amount": 200 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "REAUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "updated_at": "2024-01-02T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } } }, "Payment_transaction_is_failed_to_be_reauthorized": { "description": "Shows a payment transaction reauthorization that has been rejected by Klarna's risk and fraud decisioning.\n", "value": { "result": "REJECTED", "payment_transaction": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678", "line_items": [{ "name": "Black fountain pen", "quantity": 2, "total_amount": 2000, "product_url": "https://merchant.example/product/black-fountain-pen-1234567890", "image_url": "https://merchant.example/image/1234567890.png", "product_identifier": "1234567890" }, { "name": "Sales tax", "quantity": 1, "total_amount": 100, "total_tax_amount": 100 }], "shipping": [{ "recipient": { "given_name": "Klara", "family_name": "Angel" }, "address": { "street_address": "629 N High St", "street_address2": "Suite 300", "postal_code": "43215", "city": "Columbus", "region": "OH", "country": "US" } }] }, "payment_captures": [], "payment_refunds": [], "payment_chargebacks": [], "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "original_authorization_amount": 2100, "remaining_authorization_amount": 2100, "payment_funding": { "type": "GUARANTEED", "state": "FUNDED" }, "settlement_currency": "USD", "payment_pricing": { "applicable_rate": { "fixed_fee": { "amount": 104, "currency": "USD" }, "variable_fee": { "percentage": 139 }, "unit": "CAPTURE" }, "evaluation_parameters": { "price_plan_id": "krn:partner:global:payment:price-plan:2a3ced5d-270b-319d-7aa4-a4bcf3a2f4b6", "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291", "customer_country": "DE", "partner_country": "US", "merchant_category_code": "5111", "evaluated_at": "2024-01-01T13:00:00Z", "pricing_payment_category": "DIGITAL" } } } } }, "Capture_with_line_items": { "description": "Shows a capture request with capture amount and line items\n", "value": { "capture_amount": 5000, "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }] }, "remaining_authorization": "RELEASE" } }, "Capture_with_line_items_and_shipment_details": { "description": "Shows a capture request with line items and shipment details\n", "value": { "capture_amount": 5000, "payment_capture_reference": "capture-reference-123", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] }, "remaining_authorization": "RELEASE" } }, "Payment_capture_response": { "description": "Shows a successful payment capture response\n", "value": { "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_capture_reference": "capture-reference-123", "capture_amount": 5000, "captured_at": "2024-01-02T13:00:00Z", "supplementary_capture_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }], "shipments": [{ "delivery": { "tracking_number": "DHL123456789", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL123456789&brand=DHL", "shipping_carrier": "DHL", "shipping_type": "TO_DOOR", "shipping_type_attribute": "SIGNATURE_REQUIRED", "estimated_delivery_date": "2024-01-05" }, "return": { "tracking_number": "DHL987654321", "tracking_url": "https://www.dhl.com/en/express/tracking.html?AWB=DHL987654321&brand=DHL", "shipping_carrier": "DHL" } }] } } }, "Refund_with_line_items": { "description": "Shows a refund request with refund amount and line items\n", "value": { "refund_amount": 5000, "payment_refund_reference": "refund-reference-123", "supplementary_refund_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }] } } }, "Payment_transaction_refund_response": { "description": "Shows a successful response to a refund operation on a payment transaction.\n", "value": { "payment_refund_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:refund:1", "payment_refund_reference": "refund-reference-123", "refund_amount": 5000, "refunded_at": "2024-01-02T13:00:00Z", "supplementary_refund_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }] } } }, "Payment_capture_refund_response": { "description": "Shows a successful response to a refund operation on a payment capture.\n", "value": { "payment_refund_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:refund:1", "payment_capture_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:capture:1", "payment_refund_reference": "refund-reference-123", "refund_amount": 5000, "refunded_at": "2024-01-02T13:00:00Z", "supplementary_refund_data": { "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }] } } }, "Payment_chargeback_created_response_as_a_result_of_dispute_merchant_loss": { "description": "Shows a payment chargeback created as a result of dispute merchant loss.\n", "value": { "payment_dispute_id": "krn:payment:eu1:transaction:f9669608-a24d-43ef-9f34-ec3d785dc1ae:dispute:1", "payment_chargeback_id": "krn:payment:eu1:transaction:f9669608-a24d-43ef-9f34-ec3d785dc1ae:chargeback:1", "chargeback_amount": 5000, "chargeback_reason": "DISPUTE_ARBITRATION_LOST", "chargeback_at": "2024-01-02T13:00:00Z" } }, "Payment_chargeback_created_response_as_a_result_of_payment_default": { "description": "Shows a payment chargeback created as a result of payment default.\n", "value": { "payment_chargeback_id": "krn:payment:eu1:transaction:bc42b6ff-b222-463c-b4b2-d8d6a82e0162:chargeback:1", "chargeback_amount": 5000, "chargeback_reason": "CUSTOMER_PAYMENT_DEFAULT", "chargeback_at": "2024-01-02T13:00:00Z", "line_items": [{ "name": "Oversized vintage trabant tee", "quantity": 2, "total_amount": 5000, "product_url": "https://merchant.example/product/oversized-vintage-trabant-tee-3344556677", "image_url": "https://merchant.example/image/3344556677.png", "product_identifier": "1234567890" }] } }, "PaymentPresentationDefaultResponse": { "description": "Example standard response for Klarna payment presentation API.", "value": {} }, "PaymentPresentationWithTokenResponse": { "description": "Example response for Klarna payment presentation API for token use case.", "value": {} }, "Payment_request_submitted_webhook": { "description": "The payment request has been submitted to Klarna.\n", "value": { "metadata": { "event_type": "payment.request.state-change.submitted", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v2", "occurred_at": "2024-01-01T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payref-1234", "amount": 1000, "currency": "USD", "state": "SUBMITTED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z" } } }, "Payment_request_in-progress_webhook": { "description": "The payment request has been submitted to Klarna.\n", "value": { "metadata": { "event_type": "payment.request.state-change.in-progress", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v2", "occurred_at": "2024-01-01T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payref-1234", "amount": 1000, "currency": "USD", "state": "IN_PROGRESS", "previous_state": "SUBMITTED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z" } } }, "Payment_request_completed_webhook": { "description": "The payment request has been completed.\n", "value": { "metadata": { "event_type": "payment.request.state-change.completed", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v2", "occurred_at": "2024-01-01T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "payment_request_reference": "partner-payref-1234", "amount": 1000, "currency": "USD", "state": "COMPLETED", "previous_state": "IN_PROGRESS", "klarna_network_session_token": "krn:network:eu1:live:session-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z" } } }, "Payment_request_canceled_webhook": { "description": "The payment request has been canceled\n", "value": { "metadata": { "event_type": "payment.request.state-change.canceled", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v2", "occurred_at": "2024-01-01T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "amount": 1000, "currency": "USD", "state": "CANCELED", "state_reason": "PARTNER_CANCELED", "previous_state": "SUBMITTED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z" } } }, "Payment_request_expired_webhook": { "description": "The payment request has expired\n", "value": { "metadata": { "event_type": "payment.request.state-change.expired", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v2", "occurred_at": "2024-01-01T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "amount": 1000, "currency": "USD", "state": "EXPIRED", "previous_state": "SUBMITTED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z" } } }, "Payment_request_declined_webhook": { "description": "The payment request has been declined by Klarna.\n", "value": { "metadata": { "event_type": "payment.request.state-change.declined", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v1", "occurred_at": "2024-01-01T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "amount": 1000, "currency": "USD", "state": "DECLINED", "previous_state": "IN_PROGRESS", "state_reason": "PAYMENT_DECLINED", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z" } } }, "Payment_request_updated_webhook": { "description": "The payment request has been updated\n", "value": { "metadata": { "event_type": "payment.request.updated", "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a", "event_version": "v2", "occurred_at": "2024-01-01T13:45:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "payment_account_id": "krn:partner:global:account:payment-account:48dce58d-9289-4d79-a5cd-9d1c87a582dc", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_request_id": "krn:payment:eu1:request:552603c0-fe8b-4ab1-aacb-41d55fafbdb4", "amount": 2000, "currency": "USD", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-03T13:00:00Z", "updated_at": "2024-01-01T13:45:00Z", "state": "SUBMITTED", "updated_fields": { "currency": "USD", "amount": 2000 }, "previous_fields": { "currency": "EUR", "amount": 1000 } } } }, "Payment_transaction_updated_webhook": { "description": "Shows a payment transaction updated webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.updated", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "updated_at": "2024-01-12T13:00:00Z", "state": "AUTHORIZED", "updated_fields": { "supplementary_purchase_data": { "purchase_reference": "new-merchant-order-reference-5678" }, "payment_transaction_reference": "new-payment-transaction-reference-1234" }, "previous_fields": { "supplementary_purchase_data": { "purchase_reference": "merchant-order-reference-5678" }, "payment_transaction_reference": "payment-transaction-reference-1234" } } } }, "Payment_transaction_authorized_webhook": { "description": "Shows a payment transaction authorized webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.state-change.authorized", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-01T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "state": "AUTHORIZED", "state_reason": "AUTHORIZED", "remaining_authorization_amount": 2100, "customer_id": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "payment_account": { "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_account_reference": "payment-account-reference" }, "payment_acquiring_account": { "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_acquiring_account_reference": "payment-acquiring-account-reference" } } } }, "Payment_transaction_completed_webhook": { "description": "Shows a payment transaction completed webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.state-change.completed", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-01T16:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "state": "COMPLETED", "state_reason": "FULLY_CAPTURED", "previous_state": "AUTHORIZED", "remaining_authorization_amount": 0, "customer_id": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "payment_account": { "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_account_reference": "payment-account-reference" }, "payment_acquiring_account": { "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_acquiring_account_reference": "payment-acquiring-account-reference" } } } }, "Payment_transaction_expired_webhook": { "description": "Shows a payment transaction expired webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.state-change.expired", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-29T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "state": "EXPIRED", "state_reason": "EXPIRED", "previous_state": "AUTHORIZED", "remaining_authorization_amount": 2100, "customer_id": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-29T13:00:00Z", "payment_account": { "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_account_reference": "payment-account-reference" }, "payment_acquiring_account": { "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_acquiring_account_reference": "payment-acquiring-account-reference" } } } }, "Payment_transaction_closed_webhook": { "description": "Shows a payment transaction closed webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.state-change.closed", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-22T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "amount": 2100, "currency": "USD", "state": "CLOSED", "state_reason": "EXPIRED", "previous_state": "EXPIRED", "remaining_authorization_amount": 0, "customer_id": "krn:kuid:vxsqIkCHf5lCWmaZ2beqwz", "created_at": "2024-01-01T13:00:00Z", "expires_at": "2024-01-15T13:00:00Z", "payment_account": { "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_account_reference": "payment-account-reference" }, "payment_acquiring_account": { "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b", "payment_acquiring_account_reference": "payment-acquiring-account-reference" } } } }, "Payment_transaction_captured_webhook": { "description": "Shows a payment transaction captured webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.captured", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-22T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_capture_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216:capture:1", "payment_capture_reference": "partner-capture-reference-1234", "capture_amount": 2000, "captured_at": "2024-01-22T12:00:00Z" } } }, "Payment_transaction_refunded_webhook": { "description": "Shows a payment transaction refunded webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.refunded", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-22T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_refund_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216:refund:1", "payment_refund_reference": "partner-refund-reference-1234", "refund_amount": 2000, "refunded_at": "2024-01-22T12:00:00Z" } } }, "Payment_transaction_chargeback_webhook": { "description": "Shows a payment transaction chargeback webhook.\n", "value": { "metadata": { "event_type": "payment.transaction.chargeback", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-22T12:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_dispute_id": "krn:payment:eu1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216:dispute:1", "payment_chargeback_id": "krn:payment:eu1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216:chargeback:1", "chargeback_amount": 5000, "chargeback_reason": "DISPUTE_ARBITRATION_LOST", "chargeback_at": "2024-01-02T13:00:00Z" } } }, "Payment_funding_pending_webhook": { "description": "Shows a payment funding pending webhook.\n", "value": { "metadata": { "event_type": "payment.funding.state-change.pending", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "NON_GUARANTEED", "state": "PENDING" } } } }, "Payment_funding_funded_webhook": { "description": "Shows a payment funding funded webhook.\n", "value": { "metadata": { "event_type": "payment.funding.state-change.funded", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "NON_GUARANTEED", "state": "FUNDED", "previous_state": "PENDING" } } } }, "Payment_funding_expired_webhook": { "description": "Shows a payment funding expired webhook.\n", "value": { "metadata": { "event_type": "payment.funding.state-change.expired", "event_id": "7f1ff389-7792-4cc5-8ec5-cb2ed6e1f19c", "event_version": "v2", "occurred_at": "2024-01-12T13:00:00Z", "subject_account_id": "krn:partner:global:account:live:HGBY07TR", "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE", "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918", "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5", "live": true }, "payload": { "payment_transaction_id": "krn:payment:us1:transaction:4b8b6350-6b72-42c5-b946-f088adcdc216", "payment_transaction_reference": "payment-transaction-reference-1234", "payment_funding": { "type": "NON_GUARANTEED", "state": "EXPIRED", "previous_state": "PENDING" } } } } }, "headers": { "CacheControl": { "description": "HTTP Cache-Control header indicating the caching policy for this response. Default `max-age` is 14400 seconds (4 hours).\n", "schema": { "type": "string", "minLength": 0, "maxLength": 255 }, "examples": { "default": { "value": "max-age=14400" } } }, "PartnerCorrelationIdResponse": { "description": "An echo of the `Partner-Correlation-Id` request header. Absent when the request did not send one.", "schema": { "type": "string", "minLength": 1, "maxLength": 255 } }, "KlarnaCorrelationId": { "description": "A unique identifier Klarna assigns to this request. Quote it when reporting a problem to Klarna so the request can be traced.", "schema": { "type": "string", "format": "uuid", "minLength": 0, "maxLength": 36 } }, "KlarnaServiceLevelCategory": { "description": "The service level objective (SLO) category that applies to this response, as a lower_snake_case category key. Each category has its own response time and availability targets. Klarna may add categories, so accept values that are not listed.", "schema": { "type": "string", "minLength": 0, "maxLength": 64, "description": "\n\n**Open Enum - values** ([what is an open enum?](https://docs.klarna.com/klarna-network-distribution/setup-your-integration/integration-resilience/data-types/#open-enums)):\n\n| Value | Description |\n|-------|-------------|\n| `identity_read` | Operations that check whether a customer has an existing Klarna account or retrieve details of a customer token issued in the account linking flow. |\n| `disputes` | Operations that enable access to all dispute-related functionalities, including retrieval, updates, and resolution. |\n| `identity_operation` | Operations that revoke or update a customer token issued in the account linking flow. |\n| `account_management_onboarding` | Operations that facilitate the onboarding of a new partner account with Klarna. |\n| `account_management_operation` | Operations that enable the management of an existing partner account, supporting retrieval, updates, and deletion. |\n| `customer_token_charge` | Operations that process payments for tokenized customers, including recurring and on-demand transactions. |\n| `messaging_payment_personalization` | Operations that support personalized payment messaging, including customized options and descriptors. |\n| `messaging_placement_read` | Operations that provide access to retrieve details about available messaging placements for Klarna services. |\n| `payment_transaction_read` | Operations that read payment transactions, such as retrieving payment transaction details. |\n| `payment_transaction_operation` | Operations that support the creation and modification of payment transactions, including submission and updates. |\n| `payment_request` | Operations that handle all aspects of a Payment Request, including creation, retrieval, updates, and deletion. |\n| `payment_confirmation` | Operations that allow the completion of a Payment Request. |\n| `settlements` | Operations that provide access to settlement-related functionalities, including retrieval and reconciliation. |\n\n**Note:** This is an open enum. New values may be added in future releases. Integrators **must** implement handling for unknown values to ensure forward compatibility.", "x-extensible-enum": ["identity_read", "disputes", "identity_operation", "account_management_onboarding", "account_management_operation", "customer_token_charge", "messaging_payment_personalization", "messaging_placement_read", "payment_transaction_read", "payment_transaction_operation", "payment_request", "payment_confirmation", "settlements"] } } } }, "servers": [{ "url": "https://api-global.klarna.com", "description": "Production environment" }, { "url": "https://api-global.test.klarna.com", "description": "Test environment" }], "paths": { "/v2/payment/requests": { "post": { "tags": ["Payment Request API"], "operationId": "createPaymentRequest", "summary": "Create a server-to-server payment request", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Create a server-to-server payment request to initiate payment processing with Klarna. Use this action to handle customer-initiated and partner-initiated purchases, or set up tokenization for subscriptions or on-demand payments. Klarna validates the request, generates a unique payment_request_id for tracking, and returns the payment request along with its current state and interaction details for completing the flow. Learn more about Payment Request

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that handle all aspects of a Payment Request, including creation, retrieval, updates, and deletion.Payment Request\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 essential for a Partner to process payments with KlarnaTier 1 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 10000 ms\n

\n \n Scoped Access Policy:\n The resource type(s) this operation's Access Policy rule can be scoped to.\n \n This operation's access can be scoped by an Access Policy rule on a Payment Account.Payment Account\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n payment-request-creation\n

", "parameters": [{ "$ref": "#/components/parameters/KlarnaCustomerToken" }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": true, "content": { "application/json": { "examples": { "Minimum Payment Request": { "$ref": "#/components/examples/Minimum_payment_request" }, "Payment with line items": { "$ref": "#/components/examples/Payment_with_line_items" }, "Payment with full line items and shipping": { "$ref": "#/components/examples/Payment_with_full_line_items_and_shipping" }, "Payment with line items - sales tax per line item": { "$ref": "#/components/examples/Payment_with_line_items_-_sales_tax_per_line_item" }, "Payment with full shipping information": { "$ref": "#/components/examples/Payment_with_full_shipping_information" }, "Payment with split-shipment": { "$ref": "#/components/examples/Payment_with_split-shipment" }, "Payment with discount": { "$ref": "#/components/examples/Payment_with_discount" }, "Payment for car rental": { "$ref": "#/components/examples/Payment_for_car_rental_with_travel_reservations" }, "Full Payment Request": { "$ref": "#/components/examples/Full_Payment_Request" }, "On-demand without initial purchase": { "$ref": "#/components/examples/On_demand_without_initial_purchase" }, "On-demand with initial purchase": { "$ref": "#/components/examples/On_demand_with_initial_purchase" }, "Subscription with free trial": { "$ref": "#/components/examples/Subscription_with_free_trial" }, "Subscription without free trial": { "$ref": "#/components/examples/Subscriptions_without_free_trial" }, "Mixed Payment with storing payment details": { "$ref": "#/components/examples/Mixed_Payment_with_storing_payment_details" }, "Mixed Payment for Subscription with free trial": { "$ref": "#/components/examples/Mixed_Payment_for_Subscription_with_free_trial" }, "Mixed Payment for Subscription without free trial": { "$ref": "#/components/examples/Mixed_Payment_for_Subscription_without_free_trial" }, "Payment with an existing store using Klarna store id": { "$ref": "#/components/examples/Payment_with_an_existing_store_using_Klarna_store_id" }, "Payment with an existing store using store reference": { "$ref": "#/components/examples/Payment_with_an_existing_store_using_Klarna_store_reference" } }, "schema": { "$ref": "#/components/schemas/PaymentRequestBody" } } } }, "responses": { "201": { "description": "Payment request created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequestResponseBody" }, "examples": { "Payment request created": { "$ref": "#/components/examples/Submitted_payment_request" }, "Payment request created with physical store": { "$ref": "#/components/examples/Submitted_payment_request_with_point_of_checkout" } } } }, "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" } } } }, "callbacks": { "payment.request.state-change": { "klarna-webhook": { "description": "Webhook delivered when the payment request changes state", "post": { "tags": ["Payment Request API"], "summary": "Payment request state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.request.state-change" }, "examples": { "Payment request submitted webhook": { "$ref": "#/components/examples/Payment_request_submitted_webhook" }, "Payment request in-progress webhook": { "$ref": "#/components/examples/Payment_request_in-progress_webhook" }, "Payment request completed webhook": { "$ref": "#/components/examples/Payment_request_completed_webhook" }, "Payment request canceled webhook": { "$ref": "#/components/examples/Payment_request_canceled_webhook" }, "Payment request expired webhook": { "$ref": "#/components/examples/Payment_request_expired_webhook" }, "Payment request declined webhook": { "$ref": "#/components/examples/Payment_request_declined_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/requests/{payment_request_id}": { "get": { "tags": ["Payment Request API"], "operationId": "readPaymentRequest", "summary": "Read the state of a Payment Request", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Allows you to read the state of a payment request. Learn more about Payment Request

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that handle all aspects of a Payment Request, including creation, retrieval, updates, and deletion.Payment Request\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to read, update or cancel a payment request or payment token.Payment Request Management\n

", "parameters": [{ "name": "payment_request_id", "in": "path", "required": true, "description": "The Payment Request ID to read\n", "schema": { "$ref": "#/components/schemas/PaymentRequestId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Payment request object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRequestResponseBody" }, "examples": { "Submitted Payment Request": { "$ref": "#/components/examples/Submitted_payment_request" }, "In-progress Payment Request": { "$ref": "#/components/examples/In-progress_payment_request" }, "Payment Request completed": { "$ref": "#/components/examples/Payment_request_completed" }, "Payment request that was canceled by the customer": { "$ref": "#/components/examples/Payment_request_that_was_canceled_by_the_customer" } } } }, "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": ["Payment Request API"], "operationId": "updatePaymentRequest", "summary": "Update a Payment Request", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Allows you to update a payment request that is in the state SUBMITTED. Learn more about Update a Payment Request

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that handle all aspects of a Payment Request, including creation, retrieval, updates, and deletion.Payment Request\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to read, update or cancel a payment request or payment token.Payment Request Management\n

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

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } }, "delete": { "tags": ["Payment Request API"], "operationId": "cancelPaymentRequest", "summary": "Cancel payment request", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Allows you to cancel a payment request that is SUBMITTED or IN_PROGRESS. Learn more about Cancel a Payment Request

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that handle all aspects of a Payment Request, including creation, retrieval, updates, and deletion.Payment Request\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations used to read, update or cancel a payment request or payment token.Payment Request Management\n

", "parameters": [{ "name": "payment_request_id", "in": "path", "required": true, "description": "The Payment Request ID to cancel\n", "schema": { "$ref": "#/components/schemas/PaymentRequestId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Payment request object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanceledPaymentRequestResponseBody" }, "examples": { "Canceled payment request": { "$ref": "#/components/examples/Canceled_payment_request" } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "callbacks": { "payment.request.state-change": { "klarna-webhook": { "description": "Webhook delivered when the payment request changes state", "post": { "tags": ["Payment Request API"], "summary": "Payment request state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.request.state-change" }, "examples": { "Payment request submitted webhook": { "$ref": "#/components/examples/Payment_request_submitted_webhook" }, "Payment request in-progress webhook": { "$ref": "#/components/examples/Payment_request_in-progress_webhook" }, "Payment request completed webhook": { "$ref": "#/components/examples/Payment_request_completed_webhook" }, "Payment request canceled webhook": { "$ref": "#/components/examples/Payment_request_canceled_webhook" }, "Payment request expired webhook": { "$ref": "#/components/examples/Payment_request_expired_webhook" }, "Payment request declined webhook": { "$ref": "#/components/examples/Payment_request_declined_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/authorize": { "post": { "tags": ["Payment Authorize API"], "operationId": "authorizePayment", "summary": "Authorize a payment transaction.", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Authorize a payment transaction to secure funds for a purchase without immediately capturing them. Use this action when you need to confirm payment availability before completing fulfillment processes. Klarna validates the payment details and reserves the specified amount from the customer's account. Klarna returns the authorization status and creates a payment transaction ready for future capture operations. Learn more about Payment Authorization

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that process payments for tokenized customers, including recurring and on-demand transactions.Customer Token Charge\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 18000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to authorize a payment transaction as part of the purchase flow.Payment Transaction Authorization\n

", "parameters": [{ "$ref": "#/components/parameters/KlarnaNetworkSessionToken" }, { "$ref": "#/components/parameters/KlarnaCustomerToken" }, { "name": "Klarna-Interoperability-Token", "in": "header", "required": false, "deprecated": true, "description": "Deprecated. Use `Klarna-Network-Session-Token` instead. Carries continuity of a customer journey across domains and services.", "schema": { "$ref": "#/components/schemas/InteroperabilityToken" } }, { "name": "Klarna-Payment-Token", "in": "header", "required": false, "deprecated": true, "description": "Deprecated. Use `Klarna-Network-Session-Token` instead. Carries a payment token representing a customer's approval for payment, issued when a Klarna Payment Request completes.", "schema": { "$ref": "#/components/schemas/payment.model_PaymentToken" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAuthorizeRequestBody" }, "examples": { "Authorize a payment supporting step up": { "$ref": "#/components/examples/Authorize_supporting_step_up" }, "Authorize a payment": { "$ref": "#/components/examples/Minimal_payment_authorization" }, "Authorize a payment supporting step up with supplementary purchase data": { "$ref": "#/components/examples/Authorize_supporting_step_up_with_supplementary_purchase_data" }, "Authorize a subscription": { "$ref": "#/components/examples/Authorize_a_subscription" }, "Full authorize payment": { "$ref": "#/components/examples/Full_payment_authorization" }, "Authorize payment with an existing store using Klarna store id": { "$ref": "#/components/examples/Authorize_payment_with_existing_store_using_klarna_store_id" }, "Authorize payment with an existing store using store reference": { "$ref": "#/components/examples/Authorize_payment_with_an_existing_store_using_store_reference" }, "Authorize payment with website details": { "$ref": "#/components/examples/Authorize_payment_with_website_details" }, "Authorize payment with mobile_app details": { "$ref": "#/components/examples/Authorize_payment_with_mobile_app_details" }, "Authorize in-store payment with terminal details": { "$ref": "#/components/examples/Authorize_in_store_payment_with_terminal_details" }, "Authorize payment and request a card settlement": { "$ref": "#/components/examples/Authorize_payment_with_card_settlement" } } } } }, "responses": { "200": { "description": "The authorization result.\n\nInspect **payment_transaction_response.result** to see the outcome.\nIf any of the results is **STEP_UP_REQUIRED**, a payment_request is created which allows the customer to approve.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAuthorizeResponseBody" }, "examples": { "Authorization response approved": { "$ref": "#/components/examples/Authorization_approved" }, "Authorization response declined": { "$ref": "#/components/examples/Authorization_declined" }, "Authorization response triggers the step-up flow": { "$ref": "#/components/examples/Authorization_resulting_in_step_up_flow" }, "Authorization response with store reference": { "$ref": "#/components/examples/Authorization_response_with_store_reference" }, "Authorization response with store id": { "$ref": "#/components/examples/Authorization_response_with_store_id" }, "Authorization response approved with consumer and settlement FX": { "$ref": "#/components/examples/Authorization_approved_consumer_fx" }, "Authorization response approved with a card settlement issued": { "$ref": "#/components/examples/Authorization_approved_with_card_settlement_issued" }, "Authorization response triggering the step-up flow with a card settlement requested": { "$ref": "#/components/examples/Authorization_step_up_with_card_settlement_requested" }, "Authorization response declined because the required card settlement failed": { "$ref": "#/components/examples/Authorization_declined_card_settlement_required" } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict:\n- `CUSTOMER_TOKEN_REVOKED`: The customer token referenced by the resource has been revoked.\n- `RESOURCE_CONFLICT`: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/ResourceErrorCustomerTokenRevoked" }, { "$ref": "#/components/schemas/ResourceErrorConflictError" }], "discriminator": { "propertyName": "error_code", "mapping": { "CUSTOMER_TOKEN_REVOKED": "#/components/schemas/ResourceErrorCustomerTokenRevoked", "RESOURCE_CONFLICT": "#/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" } } }, "422": { "description": "Unprocessable Entity: The Klarna-Idempotency-Key was reused with a different request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputErrorIdempotencyKeyMismatch" }, "examples": { "IDEMPOTENCY_KEY_MISMATCH": { "value": { "error_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "error_type": "INPUT_ERROR", "error_code": "IDEMPOTENCY_KEY_MISMATCH", "error_message": "The Klarna-Idempotency-Key was reused with a different request body." } } } } }, "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" } } } }, "callbacks": { "payment.request.state-change": { "klarna-webhook": { "description": "Webhook delivered when the payment request changes state", "post": { "tags": ["Payment Request API"], "summary": "Payment request state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.request.state-change" }, "examples": { "Payment request submitted webhook": { "$ref": "#/components/examples/Payment_request_submitted_webhook" }, "Payment request in-progress webhook": { "$ref": "#/components/examples/Payment_request_in-progress_webhook" }, "Payment request completed webhook": { "$ref": "#/components/examples/Payment_request_completed_webhook" }, "Payment request canceled webhook": { "$ref": "#/components/examples/Payment_request_canceled_webhook" }, "Payment request expired webhook": { "$ref": "#/components/examples/Payment_request_expired_webhook" }, "Payment request declined webhook": { "$ref": "#/components/examples/Payment_request_declined_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/transactions/{payment_transaction_id}": { "get": { "tags": ["Payment Transaction API"], "operationId": "readPaymentTransaction", "summary": "Read Payment Transaction", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Retrieve the details of a payment transaction to access authorized amounts, currency, line items, and shipping information. Use this action when you need to check the current state of a payment or access transaction details for reconciliation. Klarna processes your request and returns the complete payment transaction data including state, amounts, and associated metadata. Klarna provides real-time information reflecting the current status of the payment transaction. Learn more about Read and update a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that read payment transactions, such as retrieving payment transaction details.Read-only Payment Transaction\n

\n \n SLA Service Class:\n The SLA Service Class this operation is classified at when evaluating SLA compliance.\n \n Operations, webhooks and other services that does not directly impact the core purchasing process in real-time and enables supplemental or secondary featuresTier 2 Services\n

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

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

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

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_transaction_id", "in": "path", "required": true, "description": "The unique identifier of the payment transaction.\n", "schema": { "$ref": "#/components/schemas/PaymentTransactionId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Payment Transaction has been successfully retrieved.", "content": { "application/json": { "schema": { "anyOf": [{ "$ref": "#/components/schemas/PaymentTransactionAuthorizedResponseBody" }, { "$ref": "#/components/schemas/PaymentTransactionCompletedResponseBody" }, { "$ref": "#/components/schemas/PaymentTransactionExpiredResponseBody" }, { "$ref": "#/components/schemas/PaymentTransactionClosedResponseBody" }], "discriminator": { "propertyName": "state", "mapping": { "AUTHORIZED": "#/components/schemas/PaymentTransactionAuthorizedResponseBody", "COMPLETED": "#/components/schemas/PaymentTransactionCompletedResponseBody", "EXPIRED": "#/components/schemas/PaymentTransactionExpiredResponseBody", "CLOSED": "#/components/schemas/PaymentTransactionClosedResponseBody" } } }, "examples": { "Payment transaction is authorized": { "$ref": "#/components/examples/Payment_transaction_authorized" }, "Payment transaction is authorized with price cap applied": { "$ref": "#/components/examples/Payment_transaction_authorized_with_price_cap_applied" }, "Payment transaction has been partially captured": { "$ref": "#/components/examples/Payment_transaction_partially_captured" }, "Payment transaction has been fully captured": { "$ref": "#/components/examples/Payment_transaction_fully_captured" }, "Payment transaction has been completed upon void operation": { "$ref": "#/components/examples/Payment_transaction_voided_and_completed" }, "Payment transaction has been closed upon void operation": { "$ref": "#/components/examples/Payment_transaction_voided_and_closed" }, "Payment transaction has been partially captured and the 7-days grace period has passed upon expiration": { "$ref": "#/components/examples/Payment_transaction_partially_captured_and_7_days_grace_period_passed_upon_expiration" }, "Payment transaction final captured": { "$ref": "#/components/examples/Payment_transaction_final_captured" }, "Payment transaction has expired": { "$ref": "#/components/examples/Payment_transaction_expired" }, "Payment transaction has been reauthorized upon expiration": { "$ref": "#/components/examples/Payment_transaction_reauthorized_upon_expiration" }, "Payment transaction has been completed and closed": { "$ref": "#/components/examples/Payment_transaction_completed_and_closed" }, "Payment transaction has not been captured and closed following the expiry": { "$ref": "#/components/examples/Payment_transaction_not_captured_and_closed_following_the_expiry" }, "Payment transaction is non guaranteed with full collection pending": { "$ref": "#/components/examples/Payment_transaction_non_guaranteed_full_collection_pending" }, "Payment transaction is non guaranteed and fully collected": { "$ref": "#/components/examples/Payment_transaction_non_guaranteed_full_collection_collected" }, "Payment transaction is non guaranteed with full collection closed": { "$ref": "#/components/examples/Payment_transaction_non_guaranteed_full_collection_closed" }, "Payment transaction is non guaranteed with full collection closed with chargeback": { "$ref": "#/components/examples/Payment_transaction_non_guaranteed_full_collection_closed_with_chargeback" }, "Payment transaction is authorized with consumer and settlement FX": { "$ref": "#/components/examples/Payment_transaction_authorized_with_consumer_fx" } } } }, "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": ["Payment Transaction API"], "operationId": "updatePaymentTransaction", "summary": "Update Payment Transaction", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Update payment transaction details to modify reference identifiers for tracking and reconciliation. Use this action when you need to change the payment_transaction_reference or the purchase_reference to align your internal records with Klarna's transaction records. Klarna processes the update request and modifies the specified fields while maintaining transaction integrity. Klarna returns the updated payment transaction with the new reference values and confirms successful modification. Learn more about Read and update a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support the creation and modification of payment transactions, including submission and updates.Payment Transaction General\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_transaction_id", "in": "path", "required": true, "description": "The unique identifier of the payment transaction.\n", "schema": { "$ref": "#/components/schemas/PaymentTransactionId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePaymentTransactionRequestBody" }, "examples": { "Update purchase reference and payment transaction reference": { "$ref": "#/components/examples/Update_purchase_reference_and_payment_transaction_reference" } } } } }, "responses": { "200": { "description": "Payment Transaction has been successfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTransactionAuthorizedResponseBody" }, "examples": { "Payment transaction is updated": { "$ref": "#/components/examples/Payment_transaction_updated" } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "callbacks": { "payment.transaction.updated": { "klarna-webhook": { "description": "Webhook notification delivered when the payment transaction is updated", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction updated", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.updated" }, "examples": { "Payment transaction updated webhook": { "$ref": "#/components/examples/Payment_transaction_updated_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/transactions/{payment_transaction_id}/authorize": { "post": { "tags": ["Payment Transaction API"], "operationId": "reauthorizePaymentTransaction", "summary": "Reauthorize Payment Transaction", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Request to reauthorize a payment transaction.

The reauthorize operation is necessary when the amount, line_items, or shipping details are changed.\nThis ensures that the payment transaction is reauthorized with the up-to-date details and can be completed without any issues.\nNote that the reauthorization operation is subject to a second risk assessment and may be rejected.

Additionally, reauthorization should be performed when the existing authorization is close to expiry, and the payment will not be completed within the current authorization period.\nThis will provide sufficient time to complete the payment transaction without any issues.\nBe aware that a payment transaction is deemed to be CLOSED 7 days following the expiry and cannot be reauthorized thereafter.

Learn more about Read and update a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support the creation and modification of payment transactions, including submission and updates.Payment Transaction General\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_transaction_id", "in": "path", "required": true, "description": "The unique identifier of the payment transaction.\n", "schema": { "$ref": "#/components/schemas/PaymentTransactionId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReauthorizePaymentTransactionRequestBody" }, "examples": { "Reauthorize payment transaction with new payment amount and line items": { "$ref": "#/components/examples/Reauthorize_payment_transaction_with_new_amount_and_line_items" }, "Reauthorize payment transaction to extend the authorization period": { "$ref": "#/components/examples/Reauthorize_payment_transaction_to_extend_authorization_period" } } } } }, "responses": { "200": { "description": "The reauthorization of the payment transaction has been processed.\n\nNote that this does not indicate successful reauthorization; it may have been rejected. You should check the `result` field for the final outcome.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReauthorizePaymentTransactionResponseBody" }, "examples": { "Payment transaction is reauthorized": { "$ref": "#/components/examples/Payment_transaction_reauthorized" }, "Payment transaction is failed to be reauthorized": { "$ref": "#/components/examples/Payment_transaction_is_failed_to_be_reauthorized" } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "callbacks": { "payment.transaction.state-change": { "klarna-webhook": { "description": "Webhook delivered when the payment transaction changes state", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.state-change" }, "examples": { "Payment transaction authorized webhook": { "$ref": "#/components/examples/Payment_transaction_authorized_webhook" }, "Payment transaction completed webhook": { "$ref": "#/components/examples/Payment_transaction_completed_webhook" }, "Payment transaction expired webhook": { "$ref": "#/components/examples/Payment_transaction_expired_webhook" }, "Payment transaction closed webhook": { "$ref": "#/components/examples/Payment_transaction_closed_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/transactions/{payment_transaction_id}/capture": { "post": { "tags": ["Payment Transaction API"], "operationId": "capturePaymentTransaction", "summary": "Capture Payment Transaction", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Capture funds from an authorized payment transaction to complete the purchase process. Use this action when you ship goods or fulfill services to transfer the reserved funds. Klarna processes the capture request and transfers the specified amount from the customer's account to your settlement account. Klarna returns the capture confirmation and initiates the settlement process with the Partner. Learn more about Capture a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support the creation and modification of payment transactions, including submission and updates.Payment Transaction General\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_transaction_id", "in": "path", "required": true, "description": "The unique identifier of the payment transaction.\n", "schema": { "$ref": "#/components/schemas/PaymentTransactionId" } }, { "$ref": "#/components/parameters/KlarnaIdempotencyKey" }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCaptureRequestBody" }, "examples": { "Capture with line items": { "$ref": "#/components/examples/Capture_with_line_items" }, "Capture with line items and shipment details": { "$ref": "#/components/examples/Capture_with_line_items_and_shipment_details" } } } } }, "responses": { "201": { "description": "Payment Transaction has been successfully captured.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCaptureResponseBody" }, "examples": { "Payment capture is created": { "$ref": "#/components/examples/Payment_capture_response" } } } }, "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" } } } }, "callbacks": { "payment.transaction.state-change": { "klarna-webhook": { "description": "Webhook delivered when the payment transaction changes state", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.state-change" }, "examples": { "Payment transaction authorized webhook": { "$ref": "#/components/examples/Payment_transaction_authorized_webhook" }, "Payment transaction completed webhook": { "$ref": "#/components/examples/Payment_transaction_completed_webhook" }, "Payment transaction expired webhook": { "$ref": "#/components/examples/Payment_transaction_expired_webhook" }, "Payment transaction closed webhook": { "$ref": "#/components/examples/Payment_transaction_closed_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } }, "payment.transaction.captured": { "klarna-webhook": { "description": "Webhook notification delivered when the payment transaction is captured", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction captured", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.captured" }, "examples": { "Payment transaction captured webhook": { "$ref": "#/components/examples/Payment_transaction_captured_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/transactions/{payment_transaction_id}/refund": { "post": { "tags": ["Payment Transaction API"], "operationId": "refundPaymentTransaction", "summary": "Refund Payment Transaction", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Refund a payment transaction to return funds to the customer when items are returned or services are canceled. Use this action when you need to process full or partial refunds for completed payments. Klarna processes the refund request and initiates the fund transfer back to the customer's original payment method. Klarna returns the refund confirmation and adjusts the Partner's settlement balance accordingly. Learn more about Refund a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support the creation and modification of payment transactions, including submission and updates.Payment Transaction General\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_transaction_id", "in": "path", "required": true, "description": "The unique identifier of the payment transaction.\n", "schema": { "$ref": "#/components/schemas/PaymentTransactionId" } }, { "$ref": "#/components/parameters/KlarnaIdempotencyKey" }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTransactionRefundRequestBody" }, "examples": { "Refund with line items": { "$ref": "#/components/examples/Refund_with_line_items" } } } } }, "responses": { "201": { "description": "Payment Transaction has been successfully refunded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentTransactionRefundedResponseBody" }, "examples": { "Payment refund is created": { "$ref": "#/components/examples/Payment_transaction_refund_response" } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "callbacks": { "payment.transaction.refunded": { "klarna-webhook": { "description": "Webhook notification delivered when the payment transaction is refunded", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction refunded", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.refunded" }, "examples": { "Payment transaction refunded webhook": { "$ref": "#/components/examples/Payment_transaction_refunded_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/transactions/{payment_transaction_id}/void": { "post": { "tags": ["Payment Transaction API"], "operationId": "voidPaymentTransaction", "summary": "Void Payment Transaction", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Request to void a payment transaction.

The void operation should be performed when the payment is no longer intended to be fulfilled.\nUpon successful completion, any remaining authorization will subsequently be released.

Learn more about Void a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support the creation and modification of payment transactions, including submission and updates.Payment Transaction General\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_transaction_id", "in": "path", "required": true, "description": "The unique identifier of the payment transaction.\n", "schema": { "$ref": "#/components/schemas/PaymentTransactionId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "required": false, "content": {} }, "responses": { "200": { "description": "Payment Transaction has been successfully voided.", "content": { "application/json": { "schema": { "anyOf": [{ "$ref": "#/components/schemas/PaymentTransactionCompletedResponseBody" }, { "$ref": "#/components/schemas/PaymentTransactionClosedResponseBody" }], "discriminator": { "propertyName": "state", "mapping": { "COMPLETED": "#/components/schemas/PaymentTransactionCompletedResponseBody", "CLOSED": "#/components/schemas/PaymentTransactionClosedResponseBody" } } }, "examples": { "Payment transaction has been completed upon void operation": { "$ref": "#/components/examples/Payment_transaction_voided_and_completed" }, "Payment transaction has been closed upon void operation": { "$ref": "#/components/examples/Payment_transaction_voided_and_closed" } } } }, "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" } } } }, "callbacks": { "payment.transaction.state-change": { "klarna-webhook": { "description": "Webhook delivered when the payment transaction changes state", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.state-change" }, "examples": { "Payment transaction authorized webhook": { "$ref": "#/components/examples/Payment_transaction_authorized_webhook" }, "Payment transaction completed webhook": { "$ref": "#/components/examples/Payment_transaction_completed_webhook" }, "Payment transaction expired webhook": { "$ref": "#/components/examples/Payment_transaction_expired_webhook" }, "Payment transaction closed webhook": { "$ref": "#/components/examples/Payment_transaction_closed_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/captures/{payment_capture_id}": { "get": { "tags": ["Payment Transaction API"], "operationId": "readPaymentCapture", "summary": "Read Payment Capture", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Retrieve the details of a payment capture to access capture amounts, line items, and shipment information. Use this action when you need to verify capture status or obtain capture details for record-keeping. Klarna processes your request and returns the complete capture data including amounts, timestamps, and associated line items. Klarna provides current capture information reflecting the actual captured funds and shipment details.

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that read payment transactions, such as retrieving payment transaction details.Read-only Payment Transaction\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_capture_id", "in": "path", "required": true, "description": "The unique identifier of the payment capture.\n", "schema": { "$ref": "#/components/schemas/PaymentCaptureId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Payment Capture has been successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCaptureResponseBody" }, "examples": { "Payment Capture has been successfully retrieved": { "$ref": "#/components/examples/Payment_capture_response" } } } }, "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/payment/captures/{payment_capture_id}/refund": { "post": { "tags": ["Payment Transaction API"], "operationId": "refundPaymentCapture", "summary": "Refund Payment Capture", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Request to refund a payment capture.

The refund should be performed when customers return the purchased items.\nUpon successful completion, the process of returning the funds to the customer will commence,\nand the merchant's settlement balance will be adjusted accordingly.

Learn more about Refund a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support the creation and modification of payment transactions, including submission and updates.Payment Transaction General\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_capture_id", "in": "path", "required": true, "description": "The unique identifier of the payment capture.\n", "schema": { "$ref": "#/components/schemas/PaymentCaptureId" } }, { "$ref": "#/components/parameters/KlarnaIdempotencyKey" }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCaptureRefundRequestBody" }, "examples": { "Refund with line items": { "$ref": "#/components/examples/Refund_with_line_items" } } } } }, "responses": { "201": { "description": "Payment Capture has been successfully refunded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentCaptureRefundedResponseBody" }, "examples": { "Payment refund is created": { "$ref": "#/components/examples/Payment_capture_refund_response" } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "400": { "description": "Bad Request:\n- `INVALID_CONTENT_TYPE`: The input does not conform to the expected content type syntax. For example invalid JSON.\n- `VALIDATION_ERROR`: An input parameter failed input validation. For example exceeding a max value, or failed pattern matching.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/InputErrorContentTypeError" }, { "$ref": "#/components/schemas/InputErrorValidationError" }], "discriminator": { "propertyName": "error_code", "mapping": { "INVALID_CONTENT_TYPE": "#/components/schemas/InputErrorContentTypeError", "VALIDATION_ERROR": "#/components/schemas/InputErrorValidationError" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "401": { "description": "Unauthorized: The request was not authorized.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorUnauthorized" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "403": { "description": "Forbidden: Insufficient privileges to perform the requested operation on the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorOperationForbidden" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "404": { "description": "Not Found: The requested resource was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorNotFoundError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "409": { "description": "Conflict: There was a conflict in using the resource. Idempotency violation or concurrent updates to a resource occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceErrorConflictError" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "429": { "description": "Too Many Requests: The request was rate limited. All requests from this client are temporarily rate limited.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessErrorRateLimited" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "500": { "description": "Internal Server Error:\n- `INTERNAL_ERROR`: An unexpected error occurred in the API. The request may be retried without modification after a delay.\n- `TIMEOUT`: The request timed out due to exceeding the threshold for the API operation or the default configured in the platform.", "content": { "application/json": { "schema": { "oneOf": [{ "$ref": "#/components/schemas/TechnicalErrorInternalError" }, { "$ref": "#/components/schemas/TechnicalErrorTimeout" }], "discriminator": { "propertyName": "error_code", "mapping": { "INTERNAL_ERROR": "#/components/schemas/TechnicalErrorInternalError", "TIMEOUT": "#/components/schemas/TechnicalErrorTimeout" } } } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } }, "503": { "description": "Service Unavailable: The system is temporarily unavailable to process the request. The request may be retried without modification after a delay.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TechnicalErrorTemporaryUnavailable" } } }, "headers": { "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } } } }, "callbacks": { "payment.transaction.refunded": { "klarna-webhook": { "description": "Webhook notification delivered when the payment transaction is refunded", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction refunded", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.refunded" }, "examples": { "Payment transaction refunded webhook": { "$ref": "#/components/examples/Payment_transaction_refunded_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/refunds/{payment_refund_id}": { "get": { "tags": ["Payment Transaction API"], "operationId": "readPaymentRefund", "summary": "Read Payment Refund", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Request to retrieve the details of a payment refund.\nA payment refund encapsulates crucial details such as the refund amount and line items.

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that read payment transactions, such as retrieving payment transaction details.Read-only Payment Transaction\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_refund_id", "in": "path", "required": true, "description": "The unique identifier of the payment refund.\n", "schema": { "$ref": "#/components/schemas/PaymentRefundId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Payment refund has been successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentRefundResponseBody" }, "examples": { "Payment refund performed on a transaction has been successfully retrieved.": { "$ref": "#/components/examples/Payment_transaction_refund_response" }, "Payment refund performed on a capture has been successfully retrieved.": { "$ref": "#/components/examples/Payment_capture_refund_response" } } } }, "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/payment/chargebacks/{payment_chargeback_id}": { "get": { "tags": ["Payment Transaction API"], "operationId": "readPaymentChargeback", "summary": "Read Payment Chargeback", "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Request to retrieve the details of a payment chargeback.\nA payment chargeback encapsulates crucial details such as the chargeback amount and chargeback reason.

Learn more about Read and update a Payment Transaction

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that read payment transactions, such as retrieving payment transaction details.Read-only Payment Transaction\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed to manage a payment, and some optional operations for a payment capture.Payment Transaction Management\n

", "parameters": [{ "name": "payment_chargeback_id", "in": "path", "required": true, "description": "The unique identifier of the payment chargeback.\n", "schema": { "$ref": "#/components/schemas/PaymentChargebackId" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Payment chargeback has been successfully retrieved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentChargebackResponseBody" }, "examples": { "Payment chargeback was created due to a dispute loss for the merchant.": { "$ref": "#/components/examples/Payment_chargeback_created_response_as_a_result_of_dispute_merchant_loss" }, "Payment chargeback was created due to a payment default.": { "$ref": "#/components/examples/Payment_chargeback_created_response_as_a_result_of_payment_default" } } } }, "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" } } } }, "callbacks": { "payment.transaction.chargeback": { "klarna-webhook": { "description": "Webhook notification delivered when a payment chargeback is created.", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction chargeback", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.chargeback" }, "examples": { "Payment transaction chargeback webhook": { "$ref": "#/components/examples/Payment_transaction_chargeback_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } } } } } }, "/v2/payment/presentation": { "get": { "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Retrieve Klarna payment presentation elements to display Klarna as a payment option in your checkout. Use this action when you need to obtain headers, subheaders, badges, and payment button elements for your payment selection interface. Klarna processes your request with the provided amount, currency, and locale to generate customized presentation content. Klarna returns tailored presentation elements with appropriate messaging, icons, and display instructions for optimal customer experience.

Acquiring configuration: Required for Acquiring Partners with multiple Payment Accounts. For Partners with a single Payment Account, omitting acquiring_config is allowed — Klarna automatically uses the only available Payment Account. Provide either acquiring_config[payment_acquiring_account_id] + acquiring_config[payment_account_reference] (Acquiring Account Reference) or acquiring_config[payment_account_id] alone (Payment Account ID) — not both.

Learn more about Integrate Payment Presentation and Build Payment Presentation with the Payment Presentation API

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

\n \n SLO Category:\n The SLO Service Category.\n \n Operations that support personalized payment messaging, including customized options and descriptors.Personalized Message Placements\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 10000 ms\n

\n \n Ratelimit Category:\n The Ratelimit Category.\n \n Operations needed for presenting Klarna as a payment method across the checkout.Payment Presentation\n

", "summary": "Retrieve Klarna payment presentation elements", "tags": ["Payment Presentation API"], "operationId": "getPresentationAPI", "parameters": [{ "name": "locale", "in": "query", "required": true, "description": "Specify the locale for the payment presentation elements. Klarna generates appropriately localized content based on this value.\n", "schema": { "$ref": "#/components/schemas/Locale" } }, { "name": "currency", "in": "query", "required": true, "description": "Specify the ISO 4217 currency code for the payment transaction. The currency must match the native currency of the locale's country — multi-currency conversion is not supported.\n", "x-validation-info": "Currency must match the native currency of the locale's country. Multi-currency conversion is not supported.", "schema": { "$ref": "#/components/schemas/Currency" } }, { "$ref": "#/components/parameters/KlarnaIntegrationMetadata" }, { "$ref": "#/components/parameters/PartnerCorrelationIdRequest" }, { "$ref": "#/components/parameters/KlarnaWorkloadType" }], "responses": { "200": { "description": "Successful response", "headers": { "Cache-Control": { "$ref": "#/components/headers/CacheControl" }, "Partner-Correlation-Id": { "$ref": "#/components/headers/PartnerCorrelationIdResponse" }, "Klarna-Correlation-Id": { "$ref": "#/components/headers/KlarnaCorrelationId" }, "Klarna-Service-Level-Category": { "$ref": "#/components/headers/KlarnaServiceLevelCategory" } }, "content": { "application/json": { "schema": { "type": "object", "properties": {} }, "examples": { "default-presentation-api": { "$ref": "#/components/examples/PaymentPresentationDefaultResponse" }, "presentation-api-with-token": { "$ref": "#/components/examples/PaymentPresentationWithTokenResponse" } } } } }, "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" } } } } } } }, "webhooks": { "payment.request.state-change": { "description": "Webhook delivered when the payment request changes state", "post": { "tags": ["Payment Request API"], "summary": "Payment request state changed", "operationId": "paymentRequestStateChangeEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.request.state-change" }, "examples": { "Payment request submitted webhook": { "$ref": "#/components/examples/Payment_request_submitted_webhook" }, "Payment request in-progress webhook": { "$ref": "#/components/examples/Payment_request_in-progress_webhook" }, "Payment request completed webhook": { "$ref": "#/components/examples/Payment_request_completed_webhook" }, "Payment request canceled webhook": { "$ref": "#/components/examples/Payment_request_canceled_webhook" }, "Payment request expired webhook": { "$ref": "#/components/examples/Payment_request_expired_webhook" }, "Payment request declined webhook": { "$ref": "#/components/examples/Payment_request_declined_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.request.updated": { "description": "Webhook delivered when the payment request is updated", "post": { "tags": ["Payment Request API"], "summary": "Payment request updated", "operationId": "paymentRequestUpdatedEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.request.updated" }, "examples": { "Payment request updated": { "$ref": "#/components/examples/Payment_request_updated_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.transaction.updated": { "description": "Webhook notification delivered when the payment transaction is updated", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction updated", "operationId": "paymentTransactionUpdatedEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.updated" }, "examples": { "Payment transaction updated webhook": { "$ref": "#/components/examples/Payment_transaction_updated_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.transaction.state-change": { "description": "Webhook delivered when the payment transaction changes state", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction state changed", "operationId": "paymentTransactionStateChangeEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.state-change" }, "examples": { "Payment transaction authorized webhook": { "$ref": "#/components/examples/Payment_transaction_authorized_webhook" }, "Payment transaction completed webhook": { "$ref": "#/components/examples/Payment_transaction_completed_webhook" }, "Payment transaction expired webhook": { "$ref": "#/components/examples/Payment_transaction_expired_webhook" }, "Payment transaction closed webhook": { "$ref": "#/components/examples/Payment_transaction_closed_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.transaction.captured": { "description": "Webhook notification delivered when the payment transaction is captured", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction captured", "operationId": "paymentTransactionCapturedEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.captured" }, "examples": { "Payment transaction captured webhook": { "$ref": "#/components/examples/Payment_transaction_captured_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.transaction.refunded": { "description": "Webhook notification delivered when the payment transaction is refunded", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction refunded", "operationId": "paymentTransactionRefundedEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.refunded" }, "examples": { "Payment transaction refunded webhook": { "$ref": "#/components/examples/Payment_transaction_refunded_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.transaction.chargeback": { "description": "Webhook notification delivered when a payment chargeback is created.", "post": { "tags": ["Payment Transaction API"], "summary": "Payment transaction chargeback", "operationId": "paymentTransactionChargebackEvent", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.transaction.chargeback" }, "examples": { "Payment transaction chargeback webhook": { "$ref": "#/components/examples/Payment_transaction_chargeback_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } }, "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

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

" } }, "payment.funding.state-change": { "post": { "tags": ["Payment Transaction API"], "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Webhook notification delivered when the payment transaction has been funded (important for non-guaranteed payment transactions).

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

", "operationId": "paymentFundingStateChangeWebhook", "summary": "Payment funding state changed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/payment.funding.state-change" }, "examples": { "Payment funding pending webhook": { "$ref": "#/components/examples/Payment_funding_pending_webhook" }, "Payment funding funded webhook": { "$ref": "#/components/examples/Payment_funding_funded_webhook" }, "Payment funding expired webhook": { "$ref": "#/components/examples/Payment_funding_expired_webhook" } } } } }, "responses": { "200": { "description": "Webhook accepted" } } } }, "payment.card-settlement.card.authorized": { "post": { "tags": ["Card Settlements API"], "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Webhook notification delivered when the card issued for settlement has been authorized.

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

", "operationId": "paymentCardSettlementCardAuthorized", "summary": "Card authorized for settlement", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": {} }, "responses": { "200": { "description": "Webhook accepted" } } } }, "payment.card-settlement.card.authorization-reversed": { "post": { "tags": ["Card Settlements API"], "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Webhook notification delivered when an authorization on the card, which was issued for settlement, has been reversed.

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

", "operationId": "paymentCardSettlementCardAuthorizationReversed", "summary": "Card authorization reversed", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": {} }, "responses": { "200": { "description": "Webhook accepted" } } } }, "payment.card-settlement.card.captured": { "post": { "tags": ["Card Settlements API"], "description": "

General AvailabilityFully available for general use of Klarna Partners

Direct PartnerPartners who offer Klarna’s payment solutions through a direct agreement with Klarna.

Webhook notification delivered when the card issued for settlement has been captured.

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

", "operationId": "paymentCardSettlementCardCaptured", "summary": "Card captured for settlement", "parameters": [{ "name": "Klarna-Signature", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSignature" } }, { "name": "Klarna-Signing-Key-ID", "in": "header", "required": true, "schema": { "$ref": "#/components/schemas/WebhookHeaderKlarnaSigningKeyID" } }], "requestBody": { "required": true, "content": {} }, "responses": { "200": { "description": "Webhook accepted" } } } } } } }; 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."); }