Introduction
Klarna’s APIs and SDKs allow acquiring partners to offer Klarna as a payment method for multiple merchants. They provide the functionality to initiate, authorize, and fully manage payment transactions on behalf of merchants. For merchants, Klarna’s APIs offer a simple and flexible way to initiate, authorize, and manage payments made with Klarna payment methods on a website, mobile app, or in a physical store.
For testing and development, you can use our APIs in a test environment, which does not affect your live data or interact with your backend systems and other networks. The API keys used for authentication are linked to the environment type, meaning test keys will only work in the test environment, while production keys will only work in the live environment.
This API reference provides details on available endpoints and how to interact with them. To learn more about integrating the Klarna API, visit our documentation.
Release notes
Please ensure you are using the latest version of the API and SDK in the sidebar:
Release 9
- Availability test: Planned - August 11, 2025
- Availability production: Planned - September 1, 2025
Release 8
- Availability test: June 9, 2025
- Availability production: Planned - June 30, 2025
The changes on release 8 focus on expanding functionality, improving system robustness, and enhancing the overall developer and partner experience.
| API / Feature | Key Improvements & Changes |
|---|---|
| Management API | |
| Enhanced partner onboarding with improved validation and clearer error reporting. | |
| Updated contract management endpoints for better automation and reliability. | |
| Dispute API | |
| Improved dispute status tracking and notification accuracy. | |
| Minor bug fixes for dispute case management. | |
| Identify API | |
| Upgraded authentication mechanisms for increased security. | |
| Enhanced session stability and user experience. | |
| Merchant Services | |
| Merchant Credential Service | |
| Expanded credential management features, including support for new credential types. | |
| Improved audit trail capabilities. | |
| Merchant Storage Service | |
| Optimized data storage and retrieval performance. | |
| Fixed minor data consistency issues. | |
| Payment Transaction API | |
| Added new endpoints for advanced order management. | |
| Improved error handling and messaging for transaction failures. | |
| Messaging API | |
| Introduced additional messaging templates for broader notification support. | |
| Enhanced delivery tracking and reporting. | |
| Pricing API | |
| Enabled more flexible partner pricing configurations. | |
| Improved validation for pricing rules and models. | |
| Partner Management | |
| Improved user management workflows, including enhanced permission controls. | |
| Fixed minor UI inconsistencies. | |
| Payment API | |
| Enhanced acquiring workflows for faster and more reliable payment processing. | |
| Added support for new payment methods and currencies. | |
| Plugin Integration API | |
| Added new integration points for third-party plugins. | |
| Improved error logging and diagnostics. | |
| Interoperability API | |
| Improved session management for seamless cross-system operations. | |
| Enhanced API response times and reliability. | |
| Settlements API | |
| Enhanced settlements report generation with new filtering and export options. | |
| Improved report accuracy and completeness. | |
| Webhooks | |
| Improved webhook delivery reliability and retry logic. | |
| Added support for additional event types. |
Deprecations and Removals
- No major deprecations or removals were introduced in this release.
Release 7
- Availability test: May 5, 2025
- Availability production: May 19, 2025
The changes on release 7 focus on enhancing platform reliability, expanding feature sets, and improving partner and merchant experiences.
| API / Feature | Key Improvements & Changes |
|---|---|
| Management API | |
| Improved onboarding workflows for business partners, including enhanced validation and error handling. | |
| Streamlined contract management processes. | |
| Dispute API | |
| Enhanced dispute case tracking with additional status fields and improved notification mechanisms. | |
| Bug fixes for dispute resolution timelines. | |
| Identify API | |
| Strengthened authentication flows with updated security protocols. | |
| Improved user session management. | |
| Merchant Services | |
| Merchant Credential Service | |
| Added support for new credential types and improved credential lifecycle management. | |
| Enhanced audit logging. | |
| Merchant Storage Service | |
| Improved data storage reliability and optimized retrieval performance. | |
| Addressed data consistency issues. | |
| Payment Transaction API | |
| Expanded order management capabilities, including new endpoints for order status updates. | |
| Improved error messaging for failed transactions. | |
| Messaging API | |
| Introduced new consumer messaging templates. | |
| Enhanced message delivery tracking and reportin | |
| Pricing API | |
| Added support for dynamic partner pricing models. | |
| Improved validation for pricing rule configurations. | |
| Partner Management | |
| Enhanced user management features, including bulk operations and improved permission controls. | |
| Addressed UI inconsistencies. | |
| Payment API | |
| Improved payment acquiring workflows for faster transaction processing. | |
| Enhanced support for additional payment methods and currencies. | |
| Plugin Integration API | |
| Added new integration hooks for third-party plugins. | |
| Improved error handling and logging. | |
| Interoperability API | |
| Enhanced session management for cross-system interoperability. | |
| Improved API response times and reliability. | |
| Settlements API | |
| Improved settlements report generation with additional filtering and export options. | |
| Addressed report accuracy and completeness issues. | |
| Webhooks | |
| Enhanced webhook delivery reliability and retry mechanisms. | |
| Added support for new event types. |
Deprecations and Removals
- No major deprecations or removals were introduced in this release.
Release 6
- Availability test: February 19, 2025
- Availability production: April 1, 2025
Release 5
- Availability test: November 12, 2024
- Availability production: December 16, 2024
| API / Feature | Key Improvements & Changes |
|---|---|
| All APIs | |
| mTLS for API authentication | |
| Disputes API | |
| List Disputes | |
| Read Dispute | |
| Accept dispute loss | |
| Upload Merchant Evidence Attachment | |
| Respond to Merchant evidence request | |
| Supplemantary purchase data | |
| customer | |
| shipping | |
| ondemand_service | |
| subscriptions | |
| lodging_reservations | |
| insurances | |
| travel_reservations | |
| customer_accounts | |
| customer_devices | |
| events | |
| Webhooks | |
| Webhooks for Disputes | |
| Webhooks for Transactions states | |
| Webhooks for Settlements | |
| Settlement API | |
| Get Settlements | |
| Settlements Reports |
Release 4
- Availability test: September 2, Q4 2024
- Availability production: October 1, 2024
| API / Feature | Key Improvements & Changes |
|---|---|
| Mobile SDK | |
| Supplemantary purchase data | |
| Delete a website channel | |
| Payment descriptors via API | |
| Add a physical store channel | |
| Payment transaction via API | |
| Support for reauthorization | |
| Webhooks | |
| Webhooks for Payment Transactions API | |
| Webhooks for Settlements | |
| Boost Products | |
| Deep Link to Klarna Portal |
Release 3
- Availability test: July 4, 2024
- Availability production: August 1, 2024
| API / Feature | Key Improvements & Changes |
|---|---|
| Authentication | |
| Single Global Account_ID | |
| Partner Management API | |
| Delete a website channel | |
| Add a physical store channel | |
| List all physical store channels | |
| Retrieve a physical store channel | |
| Update a physical store channel | |
| Delete a physical store channel | |
| Add a mobile app channel | |
| List all mobile app channels | |
| Add a collection channel | |
| Retrieve a collection channel | |
| Delete a collection channel | |
| Retrieve settlement information (Extra account data) | |
| Update settlement information (Extra account data) | |
| List all bank account information (Extra account data) | |
| Retrieve bank account information (Extra account data) | |
| Update bank account information (Extra account data) | |
| Delete bank account information (Extra account data) | |
| Create Account Group | |
| List Account Groups | |
| Read Account Group | |
| Update Account Group | |
| Delete Account Group | |
| Add account to a group | |
| Remove account from a group | |
| Update a payment product on an account | |
| Add a website channel | |
| Update MCCs on payment products | |
| Product instance suspended | |
| Product instance enabled | |
| Partner Product API: Server-Side: Shopping Session | |
| Create shopping session | |
| Receive shopping session | |
| Update shopping session | |
| Submit supplementary purchase data | |
| Update supplementary purchase data | |
| Partner Product API: WebSDK: Shopping Session | |
| Create shopping session | |
| Receive shopping session | |
| Update shopping session | |
| Partner Product API: Server-Side | |
| Create payment request | |
| Authorize Payment Request | |
| Get a payment request state | |
| Update a payment request | |
| Cancel a payment confirmation token | |
| Confirm the payment confirmation token | |
| Confirm the payment confirmation token with auto-capture | |
| Charge the user account token | |
| Partner Product API: Server-Side: SPD | |
| Delegate OTP/skip OTP based on data points received-Customer object | |
| Partner Product API: User Account Query API | |
| Query whether a phone number or email address has an existing Klarna account | |
| Partner Product API: WebSDK | |
| Request shipping address collection | |
| Payment Transaction API | |
| Read Payment Transaction | |
| Update Payment Transaction: Merchant references | |
| Void Payment Transaction | |
| Capture Payment Transaction (Full) | |
| Capture Payment Transaction (Partial) | |
| Refund Payment Transaction | |
| Refund Payment Capture | |
| Read Payment Capture | |
| Read Payment Refund | |
| Settlements | |
| Ubiquity Enablement | |
| Partner Product API: Errors | |
| API Validation (ISO, etc) | |
| Error Messaging | |
| Partner Product API: Messaging API | |
| OSM API as Payment Selector | |
| Boost Products: Klarna Express Checkout | |
| Inflight shipping address update | |
| Backwards Compatibility | |
| Backwards Compatible Pricing | |
| ILv2 Settlements Support | |
| Ubiquity Enablement | |
| ILv2 - how to retreive the MID from the account_ID |
stable/v1
- Availability test: April 1, 2024
- Availability production: April 15, 2024
| API / Feature | Key Improvements & Changes |
|---|---|
| Authentication | |
| Base URL (Production) for Mgmt API | |
| Base URL (Testing) for Mgmt API | |
| Pre-configured MoR Credentials | |
| Regional Partner Account IDs | |
| Global Partner Account IDs | |
| Partner Management API | |
| Onboard a merchant | |
| Disable a payments product | |
| Enable a payments product | |
| Register a stakeholder (Extra account data) | |
| List all stakeholders (Extra account data) | |
| Retrieve a stakeholder (Extra account data) | |
| Update a stakeholder (Extra account data) | |
| Delete a stakeholder (Extra account data) | |
| Get Credentials | |
| Create a credential | |
| Disable Credential | |
| Partner Product API: Server-Side | |
| Return pricing to partner when confirming payment request | |
| Return pricing to partner when reading a confirmed payment request | |
| Create payment request (to generate a payment link) | |
| Authorize Payment Request | |
| Get a payment request state | |
| Update a payment request | |
| Cancel a payment confirmation token request | |
| Confirm the payment confirmation token | |
| Confirm the payment confirmation token with auto-capture | |
| Partner Product API: WebSDK | |
| Display Klarna button | |
| Display checkout placement | |
| Create payment request | |
| Submit payment request | |
| Authorize payment request | |
| Get a payment request state | |
| Update a payment request | |
| Cancel a payment confirmation token | |
| Payment request update SDK events | |
| Cancel a payment confirmation token | |
| Confirm the payment confirmation token | |
| Confirm the payment confirmation token with auto-capture | |
| canMakePayment() | |
| Orders V1 | |
| Capture payment transaction | |
| Read Payment Transaction | |
| payment.request.state-change.pending-confirmation | |
| payment.request.state-change.authorized | |
| payment.request.state-change.cancelled | |
| Webhooks Platform | |
| Create webhook | |
| List webhooks | |
| Get webhook | |
| Update a webhook | |
| Delete webhook | |
| Simulate a webhook | |
| Create signing key | |
| List signing keys | |
| Get signing key | |
| Delete signing key | |
| Backwards Compatibility | |
| Settlements API | |
| OSM API |