This guide will show you how to use Klarna Mobile SDK to implement Express Checkout in your iOS mobile application, providing a fast and simple shopping experience for your users.
Klarna Express Checkout Button
Please review this brief guide first to ensure you are prepared to offer this integration to your customers.
For a Mobile SDK integration your Payment Server and Mobile App must work together to offer one-click checkout experience:
The right placement of the Express button can significantly enhance your user experience, leading to higher conversion rates and increased sales.
You can place the Express checkout button at multiple stages of the shopping journey.
To learn more about placements, check out this section.
Before you integrate Express checkout, check that you meet the following prerequisites:
To allowlist the domain URLs, follow these steps:
3. Generate a client identifier that will let you authenticate requests sent to Klarna:
If you’ve previously generated a client identifier for your store, you can use it to build your Express checkout integration.
In Xcode, navigate to File → Swift Packages → Add Package Dependency and enter the repository URL: https://github.com/klarna/klarna-mobile-sdk-spm
In Version, Select Up to Next Major and take the default option. Then choose KlarnaMobileSDK
in the Package Product column.
If you’re using Cocoapods, you can add the SDK by adding the dependency to your Podfile:
pod "KlarnaMobileSDK"
Followed by performing:
pod install
You should then be able to import the KlarnaMobileSDK
module in your workspace.
If you’re using Carthage, you can add the SDK to your Cartfile as below:
binary "https://raw.githubusercontent.com/klarna/klarna-mobile-sdk/master/KlarnaMobileSDK.json"
Followed by performing:
carthage update --use-xcframeworks
You should be then able to add the XCFramework
to your project.
To read more about Mobile SDK versioning policy, check out this section.
Klarna purchase flows might require authorizations in other applications (e.g. bank apps) or do a handover to the Klarna app. In such cases, a return URL to your application ensures seamless return to the flow in your app, hence setting up a return URL is required. It is expected that redirects to this URL should only open your application without any changes in the UI state, ensuring the customer can continue the flow prior to external navigation.
You can set up a Return URL app scheme to your application by configuring a custom URL scheme.
Important: The return URL string passed to Klarna must include ://
after the scheme name. For example, if you defined myApp
as the scheme, you must use "myApp://"
as the return URL argument to Klarna.
To avoid a Klarna specific app scheme, you can use a host in a common scheme for Klarna redirects, e.g. myApp://klarna-redirect
, this can allow you to differentiate and handle these redirect in your handler.
Considering the return URL is a constant value in Constants.klarnaReturnUrl
, you can handle redirects to your return URL as such:
Klarna flows on mobile utilize Application Queries for Klarna app schemes to offer seamless app handover experience to customers. In order for the SDK to check availability of the Klarna app, we need you to enable querying Klarna app on the device by adding Klarna app schemes to LSApplicationQueriesSchemes.
This can be configured easily in XCode by going to your project setting and under "Info"(alternatively this is also available in your Info.plist
file) you should see an entry list for Queried URL Schemes
, this list should contain the klarna
and klarnaconsent
schemes:
Create an instance of the KlarnaExpressCheckoutButton when your cart page or product detail page is loaded. This ensures that the button is readily available for user interaction. Depending on your integration setup, you can create and initiate the Express Checkout button using either a Client-Side Session or a Server-Side Session:
Once the button is created, add it to your screen. This involves adding the button to the appropriate view hierarchy in your application's user interface:
let options = KlarnaExpressCheckoutButtonOptions(
sessionOptions: KlarnaExpressCheckoutSessionOptions.ClientSideSession(
clientId: "myClientId",
sessionData: mySessionData,
autoFinalize: true,
collectShippingAddress: true
),
returnUrl: "myApp://",
delegate: self,
locale:"en-US",
Param | Type | Description |
---|---|---|
options | KlarnaExpressCheckoutButtonOptions | Contains all the options for the button. |
Param | Type | Description |
---|---|---|
sessionOptions | KlarnaExpressCheckoutSessionOptions | Authorization options that will be used for authorization upon a user click. |
returnUrl | String | URL that will be used to navigate users back to the application from external apps and browsers. |
delegate | KlarnaExpressCheckoutButtonDelegate | delegate that the merchant can use to get notified of the key events happening in the flow. |
locale | String | Locale of the button text. List of supported locales: Klarna Docs - Purchase country, locale, and currency The default is “en-US”. |
styleConfiguration | KlarnaExpressCheckoutButtonStyleConfiguration? | Style configuration for the button, including button theme, button shape, and whether the button is outlined or not. The default theme is `dark`, default shape is `rounded_rect` and default style is `filled`. |
environment | KlarnaEnvironment? | Operating environment of the button. The default is `production`. |
region | KlarnaRegion? | Geographical region for the button’s API requests. The default is `na`. |
theme | KlarnaTheme? | Theme of the flow. The default is `light`. |
loggingLevel | KlarnaLoggingLevel? | Logging level of the integration. The default is `off`. |
Param | Type | Description |
---|---|---|
clientId | String | Partner client ID from Merchant Portal. |
sessionData | String | JSON string used to update the session. |
autoFinalize | Boolean | Whether the authorization should automatically be finalized. The default is true. |
collectShippingAddress | Boolean | Whether the merchant needs the customer's shipping address from Klarna. The default is false. |
Param | Type | Description |
---|---|---|
clientToken | String | Client token generated by the backend for the server-side session. |
sessionData | String? | JSON string used to update the session. The default is null. |
autoFinalize | Boolean | Whether the authorization should automatically be finalized. The default is true. |
collectShippingAddress | Boolean | Whether the merchant needs the customer's shipping address from Klarna. The default is false. |
Param | Type | Description |
---|---|---|
theme | KlarnaButtonTheme? | Color theme of the button. The default is `dark`. |
shape | KlarnaButtonShape? | Shape of the button. The default is `rounded_rect`. |
style | KlarnaButtonStyle? | Style of the button. The default is `filled`. |
Once a customer clicks the Express Checkout button, the Klarna payment authorization process will begin. You must provide a delegate object when creating the button, which will handle Klarna's response. This delegate is essential for managing the payment flow and updating the UI based on the authorization result.
If the authorization is successful, you will receive an authorization token from the authorization response within the delegate object.
func onAuthorized(view: KlarnaMobileSDK.KlarnaExpressCheckoutButton, response: KlarnaMobileSDK.KlarnaExpressCheckoutButtonAuthorizationResponse) {
if let token = response.authorizationToken, approved {
// authorization is successful, backend may create order
}
if response.finalizeRequired {
// finalize call is required, only applicable if you are setting autoFinalize to false
// use response.clientToken to finalize
}
}
Param | Type | Description |
---|---|---|
approved | Bool | Indicates whether the payment was approved. |
showForm | Bool | Indicates whether the payment is still available for authorization. |
finalizeRequired | Bool | Indicates whether the session requires finalization. |
authorizationToken | String? | The authorization token for the payment, if applicable. |
clientToken | String? | The client token for the session, if applicable, intended to be used for finalization. |
sessionId | String | The ID of the Klarna Payments session. |
collectedShippingAddress | String? | Shipping address collected during the session, if applicable. |
merchantReference1 | String? | Merchant references provided in the session creation. |
merchantReference2 | String? | Additional merchant reference provided in the session creation. |
func onError(view: KlarnaMobileSDK.KlarnaExpressCheckoutButton, error: KlarnaMobileSDK.KlarnaError) {
// Handle different failure scenarios by checking the error name
if (error.name == KlarnaExpressCheckoutError.AuthorizationFailed) {
// The authorization process has failed.
showMessage(error.message)
}
// ...
}
KlarnaError
Represents an error that has occurred in the Klarna Express Checkout Button.
Param | Type | Description |
---|---|---|
name | String | Unique name of the error. |
message | String | Elaborate description of the error. |
isFatal | Bool | Determines whether the error is fatal. If the error is fatal, the button should not be shown any further. |
sessionId | String? | Mobile SDK’s session ID. |
params | Map<String, Any?> | A key-value map/dictionary of any additional error parameters. |
The table below lists all the different error names defined as constant values in the KlarnaExpressCheckoutButtonError:
Error Name | Description |
---|---|
InvalidClientID | Indicates that the client ID is not valid; for example, it is null or blank. |
InvalidClientToken | Indicates that the client ID is not valid. For example it is null or blank. |
MissingDelegateReference | Indicates that the delegate reference is lost. |
AlreadyInProgress | Indicates that the Klarna Express Checkout flow is already in progress. |
AuthorizationFailed | Indicates that the authorization has failed. |
ButtonRenderFailed | Indicates that the button could not be rendered successfully. |
InvalidAuthorizationResponseParams | Indicates that the authorization response could not be parsed caused by invalid/missing params. |
This is only required of autoFinalize
is set to false
in session options.
If the session needs to be finalized, you’ll need to perform this last step to get an authorization token from your checkout confirmation screen. This can be done via KlarnaPaymentView, using the clientToken
from KlarnaExpressCheckoutButtonAuthorizationResponse
to initialize the view and calling finalize
method of that view.
Once you have the authorization token, you can create an order. When creating the order, make sure the shipping address provided in the request matches the collected shipping address returned alongside the authorization token.
To continue with the purchase, you have to create an order in Klarna's system. This step takes place in the server side through the Klarna payments API.
To create an order for a one-time payment, send a POST
request to the {apiUrl}/payments/v1/authorizations/{authorizationToken}/order
endpoint and include authorization_token
in the path.
For example, if the authorization_token
is b4bd3423-24e3
, send your request to the {apiUrl}/payments/v1/authorizations/b4bd3423-24e3/order
endpoint.
{
"purchase_country": "US",
"purchase_currency": "USD",
"billing_address": {
"given_name": "John",
"family_name": "Doe",
"email": "john@doe.com",
"title": "Mr",
"street_address": "Lombard St 10",
"street_address2": "Apt 214",
A POST
request to create an order for a one-time payment.
When you receive a success response, the customer gets charged and the Klarna payments session is closed.
As part of the response, you receive the following details:
order_id
, an order identifier that you can later use to capture or refund the order using the Order management APIredirect_url
, a URL to which you redirect the customer. This isn't included in the response received if you didn't include the URL when initiating a paymentfraud_status
, an indicator of whether the transaction is suspected to be legitimate or fraudulentauthorized_payment_method
, the payment method selected by your customer for this purchase{
"order_id": "3eaeb557-5e30-47f8-b840-b8d987f5945d",
"redirect_url": "https://payments.klarna.com/redirect/...",
"fraud_status": "ACCEPTED",
"authorized_payment_method": "invoice"
}
A success response to the order creation request for a one-time payment.
Send the customer browser to redirect_url
provided in the response. Klarna places a cookie in the browser and redirects the customer back to the confirmation URL you provided when creating the session. This makes the checkout faster the next time the customer chooses to pay with Klarna.
If your request doesn't pass our validation, you'll receive an error response. The most common reasons why creating an order fails are:
{
"correlation_id": "6a9b1cb1-73a3-4936-a030-481ba4bb203b",
"error_code": "ERROR_CODE",
"error_messages": [
"ERROR_MESSAGE"
]
}
An error response to the order creation request for a one-time payment.
Here are examples of common errors with troubleshooting suggestions. You can use the value in correlation_id
to find entries related to the request under Logs in the Merchant portal.
Error code | Error message | Description |
---|---|---|
NOT_FOUND | Invalid authorization token | The authorization token has expired because the order was placed more than 60 minutes after authorization. To fix the error, request a new authorization_token and use it to place the order. |
BAD_VALUE | Not matching fields: [billing_address.postal_code] | The data shared with Klarna in a previous step (create_session , load() , or authorize() ) have been modified causing the validation to fail. |
BAD_VALUE | Not matching fields: [Incorrect number of items in the cart. Expected: 2, Actual: 3] | The order lines or the cart were updated after the authorize() call. Please ensure that the cart is kept as-is or send a new authorization request. |
REJECTED | Rejected | This is an edge case reason, but can be triggered in case the merchant is configured with being allowed to update the cart. This could be updated from the authorize to the place order in such a way that a new authorize is triggered. In this case this is rejected. |
This section will help you customize the Express checkout button to ensure a seamless and trustworthy checkout experience, while leveraging Klarna’s strong brand to boost your conversions.
Styling the Express checkout button is crucial for integrating it into your application in a way that complements your brand and encourages user engagement. To modify the style of the button, edit the source code as explained in this guide.
The theme defines the button’s color. You can change the theme by setting the value of the theme attribute.
Apart from the default dark theme, you can apply the light theme to have the button displayed in white or choose auto mode so the theme is selected automatically based on the device’s configuration.
The button’s default theme color is dark. As the theme attribute is optional, the default theme is applied both when you set the attribute to default or if you omit it from the source code altogether.
Dark theme (default)
There are three theme values available, dark (default), light and auto.
Light theme
let buttonStyleConfiguration = KlarnaExpressCheckoutButtonStyleConfiguration(
theme = KlarnaButtonTheme.dark,
shape = …,
style = …
)
ShapeCustomizing the shape of the button to match your application’s look and feel is a key step in creating a visually cohesive and engaging user experience. To control the button's shape, change the value of the shape attribute.
KlarnaButtonShape.rounded_rect
KlarnaButtonShape.pill
KlarnaButtonShape.rectangle
There are three shapes available with the Express checkout button: rounded_rect
(default), rectangle
and pill
.
let buttonStyleConfiguration = KlarnaExpressCheckoutButtonStyleConfiguration(
theme = KlarnaButtonShape.rounded_rect,
shape = …,
style = …
)
Outlined style
Use the outlined style to make the button visible on all backgrounds. To apply this style, set the KlarnaButtonStyle
attribute to outlined
, otherwise default value filled will be used instead.
let buttonStyleConfiguration = KlarnaExpressCheckoutButtonStyleConfiguration(
style = KlarnaButtonStyle.outlined,
shape = …,
theme = …
)
The SDK will log events and errors while it’s running, which you can read in XCode console. You can set the logging level for the SDK through the loggingLevel
property of integration instance.
klarnaExpressCheckoutButton.loggingLevel = .verbose
Name | Description |
---|---|
KlarnaLoggingLevel.off | Nothing will be logged into console. |
KlarnaLoggingLevel.error | Only errors will be logged into console. |
KlarnaLoggingLevel.verbose | Everything will be logged into console. |
Klarna Mobile SDK provides a full suite of mobile-first integrations, including Klarna products like:
![]() | ![]() | ![]() |
Sign in with Klarna | On-site Messaging | Payments |
Complete your integration with