## Confirm a Sofort payment

Use `stripe.confirmSofortPayment` in the [Sofort Payments with Payment Methods](/payments/sofort.md) flow when the customer submits your payment form.
When called, it will confirm the `PaymentIntent` with `data` you provide. It will then 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](/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.confirmSofortPayment` 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.

`stripe.confirmSofortPayment` will trigger a redirect when successful.
If there is an error, it will return a `Promise` which resolves with a `result` object.
This object has either:

* `result.paymentIntent`: the successful [PaymentIntent](/api/payment_intents).
* `result.error`: an error.
  Refer to the [API reference](/api#errors) for all possible errors.

**Syntax:** `stripe.confirmSofortPayment(...)`

- `clientSecret` (string) **required**
  The [client secret](/api/payment_intents/object.md#payment_intent_object-client_secret) of the `PaymentIntent`.

- `data` (object)
  Data to be sent with the request.
Refer to the [Payment Intents API](/api/payment_intents/confirm.md) for a full list of parameters.

  - `payment_method` (string | object)
    Either the `id` of an existing [PaymentMethod](/api/payment_methods.md), or an object containing data to create a `PaymentMethod` with.
See the use case sections below for details.

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

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

- `options` (object)
  An options object to control the behavior of this method.

  - `handleActions` (boolean)
    Set this to `false` if you want to [manually handle the authorization redirect](/payments/sofort/accept-a-payment?platform=web.md#handle-redirect).
Default is `true`.

### Use case: with an existing payment method

Use `stripe.confirmSofortPayment` with an existing `PaymentMethod` by passing its `id` to `payment_method`.
The `PaymentMethod` will be used to confirm the `PaymentIntent`.

### Data argument properties

- `payment_method` (string) **required**
  The `id` of an existing `PaymentMethod`.

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

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

### Confirm with existing payment method

```js
stripe
  .confirmSofortPayment('{PAYMENT_INTENT_CLIENT_SECRET}', {
    payment_method: '{PAYMENT_METHOD_ID}',
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  })
  .then(function(result) {
    // Inform the customer that there was an error.
  });
```

```es_next
const {error} = await stripe.confirmSofortPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: '{PAYMENT_METHOD_ID}',
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  },
);
```

### Use case: with collected data

The country of your customer's bank is required for the Sofort authorization to succeed.
You can pass in the country of your customer's bank directly to create a new `PaymentMethod` and confirm the `PaymentIntent`.

### Data argument properties

- `payment_method` (object) **required**
  Pass an object to confirm with the customer's name.

  - `sofort` (object) **required**
    An object detailing SOFORT specific parameters.

    - `country` (string) **required**
      The country code where customer's bank is located.

  - `billing_details` (object)
    The customer's [billing_details](/api/payment_methods/create.md#create_payment_method-billing_details).
Required when `setup_future_usage` is set to `off_session`.

    - `name` (string)
      The customer's name.

    - `email` (string)
      The customer's email.

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

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

### Confirm with self collected data

```js
stripe
  .confirmSofortPayment('{PAYMENT_INTENT_CLIENT_SECRET}', {
    payment_method: {
      sofort: {
        country: 'DE'
      }
    },
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

```es_next
const {error} = await stripe.confirmSofortPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: {
      sofort: {
        country: 'DE'
      }
    },
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  },
);
```

### Use case: with an attached PaymentMethod

If you have already attached a `PaymentMethod` to this `PaymentIntent`, then you can confirm the `PaymentIntent` using `stripe.confirmSofortPayment` without passing in any additional data.

### Confirm with an attached PaymentMethod

```js
stripe
  .confirmSofortPayment('{PAYMENT_INTENT_CLIENT_SECRET}')
  .then(function(result) {
    // Handle result.error or result.paymentIntent
  });
```

```es_next
const {paymentIntent, error} = await stripe.confirmSofortPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
);
```

### Confirm a Sofort payment

```js
stripe
  .confirmSofortPayment('{PAYMENT_INTENT_CLIENT_SECRET}', {
    payment_method: {
      sofort: {
        country: 'DE'
      }
    },
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  })
  .then(function(result) {
    if (result.error) {
      // Inform the customer that there was an error.
    }
  });
```

```es_next
const {error} = await stripe.confirmSofortPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: {
      sofort: {
        country: 'DE'
      }
    },
    // Return URL where the customer should be redirected after the authorization.
    return_url: window.location.href,
  },
);
```