v2 (r2511)

Shows an approved payment authorization response


Shows an approved payment authorization response with consumer and settlement FX


Shows a declined payment authorization response


Shows a payment authorization response containing website store


Shows a payment authorization response containing physical store details


Shows a payment authorization response containing store id from point of checkout that triggers the step up flow


Shows a payment authorization response containing store reference from point of checkout that triggers the step up flow


Shows a payment authorization response that triggers the step up flow


Charge a customer for a previously created subscription for a customer that is not present.


Premium individual

Authorizing an in-store payment with a new physical store

Authorizing an in-store payment with terminal details

Authorizing a payment in a mobile app store

Authorizing a payment with store reference

Authorizing a payment with Klarna store id

Authorizing payment with mobile app details

Authorizing a payment of a previously created payment request with step up supported.

Authorizing a payment of a previously created payment request. Step up with supplementary purchase data supported

Black fountain pen

Shows a capture request with capture amount and line items


Oversized vintage trabant tee

Shows a capture request with line items and shipment details


Product-1

Leather Notebook

Holiday sale 20% off

Test Subscription

Minimal payment authorization of a previously created payment request.


Minimum payment request for a 10 USD purchase

Simplifies purchasing an product (e.g., Video Game) and simultaneously activating a subscription (e.g., Video Game Pass)
with free trial via Klarna.


Video Game Console

Video Game Pass

Simplifies purchasing a product (e.g., Video Game) and simultaneously activating a subscription (e.g., Video Game Pass)
via Klarna.


Simplifies purchasing a product (e.g., event ticket) and activating an on-demand service to charge other items at a later time (e.g., insurance)
via Klarna.


Event Ticket

Tokenize the customer so that you can charge them at a later time for on-demand usage and create a transaction for an initial purchase


Tokenize the customer so that you can charge them at a later time for on-demand usage


Example standard response for Klarna payment presentation API.

Example response for Klarna payment presentation API for token use case.

Shows a successful response to a refund operation on a payment capture.


Shows a successful payment capture response


Shows a payment chargeback created as a result of dispute merchant loss.


Shows a payment chargeback created as a result of payment default.


The merchant has requested an arbitration appeal.


We did deliver the items even though our proof of delivery attachment does not clearly state that. Kindly reconsider the case 

The arbitration appeal window for a given dispute has just opened.


The normal deadline for Merchant and customer to resolve the dispute has expired, Klarna will now investigate the dispute.


The Dispute is closed.

* Closing dispute_reason: `WON` - Dispute is closed in favor of Merchant
* Closing dispute_reason: `LOST` - Dispute is closed in favor of Customer and a chargeback has been triggered towards Merchant


The customer has answered the evidence request.

Klarna is waiting for Partner to respond to the request.


The deadline for merchant evidence response was extended.

A payment dispute has just been submitted to Klarna.


Payment request for a car rental with additional details such as departure, arrival and drivers.


Car Rental 1 day, Columbus

Shows a payment funding expired webhook.


Shows a payment funding pending webhook.


Shows a Payment Request that has been completed.

The payment request was created with `collect_customer_profile`.

The `payment_token` and requested customer information is returned in the `state_context` object.


The payment request has been declined by Klarna.


The payment request has been submitted to Klarna.


Shows a payment request that was started, but then canceled by the customer.


Shows a payment transaction that has been created but not yet acted upon.


Sales tax

Shows a payment transaction authorized webhook.


Shows a payment transaction with consumer and settlement FX that has been created but not yet acted upon.


Shows a payment transaction captured webhook.


Shows a payment transaction chargeback webhook.


Shows a payment transaction closed webhook.


Shows a payment transaction that has been completed and closed upon reaching the end of its life.

Shows a payment transaction completed webhook.


Shows a payment transaction that has expired and where no prior capture has occurred.


Shows a payment transaction expired webhook.


Shows a payment transaction that has been captured, and remaining authorization has been automatically released.


Custom Berlin Wall Art Skateboard

Shows a payment transaction that has been fully captured.


Shows a payment transaction reauthorization that has been rejected by Klarna's risk and fraud decisioning.


Shows a payment transaction that is non guaranteed with consumer funds failed to be collected.


Shows a payment transaction that is non guaranteed with consumer funds failed to be collected and the already captured amount being charged back.


Shows a payment transaction that is non guaranteed with consumer funds collected.


Shows a payment transaction that is non guaranteed with consumer funds pending.


Shows a payment transaction that has not been captured and was closed following the 7-day grace period after expiry.

Shows a payment transaction that has been partially captured and is open to further operations such as capture, refund, update, or void.


Shows a payment transaction that has been partially captured, and the 7-days grace period has passed upon expiration.
Any remaining authorization is released, and the payment transaction is considered to be completed.


