Klarna Partner Product API - Messaging (v1/r7)

Download OpenAPI specification:Download

Credit Promotion

Get credit promotion messaging for auto-size placement

Securityklarna_api_key

Request

path Parameters

account_id

required

string (AccountIdentifier)

Unique account identifier assigned by Klarna to the onboarded merchant

Example: krn:partner:global:account:live:LWT2XJSE

validation-info: Validation that is a valid krn

query Parameters

locale required	string (Locale) Preferred locale, in IETF BCP 47 format. Supported locales `en-AU` `de-AT` `en-AT` `nl-BE` `fr-BE` `en-BE` `en-CA` `fr-CA` `cs-CZ` `en-CZ` `da-DK` `en-DK` `fi-FI` `sv-FI` `en-FI` `fr-FR` `en-FR` `de-DE` `en-DE` `el-GR` `en-GR` `hu-HU` `en-HU` `en-IE` `it-IT` `en-IT` `en-MX` `es-MX` `nl-NL` `en-NL` `en-NZ` `nb-NO` `en-NO` `pl-PL` `en-PL` `pt-PT` `en-PT` `ro-RO` `en-RO` `es-ES` `en-ES` `sv-SE` `en-SE` `de-CH` `fr-CH` `it-CH` `en-CH` `en-GB` `en-US` `es-US` Example: locale=en-US validation-info: Validation that locale contain {language}-{region} syntax.
payment_amount required	integer <int64> (PaymentAmount) [ 1 .. 2147483647 ] Total amount of a purchase, including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500 or null but cannot be 0. This is the amount that Klarna will charge the customer for this payment request. It should also include the total amount of subscriptions that will be charged at the time of purchase. Example: payment_amount=2000 validation-info: Validation that it is 10 digits max, up to 2^31-1. That is >= 0. Validation that is equal to line_items.total_amount.
custom_payment_method_ids	string You can dynamically trigger promotional credit offers. First, work with Klarna’s responsible account manager to determine the criteria for custom offers and a standard naming convention that will be referred to when requesting such offers via Klarna payments API. To be able to advertise these payment methods, pass the names as an array of strings to the On-site messaging placement. The array can be used to define which of the configured payment options within a payment category (pay_later, pay_over_time, and so on) should be included in the content selection. Example: custom_payment_method_ids=FINANCING0
message_preference	string Default: "klarna" Allows the partner to indicate preference for the message type. If no value is passed or an unrecognized value is provided, the default "klarna" message will be used. Passing "in-store" adjusts the content to display "in-store" related message, while passing "prequalification" adjusts the message to display the prequalification related content. Enum: "klarna" "in-store" "prequalification" Example: message_preference=in-store validation-info: Validation that the value should be one of the allowed values(klarna, in-store, prequalification) or the default value(klarna) will be used.
message_prefix	string Prefixes the content of the message. Allowed values: Or, or Enum: "Or" "or" Example: message_prefix=Or validation-info: Validates that the value is either "Or" or "or"

Responses

200

Successful response

204

No messaging available for the given parameters.

400

Bad request.

get/v1/accounts/{account_id}/payment/messaging/credit-promotion-auto-size

Request samples

curl
JavaScript
Node.js

Response samples

200
400

application/json

{"content": {"nodes": [{"name": "TEXT_MAIN",
"type": "TEXT",
"value": "Pay as low as $177/mo."
},
{"name": "ACTION_LEARN_MORE",
"url": "url_t",
"type": "ACTION",
"label": "Learn more"
},
{"name": "KLARNA_LOGO",
"alt": "Klarna",
"url": "https://osm.klarnaservices.com/images/logo_black_v2.svg",
"type": "IMAGE"
}
]
}
}

Get credit promotion messaging for badge placement

Securityklarna_api_key

Request

path Parameters

account_id

required

string (AccountIdentifier)

Unique account identifier assigned by Klarna to the onboarded merchant

Example: krn:partner:global:account:live:LWT2XJSE

