​
Description

The Klarna PayIn object allows platforms to process payments made via Klarna.
Note – Prerequisites to using KlarnaIn Production and Sandbox:
  • Your platform must be approved and activated by Klarna. See activation for details.
In Sandbox:

​
Attributes

​
Id
string
The unique identifier of the object.
​
Tag
string
Max. length: 255 charactersCustom 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.
​
CreationDate
Unix 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, FAILEDThe 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
Unix 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, PAYOUTThe type of the transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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: KLARNAThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
ReturnURL
string
Max. length: 255 charactersThe 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 spacesCustom 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
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: Two-letter country code (ISO 3166-1 alpha-2 format)The country of residence of the user.
​
Culture
string
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.
​
Email
string
Format: A valid email addressThe user’s email address.
​
Phone
string
Format: International telephone numbering plan E.164 (+ then country code then the number)The user’s mobile phone number. If the phone matches the user’s Klarna account, their checkout experience involves one less step.
​
PaymentMethod
string
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.
​
AdditionalData
string
Format: Serialized JSON objectThe 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.
​
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 via the Dashboard for more information.

Guide

Learn more about Klarna