Klarna - Gr4vy

Klarna is a buy now, pay later (BNPL) payment method that offers flexible payment options and supports recurring payments through merchant-initiated transactions (MIT).

Setup

A Klarna account can be requested from the Klarna Business Portal.

Credentials

To connect a Klarna account, obtain the following credentials from the Klarna Business Portal.

Username: An API username which can be generated by navigating to Preferences → Settings → Manage Klarna API Credentials
Password: An API password which can be generated by navigating to Preferences → Settings → Manage Klarna API Credentials
Region: The region of the Klarna account. Enter EU for Europe, NA for North America, or OC for Oceania
Client ID (optional): Required only for Express Checkout. Obtain from your Klarna Business Portal and enter it here so Gr4vy can return it via the Create Session API to initialize the Klarna Payments Buttons SDK.

Capabilities

Supported countries

Supported currencies

Integration

For Klarna, the default integration uses a redirect to the Klarna hosted payments page. A direct integration using the Klarna JavaScript SDK or mobile SDKs is also supported.

Redirect integration

Start by creating a new transaction with the following required fields.

var transaction = await client.Transactions.CreateAsync(
  transactionCreate: new TransactionCreate()
  {
    Amount = 1299,
    Currency = "USD",
    Country = "US",
    PaymentMethod = new PaymentMethodRequest()
    {
      Method = "klarna",
      RedirectUrl = "https://example.com/callback",
      Country = "US",
      Currency = "USD",
    },
  }
);

amount := int64(1299)
currency := "USD"
country := "US"

transactionCreate := components.TransactionCreate{
  Amount:   &amount,
  Currency: currency,
  Country:  &country,
  PaymentMethod: &components.PaymentMethodRequest{
    Method:      "klarna",
    RedirectUrl: "https://example.com/callback",
    Country:     "US",
    Currency:    "USD",
  },
}

transaction, err := client.Transactions.Create(ctx, transactionCreate, nil, nil)

CreateTransactionResponse transactionResponse = gr4vyClient.transactions().create()
  .transactionCreate(TransactionCreate.builder()
    .amount(1299L)
    .currency("USD")
    .country("US")
    .paymentMethod(new PaymentMethodRequest.Builder()
      .method("klarna")
      .redirectUrl("https://example.com/callback")
      .country("US")
      .currency("USD")
      .build())
    .build())
  .call();

Transaction transaction = transactionResponse.transaction().orElse(null);

$transactionCreate = new TransactionCreate(
  amount: 1299,
  currency: 'USD',
  country: 'US',
  paymentMethod: new PaymentMethodRequest(
    method: 'klarna',
    redirectUrl: 'https://example.com/callback',
    country: 'US',
    currency: 'USD',
  )
);
$response = $client->transactions->create($transactionCreate);
$transaction = $response->transaction;

transaction: models.Transaction = client.transactions.create(
  amount=1299,
  currency="USD",
  country="US",
  payment_method={
    "method": "klarna",
    "redirect_url": "https://example.com/callback",
    "country": "US",
    "currency": "USD",
  }
)

const transaction = await gr4vy.transactions.create({
  amount: 1299,
  currency: "USD",
  country: "US",
  paymentMethod: {
    method: "klarna",
    redirectUrl: "https://example.com/callback",
    country: "US",
    currency: "USD",
  },
});

After the transaction is created, the API response includes payment_method.approval_url and the buyer_approval_pending status.

{
  "type": "transaction",
  "id": "ea1efdd0-20f9-44d9-9b0b-0a3d71e9b625",
  "payment_method": {
    "type": "payment-method",
    "approval_url": "https://cdn.sandbox.spider.gr4vy.app/connectors/klarna/apm.html?token=..."
  },
  "method": "klarna"
}

Redirect the buyer to the approval_url to complete the Klarna approval flow. Once approved, the transaction moves to authorization_succeeded.

Direct integration

Gr4vy supports direct integration with Klarna using the Klarna Payments SDK or mobile SDKs, allowing you to embed the payment UI directly in your app while using Gr4vy to manage the transaction lifecycle. Two modes are supported: Standard Checkout (session-based) and Express Checkout (button-based, no session required).

Standard Checkout

