Klarna payments SDK reference

This method initializes the Klarna payments library. It is mandatory and expects the client_token received when initiating a payment.

For more information about initializing the JavaScript SDK, see the check out section.

Here's an example of the init() call:

try {
Klarna.Payments.init({
    client_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.dtxWM6MIcgoeMgH87tGvsNDY6cHWL6MGW4LeYvnm1JA'
})
} catch (e) {
// Handle error.
}

The init() method uses the following parameter:

options (Object)

InvalidClientTokenError: If options.client_token is not a valid JSON Web Token.

This callback occurs with the result of the load() call.

For more examples of the potential responses, see the Displaying the widget article.

Here's an example of the load() callback:

The parameters for this method are the following:

res (Object) Response

Display the Klarna widget in your checkout using the load() call.

For more information, see the Displaying the widget article.

Here are the example of the load() call:

The parameters for this method are the following:

options (Object)

data (Object) An optional object with data to update on the session.

callback (load~callback) A function that will be called when the pre-assessment is completed.

• ApplicationNotInitializedError: If load() is called without options and/or prior to init().
• InvalidContainerSelectorError: If options.container is neither an HTML element nor a valid CSS selector.
• PaymentMethodCategoryNotProvidedError: If options.payment_method_category is not provided as a parameter in the load() call.
• PreferredPaymentMethodNotSupportedError: If options.preferred_payment_method is not supported.

If your checkout enables the customer to review the order after the payment step, you can also share in this review page the payment method your customer selected previously. For this, Klarna offers a payment review widget.

Here's an example of the loadPaymentReview() call:

try {
Klarna.Payments.init({ client_token: '...' })
Klarna.Payments.loadPaymentReview({
    container: '#klarna-payments-container'
}, function (res) { // loadPaymentReview~callback
    // ...
})
} catch (e) {
// Handle error. The loadPaymentReview~callback will have been called
// with "{ show_form: false }" at this point.

The parameter for this method is the following:

options (Object)

• ApplicationNotInitializedError: If called without options and/or prior to init().
• OperationNotSupportedError: If the operation is not supported for the current purchase country.
• InvalidContainerSelectorError: If options.container is neither an HTML element nor a valid CSS selector.

This call occurs with the result of the loadPaymentReview operation.

The parameter for this method is the following:

res (Object) Response

This callback occurs with the result of the authorize() call.

For more information, see the Get authorization section.

The following are examples of this method:

res (Object) Response

The parameters for this method are the following:

res (Object) Response

This call triggers the credit risk and fraud assessment in Klarna’s system to decide whether or not to accept the purchase.

For more information, see the Get authorization section.

Here are the examples of the authorize() call:

The parameters for this method are the following:

options (Object)

data (Object) - An optional object with data to update on the session.

callback (authorize~callback) - A function to be called when the authorization is completed.

• PaymentMethodCategoryNotSupportedError: If options.payment_method_category is not supported.
• ApplicationNotLoadedError: If called prior to load().

This callback occurs with the result of a reauthorization.

The following are examples of this method:

The parameters for this method are the following:

res (Object) Response

You need to get a reauthorization if your customer made a change in the order. This applies to multi-step checkouts, where you offer a review page after selecting the payment method.

The authorization_token you received originally is only valid for that specific state of the order. If you attempt to place an order without doing a reauthorize, it will fail.

We suggest you trigger reauthorize once the customer clicks to complete the order. As with authorize(), you can provide an optional update object including all order details. It is also possible to start with a server-side session update per REST API, followed by an empty client-side call to reauthorize. The reauthorize call may trigger your customer confirmation on changed financing details. The integration should wait for the callback function.

If it happens on a different page than where you originally ran init(), you need to initialize the SDK before doing reauthorize.

Here's an example of the reauthorize() call:

try {
Klarna.Payments.init({ client_token: '...' })
Klarna.Payments.reauthorize({
    payment_method_category: 'pay_later'
}, { // Data to be updated
    billing_address: {
    // ...
    }
}, function (res) { // reauthorize~callback
    // ...

The parameters for this method are the following:

options (Object)

data (Object) - An optional object with data to update on the session.

callback (authorize~callback) - A function that will be called when the reauthorization is completed.

• ApplicationNotInitializedError: If called prior to init().
• PaymentMethodCategoryNotSupportedError: If options.payment_method_category is not supported.
• PaymentMethodCategoryNotProvidedError: If options.payment_method_category is not provided when required.

This callback occurs with the result of the finalize() operation.

For more information, see the Finalize an authorization section.

The following are examples of this method:

The parameters for this method are the following:

res (Object) Response

Finalizing the authorization is required for some payment methods.

For more information, see the Finalize an authorization section.

Here's an example of the finalize() call:

try {
Klarna.Payments.init({ client_token: '...' })
Klarna.Payments.finalize({
    payment_method_category: 'pay_later'
}, { // Data to be updated
    billing_address: {
    // ...
    }
}, function (res) { // finalize~callback
    // ...

The parameter for this method are the following:

options (Object)

data  (Object) An optional object with data to update on the session.

callback  (finalize~callback) A function that will be called when the finalization is completed.

• ApplicationNotInitializedError: If called prior to init().
• ApplicationNotLoadedError: If called prior to load().
• PaymentMethodCategoryNotProvidedError: If options.payment_method_category is not provided when required.
• PaymentMethodCategoryNotSupportedError: If options.payment_method_category is not supported.

This eventHandler occurs whenever the associated event is emitted inside Klarna payments.

The parameter for this method is the following:

payload - The payload may vary between events.

This method registers an event handler for the given eventName. The events are triggered internally in Klarna payments. The supported events are:

Here's an example of the on() call:

Klarna.Payments.on('heightChanged', function (newHeight) {
console.log('got new iframe height', newHeight)
})

The parameters for this method are the following:

EventNotSupportedError: If trying to register an unsupported event.

This method unregisters an event handler for the given eventName.

var theEventHandler = function () { ... }
Klarna.Payments.on('heightChanged', theEventHandler)

// unregister this specific listener for heightChanged
Klarna.Payments.off('heightChanged', theEventHandler)

// unregister _all_ listeners for heightChanged
Klarna.Payments.off('heightChanged')

The parameters for this method are the following: