Klarna Web SDK v2
    Preparing search index...

    Interface PaymentRequestData

    Payment request for a one-off purchase.

    interface PaymentRequestData {
        agenticConfig?: AgenticConfig;
        amount?: number;
        collectCustomerProfile?: (
            | "profile:name"
            | "profile:email"
            | "profile:phone"
            | "profile:locale"
            | "profile:billing_address"
            | "profile:country"
            | "profile:national_identification"
            | "profile:date_of_birth"
        )[];
        currency: string;
        customerInteractionConfig?: { returnUrl?: string };
        intent?: "authorization" | "preparation";
        paymentOptionId?: string;
        paymentRequestReference?: string;
        requestCustomerToken?: {
            customerTokenReference?: string;
            scopes: ("payment:customer_present" | "payment:customer_not_present")[];
        };
        shippingConfig?: {
            mode: "EDITABLE"
            | "READ_ONLY";
            supportedCountries?: string[];
        };
        supplementaryPurchaseData?: SupplementaryPurchaseData;
    }
    Index
    agenticConfig? amount? collectCustomerProfile? currency customerInteractionConfig? intent? paymentOptionId? paymentRequestReference? requestCustomerToken? shippingConfig? supplementaryPurchaseData?
    agenticConfig?: AgenticConfig

    Provide agentic configuration to enable AI Agent-initiated payment flows. Use this field when the payment is initiated by an Agent with Agentic Privilege.

    future-release

    amount?: number

    Total amount of a one-off purchase, including tax and any available discounts. The value should be in non-negative minor units. Eg: 25 Dollars should be 2500. This is the amount that Klarna will charge the customer for a one-off purchase. Should not include any amounts for subscriptions.

    collectCustomerProfile?: (
        | "profile:name"
        | "profile:email"
        | "profile:phone"
        | "profile:locale"
        | "profile:billing_address"
        | "profile:country"
        | "profile:national_identification"
        | "profile:date_of_birth"
    )[]

    The collected customer data will be available for reading under stateContext.klarnaCustomer.customerProfile when the request is in state COMPLETED.

    Note that you must have a valid purpose under GDPR or other relevant jurisdiction to request and process the identity information of the customer.

    • profile:name - returns the family name and given name
    • profile:email - returns the email and its verification status.
    • profile:phone - returns the phone number and its verification status.
    • profile:locale - returns the locale.
    • profile:billing_address - returns the customer profile address.
    • profile:country - returns the country.

    gated

    currency: string

    Currency in ISO 4217 format.

    customerInteractionConfig?: { returnUrl?: string }

    Payment initiation methods that describes how to launch the purchase flow.

    Type Declaration

    • OptionalreturnUrl?: string

      URL to redirect the customer after the payment flow is completed.

    intent?: "authorization" | "preparation"

    The payment intent.

    • AUTHORIZATION (default) - Indicates if the payment request is triggered at the last step of the checkout and no further modification is expected. The issued payment token or interoperability token can be authorized without further customer interaction.
    • PREPARATION - Indicates if the payment request is triggered at the 1st step of a multistep checkout where modification can be expected. The issued payment token or interoperability token may be authorized without further customer interaction but may also trigger step-up in certain situations.

    PaymentRequestIntent.AUTHORIZATION

    gated

    paymentOptionId?: string

    Specifies a payment option to be pre-selected in the purchase flow.

    The available payment_option_id can be obtained from the Payment Options API.

    paymentRequestReference?: string

    Reference to the payment session or equivalent resource created on your side. This will be exposed in payment request webhooks (payment.request.*) for the purpose of correlating your resource with the Klarna Payment Request.

    requestCustomerToken?: {
        customerTokenReference?: string;
        scopes: ("payment:customer_present" | "payment:customer_not_present")[];
    }

    Request a customer account linking to be set up, effectively returning a token called customer_token on successful confirmation of the payment request. The generated token allows the token owner to act on-behalf of the customer.

    The generated token will be available under stateContext.klarnaCustomer.customerToken when the request is in state COMPLETED

    Type Declaration

    • OptionalcustomerTokenReference?: string

      Partner reference to the customer token created on Klarna side. This will be exposed in webhooks related to changes to the customer token (e.g. token revoked) for the purpose of correlating your resource with the Klarna customer token.

    • scopes: ("payment:customer_present" | "payment:customer_not_present")[]

      The scopes of the requested customer token. The scopes define the permissions of the token.

      • payment:customer_not_present - Enables payment tokenization of the customer, allows you to charge for subscriptions and on-demand when the customer is not present.
      • payment:customer_present - Enables tokenization of the customer, subsequent charges depending on risk assessment and the initially selected payment method might go through immediately or, in certain cases, require step-up.
      • customer:login - Enables account linking for the customer that allows the partner to create future payment requests in a logged in state for the customer.
    shippingConfig?: {
        mode: "EDITABLE" | "READ_ONLY";
        supportedCountries?: string[];
    }

    Configure how the shipping collection form will behave in the purchase flow. Without the shipping config, no shipping collection form will be displayed.

    Type Declaration

    • mode: "EDITABLE" | "READ_ONLY"

      Configure if the shipping details should be collected from the customer.

      • EDITABLE: the shipping details will be collected from the customer and will be available under stateContext.shipping when the payment request is in state COMPLETED. If you enable this, you must read back and honour the shipping address returned in the payment request response.
      • READ_ONLY: the customer can only see the shipping details that are provided in the supplementaryPurchaseData.shipping[0] object without the ability to change them. The READ_ONLY mode will be supported in a future release. Setting it won't have any effect.
    • OptionalsupportedCountries?: string[]

      Partner's supported shipping countries (ISO 3166-1 alpha-2).

      []
    supplementaryPurchaseData?: SupplementaryPurchaseData

    Provide additional details about the transaction to help reduce fraud risk and enhance transparency. Include only the specific fields you wish to update within supplementaryPurchaseData in update requests. Klarna processes the supplementary data and uses it for fraud detection and customer communication.

    Settings
    Member Visibility

    On This Page
    Properties