When accepting ACH Direct Debit payments, Nacha requires you to validate that the shopper's bank account details are correct, if it is a consumer account. To make this validation easier for you, we have partnered with Plaid. Plaid collects the shopper's permission to connect their account to Plaid, and verifies the account details directly with the shopper's bank.
Benefits:
- Smooth shopper experience. Shoppers link their account using Plaid Link. Shoppers do not need to search for their account number and routing number.
- You send us the shopper's Plaid processor token instead of having to deal with sensitive account details.
- Plaid collects the shopper's permission to store their details and check their account balance.
- Real-time balance check. This reduces the chance that transactions are reversed because of insufficient funds. It can also save shoppers having to pay overdraft fees or non-sufficient funds fees.
If you do not want to validate the account with Plaid, you need to collect the shopper's bank account number, bank routing number, and account holder name, and pass these details in the payment request.
Requirements
| Requirement | Description |
|---|---|
| Integration type | Make sure that you have built an Advanced flow Web Drop-in, Web Components, or API-only integration. |
| Limitations | Depending on their bank, shoppers may need to re-authenticate with Plaid after a number of months. The token itself doesn't change, but you need to re-initialize it. You cannot use account validation with Plaid if your integration uses the /sessions endpoint. |
| Setup steps | Before you begin:
|
How it works
- The shopper selects ACH Direct Debit on your payment form.
- You check if the shopper has already connected their account with Plaid.
- If the shopper's account isn't connected to Plaid yet:
- You direct the shopper to Plaid Link.
- You make a series of API requests to Plaid to get the shopper's Plaid processor token.
- You make a payment with the shopper's Plaid processor token and optionally include parameters to check the customer's account balance. We use the shopper's Plaid processor token to validate their account details with Plaid.
The following diagram illustrates this flow.
For more insights, see Plaid's documentation on the Plaid - Adyen partnership.
Check the shopper's processor token
It is possible that with a previous payment to you, the shopper connected their account to Plaid and you saved their Plaid processor token. If you do not have the shopper's Plaid processor token, you need to direct the shopper to the Plaid Link app and get their token.
Proceed as follows:
-
In your POST /paymentMethods request, make sure to use:
currency: set to USD.countryCode: set to US.
-
When the shopper selects ACH Direct Debit, on your payment form collect:
- The account owner's name.
- The shopper's billing address (optional).
- Any other details to be able to look up this shopper in your database.
-
Based on the provided details, look up the shopper in your database and check if you have their Plaid processor token.
-
If you have the shopper's Plaid processor token, proceed to make a payment.
-
If you do not have the shopper's Plaid processor token, get it from Plaid:
-
Make a series of requests to Plaid from your backend:
- A POST
/link/token/createrequest to initialize the Plaid Link app and get apublic_token. - A POST
/item/public_token/exchangerequest with thepublic_tokento get anaccess_token. - A POST
/processor/token/createrequest with theaccess_tokento get the shopper'sprocessor_token.
For the details, see Plaid's instructions for Adyen integrations.
- A POST
-
Save the shopper's processor token, and proceed to make a payment.
-
Make a payment
The ACH Direct Debit payment request must include the shopper's Plaid processor token. Optionally you can add parameters to check if the account balance meets specific conditions before trying an authorization.
You can also tokenize the transaction for future recurring payments.
Proceed as follows:
-
From your server, make a POST /payments request.
Specify the following parameters:
Parameter Required Description paymentMethod.type
Set to ach. paymentMethod.ownerName
The account holder name that you collected on your payment form when the shopper selected ACH Direct Debit. billingAddressThe account owner's address information. additionalDataThe shopper's Plaid processor token and any balance check parameters you want to use. These are the Plaid parameters you can use in
additionalData:Parameter Description plaid.processorTokenThe shopper's Plaid processor token that you received from Plaid and stored in your database.
Required for validation with Plaid.plaid.balanceCheckA string value set to true if you want us to check the account balance. plaid.minimumAmountA string value indicating the minimum amount available on the account, in minor units. Use only with plaid.balanceCheckset to true.
For example, if the balance must be USD 10 or more, specify 1000. You can also use this in combination withplaid.balanceMultiplier.plaid.balanceMultiplierA string value indicating the condition that the account balance must at least be X times the payment amount.
Ifplaid.minimumAmountis specified, indicates the condition that the account balance must at least be X times the specified minimum amount. For example, if the balance must be at least 2.5 times USD 10, setplaid.balanceMultiplierto 2.5 and setplaid.minimumAmountto 1000. -
Check the /payments response.
The
additionalDataobject contains the validation result:Parameter Description achdirectdebit.dateOfSignatureThe date that the shopper gave permission to collect direct debit payments from their account. achdirectdebit.mandateIdThe identification of the shopper's permission to collect direct debit payments from their account. This ID is the same as the PSP reference of the payment. achdirectdebit.sequenceTypeIndicates if the direct debit payments are recurring. Possible values: OneOff, First. availableBalanceValueThe account balance. Only included if the request has plaid.balanceChecktrue. Note that the balance is not in minor units.bankSummaryThe last four digits of the shopper's bank account. bankVerificationResultThe result of the account validation and balance checks: Passed. If the validation fails, you receive an error message. bankVerificationResultRawThe details of the account validation result. For example:
Passed: Available Balance greater than threshold if you asked for a balance check with conditions.
Passed: Routing number and Account number successfully retrieved if you didn't ask for a balance check.plaidProcessorTokenThe shopper's Plaid processor token passed in the request. Other parameters in the response include:
Parameter Description pspReferenceOur unique reference for the payment. resultCodeAuthorised. This means that the payment has been successfully received by Adyen. However, it may take up to 5 business days to know whether the payment was authorized by the bank. If you do not get an Authorised response, refer to Handle Plaid validation errors.
The payment is sent to the bank. If the payment is successful, it will appear in the Settlement details report. If it fails, you will receive a CHARGEBACK webhook.
Handle Plaid validation errors
If the Plaid validation failed, you get an error response like the following example.
Make sure that your integration can handle the following validation error responses:
| Error | Description |
|---|---|
| 51_001 - Plaid service is currently unavailable | Try again later. |
| 51_002 - Unknown error for Plaid | Try again later. |
| 51_003 - Let the customer re-authenticate with Plaid | The shopper's Plaid processor token needs to be re-initialized. Direct the shopper to the Plaid Link update mode. The token itself doesn't change. |
| 51_004 - No valid checking or savings accounts for which account and routing numbers could be retrieved | Ask the shopper to try another account or bank. |
| 51_005 - Plaid internal error | Plaid was unable to process the request. Possible causes:
|
| 51_006 - Plaid rate limit exceeded. Please try again later | Too many requests were made in a short period of time. Possible causes:
|
Present the payment result
Use the resultCode that you received in the /payments response to present the payment result to your shopper.
The resultCode values you can receive for ACH Direct Debit are:
| resultCode | Description | Action to take |
|---|---|---|
| Authorised | The payment has been successfully received by Adyen. It may take up to 5 business days to know whether the payment was authorized by the bank. If the payment is successful, it will appear in the Settlement Detail Report. If it fails, you will receive a CHARGEBACK webhook. |
Inform the shopper that the payment was successful. |
| Refused | The payment was refused. | Ask the shopper to try the payment again using a different payment method. |
Test and go live
To test the connection with Plaid, use the Plaid sandbox. Optionally use the Plaid GitHub repo to test specific scenarios.
Before you go live, create a Plaid developer account and run tests in the Plaid Developer environment.