Introducing the Chargebee CLI

PayTo via Adyen

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

PayTo is Australia's real-time account-to-account payment method, built on the New Payments Platform (NPP). Chargebee supports PayTo as a payment method through the Adyen payment gateway, for one-time payments and subscriptions.

When customers select PayTo at checkout, they enter their PayID or BSB and account number, then approve a PayTo agreement in their banking app. The agreement also covers renewal payments. Payment status is confirmed through Adyen webhooks.

PayTo via Adyen is a subscription-based payment method: Chargebee charges a saved PayTo agreement only for invoices of the subscription it was set up for.

Supported countries and currencies

PayTo via Adyen supports the following country and currency:

CountryCurrency
AustraliaAUD (Australian Dollar)

Payment features

The following features are available for PayTo via Adyen:

FeatureDescriptionSupportedDefault stateConfiguration or behavior
Integration sync modeDefines how payment requests are processed and statuses are communicated between Chargebee and Adyen.Yes (asynchronous)AsynchronousAdyen processes PayTo payments asynchronously. The customer can approve the agreement in their banking app some time after checkout, so the transaction stays In Progress until Chargebee receives the AUTHORISATION webhook. Webhook configuration is mandatory.
Capture settingsPayment processing involves two stages: authorization and capture. Capture settings determine when funds are collected after authorization.YesAuto captureAuto capture is the only supported capture setting for PayTo via Adyen. No additional configuration is required.
Verification modesDefines how payment methods are verified before processing.YesEnabledThe customer approves the PayTo agreement in their banking app. No separate verification configuration is required in Chargebee.
Regulatory requirementsRules set by the payment scheme or local regulation.YesEnabledThe customer's bank enforces the terms of the PayTo agreement, including its billing frequency. PayTo doesn't require a notification before each debit.
Statement descriptorDisplays the business name on the customer's bank statement, helping them recognize charges and reducing disputes.NoNot applicableNot applicable to PayTo via Adyen.
Chargeback managementHandles chargeback events and applies configured actions on invoices and subscriptions.NoNot applicableChargebee doesn't manage disputes for PayTo via Adyen. Issue refunds when needed.
Fraud managementUses gateway fraud signals to identify and flag high-risk transactions.NoNot applicableNo PayTo-specific fraud configuration is available in Chargebee.
Transaction initiation typeIdentifies whether a transaction is customer-initiated (CIT) or merchant-initiated (MIT).YesSupportedThe checkout payment is customer-initiated. Renewal payments are Merchant Initiated Transactions (MIT) collected through the saved PayTo agreement.
Error intelligenceProvides standardized categorization of payment failures.YesEnabledAvailable through Adyen payment and refusal responses. 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.
Adding payment methods in the Chargebee dashboardAllows a payment method to be added in Chargebee when details are collected outside checkout.NoNot applicableCustomers must complete the PayTo checkout flow. PayTo can't be added from the Chargebee dashboard.

Prerequisites

Before you set up PayTo via Adyen in Chargebee, make sure that:

  • The Adyen payment gateway is configured in your Chargebee site, including webhook notifications.
  • PayTo is added as a payment method for your AUD-enabled merchant account in the Adyen Customer Area. Learn more
  • AUD (Australian Dollar) is enabled as a currency in your Chargebee site.
  • Your customers have an Australian bank account that supports PayTo.

Integration options

You can integrate PayTo via Adyen using the following methods:

Integration methodDescription
Chargebee Hosted PagesAccept PayTo payments using Chargebee's hosted checkout pages with minimal integration effort.
Chargebee.jsEmbed PayTo as a payment method in your custom checkout using Chargebee.js.
API (Payment Intent)Process PayTo payments using Chargebee APIs for a fully custom checkout and payment flow.

Supported token formats

This section is relevant if you're building a custom checkout.

Token typeDescriptionSupportedToken fieldToken format
Chargebee Payment IntentRecommended token format when building 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 tokenPermanent reference provided by Adyen for a saved PayTo agreement and used for renewal payments.Yespayment_method[reference_id]shopper_reference_id/recurring_detail_reference_id
Gateway temporary tokenShort-lived token format that can be converted to a permanent token.NoNot applicableNot applicable

Configure in Chargebee

Follow these steps to enable PayTo via Adyen in your Chargebee site:

  1. Log in to the Chargebee app.
  2. Go to Settings > Configure Chargebee > Payment Gateways.
  3. Select the relevant Adyen instance from the list.
  4. On the Configure Adyen page, turn on PayTo under the supported payment methods.
  5. Click Apply to save your changes.

Configure Smart Routing

When you turn on PayTo for an Adyen instance, Smart Routing for PayTo payments in AUD is set to that instance automatically. If another gateway already handles PayTo payments in AUD, update the rule manually:

  1. Log in to the Chargebee app.
  2. Go to Settings > Configure Chargebee > Payment Gateways.
  3. Click Manage Rules under Smart Routing.
  4. Go to the PayTo section and click Add a Gateway for AUD. If a payment gateway is already assigned, click Edit.
  5. From the Choose a payment gateway dropdown, select the Adyen instance with PayTo turned on.
  6. Click Save.

Configure webhook notifications

Chargebee relies on Adyen webhooks to receive the outcome of PayTo agreements, payments, and refunds. Configure the Standard webhook as described in Configure webhook notifications for Adyen. Chargebee uses the following events for PayTo:

  • AUTHORISATION: The payment was authorized or refused.
  • CAPTURE: The payment was captured. Adyen usually confirms PayTo payments through AUTHORISATION alone, so you might not receive this event.
  • RECURRING_CONTRACT: The customer approved the PayTo agreement, and Adyen saved it for renewal payments. If this event isn't enabled on your Adyen account, contact Adyen support to enable it.
  • OFFER_CLOSED: The customer declined the PayTo agreement, or it expired before they approved it.
  • REFUND: Adyen accepted the refund. Chargebee marks the refund as successful.
  • REFUND_FAILED: A refund that Adyen accepted failed later. Chargebee changes the refund status to failed.

