Klarna payments with Sources

Beta

A Source object is either created client-side using Stripe.js or server-side using the Source creation endpoint. Updatable fields enable you to create a source without providing personally identifiable information (PII), which must be added later using a source update once the customer selects Klarna as a payment option.

Note that if you are operating in one of Klarna’s Restricted Business List Categories, you will also need to add additional purchase information using the klarna[attachment] field.

To create a Klarna source, call stripe.createSource() with the relevant details:

stripe.createSource({
  type: 'klarna',
  amount: 816,
  currency: 'eur',
  klarna: {
    product: 'payment',
    purchase_country: 'DE',
  },
  source_order: {
    items: [{

Using either server-side or client-side source creation, Stripe returns a Source object containing the relevant details for the method of payment used. Information specific to Klarna is provided within the klarna subhash.

{
  "id": "src_16xhynE8WzK49JbAs9M21jaR",
  "object": "source",
  "amount": 1099,
  "client_secret": "src_client_secret_qxC8aTQt9mSnwh29lLgP9pfb",
  "created": 1445277809,
  "currency": "eur",
  "flow": "none",
  "klarna": {
    "locale": "de-DE",

Error codes

Source creation for Klarna payments may return any of the following errors:

Update the source

If customer details are not provided at source creation, they must be added using a source update.

Billing information

Billing information is required for physical goods and, if not provided during source creation a source update is required. If the billing address is provided but the shipping address isn’t, Klarna will assume the shipping address is the same as the billing address. If neither the billing or shipping address is provided, Klarna will collect the billing address during the checkout, and assume the shipping address is the same as the billing address. In both circumstances, if the order’s shipping address differs from the billing address, Klarna will not cover any losses that might occur due to customer disputes or fraud.

See an example of updating a source with billing information:

curl https://api.stripe.comv1/sources/src_18cPLvAHEMiOZZp1YBngt6En \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "klarna[first_name]"="Jenny" \
  -d "klarna[last_name]"="Rosen" \
  -d "owner[email]"="jenny.rosen@example.com" \
  -d "owner[address][line1]"="Schulstrasse 4" \
  -d "owner[address][line2]"= \
  -d "owner[address][city]"="Bad Oeynhausen" \
  -d "owner[address][state]"="Nordrhein-Westfalen" \
  -d "owner[address][postal_code]"=32547 \
  -d "owner[address][country]"="DE"

Shipping information

If selling a physical product that must be shipped, shipping information is required. If not provided during creation, shipping information should be provided in a source update.

See an example of updating a source with shipping information:

curl https://api.stripe.comv1/sources/src_18cPLvAHEMiOZZp1YBngt6En \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "klarna[shipping_first_name]"="Jenny" \
  -d "klarna[shipping_last_name]"="Rosen" \
  -d "source_order[shipping][phone]"="(0xx) xxxx-xxxx" \
  -d "source_order[shipping][address][line1]"="Schulstrasse 4" \
  -d "source_order[shipping][address][line2]"= \
  -d "source_order[shipping][address][city]"="Bad Oeynhausen" \
  -d "source_order[shipping][address][state]"="Nordrhein-Westfalen" \
  -d "source_order[shipping][address][postal_code]"=32547 \
  -d "source_order[shipping][address][country]"="DE"

Tracking information

Additionally, to assist Klarna with any customer requests about a physical shipment, you can update the source to include tracking information.

Here is an example of how to update a source with tracking information:

curl https://api.stripe.comv1/sources/src_18cPLvAHEMiOZZp1YBngt6En \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "source_order[shipping][carrier]"="UPS" \
  -d "source_order[shipping][tracking_number]"="1Z999AA10123456784"

Attachment

For businesses on Klarna’s Restricted List, it’s recommended that you update the source to include additional purchase information relating to the transaction via the klarna[attachment] parameter.

See below for an example of updating a source with an event attachment.

curl https://api.stripe.comv1/sources/src_18cPLvAHEMiOZZp1YBngt6En \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d "klarna[attachment]"="{\"event\":[{\"event_name\":\"Music Festival\",\"arena_name\":\"The Big Concert Venue\",\"start_time\":\"2019-12-12T16:00:00Z\",\"end_time\":\"2019-12-13T06:00:00Z\"}]}"

When you create a source, its status is initially set to pending and it can’t yet be used to make a charge request. The payment must first be submitted to Klarna for authorization. Once authorized, the source becomes chargeable.

To load the Klarna widget and verify that a payment has been authorized, use the Klarna JavaScript SDK:

1. Add the SDK to your checkout page and initialize it using Klarna.Payments.init() with the value from source.klarna.client_token.
2. Load a widget for each category, using Klarna.Payments.load() and a value for container to specify the DOM element where you want the widget rendered. Categories are different payment options Klarna offers. See the list of values you can pass for category in load() in source.klarna.payment_method_categories. The response from load() includes show_form: true/false, which indicates whether the Klarna payment option should remain available, based on Klarna’s risk assessment.
3. Use Klarna.Payments.authorize() to submit the payment with the selected category to Klarna for authorization.

<script>
// Load the Klarna JavaScript SDK
window.klarnaAsyncCallback = function () {

  try {
    // Initialize the SDK
    Klarna.Payments.init({
      client_token: source.klarna.client_token,
    });

    // Load the widget for each payment method category:
    // - pay_later
    // - pay_over_time
    // - pay_now
    var availableCategories = source.klarna.payment_method_categories.split(',');
    for (var category of availableCategories) {
      Klarna.Payments.load({
        container: "#klarna_" + category + "_container",
        payment_method_category: category,
      }, function(res) {
        if (res.show_form) {
          /*
          * This payment method category can be used: allow the customer
          * to choose it in your interface
          */
        } else {
          // This payment method category is not available
        }
      });
    }
  } catch (e) {
    // Handle the InvalidClientTokenError thrown if client_token is not a valid JSON Web Token.
  }
};

document.getElementByID("pay-button").addEventListener("click", function(){
  // Get the category the customer chose (using your own code)
  var selectedCategory = getSelectedCategory();
  // Submit the payment for authorization with the selected category
  Klarna.Payments.authorize({
    payment_method_category: selectedCategory
  }, function(res) {
    if (res.approved) {
      // Payment has been authorized
    } else {
      if (res.error) {
        // Payment not authorized or an error has occurred
      } else {
        // Handle other states
      }
    }
  })
});

</script>
<script src="https://x.klarnacdn.net/kp/lib/v1/api.js" async></script>

As the customer interacts with the Klarna widget, they may be asked for additional information, depending on the jurisdiction they are in.

If an attempt to authorize a payment fails, that category is removed from the list of available payment_method_categories on the source, and reloading the Klarna widget will return show_form: false. The source status will stay pending until the last method is failed, at which point the source status will become failed.

Testing the authorization process

When creating a Source object using your test API keys, use the returned klarna[client_token] with the same Klarna SDK. With a test client token, the Klarna widget does not request any additional customer information as part of the authorization process. The test source then becomes chargeable and can be used to create a test charge. When using test API keys, there is no credit issuance nor any money movement happening. It is always safe to interact with test client tokens. Klarna provides multiple test inputs so that you can test check your integration with various payment flows. These are outlined in the below section on Testing Klarna Payments.

If you haven’t already built your integration, we also provide a Klarna test payments page that embeds the Klarna widget. Use this to test the flow with test client tokens and make test sources chargeable.

Step 2a: Authorizing the payment using a redirect

As an alternative to their recommended widget-based authorization, Klarna also supports a full-redirect authorization specifically designed for both desktop and mobile experiences. To leverage the redirect flow, you create the source using these additional arguments:

stripe.createSource({
  type: 'klarna',
  flow: 'redirect',
  redirect: {
    return_url: 'https://shop.example.com/crtA6B28E1',
  },
  // ...
}).then(function(result) {
  // handle result.error or result.source
});

When flow is set to redirect, Stripe returns a Source of flow redirect. To allow your customer to authorize the payment, redirect them to one of the URLs provided within the Source object, eg: klarna[pay_later_redirect_url], klarna[pay_over_time_redirect_url] or klarna[pay_now_redirect_url].

If the customer is redirected to redirect[url], Pay later will be used if it’s available.

{
  "id": "src_16xhynE8WzK49JbAs9M21jaR",
  "object": "source",
  "amount": 1099,
  "client_secret": "src_client_secret_qxC8aTQt9mSnwh29lLgP9pfb",
  "created": 1445277809,
  "currency": "eur",
  "flow": "redirect",
  "klarna": {
    "locale": "de-DE",

After the authorization process, your customer is redirected back to the URL provided as the value of redirect[return_url]. This happens regardless of authorization success or failure. Stripe appends redirect[return_url] with a redirect_status parameter, with the following potential values:

If the customer authorizes the payment, the Source object’s status transitions to chargeable when it is ready to be used in a charge request. If your customer declines the payment and no other payment_method_categories are available, the status transitions to failed.

Testing the redirect process

When creating a Source object using your test API keys, follow any one of the URLs returned in the klarna[***_redirect_url] field. This leads to a Klarna page that displays information about the test payment, where you can either authorize or cancel the payment. Authorizing the payment redirects you to the URL specified in redirect[return_url] but doesn’t attempt to charge or contact the customer.

Once Klarna authorizes the payment, the source’s status transitions to chargeable and it can be used to make a charge request.

Since that transition happens asynchronously, it is essential that your integration rely on webhooks to determine when the source becomes chargeable in order to create a charge. Please refer to our best practices for more details on how to best integrate payment methods using webhooks.

Webhooks

The following webhook events are also sent to notify you about changes to the source’s status:

Make a charge request to finalize the authorization

After the source is chargeable, from your source.chargeable webhook handler, you can make a charge request using the source ID as the value for the source parameter to complete the payment. The amount must match the Source object’s amount.

When selling physical goods, you should pass the capture: false flag to the charge request to let Klarna know that you’re working on fulfilling the order. After all items have been shipped, send a capture request to let Klarna know that the order has been fulfilled. Only one capture, less than or equal to the charge amount, is permitted. Any remaining amount is released back to the customer.

Note that the charge must be captured by midnight of the 28th calendar day after the charge request, otherwise the authorization will expire. For example, a charge request at UTC 2020-10-01 14:00 must be captured by UTC 2020-10-29 00:00.

curl https://api.stripe.com/v1/charges \
  -u 
sk_test_4eC39HqLyjWDarjtT1zdp7dc
: \
  -d amount="1099" \
  -d currency="eur" \
  -d capture="false" \
  -d source=src_18eYalAHEMiOZZp1l9ZTjSU0

Klarna Sources are single-use and cannot be used for recurring or additional payments. Refer to our Sources & Customers guide for more information on how single-use Source objects interact with Customer objects.

Optional: Authorizing the payment and capturing immediately

By omitting the capture parameter or sending capture: true, Klarna assumes that the order is immediately fulfilled. This is handy if you’re selling digital goods.

Klarna is asynchronous for payments made by customers in the UK and U.S., and synchronous otherwise. When async for the UK and U.S., the Charge object’s status remains in a pending state for up to 24 hours from its creation. Once the charge is confirmed—and the funds guaranteed—its status is updated to succeeded.

All other supported countries are synchronously approved. The Charge object’s status immediately reflects whether or not it has succeeded.

One of the following events is sent when the charge’s status is updated:

We recommend that you rely on the charge.succeeded webhook event to notify your customer that the payment process has been completed and their order is confirmed. Please refer to our best practices for more details on how to best integrate payment methods using webhooks.

Stop payment

Klarna may request additional information relating to high risk orders and in some cases require that you cancel and create a refund for orders that haven’t shipped. Generally, failure to respond within 24 hours may result in a dispute at a later date. Refer to the Klarna shipping policies for more details.

Refunds

Payments made with Klarna can only be submitted for refund within 180 days from the date of the original charge. After 180 days, it is no longer possible to refund the charge.

Klarna supports both full and partial refunds. When you create a refund for the full amount of the charge, the Klarna order is voided, and if funds had been moved by the customer, Klarna will return these funds. You can also issue multiple partial refunds, up to the amount of the original charge. A partial refund will update the Klarna order to reflect the new total amount, and if funds were moved by the customer, Klarna will return the difference.

You can submit a refund against charges that are still pending and have not yet been confirmed. If you create a full or partial refund on a pending charge, the refund is performed only after the charge’s status is transitioned to succeeded. In the event of the charge transitioning to status failed, full and partial refunds are marked as canceled, as the money never left the customer’s bank account.

Disputes

Klarna may initiate a dispute if the customer claims that you haven’t delivered the relevant goods or services as expected. Before initiating a dispute, Klarna will contact you via email, providing details of the customer’s claim. Klarna may request additional information in order to resolve it. If Klarna ultimately rules in favor of the customer, they may initiate a dispute.

If Klarna creates a dispute, a charge.dispute.created webhook event is sent and Stripe deducts the amount of the dispute from your Stripe balance.

Klarna disputes are final and there is no appeal process.

Source expiration

A source must be used within one hour of becoming chargeable. If unused after an hour, its status automatically transitions to canceled and your integration receives a source.canceled webhook event.