Interface Result

ConfirmationToken result type.

interface Result {
    id: string;
    created: number;
    expiresAt?: number;
    liveMode: boolean;
    paymentIntentId?: string;
    setupIntentId?: string;
    returnURL?: string;
    setupFutureUsage?: PaymentIntent.FutureUsage;
    paymentMethodPreview?: ConfirmationToken.PaymentMethodPreview;
    shipping?: ConfirmationToken.ShippingDetails;
    allResponseFields: Record<string, any>;
}

Properties

id created expiresAt? liveMode paymentIntentId? setupIntentId? returnURL? setupFutureUsage? paymentMethodPreview? shipping? allResponseFields

Properties

id

id: string

Unique identifier for the object (e.g. ctoken_...).

created

created: number

Time at which the object was created. Measured in seconds since the Unix epoch.

OptionalexpiresAt

expiresAt?: number

Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.

liveMode

liveMode: boolean

true if the object exists in live mode or the value false if the object exists in test mode.

OptionalpaymentIntentId

paymentIntentId?: string

ID of the PaymentIntent this token was used to confirm.

OptionalsetupIntentId

setupIntentId?: string

ID of the SetupIntent this token was used to confirm.

OptionalreturnURL

returnURL?: string

Return URL used to confirm the intent for redirect-based methods.

OptionalsetupFutureUsage

setupFutureUsage?: PaymentIntent.FutureUsage

Indicates intent to reuse the payment method.

OptionalpaymentMethodPreview

paymentMethodPreview?: ConfirmationToken.PaymentMethodPreview

Non-PII preview of payment details captured by the Payment Element.

Optionalshipping

shipping?: ConfirmationToken.ShippingDetails

Shipping information collected on this token.

allResponseFields

allResponseFields: Record<string, any>

All response fields from the API, including any additional or undocumented fields.

Settings

Member Visibility

On This Page

Properties