APM pay-insKlarna

Create a Klarna PayIn

<Note icon="fa-regular fa-circle-info"> **Note – Timeout after 3 hours** The Klarna payment session lasts 3 hours, at which point the pay-in fails automatically (result code [101109](/errors/codes/101109)) if no action has been taken by the user. </Note> <Note icon="fa-regular fa-circle-info"> **Note – Minimum amount in Production** In Production, the minimum accepted `DebitedFunds` amount for Klarna is `1` (regardless of currency). </Note> Create a Klarna PayIn

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.
AuthorIdstringRequired
The unique identifier of the user at the source of the transaction.
DebitedFundsobjectRequired
Information about the debited funds.
FeesobjectRequired
Information about the fees.
CreditedWalletIdstringRequired
The unique identifier of the credited wallet.
ReturnURLstringRequired

Max. length: 255 characters

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

BillingobjectRequired

Information about the billing address.

The Billing.Address.Country must be the same as the pay-in’s Country parameter.

LineItemslist of objectsRequired

Information about the items purchased in the transaction. The pay-in DebitedFunds.Amount must equal all LineItems objects’ ((UnitAmount + TaxAmount) - Discount).

CountrystringRequired

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of residence of the user.

EmailstringRequired

Format: A valid email address

The user’s email address.

ReferencestringRequired

The platform’s order reference for the transaction.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

FlowDescriptorobjectOptional

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

  • The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
  • ALL UserId values in the array must be one of:
    • OWNER whose KYCLevel is REGULAR
    • PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

  • PAYER
  • OWNER whose KYCLevel is LIGHT

If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.

StatementDescriptorstringOptional

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.

ShippingobjectOptional

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.

CulturestringOptional

Format: Two-letter language code (ISO 639-1 alpha-2)

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.

PhonestringOptional

Format: International E.164 standard (preceded by plus sign and country code)

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

AdditionalDatastringOptional

Format: Serialized JSON object

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

ProfilingAttemptReferencestringOptional

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 via the Dashboard for more information.

Response

Success
Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring
The unique identifier of the user at the source of the transaction.
DebitedFundsobject
Information about the debited funds.
CreditedFundsobject

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

Feesobject
Information about the fees.
Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

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

ResultMessagestring
The explanation of the result code.
ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.
CreditedWalletIdstring
The unique identifier of the credited wallet.
CreditedUserIdstring

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

The unique identifier of the user whose wallet is credited.

FlowDescriptorobject

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

  • The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
  • ALL UserId values in the array must be one of:
    • OWNER whose KYCLevel is REGULAR
    • PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

  • PAYER
  • OWNER whose KYCLevel is LIGHT

If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.

PaymentTypestring

Returned values: KLARNA

The payment type of the pay-in.

ExecutionTypestring

Returned values: WEB

The execution type of the pay-in.

ReturnURLstring

Max. length: 255 characters

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

RedirectURLstring

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.

StatementDescriptorstring

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.

Billingobject

Default values: FirstName, LastName, and Address information of the Shipping object if sent, otherwise of the AuthorId (if address values present).

Information about the billing address.

Shippingobject

Default values: FirstName, LastName, and Address information of the Billing object if sent, otherwise of the AuthorId (if address values present).

Information about the shipping address.

LineItemslist of objects

Information about the items purchased in the transaction. The pay-in DebitedFunds.Amount must equal all LineItems objects’ ((UnitAmount + TaxAmount) - Discount).

Countrystring

Format: Two-letter country code (ISO 3166-1 alpha-2 format)

The country of residence of the user.

Culturestring

Format: Two-letter language code (ISO 639-1 alpha-2)

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.

Emailstring

Format: A valid email address

The user’s email address.

Phonestring

Format: International E.164 standard (preceded by plus sign and country code)

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

PaymentMethodstring

The payment option chosen by the user:

  • Pay Now (Card) – Pay now by card.
  • Pay Now (Direct Bank Transfer) – Pay now by bank wire.
  • Pay Now (Direct Debit) – Pay now by direct debit.
  • Pay Now (Klarna Bank Account) – Pay now from Klarna Bank Account (select regions only, e.g. Germany).
  • Pay in 30 days (by card) – Pay within 30 days by card.
  • Pay in 30 days – Pay within 30 days against an invoice (select regions only, e.g. Germany).
  • Slice it (3 installments) – Pay in 3 installments.
  • Slice it (Financing - X installments) – Pay via financing plan, where X is the number of monthly installments (6, 12, 24, or 36).

The options available to users depend on their region.

Note: This parameter is not returned unless the Status is SUCCEEDED.

AdditionalDatastring

Format: Serialized JSON object

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

Referencestring

The platform’s order reference for the transaction.

Errors

400
Bad Request Error