To initiate Standard Checkout, create a transaction with integration_client set to web, ios, or android. For mobile, use your app deep link for redirect_url (for example, yourapp://). After the transaction is created, the API response includes a session_token which can be used to get the session data for that transaction.

POST /transactions/:transaction_id/session?token=:session_token

{
  "session_data": {
    "client_token": "...",
    "purchase_country": "US",
    "purchase_currency": "USD",
    "amount": 1000
  },
  "default_completion_url": "https://api.sandbox.spider.gr4vy.app/transactions/approve/some-token",
  "integration_client": "web"
}

{
  "session_data": {
    "client_token": "...",
    "purchase_country": "US",
    "purchase_currency": "USD",
    "amount": 1000
  },
  "default_completion_url": "https://api.sandbox.spider.gr4vy.app/transactions/approve/some-token",
  "integration_client": "ios"
}

{
  "session_data": {
    "client_token": "...",
    "purchase_country": "US",
    "purchase_currency": "USD",
    "amount": 1000
  },
  "default_completion_url": "https://api.sandbox.spider.gr4vy.app/transactions/approve/some-token",
  "integration_client": "android"
}

Use the client_token from the session data to initialize the Klarna SDK. Refer to the Klarna SDK documentation for web integration. Web

<script src="https://js.klarna.com/web-sdk/v1/klarna.js"></script>

iOS (Swift) — See the iOS SDK guide.

let paymentView = KlarnaPaymentView(category: "pay_over_time", eventHandler: self)
paymentView.initialize(clientToken: sessionData.client_token, returnUrl: URL(string: "yourapp://")!)

Android (Kotlin) — See the Android SDK guide.

val paymentView = KlarnaPaymentView(context, "pay_over_time")
paymentView.initialize(clientToken, "yourapp://")

Complete the transaction After the customer authorizes the payment through the Klarna SDK, Klarna returns an authorization_token. To finalize the transaction, send this token to Gr4vy as a query parameter on the default_completion_url returned in the session response.

Terminal

curl -X GET \
    "<default_completion_url>&authorization_token=<AUTHORIZATION_TOKEN>"

Once the request completes successfully, the transaction moves to authorization_succeeded. It can then be captured, voided, or refunded through Gr4vy.

Express Checkout

Klarna Express Checkout embeds the Klarna payment button directly in your page using the Klarna Payments Buttons SDK. The buyer authorizes the payment inside the SDK widget — no redirect to a hosted page is required. After authorization, your backend creates the Gr4vy transaction in a single call using the authorization_token returned by the SDK. Get the client ID The Klarna Payments Buttons SDK requires a client_id to initialize. You can obtain this in one of two ways:

Via the Gr4vy API — Call the Create Payment Service Session endpoint for your Klarna connection. Gr4vy returns a clientId from the connector credentials without making any Klarna API call.
Terminal
```
POST /payment-services/{payment_service_id}/sessions
```
Response
```
{
  "client_id": "klarna_live_client_..."
}
```
Hardcoded — Copy the client_id from your Klarna Business Portal and embed it directly in your frontend. This is suitable when the client ID does not change per session.

Embed the Express Checkout button Load the Klarna SDK and render the Express Checkout button. The klarnaAsyncCallback function must be defined before the SDK script tag so it is available when the SDK initializes.

<div id="klarna-express-button"></div>

<script>
  window.klarnaAsyncCallback = function () {
    var orderPayload = {
      purchase_country: "US",
      purchase_currency: "USD",
      locale: "en-US",
      order_amount: 2999,
      order_tax_amount: 0,
      order_lines: [
        {
          type: "physical",
          reference: "item-001",
          name: "Example Product",
          quantity: 1,
          unit_price: 2999,
          tax_rate: 0,
          total_amount: 2999,
          total_tax_amount: 0,
        },
      ],
    };

    var klarnaButton = window.Klarna.Payments.Buttons.init({
      client_id: "<YOUR_CLIENT_ID>",
    });

    klarnaButton.load({
      container: document.getElementById("klarna-express-button"),
      theme: "default",
      shape: "default",
      locale: "en-US",
      on_click: function (authorize) {
        authorize(
          {
            collect_shipping_address: true,
            auto_finalize: true,
          },
          orderPayload,
          function (response) {
            if (!response.approved) {
              // buyer cancelled or was declined
              return;
            }

            // Send authorization_token to your server
            fetch("/create-transaction", {
              method: "POST",
              headers: { "Content-Type": "application/json" },
              body: JSON.stringify({
                authorization_token: response.authorization_token,
              }),
            });
          }
        );
      },
    });
  };
</script>

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

Mobile For mobile applications, use the Klarna Mobile SDK. The SDK is initialized with a client_id and renders a KlarnaExpressCheckoutButton. iOS (Swift) — See the iOS integration guide.

let options = KlarnaExpressCheckoutButtonOptions(
    sessionOptions: .ClientSideSession(clientId: "<CLIENT_ID>", sessionData: orderData),
    returnUrl: "yourapp://",
    delegate: self
)

Android (Kotlin) — See the Android integration guide.

val sessionOptions = KlarnaExpressCheckoutSessionOptions.ClientSideSession(
    clientId = "<CLIENT_ID>",
    sessionData = orderData,
)

React Native — See the React Native integration guide.

<KlarnaExpressCheckoutView
    sessionOptions={{ clientId: "<CLIENT_ID>" }}
    returnUrl="yourapp://klarna-redirect"
    onAuthorized={handleAuthorization}
/>

Create the transaction Once your server receives the authorization_token, create a Gr4vy transaction and pass the token in connection_options under the klarna-klarna key. Gr4vy forwards the token to Klarna to place the order directly — the transaction moves to authorization_succeeded without any redirect.

var res = await sdk.Transactions.CreateAsync(transactionCreate: new TransactionCreate() {
    Amount = 2999,
    Currency = "USD",
    Country = "US",
    PaymentMethod = new PaymentMethodRequest() {
        Method = "klarna",
    },
    CartItems = new List<CartItem> {
        new CartItem() {
            Name = "Example Product",
            Quantity = 1,
            UnitAmount = 2999,
            Sku = "item-001",
            Type = "physical",
        },
    },
    ConnectionOptions = new Dictionary<string, object> {
        ["klarna-klarna"] = new Dictionary<string, object> {
            ["authorization_token"] = "<AUTHORIZATION_TOKEN>",
        },
    },
});

res, err := s.Transactions.Create(context.Background(), &components.TransactionCreate{
    Amount:   gr4vy.Int64(2999),
    Currency: "USD",
    Country:  gr4vy.String("US"),
    PaymentMethod: &components.PaymentMethodRequest{
        Method: "klarna",
    },
    CartItems: []components.CartItem{
        {
            Name:       "Example Product",
            Quantity:   1,
            UnitAmount: gr4vy.Int64(2999),
            Sku:        gr4vy.String("item-001"),
            Type:       gr4vy.String("physical"),
        },
    },
    ConnectionOptions: map[string]interface{}{
        "klarna-klarna": map[string]interface{}{
            "authorization_token": "<AUTHORIZATION_TOKEN>",
        },
    },
})

$res = $sdk->transactions->create(new Components\TransactionCreate(
    amount: 2999,
    currency: 'USD',
    country: 'US',
    paymentMethod: new Components\PaymentMethodRequest(
        method: 'klarna',
    ),
    cartItems: [
        new Components\CartItem(
            name: 'Example Product',
            quantity: 1,
            unitAmount: 2999,
            sku: 'item-001',
            type: 'physical',
        ),
    ],
    connectionOptions: [
        'klarna-klarna' => [
            'authorization_token' => '<AUTHORIZATION_TOKEN>',
        ],
    ],
));

res = s.transactions.create(
    components.TransactionCreate(
        amount=2999,
        currency="USD",
        country="US",
        payment_method=components.PaymentMethodRequest(
            method="klarna",
        ),
        cart_items=[
            components.CartItem(
                name="Example Product",
                quantity=1,
                unit_amount=2999,
                sku="item-001",
                type="physical",
            ),
        ],
        connection_options={
            "klarna-klarna": {
                "authorization_token": "<AUTHORIZATION_TOKEN>",
            }
        },
    ),
)

const res = await gr4vy.transactions.create({
  amount: 2999,
  currency: "USD",
  country: "US",
  paymentMethod: {
    method: "klarna",
  },
  cartItems: [
    {
      name: "Example Product",
      quantity: 1,
      unitAmount: 2999,
      sku: "item-001",
      type: "physical",
    },
  ],
  connectionOptions: {
    "klarna-klarna": {
      authorizationToken: "<AUTHORIZATION_TOKEN>",
    },
  },
});

The authorization_token returned by the Klarna SDK expires within approximately 60 minutes. Create the Gr4vy transaction immediately after receiving it.

Subscriptions (MIT)

Klarna supports storing the buyer’s payment method during the first (customer-present) payment and charging future renewals as merchant-initiated transactions (MIT) using the saved payment method, typically with no redirect.

Webhooks must be configured for the Klarna payment service. After the buyer approves the payment, Klarna sends an authorization_token via webhook which Gr4vy uses to create the reusable customer token. Without this webhook, store: true will not work.

First payment

Set store to true to save the Klarna payment method for the buyer.

using Gr4vy;
using Gr4vy.Models.Components;

// Load your private key from disk, env, or your secret manager
var privateKey = "...";

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Transactions.CreateAsync(transactionCreate: new TransactionCreate() {
    Amount = 5000,
    Currency = "USD",
    Country = "US",
    PaymentMethod = new PaymentMethodRequest() {
        Method = "klarna",
        RedirectUrl = "https://yourapp.com/callback",
        Country = "US",
        Currency = "USD"
    },
    Store = true,
    PaymentSource = "recurring",
    MerchantInitiated = false,
    IsSubsequentPayment = false,
});
// handle response

package main

import(
    "context"
    "log"
    "github.com/gr4vy/gr4vy-go"
    "github.com/gr4vy/gr4vy-go/models/components"
)

func main() {
    // Load your private key from disk, env, or your secret manager
    privateKey := "..."

    s := gr4vy.New(
        gr4vy.WithID("example"),
        gr4vy.WithServer(gr4vy.ServerSandbox),
        gr4vy.WithBearerAuth(gr4vy.WithToken(privateKey)),
        gr4vy.WithMerchantAccountID("default"),
    )

    amount := int64(5000)
    store := true
    merchantInitiated := false
    isSubsequentPayment := false
    res, err := s.Transactions.Create(context.Background(), &components.TransactionCreate{
        Amount: &amount,
        Currency: "USD",
        Country: "US",
        PaymentMethod: &components.PaymentMethodRequest{
            Method: "klarna",
            RedirectUrl: "https://yourapp.com/callback",
            Country: "US",
            Currency: "USD",
        },
        Store: &store,
        PaymentSource: "recurring",
        MerchantInitiated: &merchantInitiated,
        IsSubsequentPayment: &isSubsequentPayment,
    })
    if err != nil {
        log.Fatal(err)
    }

    if res.StatusCode == 201 {
        // handle response
    }
}

import com.gr4vy.Gr4vy;
import com.gr4vy.models.components.*;
import com.gr4vy.models.operations.*;

public class Main {
    public static void main(String[] args) {
        // Load your private key from disk, env, or your secret manager
        String privateKey = "...";

        Gr4vy sdk = new Gr4vy.Builder()
            .id("example")
            .server(Server.SANDBOX)
            .bearerAuth(Auth.withToken(privateKey))
            .merchantAccountId("default")
            .build();

        TransactionCreate transactionCreate = new TransactionCreate.Builder()
            .amount(5000)
            .currency("USD")
            .country("US")
            .paymentMethod(new PaymentMethodRequest.Builder()
                .method("klarna")
                .redirectUrl("https://yourapp.com/callback")
                .country("US")
                .currency("USD")
                .build())
            .store(true)
            .paymentSource("recurring")
            .merchantInitiated(false)
            .isSubsequentPayment(false)
            .build();

        try {
            CreateTransactionResponse res = sdk.transactions().create(transactionCreate);

            if (res.statusCode == 201) {
                // handle response
            }
        } catch (Exception e) {
            // handle exception
        }
    }
}

<?php

require_once 'vendor/autoload.php';

use Gr4vy;
use Gr4vy\Auth;
use Gr4vy\Models\Components;

// Load your private key from disk, env, or your secret manager
$privateKey = '...';

$sdk = Gr4vy\SDK::builder()
    ->setId('example')
    ->setServer('sandbox')
    ->setSecuritySource(Auth::withToken($privateKey))
    ->setMerchantAccountId('default')
    ->build();

$res = $sdk->transactions->create(new Components\TransactionCreate(
    amount: 5000,
    currency: 'USD',
    country: 'US',
    paymentMethod: new Components\PaymentMethodRequest(
        method: 'klarna',
        redirectUrl: 'https://yourapp.com/callback',
        country: 'US',
        currency: 'USD',
    ),
    store: true,
    paymentSource: 'recurring',
    merchantInitiated: false,
    isSubsequentPayment: false,
));

if ($res->statusCode === 201) {
    // handle response
}

import gr4vy
from gr4vy import auth
from gr4vy.models import components

# Load your private key from disk, env, or your secret manager
private_key = "..."

s = gr4vy.Gr4vy(
    id="example",
    server=gr4vy.SERVER_SANDBOX,
    bearer_auth=auth.with_token(private_key),
    merchant_account_id="default",
)

res = s.transactions.create(
    components.TransactionCreate(
        amount=5000,
        currency="USD",
        country="US",
        payment_method=components.PaymentMethodRequest(
            method="klarna",
            redirect_url="https://yourapp.com/callback",
            country="US",
            currency="USD",
        ),
        store=True,
        payment_source="recurring",
        merchant_initiated=False,
        is_subsequent_payment=False,
    ),
)

if res.status_code == 201:
    # handle response
    pass

import { Gr4vy, withToken } from "@gr4vy/sdk";

// Load your private key from disk, env, or your secret manager
const privateKey = process.env.GR4VY_PRIVATE_KEY ?? "...";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  bearerAuth: withToken({ privateKey }),
  merchantAccountId: "default",
});

