## Confirm an iDEAL payment

`stripe.confirmIdealPayment(clientSecret: string, data?: object, options?: object)`

Use `stripe.confirmIdealPayment` in the [iDEAL Payments with Payment Methods](https://docs.stripe.com/payments/ideal.md) flow when the customer submits your payment form.
When called, it will confirm the `PaymentIntent` with `data` you provide, and it will automatically redirect the customer to authorize the transaction.
Once authorization is complete, the customer will be redirected back to your specified `return_url`.

When you confirm a `PaymentIntent`, it needs to have an attached [PaymentMethod](https://docs.stripe.com/api/payment_methods.md).
In addition to confirming the `PaymentIntent`, this method can automatically create and attach a new `PaymentMethod` for you.
If you have already attached a `PaymentMethod` you can call this method without needing to provide any additional data.
These use cases are detailed in the sections that follow.

> Note that `stripe.confirmIdealPayment` may take several seconds to complete.
> During that time, you should disable your form from being resubmitted and show a waiting indicator like a spinner.
> If you receive an error result, you should be sure to show that error to the customer, re-enable the form, and hide the waiting indicator.

- `clientSecret`
  The [client secret](https://docs.stripe.com/api/payment_intents/object.md#payment_intent_object-client_secret) of the `PaymentIntent`.

- `data`
  Data to be sent with the request.
Refer to the [Payment Intents API](https://docs.stripe.com/api/payment_intents/confirm.md) for a full list of parameters.
    - `payment_method`
      Either the `id` of an existing [PaymentMethod](https://docs.stripe.com/api/payment_methods.md), or an object containing data to create a `PaymentMethod` with.
See the use case sections below for details.
    - `return_url`
      The url your customer will be directed to after they complete authentication.
    - `setup_future_usage`
      To set up a SEPA Direct Debit payment method using the bank details from this iDEAL payment,
set this parameter to `off_session`. When using this parameter, a `customer` will need
to be set on the [PaymentIntent](https://docs.stripe.com/api/payment_intents.md). The newly created SEPA Direct Debit
[PaymentMethod](https://docs.stripe.com/api/payment_methods.md) will be attached to this customer.

- `options`
  An options object to control the behavior of this method.
    - `handleActions`
      Set this to `false` if you want to [manually handle the authorization redirect](https://docs.stripe.com/payments/ideal/accept-a-payment?platform=web.md#web-handle-redirect).
Default is `true`.

### with payment data from an Element

### Data argument properties

- `payment_method`
  Pass an object to confirm using data collected by an `idealBank` [Element](https://docs.stripe.com/js/element.md).
    - `ideal`
      An `idealBank` [Element](https://docs.stripe.com/js/element.md).
    - `billing_details`
      The customer's [billing_details](https://docs.stripe.com/api/payment_methods/create.md#create_payment_method-billing_details).
Required when `setup_future_usage` is set to `off_session`.
      - `name`
        The customer's name.
      - `email`
        The customer's email.

- `return_url`
  The url your customer will be directed to after they complete authentication.

- `setup_future_usage`
  To set up a SEPA Direct Debit payment method using the bank details from this iDEAL payment,
set this parameter to `off_session`. When using this parameter, a `customer` will need
to be set on the [PaymentIntent](https://docs.stripe.com/api/payment_intents.md). The newly created SEPA Direct Debit
[PaymentMethod](https://docs.stripe.com/api/payment_methods.md) will be attached to this customer.

### Example

```title
Confirm with an Element
```

### with an existing payment method

### Data argument properties

- `payment_method`
  The `id` of an existing `PaymentMethod`.

- `return_url`
  The url your customer will be directed to after they complete authentication.

- `setup_future_usage`
  To set up a SEPA Direct Debit payment method using the bank details from this iDEAL payment,
set this parameter to `off_session`. When using this parameter, a `customer` will need
to be set on the [PaymentIntent](https://docs.stripe.com/api/payment_intents.md). The newly created SEPA Direct Debit
[PaymentMethod](https://docs.stripe.com/api/payment_methods.md) will be attached to this customer.

### Example

```title
Confirm with existing payment method
```

### with self collected data

### Data argument properties

- `payment_method`
  Pass an object to confirm using data collected by an `idealBank` [Element](https://docs.stripe.com/js/element.md).
    - `ideal`
      An object detailing the customer's iDEAL bank.
      - `bank`
        The customer's [bank](https://docs.stripe.com/payments/ideal/accept-a-payment?platform=web&ui=element.md#bank-reference).
    - `billing_details`
      The customer's [billing_details](https://docs.stripe.com/api/payment_methods/create.md#create_payment_method-billing_details).
Required when `setup_future_usage` is set to `off_session`.
      - `name`
        The customer's name.
      - `email`
        The customer's email.

- `return_url`
  The url your customer will be directed to after they complete authentication.

- `setup_future_usage`
  To set up a SEPA Direct Debit payment method using the bank details from this iDEAL payment,
set this parameter to `off_session`. When using this parameter, a `customer` will need
to be set on the [PaymentIntent](https://docs.stripe.com/api/payment_intents.md). The newly created SEPA Direct Debit
[PaymentMethod](https://docs.stripe.com/api/payment_methods.md) will be attached to this customer.

### Example

```title
Confirm with self collected data
```

### with an attached PaymentMethod

### Example

```title
Confirm with an attached PaymentMethod
```

### Example

```title
Confirm an iDEAL payment
```