Shows a payment transaction that has been reauthorized and waiting for further actions.


Shows a payment transaction that has been re-authorized after expiry.


Shows a successful response to a refund operation on a payment transaction.


Shows a payment transaction refunded webhook.


Shows a payment transaction that has been updated prior to completion.


Shows a payment transaction updated webhook.


Shows a payment transaction that has not been captured and has been closed upon a void operation.

Shows a payment transaction that has been partially captured and completed upon a void operation. Any remaining authorization has been released.


Payment with an existing store using Klarna store id

Payment with an existing store using store reference

Illustrates how to specify a discount on the payment.


Holiday sale 10% off

Payment request including lines items and shipping information.
Tax is specified as a separate line item.


Payment request including detailed delivery information.


Illustrates how to specify sales tax per line item, rather than as a separate line item.


Reauthorize payment transaction to extend the authorization period


Reauthorize payment transaction with new payment amount and line items


Shows a refund request with refund amount and line items


Responding to an evidence request with request type 'YES_WILL_REFUND_THE_CUSTOMER_THROUGH_KLARNA'

Enables customers to initiate a subscription with a free trial period.

No immediate charges are applied, allowing for a customer-friendly introduction to the service.


Enables customers to initiate a subscription without a free trial period.

An immediate charge is applied.


Music Service subscription

Update purchase reference and payment transaction reference


Limits the number of items to be returned. If omitted, the default page size will be used.

size

A cursor used in pagination, referring to a specific item. The `last_item` returned from a previous call can be used here. The next page will list items after this item. Cannot be used together with `ending_before`. If both `starting_after` and `ending_before` are omitted, the first page will be returned.


starting_after

The request contained a validation error.


Bad Request, the request contained a validation error or the input did not conform to the expected content type syntax.


Bad Request, there was an error in the input of the request.
The request can not be retried without modifications.


Conflict, there was a conflict in using the resource.
Idempotency violation or concurrent updates to a resource occurred.


Forbidden, insufficient privileges to perform the requested operation on the resource.


Internal Server Error, there was an unexpected error in the API.


Not Found, the requested resource was not found.


Too Many Requests, the request was rate limited.


Service Temporarily Unavailable, the system is temporarily unavailable to process the request.


Unauthorized, the request was not authorized.


The request was rate limited.

All requests from this client are temporarily rate limited.


Link to Klarna docs describing how to use the API to avoid the error, or a more detailed explanation of why the error occurred. For a parameter validation error the url should refer directly to the API specification of the parameter.


A human readable error message describing the error.


The presented credentials failed authentication.


Unique account identifier assigned by Klarna to the onboarded merchant

This field should be used for any additional data relevant to the purchase.

The data should be provided in the form of a serialized JSON object in string format, containing both mandatory `content` and `content_type` fields.
The `content_type` must be a valid type supported by Klarna.

The structure within the `additional_data` field should be formatted as follows:

```
  "{\"content\":{\"customer_account_info\":[{\"unique_account_identifier\":\"test@gmail.com\",
  \"account_registration_date\":\"2017-02-13T10:49:20Z\",\"account_last_modified\":\"2019-03-13T11:45:27Z\"}]},
  \"content_type\":\"application/vnd.klarna.internal.emd-v2+json\"}"
```

Note: Generate the serialized JSON without whitespace.


Name of associated or partner company for the service

Travel reservation details for air travel including passengers, itinerary, and insurance.


Date and time of departure in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z


List of passengers that this reservation applies to

Refers to the airline booking reference code

Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.
The system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.

