## Confirm a Boleto payment

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

Use `stripe.confirmBoletoPayment` in the [Boleto Payment](https://docs.stripe.com/payments/boleto.md) with Payment Methods flow when the customer submits your payment form.
When called, it will confirm the [PaymentIntent](https://docs.stripe.com/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](https://docs.stripe.com/payments/boleto.md) for more details.

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.confirmBoletoPayment` 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`
      The `id` of an existing PaymentMethod or an object of collected data.
See use cases below for details.

- `options`
  An options object to control the behavior of this method.
    - `handleActions`
      Set to `false`.
The Boleto private beta does not handle the next actions for you automatically (e.g. display Boleto details). Please refer to our [Stripe Boleto integration guide](https://docs.stripe.com/payments/boleto.md) for more info.

### with collected data

### Data argument properties

- `payment_method`
  Pass an object to confirm using data collected.
    - `boleto`
      - `tax_id`
        The customer's Brazilian tax id (CPF/CNPJ).
    - `billing_details`
      The customer's [billing_details](https://docs.stripe.com/api/payment_methods/create.md#create_payment_method-billing_details).
`name`, `email` and `address`.
      - `name`
        The customer's name. The first and last name must be at minimum 2 characters each.
      - `email`
        The customer's email.
      - `address`
        The customer's address: street name, city, state and postal code
        - `line1`
          The customer's address line 1 (e.g. street or company name).
        - `line2`
          The customer's address line 2 (e.g. apartment, suite, unit, or building).
        - `city`
          The customer's address city (e.g. Sao Paulo).
        - `state`
          The customer's address state (e.g. SP).
        - `postal_code`
          The customer's CEP (i.e. Brazilian postal code). Must be 8 digits long.
        - `country`
          Must be BR.

### Example

```title
Confirm with collected data
```

### with an existing payment method

### Data argument properties

- `payment_method`
  The `id` of an existing [PaymentMethod](https://docs.stripe.com/api/payment_methods.md).

### Example

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

### with an attached PaymentMethod

### Example

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

### Example

```title
Confirm a Boleto payment
```