Interface PaymentRequestData

Request for a purchase authorization.

This is the authorization context to use for a normal purchase.

interface PaymentRequestData {
    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 };
    paymentOptionId?: string;
    paymentRequestReference?: string;
    shippingConfig?: {
        mode: "EDITABLE" | "READ_ONLY";
        supportedCountries?: string[];
    };
    supplementaryPurchaseData?: SupplementaryPurchaseData;
}

Properties

amount? collectCustomerProfile? currency customerInteractionConfig? paymentOptionId? paymentRequestReference? shippingConfig? supplementaryPurchaseData?

Properties

Optionalamount

amount?: number

Total payment amount.

OptionalcollectCustomerProfile

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

Configure if the customer profile data should be collected from the customer. The collected customer data will be available 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. The collected details can only be used for the purpose of fulfilling the purchase.

The following customer profile details can be collected:

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

currency

currency: string

3-letter ISO 4217 currency code.

OptionalcustomerInteractionConfig

customerInteractionConfig?: { returnUrl?: string }

Configuration for customizing customer interaction with the payment flow.

Type declaration

  • OptionalreturnUrl?: string

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

OptionalpaymentOptionId

paymentOptionId?: string

OptionalpaymentRequestReference

paymentRequestReference?: string

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

OptionalshippingConfig

shippingConfig?: {
    mode: "EDITABLE" | "READ_ONLY";
    supportedCountries?: string[];
}

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

If mode is set to EDITABLE then 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 mode is set to READ_ONLY then 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.

Type declaration

  • mode: "EDITABLE" | "READ_ONLY"
  • OptionalsupportedCountries?: string[]

    A list of countries the goods can be shipped to. When not provided, Klarna will not limit the countries available in the shipping address selector.

    Default Value

    []

OptionalsupplementaryPurchaseData

supplementaryPurchaseData?: SupplementaryPurchaseData

Supplementary purchase data.

Settings

Member Visibility

On This Page

Properties