Skip to main content

Configure Checkout.com Payment Method Updater

Zuora

Configure Checkout.com Payment Method Updater

This article describes how to configure the Checkout.com 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 Checkout gateway when the following events occur for Mastercard and Visa credit cards:

  • The card details have been updated, including a change to the card number.
  • The card details have been updated where only the expiry month or expiry year has changed.
  • The card has been disabled.
  • The card details have not changed.

Prerequisites

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

  • You have to work directly with Checkout.com Support to set up your Checkout.com Account Updater and the SFTP server. Note that you have to inform Checkout.com Support that you intend to set up an Account Updater in the Zuora system. See Checkout Account Updater (Refresh-Flex) for more information.
  • If you want to test this functionality in the sandbox environment, submit a request to Zuora Global Support.

Checkout.com requires a file sequence ID for each uploaded file. To ensure that the sequence ID is generated properly, do not associate multiple Zuora PMU instances with the same SFTP server.

Configuration

You can set up the Payment Method Updater for Checkout.com through the Zuora UI.

  1. Click your username at the top right, and navigate to Settings > Payments > Set Up Payment Method Updater.
  2. Select checkout.com 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 Checkout.com payment methods to the Checkout.com gateway for updates.
    • Select the Active box to activate your checkout.com Payment Method 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. Complete the following credential configuration:
    • Account ID: Enter the Account ID provided by Checkout.com.
    • SFTP Username: Enter your SFTP username assigned by Checkout.com. The length of the username must be less than 20 characters, and special characters should be avoided. You cannot configure the same SFTP username to multiple Zuora's PMU instances.
  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.
      The default value is 8 because the Checkout.com Account Updater service takes approximately 8 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 Checkout.com.
      • The default payment gateway of the customer account is set to Checkout.com (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 Checkout.com.
    • 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

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

Troubleshoot Checkout Account Updater

See Troubleshooting Payment Method Updater to learn how to troubleshoot Account Updater in Zuora when errors occur.