Norce Checkout - Klarna Checkout Adapter API

Version: 0.2.2

Build 2025-10-28 14:01:47

The Klarna Checkout Adapter API is used to create and manage a Klarna Checkout Order.

Related Documentation

For conceptual documentation and usage guides, see:

• Klarna Provider - Klarna integration overview and configuration
• Payment Adapters - Overview of NCO payment adapters
• NCO Introduction - Getting started with Norce Checkout

Base URLs

• https://checkout-klarna-adapter.test.norce.tech - Test server

Authentication

Bearer

• Type: apiKey
• Description: Authorization header using the bearer scheme. Example: 'Bearer a3bcdABCaB12abc3AbCDAB5AbcABCaBcABC5ab3c5A0='

Endpoints

POST /api/checkout/v1/orders/{order_id}/payments

Create a new Klarna Checkout Order

Requires an existing Norce order.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutOrder

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

409

Conflict

Content-Type: application/json

Schema: Error

POST /api/checkout/v1/orders/{order_id}/payments/recurring

Create a new Klarna Checkout order using a recurring token from a previous Klarna Checkout purchase.

Requires an existing Norce order and Klarna Checkout recurring token

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string

Request Body

Recurring token that should be used for completing the order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutRecurringOrder

400

Bad Request

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

409

Conflict

Content-Type: application/json

Schema: Error

POST /api/checkout/v1/orders/{order_id}/payments/{payment_id}/remove

Remove a Klarna Checkout Order

Requires an existing Norce order. Will do soft delete on any payments or shippings by setting state to removed. Will delete any hooks added when creating a klarna checkout order.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

GET /api/checkout/v1/orders/{order_id}/payments/{payment_id}

Get Klarna Checkout Order

Used to get the html snippet, for example after the Klarna Checkout Order has been confirmed.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutOrder

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

PUT /api/checkout/v1/orders/{order_id}/payments/{payment_id}

Update Klarna Checkout Order

Used to remap and update the Klarna Checkout Order from the Norce order, requires existing payment with Klarna Checkout Order.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutOrder

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/push

Push

Consumes push notification when a Klarna Checkout Order is completed.

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string

Responses

200

OK

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/validation

Validation

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

GET /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/confirm

Confirm

Acknowledges Klarna Order and redirects user to confirmation page.

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string

Responses

302

Found

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/address-update

Address update

Updates customer information on Norce order with latest customer information from Klarna Checkout. Frontend implementation should subscribe to Klarna frontend event and call this endpoint.

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string

Request Body

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: ShippingOptionUpdateOrder

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/shipping-option-update

Shipping option update

Shipping option updated notifications. Will update the Norce order with latest shipping selection from klarna. Frontend implementation should subscribe to Klarna frontend event and call this endpoint.

Parameters

• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string
• merchant (query) required
  • Merchant identifier
  • Type: string
• channel (query) required
  • Merchant channel
  • Type: string

Request Body

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: ShippingOptionUpdateOrder

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/state-changed

Handle State changed

State changed.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/cart-changed

Handle Cart changed

Cart changed.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/update-payment

Handle update payment

Hook to update payment on changes.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/checkout/v1/callback/orders/{order_id}/payments/{payment_id}/reference-changed

Handle reference changed

Reference changed.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/refresh-kco

Refresh the list of available PaymentActions for a Klarna Checkout Order Payment

Refreshes the list of available payment actions on the Klarna Checkout payment to reflect the current payment state

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/refresh-kp

Refresh the list of available PaymentActions for a Klarna Payment Order Payment

Refreshes the list of available payment actions on the Klarna Payment payment to reflect the current payment state

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/cancel

Cancel Klarna order

Used to cancel a Klarna order

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutOrder

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/capture

Capture Klarna order

Used to capture a Klarna order

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutOrder

POST /api/order/v1/orders/{order_id}/payments/{payment_id}/refund

Refund Klarna order

