Reserve action
Reserve Request
The reserve action is the first step to process the payment of an order with Klarna. It will return a redirect URL to forward the consumer. It is important to handle the push sent by Buckaroo of the reservation that contains the Klarna order reference ID. This will require handling the follow-up actions.
Minimal Reserve Request
{
"Currency": "EUR",
"Invoice": "Ref.1 OrderID",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "Reserve",
"Parameters": [
{
"Name": "locale",
"Value": "de-DE"
},
{
"Name": "OperatingCountry",
"Value": "DE"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "1",
"Value": "12345"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "1",
"Value": "General"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "2"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "12.34"
}
]
}
]
}
}
Full Reserve Request
{
"Currency": "EUR",
"Invoice": "Ref.1 OrderID",
"PushURL": "https://merchantURL.domain",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "Reserve",
"Parameters": [
{
"Name": "locale",
"Value": "de-DE"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "1",
"Value": "Blue Toy Car"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "1",
"Value": "12345"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "1",
"Value": "General"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "2"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "12.34"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "1",
"Value": "21"
},
{
"Name": "ArticleImageUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://apod.nasa.gov/apod/image/2210/ngc4631_sherick.jpg"
},
{
"Name": "ArticleProductUrl",
"GroupType": "Article",
"GroupID": "1",
"Value": "https://apod.nasa.gov/apod/astropix.html"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "2",
"Value": "Discount"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "2",
"Value": "Discount on product"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "2",
"Value": "1234567"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "2",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "2",
"Value": "-2.50"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "2",
"Value": "0"
},
{
"Name": "BillingFirstName",
"Value": "Testperson-de"
},
{
"Name": "BillingLastName",
"Value": "Approved"
},
{
"Name": "BillingStreet",
"Value": "Neue Schönhauser Str. 2 XII"
},
{
"Name": "BillingStreet2",
"Value": "Bill Ergänzungen"
},
{
"Name": "BillingPostalCode",
"Value": "10178"
},
{
"Name": "BillingCity",
"Value": "Berlin"
},
{
"Name": "BillingCountry",
"Value": "DE"
},
{
"Name": "BillingCellPhoneNumber",
"Value": "01761528435"
},
{
"Name": "BillingEmail",
"Value": "[email protected]"
},
{
"Name": "ShippingFirstName",
"Value": "Testperson-de"
},
{
"Name": "ShippingLastName",
"Value": "Approved"
},
{
"Name": "ShippingStreet",
"Value": "Neue Schönhauser Str. 3 IIV"
},
{
"Name": "ShippingStreet2",
"Value": "Shipp Ergänzungen"
},
{
"Name": "ShippingPostalCode",
"Value": "10178"
},
{
"Name": "ShippingCity",
"Value": "Berlin"
},
{
"Name": "ShippingCountry",
"Value": "DE"
},
{
"Name": "ShippingPhoneNumber",
"Value": "01761428434"
},
{
"Name": "ShippingEmail",
"Value": "[email protected]"
},
{
"Name": "OperatingCountry",
"Value": "DE"
},
{
"Name": "Pno",
"Value": "10071970"
},
{
"Name": "ShippingSameAsBilling",
"Value": "false"
},
{
"Name": "ContentType",
"GroupType": "Attachment",
"Value": "application/vnd.klarna.internal.emd-v2+json"
},
{
"Name": "Body",
"GroupType": "Attachment",
"Value": "{\"ExtraMerchantData\":\"Value\"}"
}
]
}
]
}
}
Request Parameters
| Parameter | Type | OCM | Description |
|---|---|---|---|
| locale | string | O | Allowed Values nl-NL / en-NL / nl-BE / fr-BE / be-BE / en-BE / de-DE / en-DE / de-AT / en-AT / de-CH / fr-CH / it-CH / en-CH / sv-SE / en-SE / nb-NO / en-NO / da-DK / en-DK / fi-FI / sv-FI / en-FI / en-GB / en-IE / fr-FR / en-FR / it-IT / en-IT / es-ES / en-ES / pt-PT / en-PT / pl-PL / en-PL |
| OperatingCountry | string | M | Allowed values NL / BE / DE / AT / CH / DK / SE / NO / GB / FI / PL / IE / FR / IT / ES / PT |
| ArticleTitle | string | M | Name of article |
| ArticleNumber | string | O | Unique product number |
| ArticleType | string | O | Allowed values: physical / digital / shipping_fee / surcharge / discount / gift_card / store_credit |
| ArticlePrice | decimal | M | Price Including VAT |
| ArticleQuantity | integer | M | Number of articles |
| ArticleVat | decimal | O | VAT percentage |
| ArticleImageUrl | string | O | Url of Product image |
| ArticleProductUrl | string | O | Url of PDP |
| BillingFirstName | string | O | Customer first name |
| BillingLastName | string | O | Customer last name |
| BillingStreet | string | O | Customer 1st line address |
| BillingStreet2 | string | O | Customer 2nd line address |
| BillingPostalCode | string | O | Customer postal code |
| BillingCellPhoneNumber | string | O | Customer phone number |
| BillingCity | string | O | Customer city |
| BillingCountry | string | O | Customer Country |
| BillingEmail | string | O | Customer email address |
| Pno | string | O | Customer birthdate format: DDMMYYYY or Customer PNO |
| ShippingSameAsBilling | boolean | O | Customer address and shipping address is the same TRUE / FALSE |
| ShippingCareOf | string | O | Person/company receiving the shipment on behalf of the shipping recipient |
| ShippingFirstName | string | O | Delivery address first name. |
| ShippingLastName | String | O | Delivery address last name. |
| ShippingStreet | string | O | Delivery address 1st address line |
| ShippingStreet2 | string | O | Delivery address 2nd address line |
| ShippingPostalCode | string | O | Delivery address postal code |
| ShippingCity | string | O | Delivery address city |
| ShippingCountry | string | O | Delivery address country code. It should be the same as Billing country. |
| ShippingEmail | string | O | Delivery address email address |
| ShippingCellPhoneNumber | string | O | Delivery address phone number |
| ShippingCompany | string | O | Delivery address company name |
| ContentType | string | O | Content type agreed with Klarna ex. "application/vnd.klarna.internal.emd-v2+json" |
| Body | string | O | Additional Parameters based on agreed format with Klarna |
Reserve Response
A successful request will return a requiredAction redirect URL to forward the consumer to the Hosted page of Klarna.
General Reserve Response
{
"Key": "49EF793FC7AC404EABC4F57A32F5F08D",
"Status": {
"Code": {
"Code": 791,
"Description": "Pending processing"
},
"SubCode": {
"Code": "S002",
"Description": "An additional action is required: Redirect to KlarnaKp"
},
"DateTime": "2019-12-03T14:48:27"
},
"RequiredAction": {
"RedirectURL": "https://checkout.buckaroo.nl/html/redirect.ashx?r=3D349C783491413EBAF06660932EF0BF",
"RequestedInformation": null,
"Name": "Redirect",
"TypeDeprecated": 0
},
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "KlarnaKp",
"IsTest": true,
"ConsumerMessage": null
}
Reserve Push
{
"DataRequest": {
"Key": "34C088DBD9244F27B3C62C21C7D6D6C8",
"Invoice": "Ref.1 OrderID Reserve",
"ServiceCode": "KlarnaKp",
"ActionCode": "Reserve",
"Status": {
"Code": {
"Code": 190,
"Description": "The request was successful."
},
"SubCode": null,
"DateTime": "2023-03-27T07:28:26"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0,
"Services": [
{
"Name": "KlarnaKp",
"Action": null,
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "11ab9249-95c7-41e8-86fa-0a60030d9eef"
}
],
"VersionAsProperty": 1
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 0,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": null
}
}
Push Parameters
| Parameter | Type | OCM | Description |
|---|---|---|---|
| ServiceCode | string | M | Klarna service label is KlarnaKp |
| Code | string | M | Contains the status of the transaction |
| IsTest | boolean | M | If there are actual funds processed |
| ReservationNumber | string | O | Contains ReservationNumber of Klarna for future actions |
Updated 2 months ago