const res = await gr4vy.transactions.create({
  amount: 5000,
  currency: "USD",
  country: "US",
  paymentMethod: {
    method: "klarna",
    redirectUrl: "https://yourapp.com/callback",
    country: "US",
    currency: "USD",
  },
  store: true,
  paymentSource: "recurring",
  merchantInitiated: false,
  isSubsequentPayment: false,
});

if (res.statusCode === 201) {
  // handle response
}

Subsequent payment

After the payment method is saved, use the payment method ID to charge future renewals.

Set payment_method.method to id and pass the saved payment method ID.
Set payment_source to recurring.
Set merchant_initiated and is_subsequent_payment to true.

using Gr4vy;
using Gr4vy.Models.Components;

// Load your private key from disk, env, or your secret manager
var privateKey = "...";

var sdk = new Gr4vySDK(
    id: "example",
    server: SDKConfig.Server.Sandbox,
    bearerAuthSource: Auth.WithToken(privateKey),
    merchantAccountId: "default"
);

var res = await sdk.Transactions.CreateAsync(transactionCreate: new TransactionCreate() {
    Amount = 5000,
    Currency = "USD",
    Country = "US",
    PaymentMethod = new PaymentMethodRequest() {
        Method = "id",
        Id = "c2495b14-ca95-4199-87c3-27cbfefcbe9e"
    },
    PaymentSource = "recurring",
    MerchantInitiated = true,
    IsSubsequentPayment = true,
});
// handle response