validation-info: Validation that is a valid krn

query Parameters

locale required	string (Locale) Preferred locale, in IETF BCP 47 format. Supported locales `en-AU` `de-AT` `en-AT` `nl-BE` `fr-BE` `en-BE` `en-CA` `fr-CA` `cs-CZ` `en-CZ` `da-DK` `en-DK` `fi-FI` `sv-FI` `en-FI` `fr-FR` `en-FR` `de-DE` `en-DE` `el-GR` `en-GR` `hu-HU` `en-HU` `en-IE` `it-IT` `en-IT` `en-MX` `es-MX` `nl-NL` `en-NL` `en-NZ` `nb-NO` `en-NO` `pl-PL` `en-PL` `pt-PT` `en-PT` `ro-RO` `en-RO` `es-ES` `en-ES` `sv-SE` `en-SE` `de-CH` `fr-CH` `it-CH` `en-CH` `en-GB` `en-US` `es-US` Example: locale=en-US validation-info: Validation that locale contain {language}-{region} syntax.
payment_amount required	integer <int64> (PaymentAmount) [ 1 .. 2147483647 ] Total amount of a purchase, including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500 or null but cannot be 0. This is the amount that Klarna will charge the customer for this payment request. It should also include the total amount of subscriptions that will be charged at the time of purchase. Example: payment_amount=2000 validation-info: Validation that it is 10 digits max, up to 2^31-1. That is >= 0. Validation that is equal to line_items.total_amount.
custom_payment_method_ids	string You can dynamically trigger promotional credit offers. First, work with Klarna’s responsible account manager to determine the criteria for custom offers and a standard naming convention that will be referred to when requesting such offers via Klarna payments API. To be able to advertise these payment methods, pass the names as an array of strings to the On-site messaging placement. The array can be used to define which of the configured payment options within a payment category (pay_later, pay_over_time, and so on) should be included in the content selection. Example: custom_payment_method_ids=FINANCING0
message_preference	string Default: "klarna" Allows the partner to indicate preference for the message type. If no value is passed or an unrecognized value is provided, the default "klarna" message will be used. Passing "in-store" adjusts the content to display "in-store" related message, while passing "prequalification" adjusts the message to display the prequalification related content. Enum: "klarna" "in-store" "prequalification" Example: message_preference=in-store validation-info: Validation that the value should be one of the allowed values(klarna, in-store, prequalification) or the default value(klarna) will be used.
message_prefix	string Prefixes the content of the message. Allowed values: Or, or Enum: "Or" "or" Example: message_prefix=Or validation-info: Validates that the value is either "Or" or "or"

Responses

200

Successful response

204

No messaging available for the given parameters.

400

Bad request.

get/v1/accounts/{account_id}/payment/messaging/credit-promotion-badge

Request samples

curl
JavaScript
Node.js

Response samples

200
400

application/json

{"content": {"nodes": [{"name": "TEXT_MAIN",
"type": "TEXT",
"value": "Pay as low as $177/mo."
},
{"name": "ACTION_LEARN_MORE",
"url": "url_t",
"type": "ACTION",
"label": "Learn more"
},
{"name": "KLARNA_BADGE",
"alt": "Klarna",
"url": "https://osm.klarnaservices.com/images/logo_black_v2.svg",
"type": "IMAGE"
}
]
}
}

Top Strip

Get top strip promotion messaging for auto-size placement

Securityklarna_api_key

Request

path Parameters

account_id

required

string (AccountIdentifier)

Unique account identifier assigned by Klarna to the onboarded merchant

Example: krn:partner:global:account:live:LWT2XJSE

validation-info: Validation that is a valid krn

query Parameters

