The Confirmation Token object

Attributes

id string Unique identifier for the object.
object string, value is "confirmation_token" String representing the object’s type. Objects of the same type share the same value.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
expires _ at nullable timestamp Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
mandate _ data nullable object Data used for generating a Mandate.
metadata nullable map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
payment _ intent nullable string ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
payment _ method _ options nullable object Payment-method-specific configuration for this ConfirmationToken.
payment _ method _ preview nullable object Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
return _ url nullable string Return URL used to confirm the Intent.
setup _ future _ usage nullable enum 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. Possible enum values off_session Use off_session if your customer may or may not be present in your checkout flow. on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.
setup _ intent nullable string ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
shipping nullable object 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.

{ "id": "ctoken_1NnQUf2eZvKYlo2CIObdtbnb", "object": "confirmation_token", "created": 1694025025, "expires_at": 1694068225, "livemode": true, "mandate_data": null, "payment_intent": null, "payment_method": null, "payment_method_preview": { "billing_details": { "address": { "city": "Hyde Park", "country": "US", "line1": "50 Sprague St", "line2": "", "postal_code": "02136", "state": "MA" }, "email": "jennyrosen@stripe.com", "name": "Jenny Rosen", "phone": null }, "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": null }, "country": "US", "display_brand": "visa", "exp_month": 8, "exp_year": 2026, "funding": "credit", "generated_from": null, "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "three_d_secure_usage": { "supported": true }, "wallet": null }, "type": "card" }, "return_url": "https://example.com/return", "setup_future_usage": "off_session", "setup_intent": null, "shipping": { "address": { "city": "Hyde Park", "country": "US", "line1": "50 Sprague St", "line2": "", "postal_code": "02136", "state": "MA" }, "name": "Jenny Rosen", "phone": null }}

Retrieve a ConfirmationToken

GET / v1 / confirmation_tokens /:id

Retrieves an existing ConfirmationToken object

Parameters

No parameters.

Returns

Returns the specified ConfirmationToken

Response

{ "id": "ctoken_1NnQUf2eZvKYlo2CIObdtbnb", "object": "confirmation_token", "created": 1694025025, "expires_at": 1694068225, "livemode": true, "mandate_data": null, "payment_intent": null, "payment_method": null, "payment_method_preview": { "billing_details": { "address": { "city": "Hyde Park", "country": "US", "line1": "50 Sprague St", "line2": "", "postal_code": "02136", "state": "MA" }, "email": "jennyrosen@stripe.com", "name": "Jenny Rosen", "phone": null }, "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": null }, "country": "US", "display_brand": "visa", "exp_month": 8, "exp_year": 2026, "funding": "credit", "generated_from": null, "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "three_d_secure_usage": { "supported": true }, "wallet": null }, "type": "card" }, "return_url": "https://example.com/return", "setup_future_usage": "off_session", "setup_intent": null, "shipping": { "address": { "city": "Hyde Park", "country": "US", "line1": "50 Sprague St", "line2": "", "postal_code": "02136", "state": "MA" }, "name": "Jenny Rosen", "phone": null }}

Create a test Confirmation Token Test helper

POST / v1 / test_helpers / confirmation_tokens

Creates a test mode Confirmation Token server side for your integration tests.

Parameters

payment _ method string ID of an existing PaymentMethod.
payment _ method _ data object If provided, this hash will be used to create a PaymentMethod.
payment _ method _ options object Payment-method-specific configuration for this ConfirmationToken.
return _ url string Return URL used to confirm the Intent.
setup _ future _ usage enum 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. Possible enum values off_session Use off_session if your customer may or may not be present in your checkout flow. on_session Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.
shipping object Shipping information for this ConfirmationToken.

Returns

Returns a testmode Confirmation Token

Response

{ "id": "ctoken_1Ow71CL4FhS6zgoxWjxc7sfr", "object": "confirmation_token", "created": 1710871450, "expires_at": 1710914650, "livemode": false, "payment_intent": null, "payment_method_preview": { "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": null, "name": null, "phone": null }, "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": "unchecked" }, "country": "US", "display_brand": "visa", "exp_month": 3, "exp_year": 2025, "fingerprint": "jbGyCKrSRsFpOBWP", "funding": "credit", "generated_from": null, "last4": "4242", "networks": { "available": [ "visa" ], "preferred": null }, "three_d_secure_usage": { "supported": true }, "wallet": null }, "type": "card" }, "return_url": null, "setup_future_usage": null, "setup_intent": null, "shipping": null, "use_stripe_sdk": true}