Allowed countries:
  `AD`, `AE`, `AF`, `AG`, `AI`, `AL`, `AM`, `AN`, `AO`, `AQ`
  `AR`, `AS`, `AT`, `AU`, `AW`, `AX`, `AZ`, `BA`, `BB`, `BD`
  `BE`, `BF`, `BG`, `BH`, `BI`, `BJ`, `BL`, `BM`, `BN`, `BO`
  `BQ`, `BR`, `BS`, `BT`, `BV`, `BW`, `BY`, `BZ`, `CA`, `CC`
  `CD`, `CF`, `CG`, `CH`, `CI`, `CK`, `CL`, `CM`, `CN`, `CO`
  `CR`, `CU`, `CV`, `CW`, `CX`, `CY`, `CZ`, `DE`, `DJ`, `DK`
  `DM`, `DO`, `DZ`, `EC`, `EE`, `EG`, `EH`, `ER`, `ES`, `ET`
  `FI`, `FJ`, `FK`, `FM`, `FO`, `FR`, `GA`, `GB`, `GD`, `GE`
  `GF`, `GG`, `GH`, `GI`, `GL`, `GM`, `GN`, `GP`, `GQ`, `GR`
  `GS`, `GT`, `GU`, `GW`, `GY`, `HK`, `HM`, `HN`, `HR`, `HT`
  `HU`, `ID`, `IE`, `IL`, `IM`, `IN`, `IO`, `IQ`, `IR`, `IS`
  `IT`, `JE`, `JM`, `JO`, `JP`, `KE`, `KG`, `KH`, `KI`, `KM`
  `KN`, `KP`, `KR`, `KW`, `KY`, `KZ`, `LA`, `LB`, `LC`, `LI`
  `LK`, `LR`, `LS`, `LT`, `LU`, `LV`, `LY`, `MA`, `MC`, `MD`
  `ME`, `MF`, `MG`, `MH`, `MK`, `ML`, `MM`, `MN`, `MO`, `MP`
  `MQ`, `MR`, `MS`, `MT`, `MU`, `MV`, `MW`, `MX`, `MY`, `MZ`
  `NA`, `NC`, `NE`, `NF`, `NG`, `NI`, `NL`, `NO`, `NP`, `NR`
  `NU`, `NZ`, `OM`, `PA`, `PE`, `PF`, `PG`, `PH`, `PK`, `PL`
  `PM`, `PN`, `PR`, `PS`, `PT`, `PW`, `PY`, `QA`, `RE`, `RO`
  `RS`, `RU`, `RW`, `SA`, `SB`, `SC`, `SD`, `SE`, `SG`, `SH`
  `SI`, `SJ`, `SK`, `SL`, `SM`, `SN`, `SO`, `SR`, `SS`, `ST`
  `SV`, `SX`, `SY`, `SZ`, `TC`, `TD`, `TF`, `TG`, `TH`, `TJ`
  `TK`, `TL`, `TM`, `TN`, `TO`, `TR`, `TT`, `TV`, `TW`, `TZ`
  `UA`, `UG`, `UM`, `US`, `UY`, `UZ`, `VA`, `VC`, `VE`, `VG`
  `VI`, `VN`, `VU`, `WF`, `WS`, `XK`, `YE`, `YT`, `ZA`, `ZM`
  `ZW`


Numeric without decimals. Minor currency units (e.g. cent, öre) following ISO 4217, must use with Currency.

Mobile application return URL (app scheme with no action deeplink).

The customer will be redirected to this URL after third party redirects or redirects to the Klarna Application.
It is expected to open the integrating mobile application in it's last state (no state changes or deeplink navigations).


Outcome of the arbitration. Possible values:
- WON: Merchant won the dispute
- LOST: Merchant lost the dispute


Preliminary outcome of the arbitration. Possible values:
- WON: Merchant won the dispute
- LOST: Merchant lost the dispute


Total amount of a one-off purchase, including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500.
This is the amount that Klarna will charge the customer for a one-off purchase. Should not include any amounts for subscriptions.

Invariant: `amount = sum(line_items[].total_line_amount)`


The Billing plan defines the billing interval and amount.

The Billing plan should correspond to the renewal period of the subscription, or
the period of which the customer is receiving goods or services.

The billing plan allows you to specify various billing frequencies.


Defines the charge amount for the specified billing plan. This value should be in positive minor-units.

The billing_amount will be used to display the amount the customer will pay for their billing plan in the upcoming billing cycle and for Klarna to make a better risk assessment.


Defines the date when the customer will be charged for the billing plan. this field will be used to display the date when the charge for this billing plan will happen for the customer.

10 days before the from, Klarna will set the subscription into renewal state and initiate customer communications in case the customer has foreseen payment issues such as no payment method on file or an expiring funding source to increase retention.

Must be in the future.


Travel reservation details for bus, train, or ferries including passengers, itinerary, and insurance.


Identifier name or reference for the arrival location

Identifier name or reference for the origin location

Name of the company providing the insurance

Price of insurance in minor local currency units

Travel reservation details for car travel including drivers, itinerary, and insurance.


End time of rental in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z


Start time of rental in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z


List of drivers that this reservation applies to

This field specifies the point in the payment flow at which the rate is calculated
* `CAPTURE` - indicates that the rate is applied at each capture event during the transaction flow


Provide the city or town name for the address indicated.
Treat the city name as an opaque string, do not validate or infer its structure.


Shipping information collected from the customer by Klarna.


The shipping address as collected from the customer by Klarna.


Provide the two-letter country code in ISO 3166‑1 alpha‑2 format for the indicated address.
The system accepts only predefined country codes such as US, DE, SE, and AU. Treat the country code as an opaque string, do not parse or interpret its structure.


