Introducing the Chargebee CLI

BECS NZ via Stripe

This feature is a Private Beta release. Contact Chargebee Support to enable BECS NZ via Stripe for your live and test sites.

BECS NZ (Bulk Electronic Clearing System for New Zealand) is a payment system that processes debit transactions directly from bank accounts in New Zealand. Chargebee lets you configure BECS NZ Direct Debit through Stripe. To learn more, see Stripe's NZ bank account documentation.

To set up the gateway first, see Configure Stripe in Chargebee.

BECS NZ applies only to payments made in NZD (New Zealand dollars).

Integration options

You can integrate BECS NZ via Stripe using the following methods:

Integration methodDescription
Chargebee Hosted PagesCollect BECS NZ Direct Debit bank account details using Chargebee's hosted checkout with minimal integration effort.
Chargebee JSEmbed BECS NZ Direct Debit as a payment method in your custom checkout using Chargebee JS.
Gateway JSCollect bank account details in your custom checkout using Gateway JS.
API (Payment Intent)Process BECS NZ Direct Debit payments using Chargebee APIs for a fully custom checkout and payment flow.

Prerequisites

Before you enable BECS NZ Direct Debit, make sure you have the following:

Configure BECS NZ via Stripe

To enable BECS NZ Direct Debit via Stripe on your Chargebee site:

  1. Log in to your Chargebee site.
  2. Go to Settings > Configure Chargebee > Payment Gateways > Stripe.
  3. Turn on BECS Direct Debit (for NZ region only) to configure direct debit payments for New Zealand–based customers.
  4. Enter the following details on the BECS NZ Configuration page:
    • Business name
    • Business email
    • Contact number
  5. Click Save, and then click Apply.

Control where Direct Debit is shown

Use the Display Direct Debit as a payment method setting to control who sees BECS NZ Direct Debit in checkout and the self-serve portal.

OptionDescription
All customersDisplays Direct Debit for all customers, including new customers, regardless of the customer-level bank account setting.
Customers with Direct Debit payments enabledDisplays Direct Debit only for customers who have Allow this customer to pay via their bank account turned on.

Click Apply to save your changes.

Payment workflow

Your customer completes the following steps at checkout when paying with BECS NZ via Stripe:

  1. The customer reviews the order details on the Your order page and clicks Proceed to Checkout.
  2. The customer enters the billing address on the Add your billing address page and clicks Next.
  3. On the Add your payment details page, the customer selects Direct Debit and clicks Proceed to Review.
  4. The customer acknowledges and accepts the mandate and clicks Next.
  5. The customer reviews the order summary on the Complete your order page and clicks Pay.
  6. The transaction is processed, and the customer sees a payment success message.

The screenshots above show the BECS NZ authorization flow in Stripe's test environment. In production, customers complete the payment using a real bank account.

Payment features

The following table describes the features supported for this integration:

FeatureDescriptionSupportedDefault stateConfiguration or behavior
Integration sync modeDefines the integration mode between Chargebee and Stripe, including how payment requests are processed and statuses are communicated.Yes (asynchronous)AsynchronousStripe processes BECS NZ Direct Debit payments asynchronously. Chargebee receives the final payment status through webhook notifications, which can arrive with a delay.
Capture settingsPayment processing involves two stages: authorization and capture. Capture settings determine when and how funds are collected after authorization.YesAuto captureNo configuration is required. Auto capture is the only supported capture setting for BECS NZ.
Verification modesDefines how customer bank accounts are validated before Direct Debit starts.YesEnabledNo configuration is required. Stripe verifies the mandate after the customer confirms their bank account details.
Regulatory requirements supportBECS NZ scheme rules require mandate text to be displayed at checkout and notifications to be sent on mandate creation and before debit (pre-notification).YesMandate display in Chargebee checkout enabled by defaultIn Chargebee's prebuilt checkout interfaces, the mandate text appears automatically when BECS NZ is used. For custom checkouts, you must render the mandate text explicitly.
Statement descriptorA statement descriptor is the business name shown on a customer's bank statement, helping them recognize charges and reducing disputes.YesDisabledConfigure this at Settings > Configure Chargebee > Transaction Descriptor.
Chargeback managementProcesses chargeback events through webhooks and automatically applies configured actions to invoices and subscriptions to streamline handling and prevent repeat disputes.YesDisabledConfigure at Settings > Configure Chargebee > Billing LogIQ > Payments > Chargeback Management.
Fraud managementAutomatically interprets fraud signals from the payment gateway to identify and flag high-risk transactions for appropriate action.NoNot applicableStripe handles fraud checks. Chargebee manages no additional fraud signals.
Transaction initiation typeIdentifies whether a transaction is customer-initiated (CIT) or merchant-initiated (MIT) based on gateway-defined parameters.NoNot applicableNot supported. Direct Debit transactions are merchant-initiated by design.
Error intelligenceProvides standardized categorization of payment failures.NoNot applicableNot supported for BECS NZ. No configuration is required.
Gateway transaction detailsProvides access to raw gateway responses for transactions.YesEnabledAvailable on the transaction page under Error details. No configuration is required.
Addition of payment methods in the Chargebee dashboardThe ability to add a payment method in Chargebee when details are collected outside the platform.NoNot applicableNot supported. Customers must complete the mandate creation flow through checkout or the portal.

Supported token formats

This section is relevant if you're building a custom checkout or migrating bank accounts from another provider to Stripe.

Token typeDescriptionSupportedToken fieldToken format
Chargebee Payment IntentRecommended token format when you build a custom checkout using Chargebee JS.Yespayment_intent[id]payment_intent_id
Chargebee tokenLegacy token format supported for selected payment methods and gateways with Chargebee JS. Not recommended for new implementations.Notoken_idNot applicable
Gateway permanent tokenA permanent reference provided by the gateway and used for future recurring payments or migrations from another PSP to Stripe.Yespayment_method[reference_id]payment_method_id

Email notifications

You must notify your customers when a mandate is created and before they're charged. To do this, turn on the following email notifications in Chargebee:

  • Mandate creation
  • Pre-notification

To find these notifications:

  1. Go to Settings > Configure Chargebee > Email Notifications.
  2. Select the Payments and credits category.

Both notifications are available there. You can edit each template to suit your requirements.

Testing

Test in the sandbox

Use a Stripe test BECS NZ bank account to validate the payment flow on your test site. For test account numbers and scenarios, see Stripe's test bank account details.

Test in production

Before you go live:

  • Make sure BECS NZ Direct Debit is fully configured in both Stripe and Chargebee.
  • Perform end-to-end testing with a real bank account to validate the complete payment flow.