Payment-method icon

ACH Direct Debit Component

Add ACH Direct Debit to an existing Components integration.

This page explains how to add ACH Direct Debit to your existing Web Components integration.

Requirements

Select which endpoint you are using:

Import resources for v6

If you are using Web Components v6, import the Component that you need for ACH Direct Debit:

import { AdyenCheckout, Ach } from '@adyen/adyen-web'

API reference

Select which endpoint you are using:

Component configuration

Step 1: Create a DOM element

Create a DOM element on your checkout page, placing it where you want the payment method form to be rendered:

 <div id="ach-container"></div>

Step 2: Create an instance of the Component

v6.0.0 or later

Create an instance of the Component, passing:

  • Your instance of AdyenCheckout.
const achDirectDebit = new Ach(checkout).mount('#ach-container');

Use the create method of your AdyenCheckout instance, in this case checkout, to create the Component:

const achDirectDebitComponent = checkout.create('ach').mount('#ach-container');

Optional configuration

When creating an instance of Components, you can optionally include the following parameters in the payment methods configuration object:

Field Description Default
billingAddressRequired Set to false to hide billing address fields if you want to pass the data yourself. true
enableStoreDetails
v5.24.0 or later
Set to true to show the checkbox for saving the payment details. false
hasHolderName Set to false to hide this field if you want to pass the data yourself. true
holderNameRequired Set to false if you want to make it optional for the shopper to fill cardholder name fields. true

Payment outcome

After we successfully received your request, it may take up to five business days to know whether the payment was authorised by the bank. If the bank authorised the payment, it will appear in the Settlement details report. If the bank failed to authorise the payment, you will receive a CHARGEBACK webhook.

Test and go live

You can test ACH Direct Debit payments as well as chargebacks.

Test the payment flow

Before making live ACH Direct Debit payments, use the following account details to test your integration.

ownerName bankAccountNumber bankLocationId
(routing number)
billingAddress
(account owner's address)
Any name Any correctly formatted account number.
Example: 1234567890
011000138 or 121000358 Any correctly formatted US address.

Test the chargeback flow

You can test the chargeback flow by making test payments with an ownerName value that consists of chargeback: followed by an ACH return reason code. For example, chargeback:R01. The other account details to use are the same as when testing payments.

For instructions, see Test a chargeback scenario.

See also