1.0.0

1.3.0 1.0.0-rc2

2.0.0

3.0.0

Street address, first line. (Street name and number)

Street address, second line. (Apartment number, suite, etc.)

Street name. Only applicable in DE/AT/NL. Do not combine with street_address. See streetNumber.

Street number. Only applicable in DE/AT/NL. Do not combine with street_address. See streetName.

Title.Valid values for UK:<ul><li>Mr</li><li>Ms</li><li>Mrs</li><li>Miss</li></ul>Valid values for DACH:<ul><li>Herr</li><li>Frau</li></ul>Valid values for NL:<ul><li>Dhr.</li><li>Mevr.</li></ul>

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).

The content type of the body. It is usually represented as "application/vnd.klarna.internal.emd-v2+json"

Default state of the additional checkbox. It will use this value when loaded for the first time.

Whether it is required for the consumer to check the additional checkbox box or not in order to complete the purchase.

Text that will be displayed to the consumer aside the checkbox. Links and formatting can be added using Markdown. (max 1000 characters)

Identifier used when presenting data back to merchant

Customer’s date of birth. The format is ‘yyyy-mm-dd’. ISO 8601 date.

Customer’s gender - ‘male’ or ‘female’.

"The organization's official registration id (organization number).

Note: Applicable only for B2B orders."

The default supported value is 'person'. If B2B is enabled for the merchant, the value may be "organization".

Organization VAT ID. Only applies for b2b orders.

The product's height as used in the merchant's webshop. Non-negative. Measured in millimeters.

The product's length as used in the merchant's webshop. Non-negative. Measured in millimeters.

The product's width as used in the merchant's webshop. Non-negative. Measured in millimeters.

The gift-card number that was entered by the user

Non-negative number. Quantity of the discount line item.

The CRM reference to the gift-card that was entered by the user

Non-negative value. The percentage value is represented with two implicit decimals. (max 10000)

Example: 25% should be 2500.

Minor units. Includes tax and discount. 

Example: -25 euros should be -2500
Value = (quantity x unit_price).
(Must be non-positive)

Must be within ±1 of total_amount - total_amount \* 10000 / (10000 + tax_rate). Should be non-positive

Minor units. Includes tax, excludes discount. (Must be non-positive).

Example: -100 Euros should be -10000.

An array of options to define the checkout behaviour. Supported options: minimal_confirmation.

The gui object is an array of options to modify checkout client ui behaviours. 

Examples: ["minimal_confirmation"]

Informs whether the additional_checkbox is checked or not, when applicable.

Informs whether the additional_checkboxes is checked or not, when applicable.

URL for shipping, tax and purchase currency updates. Will be called on address changes. (must be https, max 2000 characters)
Example: "https://merchant.com/addressupdate"

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)
Example: "https://merchant.com/terms/cancelation"

URL for the checkout page of the merchant. (max 2000 characters)
Example: "https://merchant.com/checkout"

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)
Example: "https://merchant.com/confirmation"

URL for shipping, tax and purchase currency updates. Will be called on billing or shipping country changes. (must be https, max 2000 characters)
Example: "https://merchant.com/countrychange"

URL for notifications on pending orders. (max 2000 characters)
Example: "https://merchant.com/notification/{checkout.order.id}"

URL that will be used for push notification when an order is completed. Should be different than checkout and confirmation URLs. (max 2000 characters)
Example: "https://merchant.com/push"

URL for shipping option update. (must be https, max 2000 characters)
Example: "https://merchant.com/shippingoptionupdate"

URL for the terms and conditions page of the merchant. The URL will be displayed inside the Kustom Checkout iFrame.(max 2000 characters)
Example: "https://merchant.com/terms"

URL that will be requested for final merchant validation. (must be https, max 2000 characters)
Example: "https://merchant.com/validation"

Acquiring channel for the order. The possible values are:
<ul><li>ECOMMERCE for "E-commerce"</li><li>IN_STORE for "Purchase in boutique"</li><li>Default : ECOMMERCE</li></ul>

