on This Type of PaymentPayment Type | Countries | Currency |
---|
Invoice ("Pay later") | - Austria
- DanmarkDenmark
- Finland
- Germany
- The Netherlands
- Norway
- Sweden
- Switzerland
| - Euro
- Danish crowns
- Norwegian crowns
- Swedish crowns
Swiss Francs
|
Installments ("Slice it") |
Direct Debit ("Pay now") |
UI Text Box |
---|
|
B2B transactions are currently only supported in Finland, Germany, Norway and Sweden. |
UI Text Box |
---|
|
- Klarna requires more specific customer data - depending on country of customer
- Status "PENDING" has to be processed
- for API-response "PENDING" implementation of API-version 3.11 or higher is required
- for TransactionStatus "pending" implementation of notify-version 7.6 or higher is required
- Request "capture" has to use parameter "capturemode"
- Request "debit" has to use parameter "settleaccount"
- add_paydata and workorderid have to be used for update of shopping cart
|
clearingtype | financingtype |
|
---|
fnc | KIS | Klarna "Slice It" (Installments) |
fnc
| KIV | Klarna "Pay Later" (Invoice) |
fnc | KDD | Klarna "direct_debit" (Direct Debit) |
fnc | KBT | Klarna "Pay Now" (Direct DebitBank Transfer) |
Enabling your customers to pay via Klarna requires you to integrate the Klarna payment method into your checkout process. In order to get an overview of the relationship and interaction on your checkout please see the following diagram. (This diagram is adopted from the official Klarna documentation: Klarna Docs - Offering Klarna payment methods to your customers)
Image Added
Establishing Klarna Checkout is a 3 step process.
UI Steps |
---|
UI Step |
---|
The first step is to setup a new checkout session by sending a genericpayment-request to our server API as listed below. This step is a pre-condition for loading the Klarna widget. Please make sure to Please make sure to send the customer data within this request as they're it is needed to initiate a new session. A session will remain valid for 48 hours after the last update. → Genericpayment start_session If the customer leaves the checkout page and comes back laterreturns at a later point in time, you can update the created session and change for example the address data. → Genericpayment update_session |
UI Step |
---|
Handle TokenPart 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. → Widget |
UI Step |
---|
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 UI Text Box |
---|
| The response contains a redirect-URL. You need to redirect the customer to this url, so that Klarna is able to securely handle data and optimize purchase flow. Klarna will automatically redirect the customer back again. The customer doesn't need to take any action and will not notice this step in the background. |
|
|
draw.io Diagram |
---|
border | true |
---|
viewerToolbar | true |
---|
| |
---|
fitWindow | false |
---|
diagramName | klarna_checkout |
---|
simpleViewer | false |
---|
width | 600 |
---|
diagramWidth | 1401 |
---|
revision | 6 |
---|
|
In the first step you need to setup a new checkout session. You can do so by sending a genericpayment-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
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
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.
→ Widget
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
There are a few things you need to take care of, when integrating Klarna checkout in your shop.
- You need to ensure, that the customer only triggers the "start_session" call by choosing Klarna as a payment method intentionally. As personal data will be sent to Klarna within said, he has to actively confirm this (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:
Image Removed
Anchor |
---|
widget | widget | Klarna WidgetThere are a few things you need to take care of, when integrating Klarna checkout in your shop.
- You need to ensure, that the customer only triggers the session start by deliberately choosing Klarna as a payment method. As personal data will be sent to Klarna, the customer has to actively confirm this (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:
Image Added
Display Klarna WidgetThe following 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. The Klarna widget is rendered using JavaScript SDK.
UI Steps |
---|
UI Step |
---|
Add SDK to your page (insert in body) Code Block |
---|
<script>
window.klarnaAsyncCallback = function () {
// This is where you start calling Klarna's JS SDK functions
//
// Klarna.Payments.init({....})
};
</script>
<script src="https://x.klarnacdn.net/kp/lib/v1/api.js" async></script> |
|
UI Step |
---|
Initialize SDK and place a container on your page. Please note that the Klarna widget requires a minimum width of 280px. Code Block |
---|
Klarna.Payments.init({
client_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.dtxWM6MIcgoeMgH87tGvsNDY6cH'
}) |
Code Block |
---|
<div id="klarna_container"></div> |
|
UI Step |
---|
Load Klarna Widget When loading the Klarna widget, one needs to peovide the container ID established in the previous step and specify the payment_method_category. The payment_method_category specifies which of Klarna´s customer offerings (e.g. Pay now, Pay later, or Slice it) will be shown in the widget. |
|
The following 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 |
---|
UI Step |
---|
Add SDK to your page (insert in body) Code Block |
---|
<script>
window.klarnaAsyncCallback = function () {
// This is where you start calling Klarna's JS SDK functions
//
// Klarna.Payments.init({....})
};
</script>
<script src="https://x.klarnacdn.net/kp/lib/v1/api.js" async></script> |
UI Step |
---|
Initialize SDK and place a container on your page Code Block |
---|
Klarna.Payments.init({
client_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIifQ.dtxWM6MIcgoeMgH87tGvsNDY6cH'
}) |
Code Block |
---|
<div id="klarna_container"></div> |
UI Step |
---|
Load Klarna Widget Code Block |
---|
Klarna.Payments.load({
container: '#klarna-payments-container',
payment_method_category: 'pay_later'
}, function (res) {
console.debug(res);
}) |
|
UI Step |
---|
Receive Response from load call Klarna’s widget uses the show_form:true/false field as a response flag to load and to authorize calls in the Javascript SDK. In addition the object "error" can be retrieved to receive further information about potential problems. The response information enables you to display to your customer Klarna as a payment method only when it can actually be utilised by your customer. In summary, there are three situations deriving from the "Receive Response" call. Positive Response If show_form: true , and there are no errors in the object returned, Klarna renders the payment options available to the customer in the widget. Code Block |
---|
{
show_form: true
} |
Adjust and Try Again If show_form: true , but an error is returned as well, then something is wrong and the consumer needs to take action before moving forward. Klarna will inform the consumer about the details of the error in the widget. Optionally, you can interpret the invalid fields in the error message and take appropriate actions on your checkout page. See the JavaScript SDK reference page for further information. Negative ResponseIf {
show_form: true,
error: {
invalid_fields: [
billing_address.street_address
billing_address.city
billing_address.given_name
billing_address.postal_code
billing_address.family_name
billing_address.email ]
}
} |
Negative Response If show_form: false , the payment method chosen by the customer will not be offered for this false, the payment method chosen by the customer will not be offered for this order based on Klarna’s evaluation. A message is displayed to the consumer in the Widget. When Klarna returns a show_form: false , your store cannot offer the selected payment method to this customer. You need to present other payment methods to the customer and hide the option of Klarna payment. Code Block |
---|
{
show_form: false
} |
|
|
start_session | start_session | Genericpayment start_sessionKlarna Authorize |
text-box |
Only submit a buyer's personal information within this request if you ensure the buyer has actively chosen Klarna as a payment method - due to GDPR. |
step |
---|
Authorise the Purchase Once the customer has successfully selected Klarna as payment method in the checkout, the purchase can be authorised by using the Klarna JavaScript SDK. In this step all necessary customer details are transmitted to Klarna for taking a decision about whether or not to offer credit for the purchase. As a result of the authorisation you will receive a token enabling you to place an order towards Klarna. A successful authoirsation guarantees that the order can be generated within 60 minutes. Sending the Request The Authorisation is initiated by a client-side call which will provide you with a token for the order once successfully completed. Here is an example request for an authorisation call. In the call one must provide the billing and optionally the shipping address. Code Block |
---|
KKlarna.Payments.authorize({
payment_method_category: "pay_later"
}, {
purchase_country: "GB",
purchase_currency: "GBP",
locale: "en-GB",
billing_address: {
given_name: "John",
family_name: "Doe",
email: "john@doe.com",
title: "Mr",
street_address: "13 New Burlington St",
street_address2: "Apt 214",
postal_code: "W13 3BG",
city: "London",
region: "",
phone: "01895808221",
country: "GB"
},
shipping_address: {
given_name: "John",
family_name: "Doe",
email: "john@doe.com",
title: "Mr",
street_address: "13 New Burlington St",
street_address2: "Apt 214",
postal_code: "W13 3BG",
city: "London",
phone: "01895808221",
country: "GB"
},
order_amount: 10,
order_tax_amount: 0,
order_lines: [{
type: "physical",
reference: "19-402",
name: "Battery Power Pack",
quantity: 1,
unit_price: 10,
tax_rate: 0,
total_amount: 10,
total_discount_amount: 0,
total_tax_amount: 0,
product_url: "https://www.estore.com/products/f2a8d7e34",
image_url: "https://www.exampleobjects.com/logo.png"
}],
customer: {
date_of_birth: "1970-01-01",
},
}, function(res) {
console.debug(res);
}) |
According to Klarna documentation (Klarna Docs - Authorize the purchase): User interaction during the authorize call When authorizing the order, Klarna conducts a full risk assessment. Therefore, from the point where you call authorize until you receive the callback you must: - Avoid sending another authorize call (e.g. disable the buy button from being clicked again)
- Show to the consumer that the order is being processed (e.g. by showing a loading spinner)
- Prevent consumer from changing order or billing details (e.g. lock the input fields on your page)
The callback is typically received within seconds, but may take up to a minute or so in case a consumer sign-up is required when the user interacts with the widget. |
UI Step |
---|
Process callback from authorise call Once the wigdet has processes the autorisation a callback is performed providing an object with one of the following parameter: - approved (true/false) - the authorization result, approved or denied
- show_form (true/false) - whether the Klarna Widget should be displayed or hidden
- authorization_token - a token which allows you to place the order via a server side call, only returned if the authorization was approved
- error - contains details of potential error messages
Order approved If approved carries the value "true", Klarna has approved the authorisation of credit for this order. With the authorisation_token the order can be completed using a server side pace order call. The token is valid for 60 minutes during which the authorisation is guaranteed. Code Block |
---|
{
authorization_token: "b4bd3423-24e3",
approved: true,
show_form: true
} |
Order not approved If approved: false, Klarna cannot approve the purchase. There are now two options: Option 1 - Fixable error In the case of an adjustable error, you will receive show_form: true and a specification about what fields that are invalid, e.g. error: { invalid_fields: ["billing_address.email"] } } . The widget will also display an error message to the consumer, asking them to correct it before you re-authorize the order. This error message will also clarify which specific field that is incorrect. Code Block |
---|
{
approved: false,
show_form: true,
error: {
invalid_fields: [
billing_address.street_address
billing_address.city
billing_address.given_name
billing_address.postal_code
billing_address.family_name
billing_address.email ]
}
} |
Option 2 - Order declined If show_form: false , the order is declined and the Klanra widget should be hidden requesting the customer to select a different method of payment. Code Block |
---|
{
approved: false,
show_form: false
} |
|
UI Step |
---|
Finalize the authorisaton According to Klarna documentation (Klarna Docs - Authorize the purchase) the following steps on client side are optional. Finalising an authorisation only applies to your integration if you offer payment methods where funds are drawn from the consumers directly, such as bank transfer or Sofort, in a multi-step checkout. If you integrate a multi-step checkout, you may call authorize() with the auto_finalize: false property set in order to indicate that there is a finalization step. In this case the response may differ. In a multi-step checkout scenario the authorize() call can be triggered when the consumer selects the payment method and then presses the “continue” button to go to the next step of the checkout. With Pay Now as payment method category however transferring the funds should only happen once the consumer has pressed the “buy” button to finalize the purchase. To cater for such a scenario authorize() can still be called when the consumer has selected the payment method, but with the auto_finalize property set to false. authorize() example: Code Block |
---|
Klarna.Payments.authorize(
{ payment_method_category: ‘pay_now’, auto_finalize: false},
{},
function(res) {
// proceed to next checkout page. The finalize_required property in the response indicates
// if finalize is needed or not.
//
// res = {
// show_form: true,
// approved: false,
// finalize_required: true
// }
}) |
Now when the consumer reached the last page in the checkout and can finalize the purchase finalize() is called. This will then trigger the transfer of funds and return the authorization token in the finalize callback. The flow is transparent to all payment method categories. That means if finalization was not needed in the authorize() call (e.g. for pay later) finalize()can be still be called and will return the authorization_token so that the implementation remains the same for all payment method categories. finalize() example: Code Block |
---|
Klarna.Payments.finalize(
{payment_method_category: ‘pay_now’},
{},
function(res) {
// res = {
// show_form: true,
// approved: true,
// authorization_token: ...
// }
}) |
|
|
Anchor |
---|
| start_session |
---|
| start_session |
---|
|
Genericpayment start_sessionThe first step is to setup a new checkout session by sending a genericpayment-request to our server API as listed below. This step is a pre-condition for loading the Klarna widget.
Please make sure to send the customer data within this request as it is needed to initiate a new session. A session will remain valid for 48 hours after the last update.
UI Text Box |
---|
|
Only submit a buyer's personal information within this request if you ensure the buyer has actively chosen Klarna as a payment method - due to GDPR. |
UI Expand |
---|
title | Request "Genericpayment - start_session" |
---|
|
| API parameter | Required | Comments |
---|
request | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Fixed Value |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| genericpayment |
|
| add_paydata[action] | + | identifies the request as one to start a new session Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Fixed Value |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| start_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. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| BASE 64 String |
|
| amount | + | Excerpt Include |
---|
| amount - definition |
---|
| amount - definition |
---|
nopanel | true |
---|
|
| currency | + | Excerpt Include |
---|
| currency - definition |
---|
| currency - definition |
---|
nopanel | true |
---|
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| allowed Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| EUR CHF DKK SEK NOK |
|
| country | + | Excerpt Include |
---|
| country - definition |
---|
| country - definition |
---|
nopanel | true |
---|
|
| firstname | - | Excerpt Include |
---|
| firstname - definition |
---|
| firstname - definition |
---|
nopanel | true |
---|
|
| lastname | - | Excerpt Include |
---|
| lastname - definition |
---|
| lastname - definition |
---|
nopanel | true |
---|
|
| company | - | Excerpt Include |
---|
| company - definition |
---|
| company - definition |
---|
nopanel | true |
---|
|
UI Text Box |
---|
| Submitting this parameter leads to a B2B transaction. Availability of B2B transactions is limited to some countries. |
| title | - | Excerpt Include |
---|
| title - definition |
---|
| title - definition |
---|
nopanel | true |
---|
|
| street | - | Excerpt Include |
---|
| street - definition |
---|
| street - definition |
---|
nopanel | true |
---|
|
| zip | - | Excerpt Include |
---|
| zip - definition |
---|
| zip - definition |
---|
nopanel | true |
---|
|
| city | - | Excerpt Include |
---|
| city - definition |
---|
| city - definition |
---|
nopanel | true |
---|
|
| state | - | Excerpt Include |
---|
| state - definition |
---|
| state - definition |
---|
nopanel | true |
---|
|
| addressaddition | - | Excerpt Include |
---|
| addressaddition - definition |
---|
| addressaddition - definition |
---|
nopanel | true |
---|
|
| gender | - | Excerpt Include |
---|
| gender - definition |
---|
| gender - definition |
---|
nopanel | true |
---|
|
| ip | - | Excerpt Include |
---|
| ip - definition |
---|
| ip - definition |
---|
nopanel | true |
---|
|
| email | - | Excerpt Include |
---|
| email - definition |
---|
| email - definition |
---|
nopanel | true |
---|
|
| telephonenumber | - | Excerpt Include |
---|
| telephonenumber - definition |
---|
| telephonenumber - definition |
---|
nopanel | true |
---|
|
| birthday | - | Excerpt Include |
---|
| birthday - definition |
---|
| birthday - definition |
---|
nopanel | true |
---|
|
mandatory for Austria, Germany, Switzerland and the Netherlands. | language | - | Excerpt Include |
---|
| language - definition |
---|
| language - definition |
---|
nopanel | true |
---|
|
| shipping_firstname | - | Excerpt Include |
---|
| shipping_firstname - definition |
---|
| shipping_firstname - definition |
---|
nopanel | true |
---|
|
| shipping_lastname | - | Excerpt Include |
---|
| shipping_lastname - definition |
---|
| shipping_lastname - definition |
---|
nopanel | true |
---|
|
| add_paydata[shipping_title] | - | Title recipient within the delivery address Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..50) |
|
| shipping_company | - | Excerpt Include |
---|
| shipping_company - definition |
---|
| shipping_company - definition |
---|
nopanel | true |
---|
|
| shipping_street | - | Excerpt Include |
---|
| shipping_street - definition |
---|
| shipping_street - definition |
---|
nopanel | true |
---|
|
| shipping_zip | - | Excerpt Include |
---|
| shipping_zip - definition |
---|
| shipping_zip - definition |
---|
nopanel | true |
---|
|
| shipping_city | - | Excerpt Include |
---|
| shipping_city - definition |
---|
| shipping_city - definition |
---|
nopanel | true |
---|
|
| shipping_country | - | Excerpt Include |
---|
| shipping_country - definition |
---|
| shipping_country - definition |
---|
nopanel | true |
---|
|
| shipping_state | - | Excerpt Include |
---|
| shipping_state - definition |
---|
| shipping_state - definition |
---|
nopanel | true |
---|
|
| | + | Excerpt Include |
---|
| successurl - definition |
---|
| successurl - definition |
---|
|
| errorurl | + | Excerpt Include |
---|
| errorurl - definition |
---|
| errorurl - definition |
---|
|
| backurl | + | Excerpt Include |
---|
| backurl - definition |
---|
| backurl - definition |
---|
|
| add_paydata[shipping_telephonenumber]
| - | telephone number of the recipient or a contact at the delivery address Section |
---|
Layout box |
---|
cssClass | payoneFormat |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payoneFormatValue |
---|
floating | left |
---|
| CHAR(1..30) |
|
| add_paydata[shipping_email] | - | email-address of the recipient or a contact at the delivery address Section |
---|
Layout box |
---|
cssClass | payoneFormat |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payoneFormatValue |
---|
floating | left |
---|
| CHAR(5..254) |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Symbols |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| RFC 5322 |
|
This parameter is required if a shipping adress is given. | add_paydata[last_four_ssn] | - | Last four digits for customer social security number. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| NUMERIC(4) |
|
| add_paydata[organization_entity_type] | - | Only relevant for B2B transactions. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| LIMITED_COMPANY PUBLIC_LIMITED_COMPANY ENTREPRENEURIAL_COMPANY LIMITED_PARTNERSHIP_LIMITED_COMPANY LIMITED_PARTNERSHIP GENERAL_PARTNERSHIP REGISTERED_SOLE_TRADER SOLE_TRADER CIVIL_LAW_PARTNERSHIP PUBLIC_INSTITUTION OTHER |
|
| add_paydata[organization_registry_id] | - | will be given to Klarna as "vat_id" |
|
UI Expand |
---|
title | Request "Genericpayment - start_session" |
---|
|
| API parameter | Required | Comments |
---|
add_paydata[action] | + | identifies the request as one to start a new session Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Fixed Value |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| start_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. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| BASE 64 String |
amount | + | Excerpt Include |
---|
amount - definition | amount - definition | nopanel | true |
---|
currency | + | Excerpt Include |
---|
currency - definition | currency - definition | nopanel | true |
---|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| allowed Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| EUR CHF DKK SEK NOK |
country | + | Excerpt Include |
---|
country - definition | country - definition | nopanel | true |
---|
firstname | - | Excerpt Include |
---|
firstname - definition | firstname - definition | nopanel | true |
---|
lastname | - | Excerpt Include |
---|
lastname - definition | lastname - definition | nopanel | true |
---|
company | - | Excerpt Include |
---|
company - definition | company - definition | nopanel | true |
---|
UI Text Box |
---|
| Submitting this parameter leads to a B2B transaction. Availability of B2B transactions is limited to some countries. |
title | - | Excerpt Include |
---|
title - definition | title - definition | nopanel | true |
---|
street | - | Excerpt Include |
---|
street - definition | street - definition | nopanel | true |
---|
zip | - | Excerpt Include |
---|
zip - definition | zip - definition | nopanel | true |
---|
city | - | Excerpt Include |
---|
city - definition | city - definition | nopanel | true |
---|
state | - | Excerpt Include |
---|
state - definition | state - definition | nopanel | true |
---|
addressaddition | - | Excerpt Include |
---|
addressaddition - definition | addressaddition - definition | nopanel | true |
---|
gender | - | Excerpt Include |
---|
gender - definition | gender - definition | nopanel | true |
---|
ip | - | Excerpt Include |
---|
ip - definition | ip - definition | nopanel | true |
---|
email | - | Excerpt Include |
---|
email - definition | email - definition | nopanel | true |
---|
telephonenumber | - | Excerpt Include |
---|
telephonenumber - definition | telephonenumber - definition | nopanel | true |
---|
birthday | - | Excerpt Include |
---|
birthday - definition | birthday - definition | nopanel | true |
---|
mandatory for Austria, Germany, Switzerland and the Netherlands. language | - | Excerpt Include |
---|
language - definition | language - definition | nopanel | true |
---|
shipping_firstname | - | Excerpt Include |
---|
shipping_firstname - definition | shipping_firstname - definition | nopanel | true |
---|
shipping_lastname | - | Excerpt Include |
---|
shipping_lastname - definition | shipping_lastname - definition | nopanel | true |
---|
add_paydata[shipping_title] | - | Title recipient within the delivery address Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..50) |
|
|
shipping_company | - | Excerpt Include |
---|
shipping_company - definition | shipping_company - definition | nopanel | true | shipping_streetshipping_street shipping_street | personalid - definition |
---|
nopanel | true |
---|
|
|
shipping_zip | - | Mandatory for Denmark, Finland, Norway and Sweden | it[n] | + | Klarna item type Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| goods : Goods shipment : Shipping charges handling : Handling fee voucher : Voucher / discount |
|
| id[n] | + | |
Excerpt Include |
---|
shipping_zip - definition | shipping_zip - definition | nopanel | true |
---|
shipping_city | - | Excerpt Include |
---|
shipping_city - definition | shipping_city - definition | nopanel | true |
---|
shipping_country | - | Excerpt Include |
---|
shipping_country - definition | shipping_country shipping_state | -shipping_state - definition | shipping_state - definition | nopanel | true |
---|
add_paydata[shipping_telephonenumber] - | | pr[n] - definition |
---|
| pr[n] - definition |
---|
nopanel | true |
---|
|
| no[n] | + | Excerpt Include |
---|
| no[n] - definition |
---|
| no[n] - definition |
---|
nopanel | true |
---|
|
| de[n] | + | Excerpt Include |
---|
| de[n] - definition |
---|
| de[n] - definition |
---|
nopanel | true |
---|
|
| va[n] | +
| Excerpt Include |
---|
| va[n] - definition |
---|
| va[n] - definition |
---|
nopanel | true |
---|
|
|
|
Code Block |
---|
title | Genericpayment start_session - Example Request |
---|
collapse | true |
---|
|
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=genericpayment
encoding=UTF-8
aid=12345 (your aid)
clearingtype=fnc
financingtype=KIS
amount=3000
currency=EUR
lastname=Approved
firstname=Testperson-de
salutation=Herr
country=DE
language=de
gender=m
add_paydata[action]=start_session
birthday=19600707
street=Hellersbergstraße 14
city=Musterstadt
zip=12345
email=youremail@email.com
telephonenumber=01512345678
de[1]=for the feet
id[1]=socks1
it[1]=goods
no[1]=1
pr[1]=2340
va[1]=1900 |
UI Expand |
---|
expanded | true |
---|
title | Response "Genericpayment - start_session" |
---|
|
| API parameter | Required | Comments |
---|
add_paydata[session_id] | + | Identifier for the started session at Klarna |
telephone number of the recipient or a contact at the delivery address Section |
---|
Layout box |
---|
cssClass | payoneFormat |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payoneFormatValue |
---|
floating | left |
---|
| CHAR(1..30) |
add_paydata[shipping_email] | - | email-address of the recipient or a contact at the delivery address Section |
---|
Layout box |
---|
cssClass | payoneFormat |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payoneFormatValue |
---|
floating | left |
---|
| CHAR(5..254) |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Symbols |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| RFC 5322 |
This parameter is required if a shipping adress is given. add_paydata[last_four_ssn] | - | Last four digits for customer social security number. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| NUMERIC(4) |
add_paydata[organization_entity_type] | - | Only relevant for B2B transactions. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| LIMITED_COMPANY PUBLIC_LIMITED_COMPANY ENTREPRENEURIAL_COMPANY LIMITED_PARTNERSHIP_LIMITED_COMPANY LIMITED_PARTNERSHIP GENERAL_PARTNERSHIP REGISTERED_SOLE_TRADER SOLE_TRADER CIVIL_LAW_PARTNERSHIP PUBLIC_INSTITUTION OTHER |
add_paydata[organization_registry_id] | - | will be given to Klarna as "vat_id"
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
|
| Format
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
CHAR(1..50) | personalid | - | Excerpt Include |
---|
personalid - definition | personalid - definition | nopanel | true |
---|
Mandatory for Denmark, Finland, Norway and Sweden it[n] | + | Klarna item type Section |
---|
068df369-13a7-4d47-a564-62f8408bb760 |
|
| 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 Payment Method Category to show on the Payment Page.
|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted ValuespayonePermittedSymbolsValue | floating | left |
---|
goods : Goods shipment : Shipping charges handling : Handling fee voucher : Voucher / discount | id[n] | + | Excerpt Include |
---|
id[n] - definition | id[n] - definition | nopanel | true |
---|
pr[n] | + | Excerpt Include |
---|
pr[n] - definition | pr[n] - definition | nopanel | true |
---|
no[n] | + | Excerpt Include |
---|
no[n] - definition | no[n] - definition | nopanel | true |
---|
de[n] | + | Excerpt Include |
---|
de[n] - definition | de[n] - definition | nopanel | true |
---|
va[n] | + Excerpt Include |
---|
va[n] - definition | va[n] - definition | nopanel | true |
---|
add_paydata[klsid] | - | Campaign code | |
UI Expand |
---|
expanded | true |
---|
title | Response "Genericpayment - start_session" |
---|
|
| payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| DIRECT_DEBIT DIRECT_BANK_TRANSFER PAY_NOW PAY_LATER PAY_OVER_TIME |
|
| add_paydata[payment_method_category_identifier] | + | Identifier for Klarna payment category Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| Pay_later Pay_now Pay_over_time Direct_bank_transfer Direct_debit |
|
| 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) Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| https://x.klarnacdn.net/payment-method/assets/badges/generic/klarna.svg |
|
| 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) |
| API parameter | Required | Comments |
---|
add_paydata[session_id] | + | Identifier for the started session at Klarna Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
068df369-13a7-4d47-a564-62f8408bb760 | 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] | + | https://x.klarnacdn.net/payment-method/assets/badges/generic/klarna.svg |
|
| status | + |
Name of Klarna payment category Payment Method Category to show on the Payment Page. |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
DIRECT_DEBIT DIRECT_BANK_TRANSFER PAY_NOW PAY_LATER PAY_OVER_TIME | currently only pay_later and pay_over_time are supported add_paydata[payment_method_category_identifier] | + | Identifier for Klarna payment category Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| pay_later direct_debit pay_over_time |
direct_debit is currently not supported | APPROVED |
|
|
---|
workorderid | + | Excerpt Include |
---|
| workorderid - definition |
---|
| workorderid - definition |
---|
nopanel | true |
---|
|
| ERROR |
|
|
---|
errorcode | + | Excerpt Include |
---|
| errorcode - definition |
---|
| errorcode - definition |
---|
nopanel | true |
---|
|
| errormessage | + | Excerpt Include |
---|
| errormessage - definition |
---|
| errormessage - definition |
---|
nopanel | true |
---|
|
| customermessage | + | Excerpt Include |
---|
| customermessage - definition |
---|
| customermessage - definition |
---|
nopanel | true |
---|
|
|
|
Code Block |
---|
title | Genericpayment start_session - Example Response |
---|
collapse | true |
---|
|
status=OK
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)
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
=https://x.klarnacdn.net/payment-method/assets/
badges/generic/klarna.svgbadges/generic/klarna.svg
add_paydata[client_token]=eyJhbGciOiJSUzI1NiJ9.ewogICJzZXNzaW9uX2lkIiA6ICI0N2EzNWIwOC1kNWVlLTcxYjUtOTVkMS1lYWU3NTFjNWJlZmIiLAogICJiYXNlX3VybCIgOiAiaHR0cHM6Ly9rbGFybmEtcGF5bWVudHMtZXUucGxheWdyb3VuZC5rbGFybmEuY29tIiwKICAiZGVzaWduIiA6ICJrbGFybmEiLAogICJsYW5ndWFnZSIgOiAiZW4iLAogICJwdXJjaGFzZV9jb3VudHJ5IiA6ICJERSIsCiAgInRyYWNlX2Zsb3ciIDogZmFsc2UsCiAgImVudmlyb25tZW50IiA6ICJwbGF5Z3JvdW5kIiwKICAibWVyY2hhbnRfbmFtZSIgOiAiWW91ciBidXNpbmVzcyBuYW1lIiwKICAic2Vzc2lvbl90eXBlIiA6ICJQQVlNRU5UUyIsCiAgImNsaWVudF9ldmVudF9iYXNlX3VybCIgOiAiaHR0cHM6Ly9ldnQucGxheWdyb3VuZC5rbGFybmEuY29tIiwKICAiZXhwZXJpbWVudHMiIDogWyBdCn0.gD6XVLaZeL541T1QYkGsZ01wbAYuTXyhIXcR8irG461U9w1HLugSji4_jc8LsE7cVWMVqLph_CJzCAiZNKzsC9AW6Mf88X8VdR9gV7owv3EVqEdK2K9-g-26Wu2pGE88Um2z2Iz7uUUzbhn6d4rI4CICOLsdaVXJ7MKhzPgnW-a6DM-K9JP2RLIflJKjn3wCjEtJSc_8gqj3_fv8YHaTWRkBd9pUGCBB0rUS-komFAPBdzZiCAbiw5Lsdk9dWpI2wszKeE_iPd6NuxGr4U37XtIX9Gc-uTfn21o0JUJddbiPtItmetWQSY_mruOO4WiVQxuZvxXk7XYwCCb8rrXYw
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)
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
identifier]=pay_over_time
add_paydata[session_id]=47a35b08-d5ee-71b5-95d1-eae751c5befb
add_paydata[payment_method_category_name]=Slice it.
add_paydata[payment_method_category_asset_url_standard]=https://x.klarnacdn.net/payment-method/assets/badges/generic/klarna.svg
status | + | Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
APPROVED ERROR |
APPROVED | workorderid | + | Excerpt Include |
---|
workorderid - definition | workorderid - definition | nopanel | true |
---|
ERROR | errorcode | + | Excerpt Include |
---|
errorcode - definition | errorcode - definition | nopanel | true |
---|
errormessage | + | Excerpt Include |
---|
errormessage - definition | errormessage - definition | nopanel | true |
---|
customermessage | + | Excerpt Include |
---|
customermessage - definition | customermessage - definition | nopanel | true |
---|
Code Block |
---|
title | Genericpayment start_session - Example Request |
---|
collapse | true |
---|
|
mid=23456 (your mid)
portalid=12345123 (your portalid)
key=abcdefghijklmn123456789 (your key)
api_version=3.10
mode=test (set to „live“ for live-requests)
request=genericpayment
encoding=UTF-8
aid=12345 (your aid)
clearingtype=fnc
financingtype=KIS
amount=3000
currency=EUR
lastname=Approved
firstname=Testperson-de
salutation=Herr
country=DE
language=de
gender=m
add_paydata[action]=start_session
birthday=19600707
street=Hellersbergstraße 14
city=Musterstadt
zip=12345
email=youremail@email.com
telephonenumber=01512345678
de[1]=for the feet
id[1]=socks1
it[1]=goods
no[1]=1
pr[1]=2340
va[1]=1900 |
Code Block |
---|
title | Genericpayment start_session - Example Response |
---|
collapse | true |
---|
|
status=OK
add_paydata[payment_method_category_asset_url_descriptive]=https://x.klarnacdn.net/payment-method/assets/badges/generic/klarna.svg
add_paydata[client_token]=eyJhbGciOiJSUzI1NiJ9.ewogICJzZXNzaW9uX2lkIiA6ICI0N2EzNWIwOC1kNWVlLTcxYjUtOTVkMS1lYWU3NTFjNWJlZmIiLAogICJiYXNlX3VybCIgOiAiaHR0cHM6Ly9rbGFybmEtcGF5bWVudHMtZXUucGxheWdyb3VuZC5rbGFybmEuY29tIiwKICAiZGVzaWduIiA6ICJrbGFybmEiLAogICJsYW5ndWFnZSIgOiAiZW4iLAogICJwdXJjaGFzZV9jb3VudHJ5IiA6ICJERSIsCiAgInRyYWNlX2Zsb3ciIDogZmFsc2UsCiAgImVudmlyb25tZW50IiA6ICJwbGF5Z3JvdW5kIiwKICAibWVyY2hhbnRfbmFtZSIgOiAiWW91ciBidXNpbmVzcyBuYW1lIiwKICAic2Vzc2lvbl90eXBlIiA6ICJQQVlNRU5UUyIsCiAgImNsaWVudF9ldmVudF9iYXNlX3VybCIgOiAiaHR0cHM6Ly9ldnQucGxheWdyb3VuZC5rbGFybmEuY29tIiwKICAiZXhwZXJpbWVudHMiIDogWyBdCn0.gD6XVLaZeL541T1QYkGsZ01wbAYuTXyhIXcR8irG461U9w1HLugSji4_jc8LsE7cVWMVqLph_CJzCAiZNKzsC9AW6Mf88X8VdR9gV7owv3EVqEdK2K9-g-26Wu2pGE88Um2z2Iz7uUUzbhn6d4rI4CICOLsdaVXJ7MKhzPgnW-a6DM-K9JP2RLIflJKjn3wCjEtJSc_8gqj3_fv8YHaTWRkBd9pUGCBB0rUS-komFAPBdzZiCAbiw5Lsdk9dWpI2wszKeE_iPd6NuxGr4U37XtIX9Gc-uTfn21o0JUJddbiPtItmetWQSY_mruOO4WiVQxuZvxXk7XYwCCb8rrXYw
add_paydata[payment_method_category_identifier]=pay_over_time
add_paydata[session_id]=47a35b08-d5ee-71b5-95d1-eae751c5befb
add_paydata[payment_method_category_name]=Slice it.
add_paydata[payment_method_category_asset_url_standard]=https://x.klarnacdn.net/payment-method/assets/badges/generic/klarna.svg
workorderid=WX1A37YBGD9D11DK |
Anchor |
---|
update_session | update_session | Genericpayment update_session
workorderid=WX1A37YBGD9D11DK |
Anchor |
---|
| update_session |
---|
| update_session |
---|
|
Genericpayment update_sessionIn order to update the session, e.g. the customer has added a new item tothe cart, 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 |
---|
|
- An update is only possible as long as the preauthorization is not captured completely.
- Do not send the difference/changes, instead you need to send the complete new item list
- The amount cannot be higher than the amount of the preauthorization. A lower amount is allowed.
|
UI Expand |
---|
title | Request "Genericpayment - update" |
---|
|
| API parameter | Required | Comments |
---|
request | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Fixed Value |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| genericpayment |
|
| add_paydata[action] | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Fixed value |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| update_session |
|
| add_paydata[reservation_txid] | + | Referencing the reservation (received from authorization.response -> add_paydata[reservation_txid]) | add_paydata[session_id] | + | Identifier for the started session at Klarna Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| 068df369-13a7-4d47-a564-62f8408bb760 |
|
| workorderid | + | Referencing the reservation (received from authorization.response -> add_paydata[workorderid]) Excerpt Include |
---|
| workorderid - definition |
---|
| workorderid - definition |
---|
nopanel | true |
---|
|
| country | + | Excerpt Include |
---|
| country - definition |
---|
| country - definition |
---|
nopanel | true |
---|
|
| amount | + | Excerpt Include |
---|
| amount - definition |
---|
| amount - definition |
---|
nopanel | true |
---|
|
| currency | + | Excerpt Include |
---|
| currency - definition |
---|
| currency - definition |
---|
nopanel | true |
---|
|
| financingtype | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| KIS KIV KDD
|
|
| it[n] | + | |
|
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 |
---|
|
- An update is only possible as long as the preauthorization is not captured completely.
- Don’t send the difference/changes, instead you need to send the complete new item list
- The amount can’t be higher than the amount of the preauthorization. A lower amount is allowed.
|
UI Expand |
---|
title | Request "Genericpayment - update" |
---|
|
| API parameter | Required | Comments |
---|
add_paydata[action] | + Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
|
| Fixed value
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
update_session | add_paydata[reservation_txid] | + | Referencing the reservation (received from authorization.response -> add_paydata[reservation_txid]) | add_paydata[session_id] | + | Identifier for the started session at Klarna Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| 068df369-13a7-4d47-a564-62f8408bb760 |
workorderid | + | Referencing the reservation (received from authorization.response -> add_paydata[workorderid]) Excerpt Include |
---|
goods : Goods shipment : Shipping charges handling : Handling fee voucher : Voucher / discount |
|
| id[n] | + | Excerpt Include |
---|
| id[n] - definition |
---|
| id[n] - definition |
---|
nopanel | true |
---|
|
AN..32 | pr[n] | + | Excerpt Include |
---|
| pr[n] - definition |
---|
| pr[n] - definition |
---|
nopanel | true |
---|
|
| no[n] | + | |
workorderid - definition | workorderid countrycountry country | de[n] - definition |
---|
nopanel | true |
---|
|
| amountamount amount | va[n] - definition |
---|
nopanel | true |
---|
|
| currency+currency | narrative_text - definition |
---|
|
| currency | narrative_text - definition |
---|
nopanel | true |
---|
|
| financingtype
|
UI Expand |
---|
title | Response "Genericpayment - update" |
---|
|
+ | Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| KIS KIV KDD it[n] | + | Klarna item type | API parameter | Required | Comments |
---|
status | + | |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
goods : Goods shipment : Shipping charges handling : Handling fee voucher : Voucher / discount | | APPROVED |
|
|
---|
workorderid | + | Excerpt Include |
---|
| workorderid - definition |
---|
| workorderid - definition |
---|
nopanel | true |
---|
|
| ERROR |
|
|
---|
errorcode | + | Excerpt Include |
---|
| errorcode - definition |
---|
| errorcode - definition |
---|
nopanel | true |
---|
|
| errormessage | id[n]id[n] | errormessage - definition |
---|
|
| id[n] pr[n] | | errormessage - definition |
---|
nopanel | true |
---|
|
|
AN..32 pr[n] | customermessage - definition |
---|
|
| pr[n] | customermessage - definition |
---|
nopanel | true |
---|
|
| non+ | no[n | add_paydata[reservation_txid] - definition |
---|
|
| no[n | add_paydata[reservation_txid] - definition |
---|
nopanel | true |
---|
|
| den+de[n] de[n] | workorderid - definition |
---|
nopanel | true |
---|
|
|
AN..50 va[n] | + | Excerpt Include |
---|
va[n] - definition | va[n] - definition | nopanel | true |
---|
narrative_text | - | Excerpt Include |
---|
narrative_text - definition | narrative_text - definition | nopanel | true |
---|
addresponsedata[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) |
|
Anchor |
---|
| cancel_authorization |
---|
| cancel_authorization |
---|
|
Genericpayment cancel_authorizationTo 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 |
---|
|
- An update is only possible as long as the preauthorization is not captured compeletly.
- Don’t send the difference/changes, instead you need to send the complete new item list
- The amount can’t be higher as the amount of the preauthorization. A lower amount is allowed.
|
UI Expand |
---|
title | Response Request "Genericpayment - updatecancel_authorization" |
---|
|
Response update | API parameter | Required | Comments |
---|
statusrequest | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
|
| Permitted Values
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
APPROVED ERROR | APPROVED | workorderid Excerpt Include |
---|
workorderid - definition | workorderid - definition | nopanel | true |
---|
ERROR | errorcode | + | Excerpt Include |
---|
errorcode - definition | errorcode - definition | nopanel | true |
---|
errormessage | + | Excerpt Include |
---|
errormessage - definition | errormessage - definition | nopanel | true |
---|
customermessage | + | Excerpt Include |
---|
customermessage - definition | customermessage - definition | nopanel | true |
---|
addresponsedata[reservation_txid] | Excerpt Include |
---|
add_paydata[reservation_txid] - definition | add_paydata[reservation_txid] - definition | nopanel | true | addresponsedata[workorderid]cancel_authorization | add_paydata[authorization_token] | + | Token of the authorization, which is to be canceled. Will be provided by Klarna's JS API |
|
UI Expand |
---|
title | Response "Genericpayment - cancel_authorization" |
---|
|
| API parameter | Required | Comments |
---|
status | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| APPROVED ERROR |
|
| APPROVED |
|
|
---|
workorderid | + | Excerpt Include |
---|
| workorderid - definition |
---|
| workorderid - definition |
---|
nopanel | true |
---|
|
|
addresponsedata[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) | |
Anchor |
---|
cancel_authorization | cancel_authorization | Genericpayment cancel_authorizationTo 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 |
---|
|
- An update is only possible as long as the preauthorization is not captured compeletly.
- Don’t send the difference/changes, instead you need to send the complete new item list
- The amount can’t be higher as the amount of the preauthorization. A lower amount is allowed.
|
UI Expand |
---|
title | Request "Genericpayment - cancel_authorization" |
---|
|
ERROR |
|
|
---|
errorcode | + | Excerpt Include |
---|
| errorcode - definition |
---|
| errorcode - definition |
---|
nopanel | true |
---|
|
| errormessage | + | Excerpt Include |
---|
| errormessage - definition |
---|
| errormessage - definition |
---|
nopanel | true |
---|
|
| customermessage | + | Excerpt Include |
---|
| customermessage - definition |
---|
| customermessage - definition |
---|
nopanel | true |
---|
|
|
|
Anchor |
---|
| authorization |
---|
| authorization |
---|
|
Preauthorization / Authorization |
API parameter | Required | Comments |
---|
add_paydata[action] | + | cancel_authorization |
add_paydata[authorization_token] | + | Token of the authorization, which is to be canceled. Will be provided by Klarna's JS API UI Expand |
---|
title | Response "Genericpayment - cancel_Request "preauthorization / authorization" |
---|
|
Response "Genericpayment - cancel_ | API parameter | Required | Comments |
---|
statusadd_paydata[authorization_token] | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
|
|
| Permitted Values
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
|
|
|
APPROVED ERROR | | 987d6543-f27b-45t5-b378-245465456780 |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| String |
|
| firstname |
APPROVED | workorderid | + | Excerpt Include |
---|
workorderid - definition | workorderid - definition | nopanel | true |
---|
ERROR | errorcodeerrorcode errorcode | firstname - definition |
---|
nopanel | true |
---|
|
| errormessagefull address required and must match the shipping-address | lastname | + | | errormessage errormessage | lastname - definition |
---|
nopanel | true |
---|
|
|
customermessage | full address required and must match the shipping-address | company | - | If filled, the transaction is marked as B2B. | +customermessage customermessage | company - definition |
---|
nopanel | true |
---|
|
|
|
Anchor |
---|
authorization | authorization | Preauthorization / Authorizationstreet | + | Excerpt Include |
---|
| street - definition |
---|
| street - definition |
---|
nopanel | true |
---|
|
full address required and must match the shipping-address | zip | + | Excerpt Include |
---|
| zip - definition |
---|
| zip - definition |
---|
nopanel | true |
---|
|
full address required and must match the shipping-address | city | + | Excerpt Include |
---|
| city - definition |
---|
| city - definition |
---|
nopanel | true |
---|
|
full address required and must match the shipping-address | country | + | Excerpt Include |
---|
| country - definition |
---|
| country - definition |
---|
nopanel | true |
---|
|
full address required and must match the shipping-address | addressaddition | o | Excerpt Include |
---|
| addressaddition - definition |
---|
| addressaddition - definition |
---|
nopanel | true |
---|
|
mandatory for NL | gender | o | Excerpt Include |
---|
| gender - definition |
---|
| gender |
---|
|
|
|
UI Expand |
---|
title | Request "preauthorization / authorization" |
---|
|
| API parameter | Required | Comments |
---|
add_paydata[authorization_token] | + | Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Sample |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| 987d6543-f27b-45t5-b378-245465456780 |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| String |
firstname | + | Excerpt Include |
---|
firstname - definition | firstname full address required and must match the shipping-address mandatory for Austria, Germany and the Netherlands "d" is currently not supported by Klarna | ip | lastnamelastname lastname | ip - definition |
---|
nopanel | true |
---|
|
|
full address required and must match the shipping-address company | - | If filled, the transaction is marked as B2B.company | telephonenumber - definition |
---|
|
| company | telephonenumber - definition |
---|
nopanel | true |
---|
|
| street+street street zip | + | | birthday - definition |
---|
nopanel | true |
---|
|
|
full address required and must match the shipping-address zip | shipping_firstname - definition |
---|
|
| zip city | + | | shipping_firstname - definition |
---|
nopanel | true |
---|
|
|
full address required and must match the shipping-address city | shipping_lastname - definition |
---|
|
| city | shipping_lastname - definition |
---|
nopanel | true |
---|
|
|
full address required and must match the shipping-address country | +country | shipping_company - definition |
---|
|
| country | shipping_company - definition |
---|
nopanel |
---|
|
|
true | full address required and must match the shipping-address addressaddition | +addressaddition | shipping_street - definition |
---|
|
| addressaddition | shipping_street - definition |
---|
nopanel | true |
---|
|
|
mandatory for NL gender | ogender | shipping_zip - definition |
---|
|
| gender | shipping_zip - definition |
---|
nopanel | true |
---|
|
|
mandatory for Austria, Germany and the Netherlands "d" is currently not supported by Klarna ip | +ip | shipping_city - definition |
---|
|
| ip | shipping_city - definition |
---|
nopanel | true |
---|
|
| email+email | shipping_country - definition |
---|
|
| email shipping_firstname | - | Excerpt Include |
---|
shipping_firstname - definition | shipping_firstname - definition | nopanel | true |
---|
shipping_lastname | - | Excerpt Include |
---|
shipping_lastname - definition | shipping_lastname - definition | nopanel | true |
---|
shipping_company | - | Excerpt Include |
---|
shipping_company - definition | shipping_company - definition | nopanel | true |
---|
shipping_street | - | Excerpt Include |
---|
shipping_street - definition | shipping_street - definition | nopanel | true |
---|
shipping_zip | - | Excerpt Include |
---|
shipping_zip - definition | shipping_zip - definition | nopanel | true |
---|
shipping_city | - | Excerpt Include |
---|
shipping_city - definition | shipping_city - definition | nopanel | true |
---|
shipping_country | - | Excerpt Include |
---|
shipping_country - definition | shipping_country - definition | nopanel | true |
---|
| shipping_country - definition |
---|
nopanel | true |
---|
|
| add_paydata[shipping_telephonenumber] | + | telephone number of the recipient or a contact at the delivery address |
Excerpt Include |
---|
telephonenumber - definition | telephonenumber - definition | nopanel | true |
---|
birthday | o | Excerpt Include |
---|
birthday - definition | birthday - definition | nopanel | true |
---|
mandatory for Austria, Germany, Switzerland and the Netherlands. layout-box-macro |
---|
cssClass | payoneFormat |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payoneFormatValue |
---|
floating | left |
---|
| CHAR(1..30) |
|
| add_paydata[shipping_email] | + | email-address of the recipient or a contact at the delivery address Section |
---|
Layout box |
---|
cssClass | payoneFormat |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payoneFormatValue |
---|
floating | left |
---|
| CHAR(5..254) |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Symbols |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| RFC 5322 |
|
This parameter is required if a shipping adress is given. | | + | Excerpt Include |
---|
| successurl - definition |
---|
| successurl - definition |
---|
|
| errorurl | + | Excerpt Include |
---|
| errorurl - definition |
---|
| errorurl - definition |
---|
|
| backurl | + | Excerpt Include |
---|
| backurl - definition |
---|
| backurl - definition |
---|
|
|
personalid | o | Excerpt Include |
---|
| personalid - definition |
---|
| personalid - definition |
---|
nopanel | true |
---|
|
Mandatory for Denmark, Finland, Norway and Sweden | it[n] | + | Klarna item type Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| goods : Goods shipment : Shipping charges handling : Handling fee voucher : Voucher / discount |
|
| id[n] | + | Excerpt Include |
---|
| id[n] - definition |
---|
| id[n] - definition |
---|
nopanel | true |
---|
|
| pr[n] | + | Excerpt Include |
---|
| pr[n] - definition |
---|
| pr[n] - definition |
---|
nopanel | true |
---|
|
| no[n] | + | Excerpt Include |
---|
| no[n] - definition |
---|
| no[n] - definition |
---|
nopanel | true |
---|
|
| de[n] | + | Excerpt Include |
---|
| de[n] - definition |
---|
| de[n] - definition |
---|
nopanel | true |
---|
|
| va[n] | + | Excerpt Include |
---|
| va[n] - definition |
---|
| va[n] - definition |
---|
nopanel | true |
---|
|
|
add_paydata[klsid] | o | | workorderid | + | Excerpt Include |
---|
| workorderid - definition |
---|
| workorderid - definition |
---|
nopanel | true |
---|
|
| Mandatory for Klarna Installments (KIS): Campaign code
|
Code Block |
---|
title | Authorization - Example Request |
---|
collapse | true |
---|
|
add_paydata[authorization_token]=aaa-bbbb-11111-2222-ccc
add_paydata[shipping_telephonenumber]=016545521585
add_paydata[shipping_email]=klarna@approved.de
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=KIS
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 |
UI Expand |
---|
title | Response "preauthorization / authorization" |
---|
|
| | Required | Format | Comment |
---|
status | + |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| REDIRECT ERROR PENDING |
|
| 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) | |
---|
txid | + |
| Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| userid | + |
| Excerpt Include |
---|
| userid - definition |
---|
| userid - definition |
---|
nopanel | true |
---|
|
| |
---|
txid | + |
| Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| userid | + |
| Excerpt Include |
---|
| userid - definition |
---|
| userid - definition |
---|
nopanel | true |
---|
|
| |
---|
txid | + |
| Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| userid | + |
| Excerpt Include |
---|
| userid - definition |
---|
| userid - definition |
---|
nopanel | true |
---|
|
| redirecturl | + |
| Excerpt Include |
---|
| redirecturl - definition |
---|
| redirecturl - definition |
---|
nopanel | true |
---|
|
| |
---|
errormessage | + |
| Excerpt Include |
---|
| errormessage - definition |
---|
| errormessage - definition |
---|
nopanel | true |
---|
|
| customermessage | - |
| Excerpt Include |
---|
| customermessage - definition |
---|
| customermessage - definition |
---|
nopanel | true |
---|
|
|
|
Code Block |
---|
title | Authorization - Example Response |
---|
collapse | true |
---|
|
redirecturl=https://klarna-payments-eu.playground.klarna.com/v1/sessions/aaa-bbbb-11111-2222-ccc/redirect
status=REDIRECT
txid=30343747
userid=7890123 |
=REDIRECT
txid=30343747
userid=7890123 |
In the capturing step either the full amount or a partial amount can be captured. It is also possible to split the capturing in two steps, capturing an initial amount and subsequently capturing the remaining outstanding amount. Please note that the amount in the capture request must be equal or less than the remaining authorised amount.
In the capture call one can provide the order lines thar are part of the shipment. By using the exact same order line name and reference as in the order, you will improve the customer's experience in the Klarna App.
UI Expand |
---|
|
| API parameter | Required | Comments |
---|
txid | + | Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| sequencenumber | o | Excerpt Include |
---|
| sequencenumber - definition |
---|
| sequencenumber - definition |
---|
nopanel | true |
---|
|
| capturemode | + | Parameter capturemode is mandatory to indicate whether this capture will be the last one. (Default: completed) Excerpt Include |
---|
| capturemode - definition |
---|
| capturemode - definition |
---|
nopanel | true |
---|
|
| settleaccount | + | Parameter settleaccount is mandatory to indicate whether a refund to the customer should be initiated. (Default: yes) Excerpt Include |
---|
| settleaccount - definition |
---|
| settleaccount - definition |
---|
nopanel | true |
---|
|
| amount | + | Excerpt Include |
---|
| amount - definition |
---|
| amount - definition |
---|
nopanel | true |
---|
|
| currency | + | Excerpt Include |
---|
| settleaccount - definition |
---|
| settleaccount - definition |
---|
nopanel | true |
---|
|
| narrative_text | - | Excerpt Include |
---|
| narrative_text - definition |
---|
| narrative_text - definition |
---|
nopanel | true |
---|
|
| de[n] | - | Excerpt Include |
---|
| de[n] - definition |
---|
| de[n] - definition |
---|
nopanel | true |
---|
|
| no[n] | - | Excerpt Include |
---|
| no[n] - definition |
---|
| no[n] - definition |
---|
nopanel | true |
---|
|
| id[n] | - | Excerpt Include |
---|
| id[n] - definition |
---|
| id[n] - definition |
---|
nopanel | true |
---|
|
| it[n] | - | Excerpt Include |
---|
| it[n] - definition |
---|
| it[n] - definition |
---|
nopanel | true |
---|
|
| va[n] | - | Excerpt Include |
---|
| va[n] - definition |
---|
| va[n] - definition |
---|
nopanel | true |
---|
|
| pr[n] | - | Excerpt Include |
---|
| pr[n] - definition |
---|
| pr[n] - definition |
---|
nopanel | true |
---|
|
| add_paydata[shipping_info_shipping_company_n] | - | Name of the shipping company (as specific as possible). Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..100) |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Samples |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| DHL US DHL |
|
| add_paydata[shipping_info_shipping_method_n] | - | Shipping method. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| PickUpStore Home BoxReg BoxUnreg PickUpPoint Own |
|
| add_paydata[shipping_info_tracking_number_n] | - | Tracking number for the shipment. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..100) |
|
| add_paydata[shipping_info_tracking_uri_n] | - | URI where the customer can track their shipment. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..1024) |
|
| add_paydata[shipping_info_return_shipping_company_n] | - | Name of the shipping company for the return shipment (as specific as possible). Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..100) |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Samples |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| DHL US DHL |
|
| add_paydata[shipping_info_return_tracking_uri_n] | - | URL where the customer can track the return shipment. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| CHAR(1..1024) |
|
| add_paydata[shipping_delay] | - | Delay before the order will be shipped. Use for improving the customer experience regarding payments. This field is currently not returned when reading the order. Please note: to be able to submit values larger than 0, this has to be enabled in your merchant account. Please contact Klarna for further information. Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Format |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| INT(1..50) |
|
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| min: 0 |
|
|
|
UI Expand |
---|
|
|
---|
| Required | Comment |
---|
status | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| APPROVED ERROR |
|
| clearing_instructionnote | o | - A URL pointing to a PDF of the invoice. (If invoice by mail or by e-mail isn’t activated.)
- The URL is valid for 30 days.
- This feature has to be requested.
| |
---|
txid | + | Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| settleaccount | + | Excerpt Include |
---|
| settleaccount response - definition |
---|
| settleaccount response - definition |
---|
nopanel | true |
---|
|
| |
---|
errorcode | + | Excerpt Include |
---|
| errorcode - definition |
---|
| errorcode - definition |
---|
nopanel | true |
---|
|
| errormessage | - | Excerpt Include |
---|
| errormessage - definition |
---|
| errormessage - definition |
---|
nopanel | true |
---|
|
| customermessage | - | Excerpt Include |
---|
| customermessage - definition |
---|
| customermessage - definition |
---|
nopanel | true |
---|
|
|
|
/ Refund UI Expand |
---|
|
| Common Parameter | Required | Short explanation |
---|
txid | + | Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| sequencenumber | + | Excerpt Include |
---|
| sequencenumber - definition |
---|
| sequencenumber - definition |
---|
nopanel | true |
---|
|
| amount | + | To transfer an amount from the merchant to the customer, the amount has to be negative. Excerpt Include |
---|
| amount debit - definition |
---|
| amount debit - definition |
---|
nopanel | true |
---|
|
| currency | + | Excerpt Include |
---|
| currency - definition |
---|
| currency - definition |
---|
nopanel | true |
---|
|
| narrative_text | - | Excerpt Include |
---|
| narrative_text - definition |
---|
| narrative_text - definition |
---|
nopanel | true |
---|
|
| use_customerdata | - | Excerpt Include |
---|
| use_customerdata - definition |
---|
| use_customerdata - definition |
---|
nopanel | true |
---|
|
| transaction_param | - | Excerpt Include |
---|
| transaction_param - definition |
---|
| transaction_param - definition |
---|
nopanel | true |
---|
|
|
|
---|
settleaccount | + | Parameter settleaccount is mandatory to indicate whether a refund to the customer should be initiated. (Default: yes) Excerpt Include |
---|
| settleaccount - definition |
---|
| settleaccount - definition |
---|
nopanel | true |
---|
|
| invoiceid | - | Excerpt Include |
---|
| invoiceid - definition |
---|
| invoiceid - definition |
---|
nopanel | true |
---|
|
| invoice_deliverymode | - | Excerpt Include |
---|
| invoice_deliverymode - definition |
---|
| invoice_deliverymode - definition |
---|
nopanel | true |
---|
|
| invoiceappendix | - | Excerpt Include |
---|
| invoiceappendix - definition |
---|
| invoiceappendix - definition |
---|
nopanel | true |
---|
|
| invoice_deliverydate | - | Excerpt Include |
---|
| invoice_deliverydate - definition |
---|
| invoice_deliverydate - definition |
---|
nopanel | true |
---|
|
| invoice_deliveryenddate | - | Excerpt Include |
---|
| invoice_deliveryenddate - definition |
---|
| invoice_deliveryenddate - definition |
---|
nopanel | true |
---|
|
| it[n] | - | Excerpt Include |
---|
| it[n] - definition |
---|
| it[n] - definition |
---|
nopanel | true |
---|
|
| id[n] | - | Excerpt Include |
---|
| id[n] - definition |
---|
| id[n] - definition |
---|
nopanel | true |
---|
|
| pr[n] | - | Excerpt Include |
---|
| pr[n] - definition |
---|
| pr[n] - definition |
---|
nopanel | true |
---|
|
| no[n] | - | Excerpt Include |
---|
| no[n] - definition |
---|
| no[n] - definition |
---|
nopanel | true |
---|
|
| de[n] | - | Excerpt Include |
---|
| de[n] - definition |
---|
| de[n] - definition |
---|
nopanel | true |
---|
|
| va[n] | - | Excerpt Include |
---|
| va[n] - definition |
---|
| va[n] - definition |
---|
nopanel | true |
---|
|
| sd[n] | - | Excerpt Include |
---|
| sd[n] - definition |
---|
| sd[n] - definition |
---|
nopanel | true |
---|
|
| ed[n] | - | Excerpt Include |
---|
| ed[n] - definition |
---|
| ed[n] - definition |
---|
nopanel | true |
---|
|
|
|
UI Expand |
---|
|
|
---|
| Required | Comment |
---|
status | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| APPROVED ERROR |
|
| |
---|
txid | + | Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| settleaccount | + | Excerpt Include |
---|
| settleaccount response - definition |
---|
| settleaccount response - definition |
---|
nopanel | true |
---|
|
| |
---|
errorcode | + | Excerpt Include |
---|
| errorcode - definition |
---|
| errorcode - definition |
---|
nopanel | true |
---|
|
| errormessage | - | Excerpt Include |
---|
| errormessage - definition |
---|
| errormessage - definition |
---|
nopanel | true |
---|
|
| customermessage | - | Excerpt Include |
---|
| customermessage - definition |
---|
| customermessage - definition |
---|
nopanel | true |
---|
|
|
|
For refunding / crediting the amount to the customer a Refund request can be triggered.
The refunded amount must not be higher than the captured amount. The refunded amount can be accompanied by a descriptive text and order lines. By using the exact same order line name and reference as in the capture, one will improve the customer's experience in the Klarna App as well the payment instructions sent to the customer.
UI Expand |
---|
|
| API parameter | Required | Comments |
---|
txid | + | Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| sequencenumber | + | Excerpt Include |
---|
| sequencenumber - definition |
---|
| sequencenumber - definition |
---|
nopanel | true |
---|
|
| amount | + | Excerpt Include |
---|
| amount refund - definition |
---|
| amount refund - definition |
---|
nopanel | true |
---|
|
| currency | + | Excerpt Include |
---|
| currency - definition |
---|
| currency - definition |
---|
nopanel | true |
---|
|
| narrative_text | - | Excerpt Include |
---|
| narrative_text - definition |
---|
| narrative_text - definition |
---|
nopanel | true |
---|
|
| use_customerdata | - | Excerpt Include |
---|
| use_customerdata - definition |
---|
| use_customerdata - definition |
---|
nopanel | true |
---|
|
| transaction_param | - | Excerpt Include |
---|
| transaction_param - definition |
---|
| transaction_param - definition |
---|
nopanel | true |
---|
|
| invoiceid | - | Excerpt Include |
---|
| invoiceid - definition |
---|
| invoiceid - definition |
---|
nopanel | true |
---|
|
| invoice_deliverymode | - | Excerpt Include |
---|
| invoice_deliverymode - definition |
---|
| invoice_deliverymode - definition |
---|
nopanel | true |
---|
|
| invoiceappendix | - | Excerpt Include |
---|
| invoiceappendix - definition |
---|
| invoiceappendix - definition |
---|
nopanel | true |
---|
|
| invoice_deliverydate | - | Excerpt Include |
---|
| invoice_deliverydate - definition |
---|
| invoice_deliverydate - definition |
---|
nopanel | true |
---|
|
| invoice_deliveryenddate | - | Excerpt Include |
---|
| invoice_deliveryenddate - definition |
---|
| invoice_deliveryenddate - definition |
---|
nopanel | true |
---|
|
| de[n] | - | Excerpt Include |
---|
| de[n] - definition |
---|
| de[n] - definition |
---|
nopanel | true |
---|
|
| no[n] | - | Excerpt Include |
---|
| no[n] - definition |
---|
| no[n] - definition |
---|
nopanel | true |
---|
|
| id[n] | - | Excerpt Include |
---|
| id[n] - definition |
---|
| id[n] - definition |
---|
nopanel | true |
---|
|
| pr[n] | - | Excerpt Include |
---|
| pr[n] - definition |
---|
| pr[n] - definition |
---|
nopanel | true |
---|
|
| it[n] | - | Excerpt Include |
---|
| it[n] - definition |
---|
| it[n] - definition |
---|
nopanel | true |
---|
|
| va[n] | - | Excerpt Include |
---|
| va[n] - definition |
---|
| va[n] - definition |
---|
nopanel | true |
---|
|
|
|
UI Expand |
---|
|
|
---|
| Required | Comment |
---|
status | + |
Section |
---|
Layout box |
---|
cssClass | payonePermittedSymbols |
---|
floating | left |
---|
| Permitted Values |
Layout box |
---|
cssClass | payonePermittedSymbolsValue |
---|
floating | left |
---|
| APPROVED ERROR |
|
| |
---|
txid | + | Excerpt Include |
---|
| txid - definition |
---|
| txid - definition |
---|
nopanel | true |
---|
|
| settleaccount | + | Excerpt Include |
---|
| settleaccount response - definition |
---|
| settleaccount response - definition |
---|
nopanel | true |
---|
|
| |
---|
errorcode | + | Excerpt Include |
---|
| errorcode - definition |
---|
| errorcode - definition |
---|
nopanel | true |
---|
|
| errormessage | - | Excerpt Include |
---|
| errormessage - definition |
---|
| errormessage - definition |
---|
nopanel | true |
---|
|
| customermessage | - | Excerpt Include |
---|
| customermessage - definition |
---|
| customermessage - definition |
---|
nopanel | true |
---|
|
|
|
Voucher Handling
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)
- 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)