locale required	string (Locale) Preferred locale, in IETF BCP 47 format. Supported locales `en-AU` `de-AT` `en-AT` `nl-BE` `fr-BE` `en-BE` `en-CA` `fr-CA` `cs-CZ` `en-CZ` `da-DK` `en-DK` `fi-FI` `sv-FI` `en-FI` `fr-FR` `en-FR` `de-DE` `en-DE` `el-GR` `en-GR` `hu-HU` `en-HU` `en-IE` `it-IT` `en-IT` `en-MX` `es-MX` `nl-NL` `en-NL` `en-NZ` `nb-NO` `en-NO` `pl-PL` `en-PL` `pt-PT` `en-PT` `ro-RO` `en-RO` `es-ES` `en-ES` `sv-SE` `en-SE` `de-CH` `fr-CH` `it-CH` `en-CH` `en-GB` `en-US` `es-US` Example: locale=en-US validation-info: Validation that locale contain {language}-{region} syntax.
message_preference	string Default: "klarna" Allows the partner to indicate preference for the message type. If no value is passed or an unrecognized value is provided, the default "klarna" message will be used. Passing "in-store" adjusts the content to display "in-store" related message, while passing "prequalification" adjusts the message to display the prequalification related content. Enum: "klarna" "in-store" "prequalification" Example: message_preference=in-store validation-info: Validation that the value should be one of the allowed values(klarna, in-store, prequalification) or the default value(klarna) will be used.
message_prefix	string Prefixes the content of the message. Allowed values: Or, or Enum: "Or" "or" Example: message_prefix=Or validation-info: Validates that the value is either "Or" or "or"

Responses

200

Successful response

204

No messaging available for the given parameters.

400

Bad request.

get/v1/accounts/{account_id}/payment/messaging/top-strip-promotion-auto-size

Request samples

curl
JavaScript
Node.js

Response samples

200
400

application/json

{"content": {"nodes": [{"name": "TEXT_MAIN",
"type": "TEXT",
"value": "Shop now. Pay with"
},
{"name": "ACTION_LEARN_MORE",
"url": "url_t",
"type": "ACTION",
"label": "Learn more"
},
{"name": "KLARNA_LOGO",
"alt": "Klarna",
"url": "https://osm.klarnaservices.com/images/logo_black_v2.svg",
"type": "IMAGE"
}
]
}
}

Get top strip promotion messaging for badge placement

Securityklarna_api_key

Request

path Parameters

account_id

required

string (AccountIdentifier)

Unique account identifier assigned by Klarna to the onboarded merchant

Example: krn:partner:global:account:live:LWT2XJSE

validation-info: Validation that is a valid krn

query Parameters

locale required	string (Locale) Preferred locale, in IETF BCP 47 format. Supported locales `en-AU` `de-AT` `en-AT` `nl-BE` `fr-BE` `en-BE` `en-CA` `fr-CA` `cs-CZ` `en-CZ` `da-DK` `en-DK` `fi-FI` `sv-FI` `en-FI` `fr-FR` `en-FR` `de-DE` `en-DE` `el-GR` `en-GR` `hu-HU` `en-HU` `en-IE` `it-IT` `en-IT` `en-MX` `es-MX` `nl-NL` `en-NL` `en-NZ` `nb-NO` `en-NO` `pl-PL` `en-PL` `pt-PT` `en-PT` `ro-RO` `en-RO` `es-ES` `en-ES` `sv-SE` `en-SE` `de-CH` `fr-CH` `it-CH` `en-CH` `en-GB` `en-US` `es-US` Example: locale=en-US validation-info: Validation that locale contain {language}-{region} syntax.
message_preference	string Default: "klarna" Allows the partner to indicate preference for the message type. If no value is passed or an unrecognized value is provided, the default "klarna" message will be used. Passing "in-store" adjusts the content to display "in-store" related message, while passing "prequalification" adjusts the message to display the prequalification related content. Enum: "klarna" "in-store" "prequalification" Example: message_preference=in-store validation-info: Validation that the value should be one of the allowed values(klarna, in-store, prequalification) or the default value(klarna) will be used.
message_prefix	string Prefixes the content of the message. Allowed values: Or, or Enum: "Or" "or" Example: message_prefix=Or validation-info: Validates that the value is either "Or" or "or"

Responses