package main

import(
    "context"
    "log"
    "github.com/gr4vy/gr4vy-go"
    "github.com/gr4vy/gr4vy-go/models/components"
)

func main() {
    // Load your private key from disk, env, or your secret manager
    privateKey := "..."

    s := gr4vy.New(
        gr4vy.WithID("example"),
        gr4vy.WithServer(gr4vy.ServerSandbox),
        gr4vy.WithBearerAuth(gr4vy.WithToken(privateKey)),
        gr4vy.WithMerchantAccountID("default"),
    )

    amount := int64(5000)
    merchantInitiated := true
    isSubsequentPayment := true
    res, err := s.Transactions.Create(context.Background(), &components.TransactionCreate{
        Amount: &amount,
        Currency: "USD",
        Country: "US",
        PaymentMethod: &components.PaymentMethodRequest{
            Method: "id",
            Id: "c2495b14-ca95-4199-87c3-27cbfefcbe9e",
        },
        PaymentSource: "recurring",
        MerchantInitiated: &merchantInitiated,
        IsSubsequentPayment: &isSubsequentPayment,
    })
    if err != nil {
        log.Fatal(err)
    }

    if res.StatusCode == 201 {
        // handle response
    }
}

import com.gr4vy.Gr4vy;
import com.gr4vy.models.components.*;
import com.gr4vy.models.operations.*;

