Add types for Confirmation Token GA

tests/types/src/invalid.ts

@@ -439,3 +439,19 @@ stripe.createPaymentMethod({
     },
   },
 });
+
+stripe
+  .createConfirmationToken({
+    elements,
+    params: {
+      // @ts-expect-error payment_method is not a valid parameter
+      payment_method: 'pm_12345',
+    },
+  })
+  .then((result) => {
+    if (result.error) {
+      return console.log(result.error.code);
+    }
+    // @ts-expect-error mandate_data is not a valid parameter
+    result.confirmationToken.mandate_data;
+  });

tests/types/src/valid.ts

@@ -2342,6 +2342,50 @@ stripe.createPaymentMethod({
   billing_details: {name: '', email: ''},
 });
 
+stripe
+  .createConfirmationToken({
+    elements,
+    params: {
+      payment_method_data: {
+        billing_details: {
+          name: 'Jenny Rosen',
+        },
+      },
+      shipping: {
+        address: {
+          line1: '1234 Main St',
+          line2: 'Apt 213',
+          city: 'San Francisco',
+          state: 'CA',
+          country: 'US',
+          postal_code: '94111',
+        },
+        name: 'Jenny Rosen',
+      },
+      return_url: 'https://shop.example.com/success.html',
+    },
+  })
+  .then((result) => {
+    if (result.error) {
+      return console.log(result.error.code);
+    }
+    result.confirmationToken.payment_method_preview;
+  });
+
+stripe
+  .createConfirmationToken({
+    elements,
+  })
+  .then((result) => {
+    if (result.error) {
+      return console.log(result.error.code);
+    }
+    const a = result.confirmationToken.payment_method_preview;
+    const b = result.confirmationToken.setup_future_usage;
+    const c = result.confirmationToken.shipping;
+    const d = result.confirmationToken.payment_intent;
+  });
+
 stripe
   .collectBankAccountForPayment({
     clientSecret: '',

types/api/confirmation-tokens.d.ts

@@ -0,0 +1,178 @@
+import {StripeElements} from '../stripe-js';
+import {Address} from './shared';
+import {PaymentMethod, PaymentMethodCreateParams} from './payment-methods';
+import {PaymentIntent} from './payment-intents';
+
+/**
+ * The ConfirmationToken object.
+ */
+export interface ConfirmationToken {
+  /**
+   * Unique identifier for the object.
+   */
+  id: string;
+
+  /**
+   * String representing the object's type. Objects of the same type share the same value.
+   */
+  object: 'confirmation_token';
+
+  /**
+   * Time at which the object was created. Measured in seconds since the Unix epoch.
+   */
+  created: number;
+
+  /**
+   * Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. This is set to null once this ConfirmationToken has been used. Measured in seconds since the Unix epoch.
+   */
+  expires_at: number;
+
+  /**
+   * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+   */
+  livemode: boolean;
+
+  /**
+   * ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
+   */
+  payment_intent: null | string;
+
+  /**
+   * Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken.
+   */
+  payment_method_preview: ConfirmationToken.PaymentMethodPreview;
+
+  /**
+   * The URL your customer is redirected to after they complete the payment.
+   */
+  return_url: string | null;
+
+  /**
+   * Indicates that you intend to make future payments with this ConfirmationToken’s payment method.
+   *
+   * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.
+   *
+   * Stripe uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules. For example, if your customer is impacted by [SCA](https://stripe.com/docs/strong-customer-authentication), using `off_session` will ensure that they are authenticated while processing this PaymentIntent. You will then be able to collect [off-session payments](https://stripe.com/docs/payments/cards/charging-saved-cards#off-session-payments-with-saved-cards) for this customer.
+   */
+  setup_future_usage: PaymentIntent.SetupFutureUsage | null;
+
+  /**
+   * ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.
+   */
+  setup_intent: null | string;
+
+  /**
+   * Shipping information for this ConfirmationToken.
+   */
+  shipping: PaymentIntent.Shipping | null;
+}
+
+export interface ConfirmationTokenCreateParams {
+  /**
+   * Data used to create a new payment method.
+   *
+   */
+  payment_method_data?: {
+    /**
+     * The customer's billing details.
+     */
+    billing_details?: PaymentMethodCreateParams.BillingDetails;
+  };
+
+  /**
+   * Shipping information.
+   */
+  shipping?: ConfirmationToken.Shipping;
+
+  /**
+   * The url your customer will be directed to after they complete authentication.
+   */
+  return_url?: string | null;
+}
+
+export interface CreateConfirmationToken {
+  /**
+   * The Elements instance.
+   *
+   * @docs https://stripe.com/docs/js/elements_object
+   */
+  elements: StripeElements;
+
+  /**
+   * Parameters for creating the ConfirmationToken.
+   * Details collected by Elements will be overriden by values passed here.
+   */
+  params?: ConfirmationTokenCreateParams;
+}
+
+export namespace ConfirmationToken {
+  export interface Shipping {
+    /**
+     * Recipient address.
+     */
+    address: Address;
+
+    /**
+     * Recipient name.
+     */
+    name: string | null;
+
+    /**
+     * Recipient phone (including extension).
+     */
+    phone?: string | null;
+  }
+
+  export interface PaymentMethodPreview {
+    /**
+     * The type of the PaymentMethod. An additional hash is included on payment_method_preview with a name matching this value. It contains additional information specific to the PaymentMethod type.
+     */
+    type: string;
+
+    billing_details: PaymentMethod.BillingDetails;
+
+    acss_debit?: PaymentMethod.AcssDebit;
+
+    affirm?: PaymentMethod.Affirm;
+
+    afterpay_clearpay?: PaymentMethod.AfterpayClearpay;
+
+    au_becs_debit?: PaymentMethod.AuBecsDebit;
+
+    card?: PaymentMethod.Card;
+
+    card_present?: PaymentMethod.CardPresent;
+
+    eps?: PaymentMethod.Eps;
+
+    fpx?: PaymentMethod.Fpx;
+
+    grabpay?: PaymentMethod.GrabPay;
+
+    ideal?: PaymentMethod.Ideal;
+
+    p24?: PaymentMethod.P24;
+
+    sepa_debit?: PaymentMethod.SepaDebit;
+
+    us_bank_account?: PaymentMethod.UsBankAccount;
+  }
+
+  export interface MandateData {
+    customer_acceptance: {
+      type: 'online';
+
+      online?: {
+        /**
+         * The IP address from which the Mandate was accepted by the customer.
+         */
+        ip_address: string;
+
+        /**
+         * The user agent of the browser from which the Mandate was accepted by the customer.
+         */
+        user_agent: string;
+      };
+    };
+  }
+}

types/api/index.d.ts

@@ -1,5 +1,6 @@
 export * from './shared';
 export * from './payment-methods';
+export * from './confirmation-tokens';
 export * from './payment-intents';
 export * from './orders';
 export * from './setup-intents';

types/stripe-js/confirmation-tokens.d.ts

@@ -0,0 +1 @@
+export {CreateConfirmationToken} from '../api';

types/stripe-js/stripe.d.ts

@@ -1,6 +1,7 @@
 import * as api from '../api';
 import * as paymentIntents from './payment-intents';
 import * as setupIntents from './setup-intents';
+import * as confirmationTokens from './confirmation-tokens';
 import * as orders from './orders';
 import * as tokens from './token-and-sources';
 import * as elements from './elements';
@@ -671,6 +672,15 @@ export interface Stripe {
     options: paymentIntents.CreatePaymentMethodFromElement
   ): Promise<PaymentMethodResult>;
 
+  /**
+   * Use stripe.createConfirmationToken to convert payment information collected by elements into a [ConfirmationToken](https://stripe.com/docs/api/confirmation_tokens) object that you safely pass to your server to use in an API call.
+   *
+   * @docs https://stripe.com/docs/js/confirmation_tokens/create_confirmation_token
+   */
+  createConfirmationToken(
+    options: confirmationTokens.CreateConfirmationToken
+  ): Promise<ConfirmationTokenResult>;
+
   /**
    * Retrieve a [PaymentIntent](https://stripe.com/docs/api/payment_intents) using its [client secret](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-client_secret).
    *
@@ -1250,6 +1260,10 @@ export type PaymentMethodResult =
   | {paymentMethod: api.PaymentMethod; error?: undefined}
   | {paymentMethod?: undefined; error: StripeError};
 
+export type ConfirmationTokenResult =
+  | {confirmationToken: api.ConfirmationToken; error?: undefined}
+  | {confirmationToken?: undefined; error: StripeError};
+
 export type SourceResult =
   | {source: api.Source; error?: undefined}
   | {source?: undefined; error: StripeError};