Confirmation Tokens

Confirmation Tokens ConfirmationTokens transport client-side data collected by Stripe.js to your server. You can use them to confirm a PaymentIntent or SetupIntent on your server. ## Create a ConfirmationToken with Elements stripe.createConfirmationToken(options: object) Convert payment information collected by Elements into a ConfirmationToken object. Use this method if you want to confirm payment on your server or confirm payment on a subsequent page. - options - elements The Elements instance that was used to create the Express Checkout Element or Payment Element. Calling stripe.createConfirmationToken pulls payment method, billing address, and shipping address data from the Elements instance. - params Parameters that will be passed on to the Stripe API. - payment_method_data When you call stripe.createConfirmationToken, payment details are collected from Elements. You can include additional payment_method_data fields, which will be merged with the data collected from Elements. Refer to the PaymentMethod API for a full list of parameters. - billing_details Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. - allow_redisplay Indicates whether the payment method can be displayed to the customer in subsequent checkout flows. The value passed here will override the [allow_redisplay](the relevant part of the product#payment_method_object-allow_redisplay) determined by the provided elements parameter. - shipping The shipping details for the payment, if collected. You can't specify shipping if mode: 'setup' is specified on the elements object. Note: When the Address Element in shipping mode is being used, shipping address details are collected from the Address Element. You can also include additional shipping fields, which will be merged with the data collected from the Element, overriding any fields that were also collected by the Address Element. - return_url The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter is only used for cards and other redirect-based payment methods. - metadata Set of key-value pairs that you can attach to the ConfirmationToken. This can be useful for storing additional information about the object in a structured format. Note that the metadata is saved on the Confirmation Token object but isn't returned in the frontend response. You can retrieve the metadata on the server with a retrieve confirmation token request. ### Example title Create a ConfirmationToken