Welcome to Zuora Product Documentation

Explore our rich library of product information

Set up and configure an Adyen Integration v2.0 gateway instance

Learn how to set up and configure an Adyen Integration v2.0 gateway instance, including prerequisites, configuration steps, testing procedures, and related information.

Set up and configure an Adyen Integration v2.0 gateway instance by using the information in this article, including prerequisites, configuration procedure, descriptions of the configuration fields and additional metadata, and reference for testing the payment gateway.

Prerequisites

Before setting up and configuring an Adyen Integration v2.0 instance, ensure that you have met the following requirements:

  • Enable the Adyen Integration v2.0 payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.
  • Generate an Adyen API Key for your merchant account. See How to get the API key for instructions on how to obtain the API key.
  • You must obtain the live-URL prefix from your Adyen merchant account for production. This setting will be saved as a gateway setting in Zuora. Failure to specify this prefix will result in that requests cannot be processed in production.
  • For Bank Transfer transactions, you must send a request to enable “Separate Direct Debit with authorization type AUTH” for your Adyen merchant account when setting up SEPA with Adyen.
  • To enable ACH payment processing, you must enable ACH payment processing for your Adyen merchant account.
  • For ACH credit (non-referenced refunds) processing, the storeDetailAndSubmitThirdParty and confirmThirdPartyAdyen endpoints from the Adyen Payout API v30 are used. Before ACH refunds without payment reference can be successfully made, Adyen needs to enable payouts and set up payouts to work with both endpoints on your Adyen merchant account. As required by Adyen, you must have two separate Adyen user accounts provisioned and set up: one for submitting payouts, and the other for reviewing and confirming payouts.
  • The setting for recurring fields in the API response must be enabled for your Adyen merchant account to obtain the Shopper Reference token. To enable this setting in your merchant account, navigate to Settings > API URL and Response and click Recurring Details in the Payments section. The Shopper Reference token will then be included in the payment results.
  • To ensure the network transaction ID (NTI) is returned from Adyen and saved in Zuora for processing recurring payments, you must enable the Network transaction reference setting at the Adyen side.

Test the configuration

For basic guidance on how to test payment gateway integrations within a sandbox environment, see Test payment gateway integration .

You can use the test card information and testing scenarios provided by the gateway vendor to test your integration. See Adyen's Test payment methods for details.

For more information about troubleshooting payment errors in Zuora Central Sandbox, see Test payment gateways .