Mayson Monorepo Documentation
    Preparing search index...

    ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.

    To learn more about how to use ConfirmationToken, visit the related guides:

    interface ConfirmationToken {
        id: string;
        object: "confirmation_token";
        created: number;
        expires_at: number;
        livemode: boolean;
        mandate_data?: Stripe.ConfirmationToken.MandateData;
        payment_intent: string;
        payment_method_options: Stripe.ConfirmationToken.PaymentMethodOptions;
        payment_method_preview: Stripe.ConfirmationToken.PaymentMethodPreview;
        return_url: string;
        setup_future_usage: Stripe.ConfirmationToken.SetupFutureUsage;
        setup_intent: string;
        shipping: Stripe.ConfirmationToken.Shipping;
        use_stripe_sdk: boolean;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "confirmation_token"

    String representing the object's type. Objects of the same type share the same value.

    created: number

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

    expires_at: number

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

    livemode: boolean

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

    Data used for generating a Mandate.

    payment_intent: string

    ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

    Payment-method-specific configuration for this ConfirmationToken.

    Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.

    return_url: string

    Return URL used to confirm the Intent.

    Indicates that you intend to make future payments with this ConfirmationToken's payment method.

    The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.

    setup_intent: string

    ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

    Shipping information collected on this ConfirmationToken.

    use_stripe_sdk: boolean

    Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to true on ConfirmationToken.