Interface PaymentRequest

A Payment Request represents a request for a payment. The Payment Request lifecycle is defined in PaymentRequestStateType.

A payment request is automatically created when a user clicks the Klarna payment button and the paymentRequest property is defined. See KlarnaPaymentButton for more information.

interface PaymentRequest {
    paymentRequestId: string;
    paymentRequestReference?: string;
    previousState?:
        | "SUBMITTED"
        | "IN_PROGRESS"
        | "COMPLETED"
        | "EXPIRED"
        | "CANCELED";
    state: "SUBMITTED"
    | "IN_PROGRESS"
    | "COMPLETED"
    | "EXPIRED"
    | "CANCELED";
    stateContext?: PaymentRequestStateContext;
    stateReason?:
        | "PARTNER_CANCELED"
        | "PURCHASE_FLOW_ABORTED"
        | "TECHNICAL_ERROR";
}

Properties

paymentRequestId paymentRequestReference? previousState? state stateContext? stateReason?

Properties

ReadonlypaymentRequestId

paymentRequestId: string

Unique identifier of this payment request

Optional ReadonlypaymentRequestReference

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.

Optional ReadonlypreviousState

previousState?:
    | "SUBMITTED"
    | "IN_PROGRESS"
    | "COMPLETED"
    | "EXPIRED"
    | "CANCELED"

Previous state of the payment request

Readonlystate

state: "SUBMITTED" | "IN_PROGRESS" | "COMPLETED" | "EXPIRED" | "CANCELED"

Current state of the payment request

Optional ReadonlystateContext

stateContext?: PaymentRequestStateContext

Context for the current state of the payment request

Optional ReadonlystateReason

stateReason?: "PARTNER_CANCELED" | "PURCHASE_FLOW_ABORTED" | "TECHNICAL_ERROR"

Reason why the payment request is in its current state

Settings

Member Visibility

On This Page

Properties