Used to refund a Klarna order

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaCheckoutOrder

POST /api/payments/v1/orders/{order_id}/payments

Create a new Klarna Payments Session

Requires an existing Norce order.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: PaymentSession

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

409

Conflict

Content-Type: application/json

Schema: Error

GET /api/payments/v1/orders/{order_id}/payments/{payment_id}

Get Klarna Payments Session

Used to get current payments session.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaPaymentsSession

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

PUT /api/payments/v1/orders/{order_id}/payments/{payment_id}

Update Klarna Payments Session

Used to remap and update the Klarna Payments Session from the Norce order, requires existing payment with Klarna Payments Session.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: KlarnaPaymentsSession

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

POST /api/payments/v1/orders/{order_id}/payments/{payment_id}/confirm

Confirm payment and create Klarna Order

Requires an existing Norce order.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: OrderConfirmation

400

Bad Request

Content-Type: application/json

Schema: Error

401

Unauthorized

Content-Type: application/json

Schema: Error

404

Not Found

Content-Type: application/json

GET /api/payments/v1/orders/{order_id}/payments/{payment_id}/validation

Validate Klarna Payments Session

Validate current payments session.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Responses

200

OK

Content-Type: application/json

Schema: Array of Error

401

Unauthorized

Content-Type: application/json

Schema: Array of Error

404

Not Found

Content-Type: application/json

POST /api/payments/v1/orders/{order_id}/payments/{payment_id}/cart-changed

Handle Cart changed

Cart changed.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

POST /api/payments/v1/orders/{order_id}/payments/{payment_id}/shippings-changed

Handle Shippings changed

Shippings changed.

Parameters

• x-merchant (header) required
  • Merchant identifier.
  • Type: string
  • Example: norce
• x-channel (header) required
  • Channel identifier
  • Type: string
  • Example: 1
• order_id (path) required
  • Order identifier
  • Type: string
• payment_id (path) required
  • Payment identifier
  • Type: string

Request Body

Updated order

Content-Type: application/json

Responses

200

OK

Content-Type: application/json

Schema: Array of PatchOperation

400

Bad Request

Content-Type: application/json

404

Not Found

Content-Type: application/json

Schemas

Addon

Properties

• reference (string)
  • Shipping addon reference.
• price (number)
  • Cost of addon.

Address

Properties

• givenName (string)
  • Given name or first name.
  • Example: "Rosalinainho"
• familyName (string)
  • Family name or last name.
  • Example: "Undulatsson"
• careOf (string)
  • Care of.
  • Example: "Olleinho Jyckesson"
• reference (string)
  • Reference to the customer
• organizationName (string)
  • Name of the Organization
  • Example: "Storm"
• streetAddress (string)
  • Address or street name, first line.
  • Example: "Adaptivevägen 18"
• streetAddress2 (string)
  • Address or street name, second line.
  • Example: "Lgh 1203"
• postalCode (string)
  • Postal code, zip or post code.
  • Example: "955 60"
• city (string)
  • City.
  • Example: "Boden"
• region (string)
  • State or region.
  • Example: "Norrbotten"
• country (string)
  • Country. ISO 3166 alpha-2.
  • Example: "SE"
• phone (string)
  • Phone number.
  • Example: "0753892233"
• email (string)
  • E-mail address.
  • Example: "rosalinainho.undulatsson@example.com"
• attributes (object)
  • Allows you to store any custom attributes for the address.

AuthorizedPaymentMethod

Properties

• number_of_days (string)
• number_of_installments (string)
• type (string)

Callback

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Callback Adapter ID.
  • Example: "jetshop_adapter"
• event
  • Callback event.
• url (string)
  • Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.
  • Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"

CallbackEvent

Cart

Properties

• reference (string)
  • Cart Reference
• items (array) - Array of Item
  • List of Items
• discounts (array) - Array of Discount
  • List of Discounts
• total
  • Cart total excluding shipping fees

ConfirmContext

