Create a Klarna PayIn

Note – Timeout after 48 hours

The Klarna payment session lasts 48 hours, at which point the pay-in fails automatically if no action has been taken by the user.

Note – Minimum amount in Production

In Production, the minimum accepted DebitedFunds amount for Klarna is 1 (regardless of currency).

Body parameters

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

AuthorId

string

required

The unique identifier of the user at the source of the transaction.

DebitedFunds

object

required

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

Fees

object

required

Information about the fees.

CreditedWalletId

string

required

The unique identifier of the credited wallet.

ReturnURL

string

required

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

StatementDescriptor

string

Max. length: 10 characters; only alphanumeric and spaces

Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.

Billing

object

required

Information about the end user billing address.

Shipping

object

Information about the end user’s shipping address.
The shipping address AddressLine1 must be formatted:

FR, UK, US: [Number][StreetName], for example: 33 Cavendish Square
Rest of EU: [StreetName][Number], for example: De Ruijterkade 7
Caution: Failure to follow this formatting may result in an error.
If no shipping address is sent, Klarna considers it to be the same as the billing address.

LineItems

array

required

object

Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount.

Country

string

required

Format: ISO 3166-1 alpha-2 two-letter country code

The country of residence of the user.

zimport FormatIso6391Alpha2TwoLetterLanguageCode from ‘/snippets/rules/format-iso-639-1-alpha-2-two-letter-language-code.mdx’;

Culture

string

The language in which the Klarna payment page is to be displayed.

The Culture must match the Country to show the checkout page in the desired language. If not, or if Culture is not sent, EN is the language by default.

string

required

Format: A valid email address

The user’s email address.

Phone

string

required

Format: [+CC][XXXXXXXXX] where +CC is the international dialing code and Xs are the local number, for example: [+33][689854321]

The user’s mobile phone number. If the phone matches the user’s Klarna account, their checkout experience involves one less step.

AdditionalData

string

Format: Serialized JSON object

The extra merchant data required by Klarna for the transaction, as described in the Klarna guide.

Reference

string

required

The platform’s order reference for the transaction.

ProfilingAttemptReference

string

The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.

Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay from the Hub for more information.

Responses

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

CreationDate

timestamp

The date and time at which the object was created.

AuthorId

string

The unique identifier of the user at the source of the transaction.

DebitedFunds

object

Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.

CreditedFunds

object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Fees

object

Information about the fees.

Status

string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode

string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage

string

The explanation of the result code.

ExecutionDate

timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Type

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature

string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

CreditedWalletId

string

The unique identifier of the credited wallet.

CreditedUserId

string

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

PaymentType

string

Returned values: KLARNA

The type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

ReturnURL

string

Max. length: 255 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

RedirectURL

string

The URL to which to redirect the user to complete the payment.

Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.

StatementDescriptor

string

Max. length: 10 characters; only alphanumeric and spaces

Billing

object

Information about the end user billing address.

Shipping

object

Information about the end user’s shipping address.

The shipping address AddressLine1 must be formatted:

FR, UK, US: [Number][StreetName], for example: 33 Cavendish Square
Rest of EU: [StreetName][Number], for example: De Ruijterkade 7

Caution: Failure to follow this formatting may result in an error.

If no shipping address is sent, Klarna considers it to be the same as the billing address.

LineItems

array

object

Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount.

Country

string

Format: ISO 3166-1 alpha-2 two-letter country code

The country of residence of the user.

Culture

string

Format: ISO 639-1 alpha-2 two-letter language code

The language in which the Klarna payment page is to be displayed.
The Culture must match the Country to show the checkout page in the desired language. If not, or if Culture is not sent, EN is the language by default.

string

Format: A valid email address

The user’s email address.

Phone

string

Format: [+CC][XXXXXXXXX] where +CC is the international dialing code and Xs are the local number, for example: [+33][689854321]

The user’s mobile phone number. If the phone matches the user’s Klarna account, their checkout experience involves one less step.

AdditionalData

string

Format: Serialized JSON object

The extra merchant data required by Klarna for the transaction, as described in the Klarna guide.

Reference

string

The platform’s order reference for the transaction.

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "5c1bd99e-3af9-4ac2-997a-daec27b8a255",
    "date": 1710162995,
    "type": "param_error",
    "errors": {
        "billing.Country": "The field should equal Country"
    }
}

{
    "message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "id": "34554ec3-e46e-49f2-b29c-12db3e7e1c90",
    "date": 1706798154,
    "type": "param_error",
    "errors": {
        "additionalData": "The value is not a valid JSON format"
    }
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses