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). 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.
    checkou.com PMU
  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 you select the Only update payment methods for customer accounts associated to this gateway/processor checkbox, only the credit cards for customer accounts with checkout.com set as the payment gateway (under Billing and Payment Info) are included in the updates. Clear this check box to send all credit card information to Checkout.com.
    • If you select the Only update the default payment method for AutoPay customer accounts check box, only the credit cards for customer accounts with the default AutoPay payment method are included in the updates. Clear this check box to send all credit card information to Checkout.com.
  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

When you navigate to Payments > Payment Method Updater, you can see the "Processing" status in the batch list. 

Create batches

You can create a batch through the Zuora UI.

  1. Navigate to Payments > Payment Method Updater.
  2. Click Create a Batch.
  3. In the New Payment Method Updater Batch dialog:
    1. From the Updater Name list, select the configured Checkout.com PMU.
    2. Select a value from the Bill Cycle Day list.
    3. Click create batch.

Create batch result
Because a request file might result in multiple response files from Checkout.com, the batch remains in the Processing status until Zuora receives the response for all uploaded card entries.

Resubmit batches

In some cases, you might have to resubmit a batch for processing. To resubmit a batch, navigate to Payments > Payment Method Updater, select the batch and click Re-submit batch.

Retrieve batches

If you have to manually retrieve a batch, navigate to Payments > Payment Method Updater, select the batch and click Retrieve results. Note that if Zuora does not get a response from the gateway within 7 days, the submitted batch will be expired.

Retrieve batch

Troubleshoot Checkout Account Updater

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