Properties

• authorizationToken (string) required

Consent

Properties

• id (string)
  • Unique ID for the consent item.
  • Example: "ci_newsleter"
• checked (boolean)
  • Consent checked status.
• text (string)
  • Consent description.
• required (boolean)
  • Required for transition order state to processing

Customer

Properties

• billing
  • Billing address to the customer
• shipping
  • Shipping address to the customer
• type required
  • The type of customer
  • Example: "Person"
• attributes (object)
  • Allows you to store any custom attributes for the customer.

CustomerType

DeliveryDetails

Properties

• carrier (string)
  • Carrier name.
• class (string)
  • Shipping class.
• product
  • Shipping product.
• pickupLocation
  • Pickup location.

Dimensions

Properties

• height (integer)
• width (integer)
• length (integer)

Discount

Properties

• type
  • Indicates if the discount applies to items or shipping.
• name (string)
  • Name of the discount.
• code (string)
  • Discount code.
• value
  • Total sum of discount.
• attributes (object)
  • Allows you to store any custom attributes for the discount.

DiscountType

Error

Properties

• code (string)
  • Error code
  • Example: "cart-not-found"
• message (string)
  • Detailed error information
  • Example: "Cart with id:{id} now found."
• klarnaError
  • Error if originating from Klarna

Hook

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Callback Adapter ID.
  • Example: "jetshop_adapter"
• subscribeTo (string)
  • Callback event.
• target (string)
  • Callback event.
• invoke (string)
  • Full valid url to be called by POST. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.
  • Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"

Item

Properties

• id (string)
  • Unique identifier for the order
  • Example: "ci_FpEzyBvBBUyKxkeNriFUxZOCje"
• reference (string)
  • Optional. Platform cart item reference.
• name (string)
  • Descriptive name of the item.
  • Example: "T-Shirt XL"
• sku (string)
  • SKU or article number.
  • Example: "A000123"
• productType
  • Type of product.
• items (array) - Array of Item
  • Child Items of the item.
• url (string)
  • URL to the product page.
  • Example: "https://example.com/products/A000123"
• imageUrl (string)
  • URL to an image showing the item.
  • Example: "https://example.com/products/A000123/images/1"
• quantity (integer)
  • Quantity of the item.
  • Example: 2
• unit (string)
  • Unit used to describe the quantity. Ex. st, kg
  • Example: "st"
• price
  • Unit price, excluding discount
• total
  • Total sum for all quantities including discount.
• originalTotal
  • Total sum for all quantities excluding discount.
• vatRate (number)
  • Value-added tax. 25% would be input as 0.25.
  • Example: 0.25
• discounts (array) - Array of Discount
  • Discounts applied to item.
• logistics
  • Item Logistics.
• attributes (object)
  • Allows you to store any custom attributes for the item.

KlarnaCheckoutAddress

Properties

• given_name (string)
• family_name (string)
• organization_name (string)
• email (string)
• title (string)
• street_address (string)
• street_address2 (string)
  • Also used for c/o address field
• street_name (string)
• street_number (string)
• house_extension (string)
• postal_code (string)
• city (string)
• region (string)
• phone (string)
• country (string)
• care_of (string)
• reference (string)
• attention (string)
  • Also used for reference field

KlarnaCheckoutOrder

Properties

• id (string)
  • Norce Payment Id
• status (string)
  • Klarna checkout order status.
  • Example: "CHECKOUT_INCOMPLETE"
• htmlSnippet (string)
  • Klarna checkout order html snippet.
  • Example: "\n <div id='klarna-checkout-container'><script>alert('Initializing Klarna Checkout');</script>\n </div>\n "

KlarnaCheckoutRecurringOrder

Properties

• id (string)
  • Norce Payment Id

KlarnaError

Properties

• errorCode (string)
• errorMessages (array)
• correlationId (string)

KlarnaPaymentsAddress

Properties

