View a PayIn (Klarna)

Note – Pay-in data retained for 13 months

An API call to retrieve a pay-in whose CreationDate is older than 13 months may return 404 Not Found.

For more information, see the Data availability periods article.

Path parameters

PayInId · string · required

The unique identifier of the pay-in.

Responses

200 - Succeeded

Id · string

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

The unique identifier of the object.

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.

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.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds · object

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

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees · object

Information about the fees.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

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 · 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, 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

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

Information about the end user billing address.

Show properties

FirstName · string

The first name of the user.

LastName · string

Max. length: 100 characters

The last name of the user.

Address · object

Information about the billing address.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

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

The country of the 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.

Show properties

FirstName · string

The first name of the user.

LastName · string

Max. length: 100 characters

The last name of the user.

Address · object

Information about the shipping address.

Show properties

AddressLine1 · string

Max. length: 255 characters

The first line of the address.

AddressLine2 · string

Max. length: 255 characters

The second line of the address.

City · string

Max. length: 255 characters

The city of the address.

Region · string

Max. length: 255 characters

The region of the address. This field is optional except if the Country is US, CA, or MX.

PostalCode · string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country · string

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

The country of the 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.

Show properties

Name · string

The name of the item.

Quantity · integer

The quantity of the item.

UnitAmount · integer

The cost of the item, excluding tax.

TaxAmount · integer

The tax amount applied to the item.

Sku · string

The unique identifier of the line item.

Category · string

Possible values: DIGITAL_GOODS, PHYSICAL_GOODS, DISCOUNT, SHIPPING_FEE, SALES_TAX, GIFT_CARD, STORE_CREDIT, SURCHARGE

The category of the item, allowing line items of different types to be distinguished (for example, buyer protection as DIGITAL_GOODS).

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 address

The user’s email address.

Phone · string

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.

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 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.

200 - Succeeded