Also add the Recurring tokens life cycle events webhook. Chargebee uses its recurring.token.disabled event to learn that the customer canceled the PayTo agreement in their banking app. Follow these steps to add it:

  1. Log in to your Adyen Customer Area.
  2. Go to Developers > Webhooks and click + Webhook.
  3. Select Recurring tokens life cycle events from the list of webhooks and click Add.
  4. In the URL field, enter the same Chargebee notification URL that you use for the Standard webhook.
  5. Under Security > Basic authentication, enter the same username and password that you use for the Standard webhook.
  6. Click Save changes.

Checkout flow

Your customer completes the following steps at checkout when paying with PayTo via Adyen:

  1. The customer proceeds to the payment step of the checkout and selects PayTo.
  2. The customer enters their PayID (email, phone, ABN or Org ID), or their bank BSB and account number, and completes the order.
  3. The checkout closes and the order confirmation page appears. The transaction stays In Progress.
  4. The customer's bank sends them a request to approve the PayTo agreement through SMS, email, or a notification in their banking app. The customer can approve it after checkout.
  5. Adyen reports the result through a webhook. Chargebee marks the transaction successful or failed from that webhook.

If the customer declines the agreement, or doesn't approve it before it expires, Adyen closes the agreement and the payment fails. The customer must check out again to set up a new agreement.

Recurring payments

A PayTo agreement authorizes the first payment and later renewal payments for the subscription. Chargebee collects renewal payments as Merchant Initiated Transactions (MIT) through the saved agreement, without asking the customer to approve each one. PayTo doesn't require a notification to the customer before each debit.

The agreement records the subscription's billing frequency. For a subscription billed daily, weekly, fortnightly, monthly, quarterly, half-yearly, or yearly, the customer's bank allows one debit per billing period. For any other billing period, such as every two months, Chargebee sets the agreement frequency to adhoc.

When the subscription starts with a free trial and nothing is due at checkout, Chargebee authorizes a token amount and voids it, as it does for other payment methods. That authorization sets up the PayTo agreement. Chargebee collects the first subscription payment through the agreement when the trial ends.

If the customer cancels the PayTo agreement in their banking app, Adyen sends the recurring.token.disabled event, and Chargebee marks the PayTo payment method as invalid. The customer must check out again to set up a new agreement. Chargebee receives this event only if the Recurring tokens life cycle events webhook is configured, as described in Configure webhook notifications.

For renewal invoices, dunning follows the settings under Settings > Configure Chargebee > Dunning for Online Payments. Because Adyen processes payments asynchronously, dunning starts only after the transaction reaches a failed status. See Dunning.

Test in sandbox

Use your Adyen test merchant account with PayTo added and AUD enabled, and a Chargebee test site with the Adyen test instance configured. For the test PayIDs that simulate expired or refused agreements and failed payments, see the Test and go live section of Adyen's PayTo documentation.

Test in production

Before you go live:

  • Make sure PayTo is added for your live Adyen merchant account.
  • Verify that the Standard webhook and the Recurring tokens life cycle events webhook are configured for the live merchant account, and that RECURRING_CONTRACT is enabled.
  • Run an end-to-end test with a real Australian bank account that supports PayTo, including approving the agreement in the banking app.

Reconcile transactions

For financial reconciliation between Chargebee and Adyen, use the Chargebee transaction field id_at_gateway, which maps to the Adyen pspReference.

  1. Retrieve the id_at_gateway value from the Chargebee transaction details.
  2. Locate the corresponding pspReference in your Adyen reports.
  3. Match the transactions using this reference.

A PayTo transaction stays In Progress in Chargebee until the customer approves the agreement and Adyen confirms the payment, so reconcile after the transaction reaches a final status.

Error codes and troubleshooting

Adyen returns refusal reasons for failed PayTo payments, and Chargebee shows them on the transaction page under Error details. An OFFER_CLOSED outcome means the agreement itself was declined or expired, not a single payment. For gateway error handling in Chargebee, see Payment errors.

Frequently Asked Questions (FAQs)

Can I refund a PayTo payment?

Yes. You can issue full and partial refunds. Refunds are asynchronous: the refund stays in progress until Adyen confirms it through the REFUND webhook. If the refund fails later, Adyen sends REFUND_FAILED, and Chargebee marks the refund as failed.

Can a customer use a saved PayTo agreement to pay another subscription?

No. A PayTo agreement is tied to the subscription it was set up for. Chargebee charges it only for invoices of that subscription, and charges invoices of other subscriptions to the customer's backup payment method. See Subscription-based payment methods.

Limitations and important points

  • PayTo via Adyen is available only for AUD (Australian Dollar) transactions and customers with an Australian bank account that supports PayTo.
  • A saved PayTo agreement is charged only for invoices of the subscription it was set up for. Invoices for one-time charges and invoices of other subscriptions are charged to the customer's backup payment method.
  • PayTo can't be added through the Customer Portal or the Chargebee app. Customers must complete the PayTo checkout flow.
  • A PayTo agreement can't be changed after the customer approves it. If you change the subscription's billing frequency, the customer must approve a new agreement.
  • If the customer declines the agreement or it expires before approval, the payment fails and the customer must check out again.