Create a Klarna PayIn
Note – Timeout after 3 hours
The Klarna payment session lasts 3 hours, at which point the pay-in fails automatically (result code 101109) 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
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.
The unique identifier of the user at the source of the transaction.
Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
Information about the fees.
The unique identifier of the credited wallet.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
Information about the end user billing address.
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.
object
Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of residence of the user.
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.
Format: A valid email address
The user’s email address.
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.
Format: Serialized JSON object
The extra merchant data required by Klarna for the transaction, as described in the Klarna guide.
The platform’s order reference for the transaction.
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.
Responses
200 - Created
200 - Created
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
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.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Information about the fees.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
The unique identifier of the credited wallet.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Returned values: KLARNA
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
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.
Information about the end user billing address.
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.
object
Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of residence of the user.
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.
Format: A valid email address
The user’s email address.
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.
Format: Serialized JSON object
The extra merchant data required by Klarna for the transaction, as described in the Klarna guide.
The platform’s order reference for the transaction.
400 - Billing address country doesn't match Country
400 - Billing address country doesn't match Country
400 - AdditionalData JSON format error
400 - AdditionalData JSON format error
Create a Klarna PayIn
Note – Timeout after 3 hours
The Klarna payment session lasts 3 hours, at which point the pay-in fails automatically (result code 101109) 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
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.
The unique identifier of the user at the source of the transaction.
Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
Information about the fees.
The unique identifier of the credited wallet.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
Information about the end user billing address.
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.
object
Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of residence of the user.
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.
Format: A valid email address
The user’s email address.
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.
Format: Serialized JSON object
The extra merchant data required by Klarna for the transaction, as described in the Klarna guide.
The platform’s order reference for the transaction.
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.
Responses
200 - Created
200 - Created
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
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.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Information about the debited funds. The amount must be equal to the total of all UnitAmount and TaxAmount of all LineItems.
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Information about the fees.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
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.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
The unique identifier of the credited wallet.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Returned values: KLARNA
The type of pay-in.
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION
The type of execution for the pay-in.
Max. length: 255 characters
The URL to which the user is returned after the payment, whether the transaction is successful or not.
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.
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.
Information about the end user billing address.
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.
object
Information about the items purchased in the transaction. The total of all line items’ UnitAmount and TaxAmount must equal the DebitedFunds amount.
Format: Two-letter country code (ISO 3166-1 alpha-2 format)
The country of residence of the user.
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.
Format: A valid email address
The user’s email address.
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.
Format: Serialized JSON object
The extra merchant data required by Klarna for the transaction, as described in the Klarna guide.
The platform’s order reference for the transaction.
400 - Billing address country doesn't match Country
400 - Billing address country doesn't match Country
400 - AdditionalData JSON format error
400 - AdditionalData JSON format error