Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Notes to type of payment
Payment Type | Countries | Currency |
---|---|---|
Invoice |
|
|
Installment |
|
|
UI Text Box | ||
---|---|---|
| ||
B2B transactions are not supported. |
API-Requests - special notes / deviations
Overview of deviations
UI Text Box | ||
---|---|---|
| ||
|
Clearingtype / Clearingsubtype
clearingtype | financingtype | |
---|---|---|
fnc | KIS | Klarna "Slice It" (Installment, former KLS) |
fnc | KIV | Klarna "Pay Later" (Invoice, former KLV) |
Summary
Klarna Checkout is a 3 step process.
UI Steps | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
draw.io Diagram | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Creating a new session via our server api
In the first step you need to setup a new checkout session. You can do so by sending a genericpamynet-request to our server api as listed below.
Please make sure to send the customer data within this request as they're needed to initiate a new session.
→ Genericpayment start_session
Optional update session
If the customer leaves the checkout page and comes back later, you can update the created session and change for example the address data.
→ Genericpayment update_session
Token-handling via Klarna widget
Part of the response is a client token. This token needs to be passed to the Klarna Widget. This Widget sends the client token together with the selected payment method (e.g. "Klarna Pay Later") to Klarna to get a authorization token.
Finalizing the checkout ((pre-)authorization) via our server api
In the last step, you need to send the authorization token received by Klarna widget as part of the (pre-)authorization request to our server api.
→ Preauthorization/Authorization
General integration information
There are a few things you need to take care of, when integrating Klarna checkout in your shop.
- You need to make sure, that the customer didn't accidently clicked on a Klarna payment method, because you will want to start the checkout process and directly send customer data to Klarna via "start_session" call. So please implement another step where the customer needs to confirm his payment method choice (for example: "By selecting this payment method we will send personal data to Klarna. Please confirm".
- After confirmation of the payment method, you want to start with the first calls to server api as described above and then display the Klarna Widget. This Klarna Widget needs defined parameters to only display the chosen payment method, even if the widget is capable of displaying more than one Klarna payment method. For example after selecting "Klarna Pay Later", the widget should look something like this:
Anchor | ||||
---|---|---|---|---|
|
Request "generic start session" | ||||||||||||||||||
API parameter | Required | Comments | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
add_paydata[action] | + | identifies the request as one to start a new session
| ||||||||||||||||
add_paydata[merchant_data] | - | "EMD" - Extra Merchant Data - means that integration with any such package depends on (i) merchant’s offering and (ii) merchant’s technical possibilities. It is not to be interpreted in such a way that EMD is not required at all.
| ||||||||||||||||
firstname | + |
| ||||||||||||||||
lastname | + |
| ||||||||||||||||
street | + |
| ||||||||||||||||
zip | + |
| ||||||||||||||||
city | + |
| ||||||||||||||||
country | + |
| ||||||||||||||||
addressaddition | + |
| ||||||||||||||||
gender | o |
| ||||||||||||||||
ip | + | Customer's IP-V4-address (123.123.123.123) or IP
| ||||||||||||||||
+ |
| |||||||||||||||||
telephonenumber | + |
| ||||||||||||||||
birthday | o | Date of birth (YYYYMMDD)Mandatory for _____
| ||||||||||||||||
- |
| |||||||||||||||||
shipping_lastname | - |
| ||||||||||||||||
shipping_company | - |
| ||||||||||||||||
shipping_street | - ? | Street number and name (required: at least one character)
| ||||||||||||||||
shipping_zip | - |
| ||||||||||||||||
shipping_city | - | |||||||||||||||||
shipping_country | - |
| ||||||||||||||||
add_paydata[last_four_ssn] | - | Last four digits for customer social security number. | ||||||||||||||||
add_paydata[organization_entity_type] | - | Only relevant for B2B transactions. | ||||||||||||||||
personalid | o |
AN..32 | ||||||||||||||||
it[n] | + | For KLV / KLS: Item type
| ||||||||||||||||
id[n] | + |
AN..32 Product number, order number, etc. | ||||||||||||||||
pr[n] | + |
Unit gross price in cent, max. 19 999 999 99 N..10 | ||||||||||||||||
no[n] | + |
Quantity N..6 | ||||||||||||||||
de[n] | + |
Description | ||||||||||||||||
va[n] | + |
N..4 VAT rate (% or bp) of gross price | ||||||||||||||||
add_paydata[klsid] | + | Mandatory for Klarna Installment (KLS): Campaign code |
Response "genericpayment - start_session" | |||||||||||||||||||
API parameter | Required | Comments | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
add_paydata[session_id] | + | Identifier for the started session at Klarna | |||||||||||||||||
add_paydata[client_token] | + | Client token to authorize the session for payment via Klarna Widget | |||||||||||||||||
add_paydata[authorized_payment_method] | + | Name of payment that got authorized for customer payment. (You will only receive the parameters according to the payment method you selected via clearingtype and financingtype) | |||||||||||||||||
add_paydata[payment_method_category_name] | + | Name of Klarna payment category | |||||||||||||||||
add_paydata[payment_method_category_identifier] | + | Identifier for Klarna payment category | |||||||||||||||||
add_paydata[payment_method_category_asset_url_descriptive] | + | URL of Klarna payment category assets for descriptive design (payment method identified by small icon and test on badge) | |||||||||||||||||
add_paydata[payment_method_category_asset_url_standard] | + | URL of Klarna payment category assets for standard design (payment method only identified by small icon on badge) | |||||||||||||||||
status | + |
| |||||||||||||||||
APPROVED | |||||||||||||||||||
workorderid | + |
| |||||||||||||||||
ERROR | |||||||||||||||||||
errorcode | + |
| |||||||||||||||||
errormessage | + |
| |||||||||||||||||
customermessage | + |
|
Code Block |
---|
add_paydata[action]=start_session aid=111111 amount=2222 api_version=1.00 birthday=1958101 city=Neuss clearingtype=fnc country=DE currency=EUR de[1]=for ocean use only email=klarna@approved.de encoding=UTF-8 financingtype=KLS firstname=Testperson-de gender=m id[1]=boat66 it[1]=goods key=abcd12345698fffkfk language=de lastname=Approved mid=11111 mode=test no[1]=1 portalid=2011111 pr[1]=8540 request=genericpayment salutation=Herr street=Hellersbergstraße 14 telephonenumber=01522113356 va[1]=1900 zip=41460 |
Code Block |
---|
status=OK add_paydata[payment_method_category_name_3]=Slice it. add_paydata[payment_method_category_name_2]=Pay later. add_paydata[payment_method_category_name_1]=Direct debit add_paydata[session_id]=123-2227-456-avc11-fefe456 add_paydata[payment_method_category_identifier_3]=pay_over_time add_paydata[client_token]=W9uX2lkIiA6ICI3MGFjNGI3Ny0yMjI3LTdkNDEtY add_paydata[payment_method_category_identifier_2]=pay_later add_paydata[payment_method_category_asset_url_standard_2]=https://cdn.klarna.com/1.0/shared/image/generic/badge/en_us/pay_later/standard/pink.svg add_paydata[payment_method_category_asset_url_standard_1]=https://cdn.klarna.com/1.0/shared/image/generic/badge/en_us/pay_now/standard/pink.svg add_paydata[payment_method_category_asset_url_standard_3]=https://cdn.klarna.com/1.0/shared/image/generic/badge/en_us/slice_it/standard/pink.svg add_paydata[payment_method_category_asset_url_descriptive_3]=https://cdn.klarna.com/1.0/shared/image/generic/badge/en_us/slice_it/descriptive/pink.svg add_paydata[payment_method_category_asset_url_descriptive_2]=https://cdn.klarna.com/1.0/shared/image/generic/badge/en_us/pay_later/descriptive/pink.svg add_paydata[payment_method_category_asset_url_descriptive_1]=https://cdn.klarna.com/1.0/shared/image/generic/badge/en_us/pay_now/descriptive/pink.svg add_paydata[payment_method_category_identifier_1]=direct_debit workorderid=WX123456799 |
Anchor | ||||
---|---|---|---|---|
|
To update an order, you need to send a genericpayment-request with action=update. The call needs to provide the new list of items representing the complete shopping cart.
UI Text Box | ||
---|---|---|
| ||
|
Request "genericpayment - update" | ||||||||||||||||||
API parameter | Required | Comments | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
add_paydata[action] | + | Fixed value "update" | ||||||||||||||||
add_paydata[reservation_txid] | + | Referencing the reservation (received from authorization.response -> add_paydata[reservation_txid]) | ||||||||||||||||
+ | Referencing the reservation (received from authorization.response -> add_paydata[workorderid])
| |||||||||||||||||
country | + |
| ||||||||||||||||
amount | + |
Total gross amount (in smallest currency unit! e.g. N..10 | ||||||||||||||||
currency | + |
Currency (ISO 4217) | ||||||||||||||||
financingtype | + |
| ||||||||||||||||
it[n] | + | For KLV / KLS: Item type Format Default
| ||||||||||||||||
id[n] | + |
Product number, order number, etc. AN..32 | ||||||||||||||||
pr[n] | + |
Unit gross price in cent, max. 19 999 999 99 N..10 | ||||||||||||||||
no[n] | + | Quantity N..6 | ||||||||||||||||
de[n] | + |
Description AN..50 | ||||||||||||||||
va[n] | + |
VAT rate (% or bp) of gross price N..4 |
Response "genericpayment - update" | ||||||||||||||||||
API parameter | Required | Comments | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
status | + |
| ||||||||||||||||
APPROVED | ||||||||||||||||||
workorderid | + |
| ||||||||||||||||
ERROR | ||||||||||||||||||
errorcode | + |
| ||||||||||||||||
errormessage | + |
| ||||||||||||||||
customermessage | + |
|
Anchor | ||||
---|---|---|---|---|
|
the follwing integration steps are taken from Klarna documentation ( https://developers.klarna.com/documentation/klarna-payments/integration-guide/present-klarna-widget )
After creating a new session, you want to present the klarna widget to your customer. This widget allows you to present all 3 payment methods offered by Klarna to the customer or define what payment method should be presented to the customer. This is
UI Steps | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Request "preauthorization / authorization" | ||||||||||
API parameter | Required | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
firstname | + | First name AN1..50
| ||||||||
lastname | + | Surname AN2..50
| ||||||||
company | - | If filled, the transaction is marked as B2B. AN..50
| ||||||||
street | + | Street number and name AN1..50
| ||||||||
zip | + | Postcode, format [a-zA-Z0-9_.-/]{2,10} AN2..10
| ||||||||
city | + | City AN2..50
| ||||||||
country | + | Country (ISO 3166) Default
| ||||||||
addressaddition | + | Address line 2 (e.g. "7th floor", "c/o Maier") AN1..50
| ||||||||
gender | o | f=female, m=male Default
| ||||||||
ip | + | Customer's IP-V4-address (123.123.123.123) or IP AN..39
| ||||||||
+ | Email address AN..254
| |||||||||
telephonenumber | + | Telephone number AN..30
| ||||||||
birthday | o | Date of birth (YYYYMMDD) Mandatory for Germany, Netherlands and Austria N8
| ||||||||
shipping_firstname | - | First name AN..50
| ||||||||
shipping_lastname | - | Surname AN..50
| ||||||||
shipping_company | - | Company AN2..50
| ||||||||
shipping_street | - | Street number and name (required: at least one character) AN1..50
| ||||||||
shipping_zip | - | Postcode, format [a-zA-Z0-9_.-/]{2,10} AN2..10
| ||||||||
shipping_city | - | City AN2..50
| ||||||||
shipping_country | - | Country (ISO 3166) Default
| ||||||||
personalid | o | Mandatory for Sweden, Finland, Denmark and Norway AN..32
| ||||||||
it[n] | + | For KLV / KLS: Item type
Default Format | ||||||||
id[n] | + | Product number, order number, etc. AN..32
| ||||||||
pr[n] | + | Unit gross price in cent, max. 19 999 999 99 N..10
| ||||||||
no[n] | + | Quantity N..6 | ||||||||
de[n] | + | Description AN..255
| ||||||||
va[n] | + | VAT rate (% or bp) of gross price N..4
| ||||||||
add_paydata[klsid] | o | Mandatory for Klarna Installment (KLS): Campaign code |
Code Block |
---|
add_paydata[authorization_token]=aaa-bbbb-11111-2222-ccc aid=12346 amount=8540 api_version=3.10 backurl=https://meine.test.url.de/Checkout/back birthday=19600707 city=Neuss clearingtype=fnc country=DE currency=EUR de[1]=for ocean use only email=klarna@approved.de encoding=UTF-8 errorurl=https://meine.test.url.de/Checkout/error financingtype=KLS firstname=Testperson-de gender=m id[1]=boat66 it[1]=goods key=e123dc456a language=de lastname=Approved mid=12345 mode=test narrative_text=0123456789012345678901234567890123456789 no[1]=1 portalid=2000123 pr[1]=8540 reference=R15595689952007 request=authorization salutation=Herr street=Hellersbergstraße 14 successurl=https://meine.test.url.de/Checkout/success telephonenumber=01522113356 va[1]=1900 zip=41460 |
Response "preauthorization / authorization" | ||
API parameter | Required | Comments |
---|---|---|
add_paydata[workorderid] | + | Klarna Invoice: Workorder ID, used for update calls (cart updates) |
add_paydata[reservation_txid] | + | Klarna Invoice: Reservation ID, used for update calls (cart updates) |
Code Block |
---|
redirecturl=https://klarna-payments-eu.playground.klarna.com/v1/sessions/aaa-bbbb-11111-2222-ccc/redirect status=REDIRECT txid=30343747 userid=7890123 |
Capture
Request "capture" | ||||||||||
API parameter | Required | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
capturemode | + | Parameter capturemode is mandatory to indicate whether this capture will be the last one. (Default: completed)
| ||||||||
settleaccount | + | Parameter settleaccount is mandatory to indicate whether a refund to the customer should be initiated. (Default: yes)
|
Response "capture" | ||
API parameter | Required | Comments |
---|---|---|
clearing_instructionnote | o |
|
Debit / Refund
Request "debit" | ||||||||||
API parameter | Required | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
settleaccount | + | Parameter settleaccount is mandatory to indicate whether a refund to the customer should be initiated. (Default: yes)
|
If you're using vouchers in your checkout, and want to partial refund items, you do have 2 options to do this:
- send a debit-request with the items using the original amount without any discounts and send a additional item as voucher, with an amount that sums up all discounts
- example cart with auth
- item 1; red car; 20 €
- item 2; green truck; 30 €
- item 3; voucher -10€ (-5€ discount on both items)
- example cart with debit/refund
- item 1; red car; 20 €
- item 2; voucher -5€ (15€ for one item will be returned)
- example cart with auth
- send a debit-request with the items using an reduced amount, so that the whole discount is broken down on every item.
- example cart with auth
- item 1; red car; 20 €
- item 2; green truck; 30 €
- item 3; voucher -10€ (-5€ discount on both items)
- example cart with debit/refund
- item 1; red car; 15 € (15€ for one item will be returned)
- example cart with auth
Table of Contents | ||||
---|---|---|---|---|
|