{
    "Id": "wt_5a175522-04c3-4115-88ef-3b1b3446c4c6",
    "Tag": "Created using the Mangopay API Postman collection",
    "CreationDate": 1706797249,
    "AuthorId": "213407540",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1500
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1200
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 300
    },
    "Status": "SUCCEEDED",
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1706797396,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "213407543",
    "CreditedUserId": "213407540",
    "PaymentType": "KLARNA",
    "ExecutionType": "WEB",
    "ReturnURL": "http://www.mangopay.com/docs/please-ignore?transactionId=wt_5a175522-04c3-4115-88ef-3b1b3446c4c6",
    "RedirectURL": "https://pay.playground.klarna.com/eu/hpp/payments/2fuacUE",
    "StatementDescriptor": "Mangopay",
    "Billing": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "6 rue de la Cité",
            "AddressLine2": "Appartement 3",
            "City": "Paris",
            "Region": "île-de-france",
            "PostalCode": "75003",
            "Country": "FR"
        }
    },
    "Shipping": {
        "FirstName": "Alex",
        "LastName": "Smith",
        "Address": {
            "AddressLine1": "Rue de la Fourche 26",
            "AddressLine2": "Appartement 3",
            "City": "Bruxelles",
            "Region": "Bruxelles-Capitale",
            "PostalCode": "75003",
            "Country": "BE"
        }
    },
    "LineItems": [
        {
            "Name": "Running shoes",
            "Quantity": 2,
            "UnitAmount": 400,
            "TaxAmount": 100,
            "Description": "ID of Seller 1",
            "Category": "PHYSICAL_GOODS",
            "Sku": "example-item-123"
        },
        {
            "Name": "Walking shoes",
            "Quantity": 1,
            "UnitAmount": 400,
            "TaxAmount": 100,
            "Description": "ID of Seller 2",
            "Category": "PHYSICAL_GOODS",
            "Sku": "example-item-456"
        }
    ],
    "Country": "FR",
    "Culture": "FR",
    "Email": "[e-mail]",
    "Phone": "[+33][689854321]",
    "PaymentMethod": "Pay in 30 days",
    "AdditionalData": "{\"customer_account_info\": [{\"unique_account_identifier\": \"382f5a69-c51c-45af-9707-6991eb08f7bf\",\"app_id\": \"81363501-3540-494a-8627-33bc6112035d\",\"loyalty_level\": \"high\",\"customer_email\": \"[e-mail]\",\"customer_phone\": \"0611223344\",\"customer_ranking\": 2,\"customer_reviews\": 5,\"last_login_time\": \"2023-10-21T19:11:34Z\",\"account_security\": {\"last_verification_method\": \"2FA TOTP\",\"last_verification_time\": \"2023-10-21T19:11:34Z\",\"device_id\": \"772af5a5-2d55-4a5e-bb79-85969f683810\",\"fraud_behavior\": false,\"devices_linked\": 2,\"phone_verified\": true,\"email_verified\": true,\"failed_transactions_attempts\": 0},\"account_registration_date\": \"2020-06-10T12:02:21Z\",\"account_last_modified\": \"2022-12-22T18:45:44Z\"}],\"marketplace_seller_info\": [{\"sub_merchant_id\": \"615a0e87-4941-45dc-978d-e6efcbd90ba0\",\"sub_merchant_name\": \"Marketbrick Ltd.\",\"sub_merchant_postal_code\": \"75010\",\"product_category\": \"Computers\",\"product_name\": \"Asus Zenbook 14\",\"account_registration_date\": \"2020-06-10T12:02:21Z\",\"account_last_modified\": {\"password\": \"2020-06-10T12:02:21Z\",\"email\": \"2020-06-10T12:02:21Z\",\"listing\": \"2020-06-10T12:02:21Z\",\"login\": \"2020-06-10T12:02:21Z\",\"address\": \"2020-06-10T12:02:21Z\"},\"digital_download\": false,\"seller_rating\": 4.5,\"number_of_trades\": 34,\"volume_of_trades\": 4500}],\"payment_history_full\": [{\"unique_account_identifier\": \"382f5a69-c51c-45af-9707-6991eb08f7bf\",\"number_paid_purchases\": 10,\"payment_option\": \"card\",\"total_amount_paid_purchases\": 1000.10,\"date_of_first_paid_purchase\": \"2020-06-10T12:12:34Z\",\"date_of_last_paid_purchase\": \"2023-10-26T18:52:38Z\"},{\"unique_account_identifier\": \"382f5a69-c51c-45af-9707-6991eb08f7bf\",\"number_paid_purchases\": 14,\"payment_option\": \"non klarna credit\",\"total_amount_paid_purchases\": 2322.10,\"date_of_first_paid_purchase\": \"2021-10-11T20:31:15Z\",\"date_of_last_paid_purchase\": \"2023-09-22T14:59:22Z\"}],\"marketplace_winner_info\": [{\"account_registration_date\": \"2020-06-10T12:02:21Z\",\"account_last_modified\": {\"password\": \"2022-12-22T18:45:44Z\",\"email\": \"2020-06-10T12:02:21Z\",\"listing\": \"2023-08-14T08:23:34Z\",\"login\": \"2020-06-10T12:02:21Z\",\"address\": \"2020-06-10T12:02:21Z\"},\"number_of_trades\": 24,\"volume_of_trades\": 3322}],\"other_delivery_address\": [{\"shipping_method\": \"pick-up point\",\"shipping_type\": \"express\",\"first_name\": \"Test\",\"last_name\": \"Person\",\"street_address\": \"Rue La Fayette\",\"street_number\": \"33\",\"postal_code\": \"75009\",\"city\": \"Paris\",\"country\": \"FR\"}]}",
    "Reference": "1234"
}  

PHP

<?php 

require_once 'vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'your-client-id';
$api->Config->ClientPassword = 'your-api-key';
$api->Config->TemporaryFolder = 'tmp/';

try {
    $payinId = 'payin_m_01HYG8DRT5FHT1FV44MV9KR1BS';

    $response = $api->PayIns->Get($payinId);

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}