Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.gr4vy.com/llms.txt

Use this file to discover all available pages before exploring further.

Adyen is a global payment technology company founded in 2006 in Amsterdam, Netherlands. The company provides a single platform for accepting payments across online, mobile, and in-store channels for major enterprises worldwide including Uber, Spotify, and Microsoft. ACH Direct Debit is a bank payment method in the United States. The buyer enters their bank account and routing numbers on the Adyen Drop-in component, and the funds are debited from their account. Adyen verifies and processes the debit, and the payment method can be stored for recurring debits. This connector renders the Adyen Drop-in for ACH Direct Debit. To submit bank account details directly through the API instead, see Bank (ACH, SEPA, BACS) via Adyen.

​
Setup

Please follow the common Adyen instructions to get set up with ACH Direct Debit. Next, make sure to enable ACH Direct Debit as a payment method on your configured account.

​
Supported countries

ACH Direct Debit supports transactions from buyers in PR and US.

​
Supported currencies

ACH Direct Debit supports processing payments in USD.

​
Features

ACH Direct Debit via Adyen supports the following features:
  • Direct capture - Capture funds at the time of the transaction
  • Refunds - Refund transactions in full
  • Partial refunds - Refund a portion of the original transaction amount
  • Payment method tokenization - Store the bank account for recurring debits
  • Settlement reporting - Reconcile transactions against Adyen settlement reports

​
Limitations

The following features are not supported by this connector:
  • Delayed capture - Authorization and capture happen together
  • Partial capture - Cannot capture a portion of the authorized amount
  • Void - Cannot cancel a transaction once initiated
  • Zero auth - Zero-amount verification transactions are not supported

​
Integration

For ACH Direct Debit, the default integration for Adyen is through a redirect to a hosted payments page that renders the Adyen Drop-in in a popup. The buyer enters their bank account and routing numbers on the Drop-in to authorize the debit.

​
Redirect integration

Start by creating a new transaction with the following required fields. 
var transaction = await client.Transactions.CreateAsync(
    transactionCreate: new TransactionCreate()
    {
        Amount = 1299,
        Currency = "USD",
        Country = "US",
        PaymentMethod =
            TransactionCreatePaymentMethod.CreateCheckoutSessionWithUrlPaymentMethodCreate(
                new RedirectPaymentMethodCreate()
                {
                    Method = "ach",
                    RedirectUrl = "https://example.com/callback",
                }
            ),
    }
);
After the transaction is created, the API response includes payment_method.approval_url and the buyer_approval_pending status. 
{
  "type": "transaction",
  "id": "ea1efdd0-20f9-44d9-9b0b-0a3d71e9b625",
  "payment_method": {
    "type": "payment-method",
    "approval_url": "https://cdn.sandbox.spider.gr4vy.app/connectors/adyen/apm.html?token=..."
  },
  "method": "ach"
}
Open the approval_url in a popup so the buyer can enter their bank account and routing numbers on the Adyen Drop-in and authorize the debit. After the buyer completes the form they are redirected to the redirect_url you provided when creating the transaction. Do not rely solely on the redirect - either poll the transaction or (recommended) rely on webhooks to detect the final status (for example capture_succeeded or failure states).

​
Direct integration

Adyen provides web, Android and iOS SDKs for a direct integration. For these flows you should indicate the platform by setting an appropriate integration_client when creating the transaction, and then build a client-side integration that uses the POST /transactions/:transaction_id/session API to initialize the Adyen SDK. To start, create a new transaction with the appropriate integration_client. 
var transaction = await client.Transactions.CreateAsync(
  transactionCreate: new TransactionCreate()
  {
    Amount = 1299,
    Currency = "USD",
    Country = "US",
    IntegrationClient = "ios",
    PaymentMethod =
      TransactionCreatePaymentMethod.CreateCheckoutSessionWithUrlPaymentMethodCreate(
        new RedirectPaymentMethodCreate()
        {
          Method = "ach",
          RedirectUrl = "https://example.com/callback",
        }
      ),
  }
);
For mobile, set integration_client to ios or android and use your app deep link for redirect_url (for example, yourapp://). After the transaction is created, the API response includes a session_token which can be used to get the session data for that transaction. 
POST /transactions/:transaction_id/session?token=:session_token
This session data provides the sessionId and sessionData required to load the Adyen SDK. Refer to the common Adyen integration guidance for a worked example of initializing the Adyen SDK with this session data.

​
Recurring payments

ACH Direct Debit via Adyen supports storing the bank account for later reuse. When you store the payment method, Gr4vy registers a recurring contract with Adyen so the stored bank account can be debited for subsequent transactions. See Recurring payments for an overview of storing and reusing payment methods.

​
Testing

Adyen has instructions on how to test ACH Direct Debit.