Additional merchant defined field. e.g. Extra terms and conditions to show.

Example: "ADDITIONAL MERCHANT TERMS! \[terms link\](https://merchant.com/extra_terms)"

If true, the consumer can enter different billing and shipping addresses. Default: false, except for purchase_country DE where default is: true

A list of allowed customer types. Supported types: person & organization.
Example: ["person","organization"]

Allow merchant to trigger auto capturing.

Color for the buttons within the iFrame. Value should be a CSS hex color, e.g. "#FF9900"

Color for the text inside the buttons within the iFrame. Value should be a CSS hex color, e.g. "#FF9900"

Color for the checkboxes within the iFrame. Value should be a CSS hex color, e.g. "#FF9900"

Color for the checkboxes checkmark within the iFrame. Value should be a CSS hex color, e.g. "#FF9900"

Color for the headers within the iFrame. Value should be a CSS hex color, e.g. "#FF9900"

Color for the hyperlinks within the iFrame. Value should be a CSS hex color, e.g. "#FF9900"

If true, the consumer cannot skip date of birth. Default: false

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 Klarna’s merchant support.

If false, the consumer can skip the phone. Only available for orders in DACH countries.

Radius for the border of elements within the iFrame.

If true, a client side validation is needed to complete the purchase

If true, validate callback must get a positive response to not stop purchase. Default: false.

A message that will be presented on the confirmation page under the headline "Delivery" (max 255 characters).

If true, the Order Detail subtotals view is expanded when the Kustom Checkout iFrame is loaded. Default: false

If true, a optional VAT registration number field will be shown in the address form. Only applies for b2b orders.

If specified to false, title becomes optional. Only available for orders for country GB.

If true, VAT is not displayed in Checkout's Order Summary page.

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)

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 ‘billing_address_change’ javascript event.
If not specified but shipping_countries is specified, will use same values as shipping_countries.
If not specified and shipping_countries is not specified, then the default value will be the purchase country.

Example: ["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"]"

ISO 8601 datetime. The date and time when the order has been completed. The format will be as follows:
"yyyy-mm-ddThh:mm:ssZ"

List of discounts applied to this order via the KCO discount-service

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

List of external payment methods that will be displayed as part of payment methods in the checkout.

The HTML snippet that is used to render the checkout in an iframe.

ISO 8601 datetime. The date and time when the order was last modified. The format will be as follows:
"yyyy-mm-ddThh:mm:ssZ"

Pass through field to send any information about the order to be used later for reference while retrieving the order details (max 6000 characters).

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).
Example: "45aa52f387871e3a210645d4"

Used for storing merchant's internal order number or other reference. The value is available in the settlement files. (max 255 characters).
Example: "45aa52f387871e3a210645d4"

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.

Unique order ID that will be used for the entire lifecycle of the order. (max 255 characters)

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.

Total tax amount of the order. The value should be in non-negative minor units.