• attention (string)
• city (string)
• country (string)
• email (string)
• family_name (string)
• given_name (string)
• organization_name (string)
• phone (string)
• postal_code (string)
• region (string)
• street_address (string)
• street_address2 (string)
• title (string)

KlarnaPaymentsAssetUrls

Properties

• descriptive (string)
• standard (string)

KlarnaPaymentsAttachment

Properties

• body (string)
  • The content of the extra merchant data 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 serialized to JSON. More information on that object can be found here.
• content_type (string)
  • The content type of the body. It is usually represented as "application/vnd.klarna.internal.emd-v2+json"

KlarnaPaymentsCustomer

Properties

• date_of_birth (string)
  • Customer’s date of birth. The format is ‘yyyy-mm-dd’
• gender (string)
  • Customer’s gender - ‘male’ or ‘female’
• last_four_ssn (string)
  • Last four digits of the customer's social security number. This value is available for US customers.
• national_identification_number (string)
  • The customer's national identification number. This value is available for EU customers utilizing national identification numbers.
• organization_entity_type (string)
  • Organization entity type. Only applicable for B2B customers.
• organization_registration_id (string)
  • Organization registration id. Only applicable for B2B customers.
• title (string)
  • Customer’s Title. Allowed values per country:\nUK - "Mr", "Ms"\nDE - "Herr", "Frau"\nAT: "Herr, "Frau"\nCH: de-CH: "Herr, "Frau" it-CH: "Sig.", "Sig.ra" fr-CH: "M", "Mme" \nBE: "Dhr.", "Mevr."\nNL: "Dhr.", "Mevr."
• type (string)
  • Type of customer in the session. If nothing is added, a B2C session will be the default. If it is a b2b-session, you should enter organization to trigger a B2B session.
• vat_id (string)
  • VAT ID. Only applicable for B2B customers.

KlarnaPaymentsMerchantUrls

Properties

• confirmation (string)
• notification (string)
• push (string)
• authorization (string)

KlarnaPaymentsOptions

Properties

• color_border (string)
• color_border_selected (string)
• color_details (string)
• color_text (string)
• radius_border (string)

KlarnaPaymentsOrder

Properties

• authorized_payment_method
• fraud_status (string)
• order_id (string)
• redirect_url (string)

KlarnaPaymentsOrderLine

Properties

• image_url (string)
• merchant_data (string)
• name (string)
• product_identifiers
• product_url (string)
• quantity (integer)
• quantity_unit (string)
• reference (string)
• tax_rate (integer)
• total_amount (integer)
• total_discount_amount (integer)
• total_tax_amount (integer)
• type (string)
• unit_price (integer)
• subscription

KlarnaPaymentsPaymentMethodCategory

Properties

• asset_urls
• identifier (string)
• name (string)

KlarnaPaymentsProductIdentifiers

Properties

• brand (string)
• category_path (string)
• global_trade_item_number (string)
• manufacturer_part_number (string)
• color (string)
• size (string)

KlarnaPaymentsSession

Properties

• session_id (string)
• acquiring_channel (string)
  • The acquiring channel in which the session takes place. Ecommerce is default unless specified. Any other values should be defined in the agreement.
• attachment
• authorization_token (string)
  • Authorization token.
• billing_address
• client_token (string)
• custom_payment_method_ids (array)
  • Promo codes - The array could be used to define which of the configured payment options within a payment category (pay_later, pay_over_time, etc.) should be shown for this purchase. Discuss with the delivery manager to know about the promo codes that will be configured for your account. The feature could also be used to provide promotional offers to specific customers (eg: 0% financing). Please be informed that the usage of this feature can have commercial implications.
• customer
• design (string)
• expires_at (string)
• locale (string)
• merchant_data (string)
• merchant_reference1 (string)
• merchant_reference2 (string)
• merchant_urls
• options
• order_amount (integer)
• order_lines (array) - Array of KlarnaPaymentsOrderLine
• order_tax_amount (integer)
• payment_method_categories (array) - Array of KlarnaPaymentsPaymentMethodCategory
• purchase_country (string)
• purchase_currency (string)
• shipping_address
• status (string)
• intent (string)
• order

