Skip to main content

Configure Adyen Payment Method Updater

Zuora

Configure Adyen Payment Method Updater

This article describes how to configure the Adyen Account Updater to use it with the Zuora Payment Method Updater (PMU) for Visa and MasterCard. This feature helps keep Zuora and you informed when card members change, replace, or upgrade their card information.

Zuora can receive updates from the Adyen gateway when the following events occur for MasterCard and Visa credit cards:

  • A new expiry date for expired cards is available.
  • A new card replaces the old one.
  • A shopper reports loss or theft of their card.
  • A shopper informs their card issuer that they no longer authorize the merchant to charge their card automatically.

Zuora uses the bulk account updater option from Adyen for the integration. See Adyen Account Updater for more information about detailed account updates. 

Prerequisites

If you are interested in using the Adyen Account Updater functionality, you must go through a series of steps to configure the PMU service before it can be used. 

  • Ensure you are in a region where the Adyen Account Updater service is supported.
  • You have to work directly with Adyen Support to set up your updater account and SFTP server. See Account Updater and Advanced SFTP batch files for more information.
  • To use Batch Account Updater of Adyen, ensure that the Merchant Recurring Role permission is enabled on your Adyen merchant account.
  • Download the public PGP key files provided by Zuora for Sandbox and Production, and configure these key files to your Adyen account. 
  • Download the public SSH key files provided by Zuora for Sandbox and Production, and configure these key files to your Adyen SFTP account. 

    After the response file is processed by Zuora, it will be deleted from the SFTP server. Therefore, you cannot associate multiple tenants with the same SFTP server.

  • Configure outbound IP addresses from Zuora based on your region for IP whitelisting. See Inbound and Outbound IP Addresses for details.

Set Up Adyen Payment Method Updater

You can set up Adyen Account Updater through the Zuora UI.

  1. Click your username at the top right, and navigate to Settings > Payments > Set Up Payment Method Updater.
  2. Select Adyen from the Updater Type list, and click add payment method updater.
  3. In the Basic information area, configure the following information:
    • Processor: The PMU functionality has to be approved by your gateway/processor. Once enabled, Zuora will automatically send Adyen payment methods to the Adyen gateway for updates.
    • Select the Active box to activate your Adyen Account Updater in Zuora. 
      When this check box is selected, PMU will automatically submit credit card information for updates. Note that if multiple active updaters are configured, they might submit the same cards and receive the same updates.
    • In the Name field, enter the name you want to use to identify the updater. 
  4. In the Credentials area, configure the following information:
    • In the Merchant Account Name field, enter the merchant account name assigned by Adyen.
    • In the Company Account Name field, enter the company account name assigned by Adyen.
    • In the SFTP Username field, enter the SFTP user name used for account updates.
    • In the File Submission Platform field, enter a unique identifier for the server used to submit batch files to Adyen. Note that do not enter the identifier for a server that hosts multiple Zuora tenants. If you do not have any specific setting, you can enter Zuora.
  5. In the Updater services area, select the updater services that you want to use.
    • Select the Visa Account Updater (VAU) check box.
    • Select the MasterCard Automatic Billing Updater check box.
      Both Visa and Mastercard services are supported.
  6. In the Rules area, configure the following information:
    • Specify a value for Start Payment Method Updater service days prior to the Bill Cycle Day field.
      Zuora recommends using a value of 5 to 7 days prior to the Bill Cycle Day, because the Adyen Account Updater service takes approximately 5 days to process the credit card account information for updates.
    • If the Only update payment methods for customer accounts associated to this gateway/processor option is selected, only the credit cards for customer accounts that meet either of the following conditions are included in the updates. Disable this field to send all credit card information to Adyen.
      • The default payment gateway of the customer account is set to Adyen (in the Billing and Payment Info section on the Customer Account page).
      • The default payment gateway of the customer account is not configured, but the default payment gateway of the tenant is set to Adyen.
    • If the Only update the default payment method for AutoPay customer accounts setting is selected, only the default credit card payment methods for customer accounts with the AutoPay setting enabled are included in the updates. Clear this check box to submit data of all credit cards for all customer accounts, regardless of whether AutoPay is enabled for the customer account or not.
  7. Click save updater information to save configurations.

For more information about Updater Services and Rules, see Using Payment Method Updater.

Submit and Retrieve PMU Batches

Payment methods are collected every day at 18:00:00 Pacific Standard Time (PST). When you navigate to Payments > Payment Method Updater, you can see the "Processing" status in batch list. 

An Adyen scheduled job runs every day at 18:00:00 PST, this job retrieves the completed batch from Adyen via SFTP. When the batch is successfully sent, the status is displayed as “Completed”.

If you attempt to resubmit batches one hour before the daily scheduled batch processing time of 18:00:00 PST, you will receive an error and will have to wait until the daily batch processing is complete before resubmitting.

For more information about how to manually create PMU batches, resubmit batches, and retrieve batch results, see Use Payment Method Updater.

Known Limitations

The Adyen Account Updater feature has some known limitations from Adyen and Zuora.

Adyen Limitations

The Adyen Account Updater feature has the following limitations from the Adyen side:

  • Only Visa and Mastercard are currently supported.
  • Adyen and the card updater service do not support posting report files based on requests in the test environment. Report files are only posted in the Adyen production server, so this feature can only be tested from a production tenant.

Zuora Limitations

Report files cannot be populated with real cardholder names by Zuora. Because the cardholder name field is required by Adyen, Zuora uses a dummy value as the cardholder name to populate report files.

Troubleshoot Adyen Account Updater

See Troubleshooting Payment Method Updater to learn how to troubleshoot Account Updater in Zuora when errors occur. The following Adyen documentation is provided as a reference: Batch Account Updater.