200

Successful response

204

No messaging available for the given parameters.

400

Bad request.

get/v1/accounts/{account_id}/payment/messaging/top-strip-promotion-badge

Request samples

curl
JavaScript
Node.js

Response samples

200
400

application/json

{"content": {"nodes": [{"name": "TEXT_MAIN",
"type": "TEXT",
"value": "Shop now. Pay with"
},
{"name": "ACTION_LEARN_MORE",
"url": "url_t",
"type": "ACTION",
"label": "Learn more"
},
{"name": "KLARNA_BADGE",
"alt": "Klarna",
"url": "https://osm.klarnaservices.com/images/logo_black_v2.svg",
"type": "IMAGE"
}
]
}
}

Checkout

Get messaging for checkout placement

Securityklarna_api_key

Request

path Parameters

account_id

required

string (AccountIdentifier)

Unique account identifier assigned by Klarna to the onboarded merchant

Example: krn:partner:global:account:live:LWT2XJSE

validation-info: Validation that is a valid krn

query Parameters

locale required	string (Locale) Preferred locale, in IETF BCP 47 format. Supported locales `en-AU` `de-AT` `en-AT` `nl-BE` `fr-BE` `en-BE` `en-CA` `fr-CA` `cs-CZ` `en-CZ` `da-DK` `en-DK` `fi-FI` `sv-FI` `en-FI` `fr-FR` `en-FR` `de-DE` `en-DE` `el-GR` `en-GR` `hu-HU` `en-HU` `en-IE` `it-IT` `en-IT` `en-MX` `es-MX` `nl-NL` `en-NL` `en-NZ` `nb-NO` `en-NO` `pl-PL` `en-PL` `pt-PT` `en-PT` `ro-RO` `en-RO` `es-ES` `en-ES` `sv-SE` `en-SE` `de-CH` `fr-CH` `it-CH` `en-CH` `en-GB` `en-US` `es-US` Example: locale=en-US validation-info: Validation that locale contain {language}-{region} syntax.
custom_payment_method_ids	string You can dynamically trigger promotional credit offers. First, work with Klarna’s responsible account manager to determine the criteria for custom offers and a standard naming convention that will be referred to when requesting such offers via Klarna payments API. To be able to advertise these payment methods, pass the names as an array of strings to the On-site messaging placement. The array can be used to define which of the configured payment options within a payment category (pay_later, pay_over_time, and so on) should be included in the content selection. Example: custom_payment_method_ids=FINANCING0
payment_amount required	integer <int64> (PaymentAmount) [ 1 .. 2147483647 ] Total amount of a purchase, including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500 or null but cannot be 0. This is the amount that Klarna will charge the customer for this payment request. It should also include the total amount of subscriptions that will be charged at the time of purchase. Example: payment_amount=2000 validation-info: Validation that it is 10 digits max, up to 2^31-1. That is >= 0. Validation that is equal to line_items.total_amount.

Responses

200

Successful response

204

No messaging available for the given parameters.

400

Bad request.

get/v1/accounts/{account_id}/payment/messaging/checkout

Request samples

curl
JavaScript
Node.js

Response samples

200
400

application/json

{"content": {"nodes": [{"name": "TEXT_MAIN",
"type": "TEXT",
"value": "Enjoy Buyer Protection with Klarna"
},
{"name": "ACTION_LEARN_MORE",
"url": "url_t",
"type": "ACTION",
"label": "Learn more"
},
{"name": "KLARNA_BADGE",
"alt": "Klarna",
"url": "https://osm.klarnaservices.com/images/logo_black_v2.svg",
"type": "IMAGE"
},
{"name": "ACTION_OPEN_BUYERS_PROTECTION_LINK",
"label": "Buyer Protection",
"url": "https://www.klarna.com/de/kauferschutzrichtlinie/",
"type": "ACTION"
},
{"name": "ZERO_INTEREST_BADGE_TEXT",
"label": "0% Financing",
"type": "TEXT"
}
]
}
}