Klarna · Schema
order
FintechBuy Now Pay LaterPaymentsCardsShoppingBankingCheckoutOrder ManagementSettlementOpen BankingPSD2Consumer CreditSwedenAgentic CommerceConsumer Finance
Properties
| Name | Type | Description |
|---|---|---|
| order_id | string | Unique order ID that will be used for the entire lifecycle of the order. (max 255 characters) |
| name | string | The merchant name (max 255 characters). |
| purchase_country | string | The purchase country of the merchant's store. The format to be used is ISO 3166 alpha-2. Eg: GB, SE, DE, US, etc. Note: purchase country and currency need to match the defined merchant configuration. |
| purchase_currency | string | The purchase currency of the merchant's store. The format to be used is ISO 4217. Eg: USD, EUR, SEK, GBP, etc. Note: purchase country and currency need to match the defined merchant configuration. For |
| locale | string | Used to define the language and region of the customer. RFC 1766 customer's locale. |
| status | string | The current status of the order. The status will be incomplete until the customer has been successfully authorized. |
| billing_address | object | |
| shipping_address | object | |
| order_amount | integer | Total amount of the order including tax and any available discounts. The value should be in non-negative minor units. Example: 25 Euros should be 2500. |
| order_tax_amount | integer | Total tax amount of the order. The value should be in non-negative minor units. Example: 25 Euros should be 2500. |
| order_lines | array | An array containing list of line items that are part of this order. Maximum of 1000 line items could be processed in a single order. |
| customer | object | |
| merchant_urls | object | |
| html_snippet | string | The HTML snippet that is used to render the checkout in an iframe. |
| merchant_reference1 | string | Used for storing merchant's internal order number or other reference. If set, will be shown on the confirmation page as "order number" . The value is also available in the settlement files. (max 255 c |
| merchant_reference2 | string | Used for storing merchant's internal order number or other reference. The value is available in the settlement files. (max 255 characters). Example: "45aa52f387871e3a210645d4" |
| started_at | string | ISO 8601 datetime. The date and time when the order has been created. The format will be as follows: "yyyy-mm-ddThh:mm:ssZ" |
| completed_at | string | ISO 8601 datetime. The date and time when the order has been completed. The format will be as follows: "yyyy-mm-ddThh:mm:ssZ" |
| last_modified_at | string | ISO 8601 datetime. The date and time when the order was last modified. The format will be as follows: "yyyy-mm-ddThh:mm:ssZ" |
| options | object | |
| attachment | object | |
| external_payment_methods | array | List of external payment methods that will be displayed as part of payment methods in the checkout. |
| external_checkouts | array | List of external checkouts that will be displayed as part of payment methods in the checkout. The image_url is required, and the image size has to be 276x48px |
| shipping_countries | array | List of allowed shipping countries for this order in ISO-3166 alpha-2 format. If specified, the customer will be able to change the shipping country in the checkout and you will be notified through ad |
| shipping_options | array | A list of shipping options available for this order. |
| merchant_data | string | Pass through field to send any information about the order to be used later for reference while retrieving the order details (max 6000 characters). |
| gui | object | |
| merchant_requested | object | |
| selected_shipping_option | object | |
| recurring | boolean | Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false Depending on specified |
| recurring_token | string | Token to be used when creating recurring orders. |
| recurring_description | string | Description to be added to the recurring order. |
| billing_countries | array | List of allowed billing countries for this order. If specified, the customer will be able to change the billing country in the checkout and you will be notified through country_change callback or the |
| tags | array | Extra information added to the order. Example: ["dangerous_goods", "bulky"] |
| discount_lines | array | List of discounts applied to this order via the KCO discount-service |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/klarna/main/json-schema/klarna-order-schema.json",
"title": "order",
"x-generated": "2026-10-12",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/klarna-checkout-api-openapi.yml#/components/schemas/order",
"type": "object",
"required": [
"locale",
"order_amount",
"order_lines",
"order_tax_amount",
"purchase_country",
"purchase_currency"
],
"properties": {
"order_id": {
"type": "string",
"description": "Unique order ID that will be used for the entire lifecycle of the order. (max 255 characters)",
"readOnly": true
},
"name": {
"type": "string",
"description": "The merchant name (max 255 characters).",
"readOnly": true
},
"purchase_country": {
"type": "string",
"description": "The purchase country of the merchant's store. The format to be used is ISO 3166 alpha-2. Eg: GB, SE, DE, US, etc. \n\nNote: purchase country and currency need to match the defined merchant configuration. For global configuration see more details [here](https://docs.klarna.com/kco/use-cases/selling-to-multiple-countries/)",
"pattern": "^[A-Za-z]{2,2}$"
},
"purchase_currency": {
"type": "string",
"description": "The purchase currency of the merchant's store. The format to be used is ISO 4217. Eg: USD, EUR, SEK, GBP, etc.\n\nNote: purchase country and currency need to match the defined merchant configuration. For global configuration see more details [here](https://docs.klarna.com/kco/use-cases/selling-to-multiple-countries/)",
"pattern": "^[A-Za-z]{3,3}$"
},
"locale": {
"type": "string",
"description": "Used to define the language and region of the customer. RFC 1766 customer's locale.",
"pattern": "^[A-Za-z]{2,2}(?:-[A-Za-z]{2,2})*$"
},
"status": {
"type": "string",
"description": "The current status of the order. The status will be incomplete until the customer has been successfully authorized."
},
"billing_address": {
"$ref": "#/$defs/address"
},
"shipping_address": {
"$ref": "#/$defs/address"
},
"order_amount": {
"type": "integer",
"format": "int64",
"description": "Total amount of the order including tax and any available discounts. The value should be in non-negative minor units.\n\nExample: 25 Euros should be 2500.",
"minimum": 0
},
"order_tax_amount": {
"type": "integer",
"format": "int64",
"description": "Total tax amount of the order. The value should be in non-negative minor units.\n\nExample: 25 Euros should be 2500.",
"minimum": 0
},
"order_lines": {
"type": "array",
"description": "An array containing list of line items that are part of this order. Maximum of 1000 line items could be processed in a single order.",
"items": {
"$ref": "#/$defs/order_line"
},
"maxItems": 1000,
"minItems": 0
},
"customer": {
"$ref": "#/$defs/customer"
},
"merchant_urls": {
"$ref": "#/$defs/merchant_urls"
},
"html_snippet": {
"type": "string",
"description": "The HTML snippet that is used to render the checkout in an iframe.",
"readOnly": true
},
"merchant_reference1": {
"type": "string",
"description": "Used for storing merchant's internal order number or other reference. If set, will be shown on the confirmation page as \"order number\" . The value is also available in the settlement files. (max 255 characters).\nExample: \"45aa52f387871e3a210645d4\"",
"minLength": 0,
"maxLength": 255
},
"merchant_reference2": {
"type": "string",
"description": "Used for storing merchant's internal order number or other reference. The value is available in the settlement files. (max 255 characters).\nExample: \"45aa52f387871e3a210645d4\"",
"minLength": 0,
"maxLength": 255
},
"started_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 datetime. The date and time when the order has been created. The format will be as follows:\n\"yyyy-mm-ddThh:mm:ssZ\"",
"readOnly": true
},
"completed_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 datetime. The date and time when the order has been completed. The format will be as follows:\n\"yyyy-mm-ddThh:mm:ssZ\"",
"readOnly": true
},
"last_modified_at": {
"type": "string",
"format": "date-time",
"description": "ISO 8601 datetime. The date and time when the order was last modified. The format will be as follows:\n\"yyyy-mm-ddThh:mm:ssZ\"",
"readOnly": true
},
"options": {
"$ref": "#/$defs/options"
},
"attachment": {
"$ref": "#/$defs/attachment"
},
"external_payment_methods": {
"type": "array",
"description": "List of external payment methods that will be displayed as part of payment methods in the checkout.",
"items": {
"$ref": "#/$defs/payment_provider"
}
},
"external_checkouts": {
"type": "array",
"description": "List of external checkouts that will be displayed as part of payment methods in the checkout.\nThe image_url is required, and the image size has to be 276x48px",
"items": {
"$ref": "#/$defs/payment_provider"
}
},
"shipping_countries": {
"type": "array",
"description": "List of allowed shipping countries for this order in ISO-3166 alpha-2 format.\n\nIf specified, the customer will be able to change the shipping country in the checkout and you will be notified through address_update callback or the shipping_address_change javascript event. \n\nIf not specified then the default value will be the purchase country.\n\nExample: look at billing_countries example.",
"items": {
"type": "string"
}
},
"shipping_options": {
"type": "array",
"description": "A list of shipping options available for this order.",
"items": {
"$ref": "#/$defs/shipping_option"
}
},
"merchant_data": {
"type": "string",
"description": "Pass through field to send any information about the order to be used later for reference while retrieving the order details (max 6000 characters).",
"minLength": 0,
"maxLength": 6000
},
"gui": {
"$ref": "#/$defs/gui"
},
"merchant_requested": {
"$ref": "#/$defs/merchant_requested"
},
"selected_shipping_option": {
"$ref": "#/$defs/shipping_option"
},
"recurring": {
"type": "boolean",
"description": "Indicates whether this purchase will create a token that can be used by the merchant to create recurring purchases. This must be enabled for the merchant to use. Default: false\n\nDepending on specified country, recurring could be used for the following payment methods: Pay Later, Direct Debit, Card."
},
"recurring_token": {
"type": "string",
"description": "Token to be used when creating recurring orders.",
"readOnly": true
},
"recurring_description": {
"type": "string",
"description": "Description to be added to the recurring order.",
"readOnly": true,
"minLength": 0,
"maxLength": 255
},
"billing_countries": {
"type": "array",
"description": "List of allowed billing countries for this order.\nIf specified, the customer will be able to change the billing country in the checkout and you will be notified through country_change callback or the billing_address_change javascript event.\nIf not specified but shipping_countries is specified, will use same values as shipping_countries.\nIf not specified and shipping_countries is not specified, then the default value will be the purchase country.\n\nExample: [\"AD\", \"AE\", \"AG\", \"AI\", \"AL\", \"AM\", \"AQ\", \"AR\", \"AS\", \"AT\", \"AU\", \"AW\", \"AX\", \"AZ\", \"BA\", \"BB\", \"BD\", \"BE\", \"BF\", \"BG\", \"BH\", \"BJ\", \"BL\", \"BM\", \"BN\", \"BO\", \"BQ\", \"BR\", \"BS\", \"BT\", \"BW\", \"BY\", \"BZ\", \"CA\", \"CF\", \"CH\", \"CI\", \"CK\", \"CL\", \"CM\", \"CN\", \"CO\", \"CR\", \"CU\", \"CV\", \"CW\", \"CX\", \"CY\", \"CZ\", \"DE\", \"DJ\", \"DK\", \"DM\", \"DO\", \"DZ\", \"EC\", \"EE\", \"EG\", \"ER\", \"ES\", \"ET\", \"FI\", \"FJ\", \"FK\", \"FM\", \"FO\", \"FR\", \"GA\", \"GB\", \"GD\", \"GE\", \"GF\", \"GG\", \"GH\", \"GI\", \"GL\", \"GM\", \"GN\", \"GP\", \"GR\", \"GS\", \"GT\", \"GU\", \"GY\", \"HK\", \"HN\", \"HR\", \"HU\", \"ID\", \"IE\", \"IL\", \"IM\", \"IN\", \"IS\", \"IT\", \"JE\", \"JM\", \"JO\", \"JP\", \"KE\", \"KG\", \"KI\", \"KM\", \"KN\", \"KR\", \"KW\", \"KY\", \"KZ\", \"LA\", \"LA\", \"LB\", \"LC\", \"LI\", \"LK\", \"LR\", \"LS\", \"LT\", \"LU\", \"LV\", \"MA\", \"MC\", \"MD\", \"ME\", \"MF\", \"MG\", \"MH\", \"MK\", \"MK\", \"ML\", \"MM\", \"MN\", \"MO\", \"MP\", \"MQ\", \"MR\", \"MT\", \"MU\", \"MV\", \"MW\", \"MX\", \"MY\", \"MZ\", \"NA\", \"NC\", \"NE\", \"NF\", \"NG\", \"NI\", \"NL\", \"NO\", \"NP\", \"NR\", \"NU\", \"NZ\", \"OM\", \"PA\", \"PE\", \"PF\", \"PG\", \"PH\", \"PK\", \"PL\", \"PM\", \"PR\", \"PS\", \"PT\", \"PW\", \"PY\", \"QA\", \"RE\", \"RO\", \"RS\", \"RU\", \"RW\", \"SA\", \"SB\", \"SC\", \"SE\", \"SG\", \"SH\", \"SI\", \"SJ\", \"SK\", \"SL\", \"SM\", \"SN\", \"SR\", \"ST\", \"SV\", \"SX\", \"SZ\", \"TC\", \"TF\", \"TG\", \"TH\", \"TJ\", \"TK\", \"TL\", \"TO\", \"TR\", \"TT\", \"TV\", \"TW\", \"TZ\", \"UA\", \"UG\", \"UM\", \"US\", \"UY\", \"UZ\", \"VA\", \"VC\", \"VG\", \"VI\", \"VN\", \"VU\", \"WF\", \"WS\", \"XK\", \"YT\", \"ZA\", \"ZM\", \"ZW\"]\"",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"description": "Extra information added to the order.\n\nExample: [\"dangerous_goods\", \"bulky\"]",
"items": {
"type": "string"
}
},
"discount_lines": {
"type": "array",
"description": "List of discounts applied to this order via the KCO discount-service",
"items": {
"$ref": "#/$defs/discount_line"
}
}
},
"$defs": {
"DeliveryDetailsV1": {
"type": "object",
"properties": {
"carrier": {
"type": "string",
"description": "Carrier product name"
},
"class": {
"type": "string",
"description": "Type of shipping class"
},
"product": {
"$ref": "#/$defs/ProductV1"
},
"timeslot": {
"$ref": "#/$defs/TimeslotV1"
},
"pickup_location": {
"$ref": "#/$defs/PickupLocationV1"
}
}
},
"PickupLocationV1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id"
},
"name": {
"type": "string",
"description": "Name of the location"
},
"address": {
"$ref": "#/$defs/address"
}
}
},
"ProductV1": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Carrier product name"
},
"identifier": {
"type": "string",
"description": "Carrier product identifier"
}
}
},
"TimeslotV1": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Id"
},
"start": {
"type": "string",
"description": "Start time"
},
"end": {
"type": "string",
"description": "End time"
}
}
},
"address": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "Given name."
},
"family_name": {
"type": "string",
"description": "Family name."
},
"email": {
"type": "string",
"description": "E-mail address."
},
"title": {
"type": "string",
"description": "Title.<p>Valid values for UK:</p><ul><li><em>Mr</em></li><li><em>Ms</em></li><li><em>Mrs</em></li><li><em>Miss</em></li></ul><p>Valid values for DACH:</p><ul><li><em>Herr</em></li><li><em>Frau</em></li></ul><p>Valid values for NL:</p><ul><li><em>Dhr.</em></li><li><em>Mevr.</em></li></ul>"
},
"street_address": {
"type": "string",
"description": "Street address, first line. (Street name and number)"
},
"street_address2": {
"type": "string",
"description": "Street address, second line. (Apartment number, suite, etc.)"
},
"street_name": {
"type": "string",
"description": "Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See <b>streetNumber</b>."
},
"street_number": {
"type": "string",
"description": "Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See <b>streetName</b>."
},
"house_extension": {
"type": "string",
"description": "House extension. Only applicable in NL"
},
"postal_code": {
"type": "string",
"description": "Postal/post code."
},
"city": {
"type": "string",
"description": "City."
},
"region": {
"type": "string",
"description": "State or Region."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"country": {
"type": "string",
"description": "ISO 3166 alpha-2. Country."
},
"care_of": {
"type": "string",
"description": "Care of."
}
}
},
"attachment": {
"type": "object",
"required": [
"body",
"content_type"
],
"properties": {
"body": {
"type": "string",
"description": "The content of the extra merchant data which should be presented as a string inside this property. The body should be an object containing any of the keys and sub objects described below serialised to JSON. More information on that object can be found [here](https://docs.klarna.com/api/extra-merchant-data)."
},
"content_type": {
"type": "string",
"description": "The content type of the body. It is usually represented as \"application/vnd.klarna.internal.emd-v2+json\""
}
}
},
"checkbox": {
"type": "object",
"required": [
"checked",
"required",
"text"
],
"properties": {
"text": {
"type": "string",
"description": "Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)"
},
"checked": {
"type": "boolean",
"description": "Default state of the additional checkbox. It will use this value when loaded for the first time."
},
"required": {
"type": "boolean",
"description": "Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase."
}
}
},
"checkbox-v2": {
"type": "object",
"required": [
"checked",
"id",
"required",
"text"
],
"properties": {
"text": {
"type": "string",
"description": "Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)"
},
"checked": {
"type": "boolean",
"description": "Default state of the additional checkbox. It will use this value when loaded for the first time."
},
"required": {
"type": "boolean",
"description": "Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase."
},
"id": {
"type": "string",
"description": "Identifier used when presenting data back to merchant"
}
}
},
"customer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The default supported value is 'person'. If B2B is enabled for the merchant, the value may be \"organization\"."
},
"gender": {
"type": "string",
"description": "Customers gender - male or female."
},
"date_of_birth": {
"type": "string",
"description": "Customers date of birth. The format is yyyy-mm-dd. ISO 8601 date."
},
"organization_registration_id": {
"type": "string",
"description": "\"The organization's official registration id (organization number).\n\nNote: Applicable only for B2B orders.\""
},
"vat_id": {
"type": "string",
"description": "Organization VAT ID. Only applies for b2b orders."
}
}
},
"dimensions": {
"type": "object",
"properties": {
"height": {
"type": "integer",
"format": "int64",
"description": "The product's height as used in the merchant's webshop. Non-negative. Measured in millimeters."
},
"width": {
"type": "integer",
"format": "int64",
"description": "The product's width as used in the merchant's webshop. Non-negative. Measured in millimeters."
},
"length": {
"type": "integer",
"format": "int64",
"description": "The product's length as used in the merchant's webshop. Non-negative. Measured in millimeters."
}
}
},
"discount_line": {
"type": "object",
"required": [
"name",
"quantity",
"tax_rate",
"total_amount",
"total_tax_amount",
"unit_price"
],
"properties": {
"name": {
"type": "string",
"description": "Descriptive name of discount",
"minLength": 1,
"maxLength": 255
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "Non-negative number. Quantity of the discount line item.",
"minimum": 0
},
"unit_price": {
"type": "integer",
"format": "int64",
"description": "Minor units. Includes tax, excludes discount. (Must be non-positive).\n\nExample: -100 Euros should be -10000.",
"maximum": 0
},
"tax_rate": {
"type": "integer",
"format": "int64",
"description": "Non-negative value. The percentage value is represented with two implicit decimals. (max 10000)\n\nExample: 25% should be 2500.",
"maximum": 10000
},
"total_amount": {
"type": "integer",
"format": "int64",
"description": "Minor units. Includes tax and discount. \n\nExample: -25 euros should be -2500\nValue = (quantity x unit_price).\n(Must be non-positive)",
"maximum": 0
},
"total_tax_amount": {
"type": "integer",
"format": "int64",
"description": "Must be within �1 of total_amount - total_amount \\* 10000 / (10000 + tax_rate). Should be non-positive"
},
"reference": {
"type": "string",
"description": "The CRM reference to the gift-card that was entered by the user",
"minLength": 0,
"maxLength": 255
},
"merchant_data": {
"type": "string",
"description": "The gift-card number that was entered by the user",
"minLength": 0,
"maxLength": 1024
}
}
},
"gui": {
"type": "object",
"properties": {
"options": {
"type": "array",
"description": "An array of options to define the checkout behaviour. Supported options: minimal_confirmation.\n\nThe gui object is an array of options to modify checkout client ui behaviours. \n\nExamples: [\"minimal_confirmation\"]",
"items": {
"type": "string"
}
}
}
},
"merchant_requested": {
"type": "object",
"properties": {
"additional_checkbox": {
"type": "boolean",
"description": "Informs whether the additional_checkbox is checked or not, when applicable.",
"readOnly": true
},
"additional_checkboxes": {
"type": "array",
"description": "Informs whether the additional_checkboxes is checked or not, when applicable.",
"readOnly": true,
"items": {
"$ref": "#/$defs/merchant_requested_checkbox"
}
}
}
},
"merchant_requested_checkbox": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"checked": {
"type": "boolean"
}
}
},
"merchant_urls": {
"type": "object",
"required": [
"checkout",
"confirmation",
"push",
"terms"
],
"properties": {
"terms": {
"type": "string",
"description": "URL for the terms and conditions page of the merchant. The URL will be displayed inside the Klarna Checkout iFrame.(max 2000 characters)\nExample: \"https://merchant.com/terms\"",
"minLength": 0,
"maxLength": 2000
},
"checkout": {
"type": "string",
"description": "URL for the checkout page of the merchant. (max 2000 characters)\nExample: \"https://merchant.com/checkout\"",
"minLength": 0,
"maxLength": 2000
},
"confirmation": {
"type": "string",
"description": "URL of the merchant confirmation page. The consumer will be redirected back to the confirmation page if the authorization is successful after the customer clicks on the Place Order button inside checkout. The special characters of the confirmation URL should be encoded, e.g. the \"space\" character should be written as \"%20\". Then, on top of that, the whole confirmation URL should be encoded. E.g. the \"space\" character should become \"%2520\". (max 2000 characters)\nExample: \"https://merchant.com/confirmation\"",
"minLength": 0,
"maxLength": 2000
},
"push": {
"type": "string",
"description": "URL that will be used for push notification when an order is completed. Should be different than checkout and confirmation URLs. (max 2000 characters)\nExample: \"https://merchant.com/push\"",
"minLength": 0,
"maxLength": 2000
},
"validation": {
"type": "string",
"description": "URL that will be requested for final merchant validation. (must be https, max 2000 characters)\nExample: \"https://merchant.com/validation\"",
"minLength": 0,
"maxLength": 2000
},
"notification": {
"type": "string",
"description": "URL for notifications on pending orders. (max 2000 characters)\nExample: \"https://merchant.com/notification/{checkout.order.id}\"",
"minLength": 0,
"maxLength": 2000
},
"cancellation_terms": {
"type": "string",
"description": "URL for the cancellation terms page of the merchant. The URL will be displayed in the email that is sent to the customer after the order is captured.(max 2000 characters)\nExample: \"https://merchant.com/terms/cancelation\"",
"minLength": 0,
"maxLength": 2000
},
"shipping_option_update": {
"type": "string",
"description": "URL for shipping option update. (must be https, max 2000 characters)\nExample: \"https://merchant.com/shippingoptionupdate\"",
"minLength": 0,
"maxLength": 2000
},
"address_update": {
"type": "string",
"description": "URL for shipping, tax and purchase currency updates. Will be called on address changes. (must be https, max 2000 characters)\nExample: \"https://merchant.com/addressupdate\"",
"minLength": 0,
"maxLength": 2000
},
"country_change": {
"type": "string",
"description": "URL for shipping, tax and purchase currency updates. Will be called on billing or shipping country changes. (must be https, max 2000 characters)\nExample: \"https://merchant.com/countrychange\"",
"minLength": 0,
"maxLength": 2000
}
}
},
"options": {
"type": "object",
"properties": {
"require_validate_callback_success": {
"type": "boolean",
"description": "If true, validate callback must get a positive response to not stop purchase. Default: false."
},
"acquiring_channel": {
"type": "string",
"description": "Acquiring channel for the order. The possible values are:\n<ul><li><em>ECOMMERCE for \"E-commerce\"</em></li><li><em>IN_STORE for \"Purchase in boutique\"</em></li><li><em>Default : ECOMMERCE</em></li></ul>",
"pattern": "ECOMMERCE|MOTO|IN_STORE|TELESALES"
},
"vat_removed": {
"type": "boolean",
"description": "If true, VAT is not displayed in Checkout's Order Summary page."
},
"allow_separate_shipping_address": {
"type": "boolean",
"description": "If true, the consumer can enter different billing and shipping addresses. Default: false, except for purchase_country DE where default is: true"
},
"color_button": {
"type": "string",
"description": "Color for the buttons within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"",
"pattern": "^#[A-Fa-f0-9]{6}$"
},
"color_button_text": {
"type": "string",
"description": "Color for the text inside the buttons within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"",
"pattern": "^#[A-Fa-f0-9]{6}$"
},
"color_checkbox": {
"type": "string",
"description": "Color for the checkboxes within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"",
"pattern": "^#[A-Fa-f0-9]{6}$"
},
"color_checkbox_checkmark": {
"type": "string",
"description": "Color for the checkboxes checkmark within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"",
"pattern": "^#[A-Fa-f0-9]{6}$"
},
"color_header": {
"type": "string",
"description": "Color for the headers within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"",
"pattern": "^#[A-Fa-f0-9]{6}$"
},
"color_link": {
"type": "string",
"description": "Color for the hyperlinks within the iFrame. Value should be a CSS hex color, e.g. \"#FF9900\"",
"pattern": "^#[A-Fa-f0-9]{6}$"
},
"date_of_birth_mandatory": {
"type": "boolean",
"description": "If true, the consumer cannot skip date of birth. Default: false"
},
"shipping_details": {
"type": "string",
"description": "A message that will be presented on the confirmation page under the headline \"Delivery\" (max 255 characters)."
},
"title_mandatory": {
"type": "boolean",
"description": "If specified to false, title becomes optional. Only available for orders for country GB."
},
"additional_checkbox": {
"$ref": "#/$defs/checkbox"
},
"national_identification_number_mandatory": {
"type": "boolean",
"description": "If true, the user cannot skip national identification number in SE, NO, FI and DK. Default: false. In order to read the national identification number in the validation callback, please contact Klarnas merchant support."
},
"additional_merchant_terms": {
"type": "string",
"description": "Additional merchant defined field. e.g. Extra terms and conditions to show.\n\nExample: \"ADDITIONAL MERCHANT TERMS! \\[terms link\\](https://merchant.com/extra_terms)\""
},
"phone_mandatory": {
"type": "boolean",
"description": "If false, the consumer can skip the phone. Only available for orders in DACH countries."
},
"radius_border": {
"type": "string",
"description": "Radius for the border of elements within the iFrame."
},
"allowed_customer_types": {
"type": "array",
"description": "A list of allowed customer types. Supported types: <b>person</b> & <b>organization</b>.\nExample: [\"person\",\"organization\"]",
"items": {
"type": "string"
},
"maxItems": 2,
"minItems": 1
},
"show_subtotal_detail": {
"type": "boolean",
"description": "If true, the Order Detail subtotals view is expanded when the Klarna Checkout iFrame is loaded. Default: false"
},
"additional_checkboxes": {
"type": "array",
"items": {
"$ref": "#/$defs/checkbox-v2"
}
},
"verify_national_identification_number": {
"type": "boolean",
"description": "Enable verification of National Identification Numbers only in Sweden and Norway. This option also make the national identification number mandatory. (Not applicable for countries outside of Sweden and Norway)"
},
"auto_capture": {
"type": "boolean",
"description": "Allow merchant to trigger auto capturing."
},
"require_client_validation": {
"type": "boolean",
"description": "If true, a client side validation is needed to complete the purchase"
},
"enable_discount_module": {
"type": "boolean",
"description": "Enables the inline discount module"
},
"show_vat_registration_number_field": {
"type": "boolean",
"description": "If true, a optional VAT registration number field will be shown in the address form. Only applies for b2b orders."
}
}
},
"order_line": {
"type": "object",
"required": [
"name",
"quantity",
"tax_rate",
"total_amount",
"total_tax_amount",
"unit_price"
],
"properties": {
"type": {
"type": "string",
"description": "Type of the order line item. The possible values are:<ul><li><em>physical (physical good)</em></li><li><em>discount</em></li><li><em>shipping_fee</em></li><li><em>sales_tax (depends on the country/city, usually called VAT)</em></li><li><em>digital (digital good)</em></li><li><em>gift_card</em></li><li><em>store_credit (credit from the merchant)</em></li><li><em>surcharge (extra charge)</em></li></ul>"
},
"reference": {
"type": "string",
"description": "Article number, SKU or similar. (max 255 characters)",
"minLength": 0,
"maxLength": 255
},
"name": {
"type": "string",
"description": "Descriptive name of the order line item (max 255 characters)",
"minLength": 1,
"maxLength": 255
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "Non-negative number. Quantity of the order line item.",
"minimum": 0
},
"subscription": {
"$ref": "#/$defs/subscription"
},
"quantity_unit": {
"type": "string",
"description": "Unit used to describe the quantity, e.g. kg, pcs... If defined has to be 1-8 characters"
},
"unit_price": {
"type": "integer",
"format": "int64",
"description": "Minor units. Includes tax, excludes discount. (max value: 100000000).\n\nExample: 100 Euros should be 10000.",
"maximum": 100000000
},
"tax_rate": {
"type": "integer",
"format": "int64",
"description": "Non-negative value. The percentage value is repres
# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/klarna/refs/heads/main/json-schema/klarna-order-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/klarna-order"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.