public class Main {
    public static void main(String[] args) {
        // Load your private key from disk, env, or your secret manager
        String privateKey = "...";

        Gr4vy sdk = new Gr4vy.Builder()
            .id("example")
            .server(Server.SANDBOX)
            .bearerAuth(Auth.withToken(privateKey))
            .merchantAccountId("default")
            .build();

        TransactionCreate transactionCreate = new TransactionCreate.Builder()
            .amount(5000)
            .currency("USD")
            .country("US")
            .paymentMethod(new PaymentMethodRequest.Builder()
                .method("id")
                .id("c2495b14-ca95-4199-87c3-27cbfefcbe9e")
                .build())
            .paymentSource("recurring")
            .merchantInitiated(true)
            .isSubsequentPayment(true)
            .build();

        try {
            CreateTransactionResponse res = sdk.transactions().create(transactionCreate);

            if (res.statusCode == 201) {
                // handle response
            }
        } catch (Exception e) {
            // handle exception
        }
    }
}

<?php

require_once 'vendor/autoload.php';

use Gr4vy;
use Gr4vy\Auth;
use Gr4vy\Models\Components;

// Load your private key from disk, env, or your secret manager
$privateKey = '...';

$sdk = Gr4vy\SDK::builder()
    ->setId('example')
    ->setServer('sandbox')
    ->setSecuritySource(Auth::withToken($privateKey))
    ->setMerchantAccountId('default')
    ->build();

