When you have created an HPP Session you will have the ability to distribute to the Consumer a link to the Hosted Payment Page either by e-mail or SMS using the Distribute Endpoint. You will get the URL of the distribution endpoint in the distribute_url field that you got back from the create session response.
The message sent to the Consumer using the contact information given in parameters will be localised to the Consumer’s language from the HPP Session creation and will contain a link. When using the link, the Consumer will see the specific Hosted Payment Page.
By accessing the HPP Session by this distribution mechanism, the given phone number or e-mail address will be used by Klarna to try to pre-fill the Consumer if they already used Klarna before and agreed to be pre-filled. This is done because Klarna now knows that the Consumer actually owns this phone number or e-mail address.
When asking for a distribution by SMS or e-mail, HPP will start by validating that the phone number or address is a correct one. If it is not, an error code will be sent back to the integrator (4xx Bad Request). If distribution is done by a human entering a phone number or e-mail address on a User Interface, it is advised to create error flows. You can expect the SMS or e-mail to be sent in the few seconds after this call, but this deliveries are not synchronous and it may take up to a few minutes for the Consumer to actually receive the link. You can use up to 20 SMS and 100 emails per day for testing purposes.
Description | Distributes HPP via email or SMS |
---|---|
Reference | For a full list of accepted parameters listed in HPP Distribute Session Parameters below |
Url structure | https://{endpoint}/hpp/v1/sessions/{session_id}/distribution |
Example | curl -X POST https://api.klarna.com/hpp/v1/sessions/<session_id>/distribution --header "Authorization: Basic <token>" --header "Content-Type: application/json" --header “Cache-Control: no-cache” --data “<parameters>" |
Error codes explanation:
Status | Error Code | Description |
---|---|---|
400 | UNKNOWN | undefined error, please contact Klarna support |
400 | MISSING_CONTACT_DATA | sms/email data is incomplete for selected method |
404 | NOT_FOUND | payment session no longer exists |
400 | CONSTRAINT_VIOLATION | invalid request |
400 | NOT_SMS_CAPABLE | phone can not be used to receive SMS |
400 | UNSUPPORTED_COUNTRY | phone number of requested country can not be used in current region |
400 | BLACKLIST_REFUSED | user is blacklisted |
429 | SMS_LIMIT_EXCEEDED | sms limit for testing environment exceeded |
429 | EMAIL_LIMIT_EXCEEDED | email limit for testing environment exceeded |
Parameters | Type | Description |
---|---|---|
method | String | Set to sms |
contact_information.phone | String | Phone number of the Consumer, can be either in local format 07xxxxxx or in international format +46xxxxxxxxx. |
contact_information.phone_country | String | Country of the phone number that will be used to define what local refers to. In a Sweden integration, it is advised to always useSEand let an operator input an international format for everything that is outside of Sweden. |
{
"contact_information": {
"phone": "0712345678",
"phone_country": "se"
},
"method": "sms"
}
{
"contact_information": {
"phone": "+33712345678",
"phone_country": "se"
},
"method": "sms"
}
Parameters | Type | Description |
---|---|---|
method | String | Set to email |
contact_information.email | String | Email address of the customer. |
{
"contact_information": {
"email": "user@example.com"
},
"method": "email"
}
Parameters | Type | Description |
---|---|---|
method | String | Set to token |
contact_information.access_id | String | The access identifier is the value read from the QR code shown by the customer. It should not be altered by the integrator. It is important that whatever the value read from the QR is, the system is able to properly escape the String for JSON format and send the value as is. |
{
"contact_information": {
"access_id": "5a5e8e70-1a96-4651-b3b6-b774012a5bbb"
},
"method": "token"
}