## Confirm a BECS Debit payment Use `stripe.confirmAuBecsDebitPayment` in the [BECS Direct Debit Payments](/payments/au-becs-debit.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/au-becs-debit.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.confirmAuBecsDebitPayment` 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.confirmAuBecsDebitPayment` will return a `Promise` which resolves with a result object. This object has either: * `result.paymentIntent`: the successful PaymentIntent. * `result.error`: an error. Refer to the API reference for all possible errors. **Syntax:** `stripe.confirmAuBecsDebitPayment(...)` - `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` (object | string) The `id` of an existing PaymentMethod or an object of collected data. See use cases below for details. - `setup_future_usage` (string) To set up the BECS Direct Debit account for reuse, set this parameter to `off_session`. BECS Direct Debit only accepts an `off_session` value for this parameter. If a `customer` is provided on this [PaymentIntent](/api/payment_intents.md), the [PaymentMethod](/api/payment_methods.md) will be attached to the customer when the PaymentIntent transitions to `processing`. ### Use case: with payment data from an Element Create and attach a new PaymentMethod with `stripe.confirmAuBecsDebitPayment` by passing an `auBankAccount` [Element](/js/element.md) to `payment_method[au_becs_debit]`. The new `PaymentMethod` will be created with the data collected by the `Element` and will be used to confirm the `PaymentIntent`. Additionally, to create a BECS Direct Debit `PaymentMethod`, you are required to collect and include the account holder's name and the customer's email address. ### Data argument properties - `payment_method` (object) **required** Pass an `object` to confirm the payment using data collected by an `auBankAccount` [Element](/js/element.md). - `au_becs_debit` (Element) **required** An `auBankAccount` Element. - `billing_details` (Object) **required** The customer's [billing_details](/api/payment_methods/create.md#create_payment_method-billing_details). `name` and `email` are required. - `name` (string) **required** The account holder's name. - `email` (string) **required** The customer's email. ### Confirm with an Element ```js stripe .confirmAuBecsDebitPayment('{PAYMENT_INTENT_CLIENT_SECRET}', { payment_method: { au_becs_debit: auBankAccountElement, billing_details: { name: 'John Smith', email: 'john.smith@example.com', }, }, }) .then(function(result) { // Handle result.error or result.paymentIntent }); ``` ```es_next const {paymentIntent, error} = await stripe.confirmAuBecsDebitPayment( '{PAYMENT_INTENT_CLIENT_SECRET}', { payment_method: { au_becs_debit: auBankAccountElement, billing_details: { name: 'John Smith', email: 'john.smith@example.com', }, }, }, ); ``` ### Use case: with self collected data If you already know the customer’s BSB number and bank account number or want to collect it yourself, then you do not need to use the `auBankAccount` Element with `stripe.confirmAuBecsDebitPayment`. You can pass in the customer’s bank account information directly to create a new `PaymentMethod` and confirm the `PaymentIntent`. To create a BECS Direct Debit `PaymentMethod`, you are required to collect and include the account holder's name and the customer's email address. ### Data argument properties - `payment_method` (object) **required** Pass an object to confirm using data collected without an `Element`. - `au_becs_debit` (object) **required** - `bsb_number` (string) **required** A Bank State Branch (BSB) number. - `account_number` (string) **required** A bank account number. - `billing_details` (Object) **required** The customer's [billing_details](/api/payment_methods/create.md#create_payment_method-billing_details). `name` and `email` are required. - `name` (string) **required** The account holder's name. - `email` (string) **required** The customer's email. ### Confirm with self collected data ```js stripe .confirmAuBecsDebitPayment('{PAYMENT_INTENT_CLIENT_SECRET}', { payment_method: { au_becs_debit: { bsb_number: '000000', account_number: '000123456' }, billing_details: { name: 'John Smith', email: 'john.smith@example.com', }, }, }) .then(function(result) { // Handle result.error or result.paymentIntent }); ``` ```es_next const {paymentIntent, error} = await stripe.confirmAuBecsDebitPayment( '{PAYMENT_INTENT_CLIENT_SECRET}', { payment_method: { au_becs_debit: { bsb_number: '000000', account_number: '000123456' }, billing_details: { name: 'John Smith', email: 'john.smith@example.com', }, }, }, ); ``` ### Use case: with an existing payment method If you have already created a `PaymentMethod`, you can pass its `id` to `payment_method` when calling `stripe.confirmAuBecsDebitPayment`. 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 .confirmAuBecsDebitPayment('{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.confirmAuBecsDebitPayment( '{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 the `PaymentIntent` using `stripe.confirmAuBecsDebitPayment` without passing in any additional data. ### Confirm with an attached PaymentMethod ```js stripe .confirmAuBecsDebitPayment('{PAYMENT_INTENT_CLIENT_SECRET}') .then(function(result) { // Handle result.error or result.paymentIntent }); ``` ```es_next const {paymentIntent, error} = await stripe.confirmAuBecsDebitPayment( '{PAYMENT_INTENT_CLIENT_SECRET}', ); ``` ### Confirm a BECS Debit payment ```js stripe .confirmAuBecsDebitPayment('{PAYMENT_INTENT_CLIENT_SECRET}', { payment_method: { au_becs_debit: auBankAccountElement, billing_details: { name: 'John Smith', email: 'john.smith@example.com', }, }, }) .then(function(result) { // Handle result.error or result.paymentIntent }); ``` ```es_next const {paymentIntent, error} = await stripe.confirmAuBecsDebitPayment( '{PAYMENT_INTENT_CLIENT_SECRET}', { payment_method: { au_becs_debit: auBankAccountElement, billing_details: { name: 'John Smith', email: 'john.smith@example.com', }, }, }, ); ```