This object provides information about the customer based on their previous interactions with the merchant.
These data points may be used by Klarna to simplify sign-up and during fraud assessment, as well as for underwriting purposes to provide an enhanced experience to returning customers.
This information will not be persisted on created Payment Transactions.


Domicile address of the customer (billing address). Klarna will only use this as an indicator for fraud and to simplify sign-up. The address will not be used for underwriting and will not be persisted on created Payment Transactions. Klarna will also not assume that this is  the shipping address of the customer, to send Klarna the shipping address of the customer, you must populate the shipping object.

Date of the most recent email verification done in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z

Date of the most recent phone verification done in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z

Information about the customer's account with the merchant. This information may be used by Klarna for fraud assessment and will not be not persisted on placed orders.

A unique identifier for the customer's account with the merchant. This may be for example a customer number or a loyalty program number.

The date when the customer's account with the merchant was created in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z.

Indicates level of loyalty within the merchant loyalty program.

Last date when the customer's account with the merchant was modified in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z.

Last login of the customer into the account.

Last date of the customer's login into the account in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z

Purchase history of the customer with the merchant.

The date when the customer made the first payment in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z

The date when the customer made the last payment in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z

The number of disputes the customer has made with the merchant in the last 12 month

The number of successfully paid purchases the customer has made with the merchant in the last 12 month

The number of purchases the customer has made with the merchant in the last 12 month

Accumulated amount of payments done in minor currency units.

The customers address as set on their customer account profile.


Adjustments due to currency conversion in customer payments, which can be positive or negative.

Delta  amount.
The value may be in positive or negative minor units


The device used by the customer during the session

Identifier for the app the session was browsed on.

Identifier for the device the session was browsed on

IP address of the device at the time of the session.

User agent of the device at the time of the session.

The geographical location of the device during verification

The latitude coordinate in which the device was located in during verification.

The longitude coordinate in which the device was located in during verification.

Unique identifier of Klarna Customer account.

Payment initiation methods that describes how to launch the purchase flow.


One-time use link that you can redirect the customer to

Returned if Account Linking or payment tokenization was requested.

The customer token represents the tokenized customer and allows you to act
on behalf of the customer. You must persist this token in your system associated with the customer
account. To de-duplicate customers, you should use the `customer_id` as the unique identifier.


The customer token represents the tokenized customer and allows you to act on behalf of the customer.


Partner reference to the customer token created on Klarna side.
This will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.


Customer token response with result `APPROVED`


Customer token response with result `DECLINED` or `STEP_UP_REQUIRED`


Date of birth of the person on the format YYYY-MM-DD

The currency that will be used to settle the Payment Transaction.
The value should conform to ISO 4217 format. Defaults to `currency`
when not provided.


Duration in ISO 8601 format.
Valid examples:
  - PT15M (for 15 minutes)
  - PT1H (for 1 hour)
  - P1D (for 1 day)
  - P48H (for 48 hours)


E-mail address.
Regex ^(?=.{1,64}@.{1,255}$)(?:[a-zA-Z0-9!#$%&'*+/=?^_`{|}~\p{IsLatin}\p{N}\p{S}-&&[^<>]]+(?:\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~\p{IsLatin}\p{N}\p{S}-&&[^<>]]+)*|"(?:[\x01-\x08\x0B\x0C\x0E-\x1F\x21\x23-\x5B\x5D-\x7F]|\\[\x01-\x09\x0B\x0C\x0E-\x7F])*")@(?:(?:[a-zA-Z0-9\p{IsLatin}\p{N}\p{S}&&[^<>\^]}](?:[a-zA-Z0-9\p{IsLatin}\p{N}\p{S}-&&[^<>\^]]*[a-zA-Z0-9\p{IsLatin}\p{N}\p{S}&&[^<>\^]])?\.)+[a-zA-Z\p{L}]{2,}|\[(?:(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)\.){3}(?:(?:25[0-5]|2[0-4]\d|1\d{2}|[1-9]?\d)|[a-zA-Z0-9\p{IsLatin}\p{N}\p{S}-&&[^<>^]]*[a-zA-Z0-9\p{L}\p{N}\p{S}-&&[^<>\^]]:(?:[\x01-\x08\x0B\x0C\x0E-\x1F\x21-\x5A\x53-\x7F]|\\[\x01-\x09\x0B\x0C\x0E-\x7F])+)\])$


The timestamp in UTC when the pricing was evaluated.


The country where the partner is registered.


Describes detailed information about event reservation.


Indicates if the tickets are digitally checked when entering the venue

State/county/province/region formatted according to country.

End time of the event in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z


Start time of the event in ISO 8601 with timezone e.g. 2024-01-01T12:00:00Z