KlarnaPaymentsSubscription

Properties

• name (string)
• interval (string)
  • Enum: DAY, WEEK, MONTH, YEAR
• interval_count (integer)

Logistics

Properties

• weight (integer)
• height (integer)
• width (integer)
• length (integer)
• tags (array)

Order

Properties

• id (string)
  • Unique identifier for the order
  • Example: "o_yClTSySjyAuuBjmiBlHCjuEcTf"
• merchant (string)
  • Merchant identifier
• channel (string)
  • Merchant channel
• reference (string)
  • External order reference
• created (string)
  • Order creation date time
• lastModified (string)
  • Order last modified date time
• state
  • Order state
• culture (string)
  • Order Culture
• currency (string)
  • Order Currency
• country (string)
  • Order Country
• cart
  • Order cart
• shippings (array) - Array of Shipping
  • Shippings related to the order
• payments (array) - Array of Payment
  • Payments related to the order
• customer
  • Customer information
• consents (array) - Array of Consent
  • Order consents
• actions (array) - Array of Callback
  • Order actions are called in order to complete an action, such as 'Validate'. If provided the action is not completed if the response is not successful (eg. http status code 400), note however that in case of a time constraint the action might be completed without a successful response.
• hooks (array) - Array of Hook
  • Hooks, added by a separate endpoint.
• validations (array) - Array of Validation
  • Validations, added by a separate endpoint.
• total
  • Order total including shipping fees
• attributes (object)
  • Allows you to store any custom attributes for the order.

OrderConfirmation

Properties

• redirectUrl (string)
• order

OrderLine

Properties

• type (string)
• reference (string)
• name (string)
• quantity (integer)
• quantity_unit (string)
• unit_price (integer)
• tax_rate (integer)
• total_amount (integer)
• total_discount_amount (integer)
• total_tax_amount (integer)
• merchant_data (string)
• product_url (string)
• image_url (string)
• product_identifiers
• shipping_attributes

OrderStatus

PatchOperation

Properties

• op (string)
• path (string)
• value

Payment

Properties

• id (string)
  • Unique ID of the payment.
  • Example: "p_KBiXuYjvYxsezKCQAMuuSKGDaT"
• adapterId (string)
  • Adapter ID
  • Example: "klarna-checkout"
• name (string)
  • Payment service provider name
• merchant (string)
  • Merchant identifier.
  • Example: "norce"
• channel (string)
  • Merchant channel.
• currency (string)
  • Currency of the purchase. ISO 4217.
  • Example: "SEK"
• type
  • Type of payment.
  • Example: "default"
• orderId (string)
  • ID of the order.
  • Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
• amount (number)
  • The amount to be covered by the payment.
  • Example: 10
• upperLimitAmount (number)
  • The upper limit to be used by this payment. For example the amount available on a voucher.
  • Example: 100
• state
  • The state of the payment.
  • Example: "Intent"
• reference (string)
  • External reference to payment service provider.
  • Example: "7d31e2cf-2d46-4db0-b87d-d65dfaae298f"
• attributes (object)
  • Allows you to store any custom attributes for the payment.

PaymentSession

Properties

• id (string)
  • Norce Payment Id
• session
  • Klarna Payments Session

PaymentState

PaymentType

PickupLocation

Properties

• reference (string)
  • Pickup location reference.
• name (string)
  • Name of pickup location.
• address
  • Pickup location address.

PickupLocationAddress

Properties

• streetAddress (string)
  • Address or street name, first line.
  • Example: "Adaptivevägen 18"
• city (string)
  • City.
  • Example: "Boden"
• postalCode (string)
  • Postal code, zip or post code.
  • Example: "955 60"
