## Confirm a Pix payment

Use `stripe.confirmPixPayment` in the [Pix Payment](/payments/pix.md) with Payment Methods flow when the customer submits your payment form.
When called, it will confirm the [PaymentIntent](/api/payment_intents.md) with `data` you provide.
Note that there are some additional requirements to this flow that are not covered in this reference.
Refer to our [integration guide](/payments/pix.md) for more details.

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.confirmPixPayment` may take several seconds to complete and display the QR code.
> 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.

By default, `stripe.confirmPixPayment` will display the Pix QR code overlay. If
there is an error, or when handling next actions manually by using the
`handleActions: false` option, 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.confirmPixPayment(...)`

- `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.

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

  - `handleActions` (boolean)
    Default to be `true`. Set this to `false` if you would like to [handle displaying the Pix QR code yourself](/payments/pix/accept-a-payment.md#confirm-payment-intent).

### Use case: without an existing payment method

If you have not already created a `PaymentMethod`, you can pass payment method parameters, and the newly created `PaymentMethod` will be used to confirm the `PaymentIntent`.

### Data argument properties

- `payment_method` (object) **required**
  Pass payment method paramters or and empty payment method object.

### Confirm without existing payment method

```js
stripe.confirmPixPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: {},
  }
).then(function(result) {
  // Handle result.error or result.paymentIntent
});
```

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

### Use case: with an existing payment method

If you have already created a `PaymentMethod`, you can pass its `id` to `payment_method` and it will be used to confirm the `PaymentIntent`.

### Data argument properties

- `payment_method` (string) **required**
  The `id` of an existing [PaymentMethod](/api/payment_methods.md).

### Confirm with existing payment method

```js
stripe.confirmPixPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: '{PAYMENT_METHOD_ID}',
  }
).then(function(result) {
  // Handle result.error or result.paymentIntent
});
```

```es_next
const {paymentIntent, error} = await stripe.confirmPixPayment(
  '{PAYMENT_INTENT_CLIENT_SECRET}',
  {
    payment_method: '{PAYMENT_METHOD_ID}',
  }
);
```

### Use case: with an attached PaymentMethod

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

### Confirm with an attached PaymentMethod

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

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

### Confirm a Pix payment

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

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