Example: 25 Euros should be 2500.

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. For global configuration see more details [here](https://docs.klarna.com/kco/use-cases/selling-to-multiple-countries/)

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 global configuration see more details [here](https://docs.klarna.com/kco/use-cases/selling-to-multiple-countries/)

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 country, recurring could be used for the following payment methods: Pay Later, Direct Debit, Card.

Description to be added to the recurring order.

Token to be used when creating recurring orders.

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 ‘address_update’ callback or the ‘shipping_address_change’ javascript event. 

If not specified then the default value will be the purchase country.

Example: look at billing_countries example.

A list of shipping options available for this order.

ISO 8601 datetime. The date and time when the order has been created. The format will be as follows:
"yyyy-mm-ddThh:mm:ssZ"

The current status of the order. The status will be ‘incomplete’ until the customer has been successfully authorized.

URL to an image that can be later embedded in communications between Klarna and the customer. (max 1024 characters)

Improves post-purchase customer experiences.

Property used to store additional metadata per item that will be returned whenever an order is read from Klarna. Pass through field. (max 1024 characters).

Descriptive name of the order line item (max 255 characters)

URL to the product page that can be later embedded in communications between Klarna and the customer. (max 1024 characters)

Non-negative number. Quantity of the order line item.

Unit used to describe the quantity, e.g. kg, pcs... If defined has to be 1-8 characters

Article number, SKU or similar. (max 255 characters)

Describes the subscription. (Only applicable for recurring orders)

Minor units. Includes tax and discount. 

Example: 25 euros should be 2500
Value = (quantity x unit_price) - total_discount_amount.
(max value: 100000000)

Non-negative minor units. Includes tax.

Example: 25 euros should be 2500

Must be within ±1 of total_amount - total_amount \* 10000 / (10000 + tax_rate). Negative when type is discount.

Type of the order line item. The possible values are:<ul><li>physical (physical good)</li><li>discount</li><li>shipping_fee</li><li>sales_tax (depends on the country/city, usually called VAT)</li><li>digital (digital good)</li><li>gift_card</li><li>store_credit (credit from the merchant)</li><li>surcharge (extra charge)</li></ul>

Minor units. Includes tax, excludes discount. (max value: 100000000).

Example: 100 Euros should be 10000.

If specified, limits the method to the listed countries (alpha 2 codes).

Short description of the payment method. This is displayed below the selected payment method. (max 500 characters)

URL to an image to display. (must be https, max 2000 characters)

Controls label of buy button<ul><li>continue</li><li>complete</li></ul>

The name of the payment provider. (max 255 characters)

URL to redirect to. (must be https, min 7, max 2000 characters)

The product's brand name as generally recognized by consumers. If no brand is available for a product, do not supply any value.

The product's category path as used in the merchant's webshop. Include the full and most detailed category and separate the segments with ' > '. (max 750 characters)

Example: "Electronics Store > Computers & Tablets > Desktops"

Color to be shown to the end customer (max 64 characters).

The product's Global Trade Item Number (GTIN). Common types of GTIN are EAN, ISBN or UPC. Exclude dashes and spaces, where possible

The product's Manufacturer Part Number (MPN), which - together with the brand - uniquely identifies a product. Only submit MPNs assigned by a manufacturer and use the most specific MPN possible

Size to be shown to the end customer (max 64 characters).

The product's weight as used in the merchant's webshop. Non-negative. Measured in grams.

If true, this option will be preselected when checkout loads. Default: false

Promotion name. To be used if this shipping option is promotional.

Shipping method. Possible values:<ul><li>PickUpStore</li><li>Home</li><li>BoxReg</li><li>BoxUnreg</li><li>PickUpPoint</li><li>Own</li><li>Postal</li><li>DHLPackstation</li><li>Digital</li></ul> If DHLPackstation is selected the correct form will be displayed.

Non-negative. In percent, two implicit decimals. I.e 2500 = 25%.

TMS reference. Required to map completed orders to shipments reserved in TMS.

The cadence unit for this.

Example: "DAY"

The name of the subscription product.

Example: "Premium Account"

The checkout API is used to create a checkout with Klarna and update the checkout order during the purchase. As soon as the purchase is completed the order should be read and handled using the [Order Management API](https://docs.klarna.com/api/ordermanagement). Read more on [Kustom checkout](https://docs.klarna.com/kco/).

Checkout API V3

To create a new order simply provide a JSON object with the applicable properties. The location of the newly created checkout order can be found in the location header of the response. Please note: This is the url that should be used for future interactions (read and update) with the order, i.e. do not construct the order url based on the order id.

body

Klarna-Partner

We were unable to create an order with the provided data. Some field constraint was violated.

You were not authorized to execute this operation.

array|Bad value: order_amount|Bad value: order_tax_amount|Bad value: locale

order_id

We did not find any order with given ID. You need to create a new order.

To update an order simply provide a JSON object with the properties you want to update. Properties not provided in the request will stay the same. Please note: an order can only be updated when the status is checkout_incomplete

We were unable to update an order with the provided data. Some field constraint was violated.

You tried to modify a read only resource.