• country (string)
  • Country. ISO 3166 alpha-2.
  • Example: "SE"

Price

Properties

• includingVat (number)
  • Total price including vat in the checkout specified currency. Requires two decimal points or multiples of 0.01.
  • Example: 1234
• excludingVat (number)
  • Total price excluding vat in the checkout specified currency. Requires two decimal points or multiples of 0.01.
  • Example: 987.2

ProblemDetails

Properties

• type (string)
• title (string)
• status (integer)
• detail (string)
• instance (string)

Product

Properties

• reference (string)
  • Product reference.
• name (string)
  • Carrier product name.

ProductIdentifiers

Properties

• category_path (string)
• global_trade_item_number (string)
• manufacturer_part_number (string)
• brand (string)

ProductType

RecurringTokenModel

Properties

• token (string)
• autoCapture (boolean)

Session

Properties

• client_token (string)
  • Client Token
• payment_method_categories (array) - Array of KlarnaPaymentsPaymentMethodCategory
  • Available payment method categories
• session_id (string)
  • ID of the created session. Please use this ID to share with Klarna for identifying any issues during integration.

Shipping

Properties

• id (string)
  • Unique identifier for the shipping.
  • Example: "s_pmHreuEBboeezpixrHMDPQlazU"
• merchant (string)
  • Merchant identifier.
  • Example: "norce"
• channel (string)
  • Channel identifier
  • Example: "1"
• state
  • Current state of the shipping.
• reference (string)
  • External reference to shipping.
  • Example: "e8ed2091-c34c-4837-a3a8-bc827b0dc183"
• tmsReference (string)
  • TMS Reference.
  • Example: "a935a628-f70c-47a4-a9f6-98c6d08c2ba3"
• orderId (string)
  • ID of the order.
  • Example: "o_DhZSbDfVzNzuxOzHyCFskzGzaJ"
• adapterId (string)
  • Adapter ID
  • Example: "ingrid-shipping-adapter"
• name (string)
  • Descriptive name of the shipping.
  • Example: "PostNord MyPack Home"
• total required
  • Total price of the shipping.
• vatRate (number) required
  • Value-added tax. 25% would be input as 0.25.
  • Example: 0.25
• deliveryDetails
  • Delivery details.
• addons (array) - Array of Addon
  • Shipping addons.
• attributes (object)
  • Allows you to store any custom attributes for the shipping.

ShippingAttributes

Properties

• weight (integer)
• dimensions
• tags (array)

ShippingOption

Properties

• id (string)
• name (string)
• description (string)
• promo (string)
• price (integer)
• tax_amount (integer)
• tax_rate (integer)
• preselected (boolean)
• shipping_method (string)
• delivery_details
• tms_reference (string)
• selected_addons (array) - Array of Addon

ShippingOptionUpdateOrder

Properties

• purchase_currency (string)
• order_amount (integer)
• order_tax_amount (integer)
• order_lines (array) - Array of OrderLine

ShippingServiceRequest

Properties

• order_amount (integer)
• order_tax_amount (integer)
• order_lines (array) - Array of OrderLine
• billing_address
• shipping_address
• selected_shipping_option
• purchase_currency (string)
• merchant_data (string)
• merchant_reference1 (string)
• merchant_reference2 (string)
• customer
• locale (string)
• tags (array)

ShippingState

State

Properties

• currentStatus
  • State of the order.
• transitions (array) - Array of Transition
  • State transitions.

Transition

Properties

• status
  • State of the order.
• timeStamp (string)
  • UTC Time when state was set.

Validation

Properties

• id (string)
  • Unique ID for the callback.
  • Example: "oc_BaDIudFOjBEuFmLlmDExePUFTh"
• adapterId (string)
  • Callback Adapter ID.
  • Example: "jetshop_adapter"
• url (string)
  • Full valid url to be called by GET. If the url contains the substring '{order_id}' it will be replaced with the orders id before call is performed.
  • Example: "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"