Requests
Reserve
Start an order by performing a Reserve request. When approved by Klarna, a reservation will be created for the specified products. For this call, the AmounDebit parameter can be left out (but do specify the currency). A discount should be specified as an article, with a negative ArticlePrice. Lastly, B2B orders are not supported..
Use the base request as instructed on this page
Reserve request
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
ClientIP | string | Required | IP-address of the customer, in the following format: "ClientIP": { "Type": 0, "Address": "0.0.0.0" }, where type 0 = IPv4 and type 1 = IPv6. Note: this is a basic parameter. | |
ArticleTitle | string | Required | Name of article | |
ArticleNumber | string | Required | Number by which the article is identified | |
ArticleType | string | Whether the article is a product or a discount (value = General), a shipping fee (value = ShipmentFee) or a fee for the chosen payment method (value = HandlingFee). This parameter is not required but can be used to place the products in the right order on the invoice that Klarna sends. | ||
ArticlePrice | decimal | Required | Price per article (including VAT) | |
ArticleQuantity | integer | Required | Number of articles | |
ArticleVat | decimal | Required | VAT percentage of article | |
BillingCareOf | string | Person/company receiving the invoice on behalf of billed person | ||
BillingCellPhoneNumber | string | Billing cell phone number. It is required to sent in at least 1 billing phone number; either BillingCellPhoneNumber or BillingPhoneNumber. | ||
BillingCity | string | Required | Billing city | |
BillingCompanyName | string | Billing company name | ||
BillingCountry | string | Required | Billing country. Possible values: NL (Netherlands), BE (Belgium), DE (Germany) or AT (Austria). | |
BillingEmail | string | Required | ||
BillingFirstName | string | Required | Billing first name | |
BillingLastName | string | Billing last name | ||
BillingHouseNumber | string | Required | Billing house number | |
BillingHouseNumberSuffix | string | Billing house number suffix (NL) | ||
BillingPhoneNumber | string | Billing phone number. It is required to sent in at least 1 billing phone number; either BillingCellPhoneNumber or BillingPhoneNumber. | ||
BillingPostalCode | string | Billing postal code | ||
BillingStreet | string | Required | Billing street | |
Gender | integer | The gender of the customer. 1=Male, 2=Female. | ||
OperatingCountry | string | Required | Country where your sales will be. Possible values: NL (Netherlands), BE (Belgium), DE (Germany) or AT (Austria). It must be the same as BillingCountry. | |
Pno | date | Consumer’s birth date. Use the following format: DDMMYYYY | ||
ShippingSameAsBilling | boolean | Required | Specifies whether the billing address is the same as the shipping address | |
ShippingCareOf | string | Person/company receiving the shipment on behalf of the shipping recipient | ||
ShippingCellPhoneNumber | string | Shipping cell phone number. If Shipping address is provided, then it is required to sent in at least 1 shipping phone number; either ShippingCellPhoneNumber or ShippingPhoneNumber. | ||
ShippingCity | string | Shipping city | ||
ShippingCompany | string | Shipping company name | ||
ShippingCountry | string | Shipping country code. It should be the same as Billing country. | ||
ShippingEmail | string | Shipping email address | ||
ShippingFirstName | string | Shipping first name. It should be the same as Billing first name | ||
ShippingLastName | String | Shipping last name. It should be the same as Billing last name | ||
ShippingHouseNumber | string | Shipping house number | ||
ShippingHouseNumberSuffix | string | Shipping house number suffix | ||
ShippingPhoneNumber | string | Shipping phone number. If Shipping address is provided, then it is required to sent in at least 1 shipping phone number; either ShippingCellPhoneNumber or ShippingPhoneNumber. | ||
ShippingPostalCode | string | Shipping postal code | ||
ShippingStreet | string | Shipping street | ||
ArticleImageUrl | string | Article Image URL | ||
ArticleProductUrl | string | Article Product URL | ||
Body | string | GroupType: Attachment. Additional parameter that can be included to add additional merchant information. Check with Klarna if this is applicable, and for the exact format, as this can differ per merchant | ||
ContentType | string | GroupType: Attachment. Additional parameter that can be included to add additional merchant information. Check with Klarna if this is applicable, and for the exact format, as this can differ per merchant. Default value: "application/vnd.klarna.internal.emd-v2+json" |
Example request
{
"Currency": "EUR",
"Invoice": "testinvoice 1234zh",
"ClientIP": {
"Type": 0,
"Address": "0.0.0.0"
},
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "Reserve",
"Parameters": [
{
"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": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "1",
"Value": "19"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "2",
"Value": "Yellow Toy Train"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "2",
"Value": "123456"
},
{
"Name": "ArticleType",
"GroupType": "Article",
"GroupID": "2",
"Value": "General"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "2",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "2",
"Value": "5.00"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "2",
"Value": "19"
},
{
"Name": "ArticleTitle",
"GroupType": "Article",
"GroupID": "3",
"Value": "Discount"
},
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "3",
"Value": "1234567"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "3",
"Value": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "3",
"Value": "-1.00"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "3",
"Value": "0"
},
{
"Name": "BillingFirstName",
"Value": "Testperson-nl"
},
{
"Name": "BillingLastName",
"Value": "Approved"
},
{
"Name": "BillingStreet",
"Value": "Neherkade"
},
{
"Name": "BillingHouseNumber",
"Value": "1"
},
{
"Name": "BillingPostalCode",
"Value": "2521VA"
},
{
"Name": "BillingCity",
"Value": "Gravenhage"
},
{
"Name": "BillingCountry",
"Value": "NL"
},
{
"Name": "BillingCellPhoneNumber",
"Value": "0612345678"
},
{
"Name": "BillingEmail",
"Value": "youremail@example.nl"
},
{
"Name": "ShippingFirstName",
"Value": "Testperson-nl"
},
{
"Name": "ShippingLastName",
"Value": "Approved"
},
{
"Name": "ShippingStreet",
"Value": "Neherkade"
},
{
"Name": "ShippingHouseNumber",
"Value": "2"
},
{
"Name": "ShippingPostalCode",
"Value": "2521VA"
},
{
"Name": "ShippingCity",
"Value": "Gravenhage"
},
{
"Name": "ShippingCountry",
"Value": "NL"
},
{
"Name": "ShippingPhoneNumber",
"Value": "0698765432"
},
{
"Name": "ShippingEmail",
"Value": "youremail@example.nl"
},
{
"Name": "Gender",
"Value": "1"
},
{
"Name": "OperatingCountry",
"Value": "NL"
},
{
"Name": "Pno",
"Value": "10071970"
},
{
"Name": "ShippingSameAsBilling",
"Value": "false"
}
]
}
]
}
}
Reserve response
If the request has a valid structure and a valid signature, a transaction will be created in the Payment Engine and a gateway response will be returned. In this case, the response will return a pending status and an additional action is required before the transaction can be completed; the customer needs to be redirected to the payment environment through the returned RedirectURL.
Parameters
Example 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
When the customer has successfully completed the transaction and returned to the merchant environment, Buckaroo will update the transaction status to success. This status update will be pushed to the push URL provided by the merchant.
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
ReservationNumber | string | Klarna reservation number. This number is required for the Pay call. |
Example push
{
"DataRequest": {
"Key": "49EF793FC7AC404EABC4F57A32F5F08D",
"Invoice": "testinvoice 1234zh",
"ServiceCode": "klarnakp",
"ActionCode": "Reserve",
"Status": {
"Code": {
"Code": 190,
"Description": "Transaction successfully processed"
},
"SubCode": null,
"DateTime": "2017-09-22T09:13:49+02:00"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0.0,
"Services": [
{
"Name": "klarnakp",
"Action": null,
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "2379012xxx"
}
],
"VersionAsProperty": 1
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 0,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": null
}
}
CancelReservation
In case of a reservation, the requested amount will be reserved from the customer’s account. This reservation will have to be activated (the amount will be captured): the amount will be deducted from the customer’s account or canceled. Both full- and partial activations are possible. When an accepted reservation will not be shipped this should be cancel to clear the reserved amount of the consumer. This can also be used to cancel the remaining part in case of partial shipment that cannot be shipped.
Use the base request as instructed on this page
CancelReservation request
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
ReservationNumber | string | Required | Klarna reservation number |
Example request
{
"Currency": "EUR",
"Invoice": "testinvoice 123",
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "CancelReservation",
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "xxxxxxxxx"
}
]
}
]
}
}
CancelReservation response
Parameters
Example response
{
"Key": "E3901DFE6C574081BDE223764C39XXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2017-08-01T12:13:20"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "klarnakp",
"IsTest": true,
"ConsumerMessage": null
}
CancelReservation push
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|
Example push
{
"DataRequest": {
"Key": "E3901DFE6C574081BDE223764C39XXXX",
"Invoice": "testinvoice 123",
"ServiceCode": "klarnakp",
"ActionCode": "CancelReservation",
"Status": {
"Code": {
"Code": 190,
"Description": "Transaction successfully processed"
},
"SubCode": null,
"DateTime": "2017-08-01T12:13:20+02:00"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 0,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": null
}
}
UpdateReservation
If a reservation needs to be changed, it is possible to do this via an UpdateReservation request. When updating the products in the reservation, please note that it is only possible to do an updatereservation for the same amount that is reserved or a lower amount. When updating the address information of the customer, please note that this results in Klarna doing a risk check again, with the possibility of being declined.
Use the base request as instructed on this page
UpdateReservation request
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
ArticleNumber | string | Required | Number by which the article is identified | |
ArticleType | string | Whether the article is a product or a discount (value = General), a shipping fee (value = ShipmentFee) or a fee for the chosen payment method (value = HandlingFee). This parameter is not required but can be used to place the products in the right order on the invoice that Klarna sends. | ||
ArticlePrice | decimal | Required | Price per article (including VAT) | |
ArticleQuantity | integer | Required | Number of articles | |
ArticleVat | decimal | Required | VAT percentage of article | |
BillingCareOf | string | Person/company receiving the invoice on behalf of billed person | ||
BillingCellPhoneNumber | string | Billing cell phone number. It is required to sent in at least 1 billing phone number; either BillingCellPhoneNumber or BillingPhoneNumber. | ||
BillingCity | string | Required | Billing city | |
BillingCompanyName | string | Billing company name | ||
BillingCountry | string | Required | Billing country. Possible values: NL (Netherlands), BE (Belgium), DE (Germany) or AT (Austria). | |
BillingEmail | string | Required | ||
BillingFirstName | string | Required | Billing first name | |
BillingLastName | string | Billing last name | ||
BillingHouseNumber | string | Required | Billing house number | |
BillingHouseNumberSuffix | string | Billing house number suffix (NL) | ||
BillingPhoneNumber | string | Billing phone number. It is required to sent in at least 1 billing phone number; either BillingCellPhoneNumber or BillingPhoneNumber. | ||
BillingPostalCode | string | Billing postal code | ||
BillingStreet | string | Required | Billing street | |
Gender | integer | The gender of the customer. 1=Male, 2=Female. | ||
OperatingCountry | string | Required | Country where your sales will be. Possible values: NL (Netherlands), BE (Belgium), DE (Germany) or AT (Austria). It must be the same as BillingCountry. | |
Pno | date | Consumer’s birth date. Use the following format: DDMMYYYY | ||
ShippingSameAsBilling | boolean | Required | Specifies whether the billing address is the same as the shipping address | |
ShippingCareOf | string | Person/company receiving the shipment on behalf of the shipping recipient | ||
ShippingCellPhoneNumber | string | Shipping cell phone number. If Shipping address is provided, then it is required to sent in at least 1 shipping phone number; either ShippingCellPhoneNumber or ShippingPhoneNumber. | ||
ShippingCity | string | Shipping city | ||
ShippingCompany | string | Shipping company name | ||
ShippingCountry | string | Shipping country code. It should be the same as Billing country. | ||
ShippingEmail | string | Shipping email address | ||
ShippingFirstName | string | Shipping first name. It should be the same as Billing first name | ||
ShippingLastName | String | Shipping last name. It should be the same as Billing last name | ||
ShippingHouseNumber | string | Shipping house number | ||
ShippingHouseNumberSuffix | string | Shipping house number suffix | ||
ShippingPhoneNumber | string | Shipping phone number. If Shipping address is provided, then it is required to sent in at least 1 shipping phone number; either ShippingCellPhoneNumber or ShippingPhoneNumber. | ||
ShippingPostalCode | string | Shipping postal code | ||
ShippingStreet | string | Shipping street |
Example request
{
"Currency": "EUR",
"Invoice": "testinvoice 1234",
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "UpdateReservation",
"Parameters": [
{
"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": "1"
},
{
"Name": "ArticlePrice",
"GroupType": "Article",
"GroupID": "1",
"Value": "10.00"
},
{
"Name": "ArticleVat",
"GroupType": "Article",
"GroupID": "1",
"Value": "19"
},
{
"Name": "BillingFirstName",
"Value": "Testperson-nl"
},
{
"Name": "BillingLastName",
"Value": "Approved"
},
{
"Name": "BillingStreet",
"Value": "Neherkade"
},
{
"Name": "BillingHouseNumber",
"Value": "1"
},
{
"Name": "BillingPostalCode",
"Value": "2521VA"
},
{
"Name": "BillingCity",
"Value": "Gravenhage"
},
{
"Name": "BillingCountry",
"Value": "NL"
},
{
"Name": "BillingCellPhoneNumber",
"Value": "0612345678"
},
{
"Name": "BillingEmail",
"Value": "your@email.nl"
},
{
"Name": "ReservationNumber",
"Value": "xxxxxxx"
},
{
"Name": "ShippingSameAsBilling",
"Value": "true"
}
]
}
]
}
}
UpdateReservation response
Parameters
Example response
{
"Key": "AE5CE6004711494C81741182E14Bxxxx",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2017-08-14T15:06:39"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "klarnakp",
"IsTest": true,
"ConsumerMessage": null
}
UpdateReservation push
Parameters
Example push
{
"DataRequest": {
"Key": "AE5CE6004711494C81741182E14Bxxxx",
"Invoice": "testinvoice 1234",
"ServiceCode": "klarnakp",
"ActionCode": "UpdateReservation",
"Status": {
"Code": {
"Code": 190,
"Description": "Transaction successfully processed"
},
"SubCode": null,
"DateTime": "2017-08-14T15:06:39+02:00"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 0,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 0,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": null
}
}
Pay
When a reservation is accepted, the merchant can send the product to the customer and do an activation of the reservation. The shipment needs to be within 14 days from the reservation date (unless otherwise agreed upon with Klarna). When an order is shipped outside the reservation period and the consumer has not paid during the full collection period, Klarna has the option to revoke the payout to the merchant.
Use the base request as instructed on this page
Pay request
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
ReservationNumber | string | Required | Klarna reservation number | |
ArticleNumber | string | Article number as sent in the Reserve request (only required for partial payments) | ||
ArticleQuantity | string | The number of articles (only required for partial payments) |
Example request
{
"Currency": "EUR",
"AmountDebit": 10,
"Invoice": "testinvoice 123",
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "Pay",
"Parameters": [
{
"Name": "ArticleNumber",
"GroupType": "Article",
"GroupID": "1",
"Value": "12345"
},
{
"Name": "ArticleQuantity",
"GroupType": "Article",
"GroupID": "1",
"Value": "1"
},
{
"Name": "ReservationNumber",
"Value": "2377577xxx"
}
]
}
]
}
}
Pay response
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
InvoiceNumber | string | Invoice number of Klarna to this shipment |
Example response
{
"Key": "CC344AF79CB14DFE96392D083E06xxx",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2017-08-14T16:39:08"
},
"RequiredAction": null,
"Services": [
{
"Name": "klarnakp",
"Action": null,
"Parameters": [
{
"Name": "InvoiceNumber",
"Value": "4170859107094xxxx"
}
]
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "testinvoice 123",
"ServiceCode": "klarnakp",
"IsTest": true,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C700",
"MutationType": 1,
"RelatedTransactions": null,
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "198B430A761A4BEE93A280EC128Bxxxx"
}
Pay push
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
InvoiceNumber | string | Invoice number of Klarna to this shipment |
Example push
{
"Transaction": {
"Key": "CC344AF79CB14DFE96392D083E06xxxx",
"Invoice": "testinvoice 123",
"ServiceCode": "klarnakp",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2017-08-14T16:39:08"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountDebit": 10,
"TransactionType": "C700",
"Services": [
{
"Name": "klarnakp",
"Action": null,
"Parameters": [
{
"Name": "InvoiceNumber",
"Value": "4170859107094xxxx"
}
],
"VersionAsProperty": 1
}
],
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": null,
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "198B430A761A4BEE93A280EC128Bxxxx"
}
}
Refund
After a successful payment, a refund action can be performed. Please keep in mind to use the parameter Amount_Credit to specify the refund amount and Originaltransaction to refer to the payment transaction.
Use the base request as instructed on this page
Refund request
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
OriginalTransactionKey | string | yes | Original Transaction Key of the transaction that needs to be refunded | |
AmountCredit | amount | yes | Refund amount |
Example request
{
"Currency": "EUR",
"AmountCredit": 1.45,
"Invoice": "100004441",
"OriginalTransactionKey": "FC693CDE6C4D447094E37633BA8Bxxxx",
"Services": {
"ServiceList": [
{
"Name": "klarnakp",
"Action": "Refund"
}
]
}
}
Refund response
Parameters
Example response
{
"Key": "10C63E926E724A4E8FF53246951Exxxx",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S001",
"Description": "Transaction successfully processed"
},
"DateTime": "2017-08-14T17:15:33"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"Invoice": "100004441",
"ServiceCode": "klarnakp",
"IsTest": true,
"Currency": "EUR",
"AmountCredit": 1.45,
"TransactionType": "C701",
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "FC693CDE6C4D447094E37633BA8Bxxxx"
}
],
"ConsumerMessage": null,
"Order": null,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "608987C866A3462FA5AB550C290Axxxx"
}
Refund push
Parameters
Example push
{
"Transaction": {
"Key": "10C63E926E724A4E8FF53246951Exxxx",
"Invoice": "100004441",
"ServiceCode": "klarnakp",
"Status": {
"Code": {
"Code": 190,
"Description": "Succes"
},
"SubCode": {
"Code": "S001",
"Description": "Transactie succesvol uitgevoerd"
},
"DateTime": "2017-08-14T17:15:33+02:00"
},
"IsTest": true,
"Order": null,
"Currency": "EUR",
"AmountCredit": 1.45,
"TransactionType": "C701",
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"MutationType": 1,
"RelatedTransactions": [
{
"RelationType": "refund",
"RelatedTransactionKey": "FC693CDE6C4D447094E37633BA8Bxxxx"
}
],
"IsCancelable": false,
"IssuingCountry": null,
"StartRecurrent": false,
"Recurring": false,
"CustomerName": null,
"PayerHash": null,
"PaymentKey": "608987C866A3462FA5AB550C290Axxxx"
}
}
ExtendReservation
The action ExtendReservation can be used to extend the time available to capture a transaction. Reversations are default valid for 28 days, which can be extented to max 180 days. This is extended by 28 days every time this call is made.
Use the base request as instructed on this page
ExtendReservation request
Parameters
Service specific parameters
Parameter | Type | Required | Recommended | Description |
---|---|---|---|---|
ReservationNumber | string | Required | Reservation number that needs to be extended |
Example request
{
"Description": "KlarnaKP ExtendReservation",
"Services": {
"ServiceList": [
{
"Name": "KlarnaKP",
"Action": "ExtendReservation",
"Parameters": [
{
"Name": "ReservationNumber",
"Value": "2377577xxx"
}
]
}
]
}
}
ExtendReservation response
Parameters
Example response
{
"Key": "6321CD2657A6489880D8FBXXXXXXXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2022-08-22T14:11:27"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "KlarnaKp",
"IsTest": true,
"ConsumerMessage": null
}
ExtendCapture
The action ExtendCapture allows the merchant to extend the customers payment due date. This can be used if the merchant has shipped wrong goods for example, and needs more time to correct the mistake.
This call is done based on the CaptureId, which is returned on the Pay call.
Use the base request as instructed on this page
ExtendCapture response
Parameters
Example response
{
"Key": "AE8DA2F579AB4A29B37673XXXXXXXXXX",
"Status": {
"Code": {
"Code": 190,
"Description": "Success"
},
"SubCode": {
"Code": "S990",
"Description": "The request was successful."
},
"DateTime": "2022-08-22T14:00:03"
},
"RequiredAction": null,
"Services": null,
"CustomParameters": null,
"AdditionalParameters": null,
"RequestErrors": null,
"ServiceCode": "KlarnaKp",
"IsTest": true,
"ConsumerMessage": null
}