$res = $sdk->transactions->create(new Components\TransactionCreate(
    amount: 5000,
    currency: 'USD',
    country: 'US',
    paymentMethod: new Components\PaymentMethodRequest(
        method: 'id',
        id: 'c2495b14-ca95-4199-87c3-27cbfefcbe9e',
    ),
    paymentSource: 'recurring',
    merchantInitiated: true,
    isSubsequentPayment: true,
));

if ($res->statusCode === 201) {
    // handle response
}

import gr4vy
from gr4vy import auth
from gr4vy.models import components

# Load your private key from disk, env, or your secret manager
private_key = "..."

s = gr4vy.Gr4vy(
    id="example",
    server=gr4vy.SERVER_SANDBOX,
    bearer_auth=auth.with_token(private_key),
    merchant_account_id="default",
)

res = s.transactions.create(
    components.TransactionCreate(
        amount=5000,
        currency="USD",
        country="US",
        payment_method=components.PaymentMethodRequest(
            method="id",
            id="c2495b14-ca95-4199-87c3-27cbfefcbe9e",
        ),
        payment_source="recurring",
        merchant_initiated=True,
        is_subsequent_payment=True,
    ),
)

if res.status_code == 201:
    # handle response
    pass

import { Gr4vy, withToken } from "@gr4vy/sdk";

// Load your private key from disk, env, or your secret manager
const privateKey = process.env.GR4VY_PRIVATE_KEY ?? "...";

const gr4vy = new Gr4vy({
  id: "example",
  server: "sandbox",
  bearerAuth: withToken({ privateKey }),
  merchantAccountId: "default",
});

const res = await gr4vy.transactions.create({
  amount: 5000,
  currency: "USD",
  country: "US",
  paymentMethod: {
    method: "id",
    id: "c2495b14-ca95-4199-87c3-27cbfefcbe9e",
  },
  paymentSource: "recurring",
  merchantInitiated: true,
  isSubsequentPayment: true,
});

if (res.statusCode === 201) {
  // handle response
}

​Setup

​Credentials

​Capabilities

​Supported countries

​Supported currencies

​Integration

​Redirect integration

​Direct integration

​Standard Checkout

​Express Checkout

​Subscriptions (MIT)

​First payment

​Subsequent payment

Setup

Credentials

Capabilities

Supported countries

Supported currencies

Integration

Redirect integration

Direct integration

Standard Checkout

Express Checkout

Subscriptions (MIT)

First payment

Subsequent payment