Skip to main content

Configure CyberSource Payment Method Updater


Configure CyberSource Payment Method Updater

This article explains how to configure CyberSource Account Updater with the Zuora Payment Method Updater. 

Configuration Summary

The customer must implement procedures to manage what happens when a payment method becomes inactive (for example, if a credit card is canceled).

The following diagram shows the process to configure the Zuora PMU with CyberSource Account Updater. 

CyberSource Setup.png


Submit a request at Zuora Global Support to enable this feature or service.

Enroll in the CyberSource Account Updater program. If you are not yet enrolled, contact your account representative at CyberSource to enroll and specify if you would like to enroll using Visa and Mastercard. If you do not have a CyberSource merchant account yet, create a CyberSource test account. Contact the CyberSource sales representative for more information.

Once you satisfy the preceding prerequisites, do the following in Zuora (each step is described in this article):

  1. Contact Zuora Global Support to enable the CyberSource Payment Method Updater for your Zuora tenant.
  2. Create the Java keystore and keystore passphrase.
  3. Acquire CyberSource account information and enter the credentials into the Zuora PMU configuration page.
  4. Create a security key to link CyberSource Account Updater and Zuora PMU accounts.

See the CyberSource Account Updater User Guide as you follow these procedures. 

If you have more than one tenant, you must have a separate merchant ID for each tenant to update payment methods using the CyberSource PMU.

Create the Java Keystore and Keystore Passphrase

Use the following steps to create the CyberSource Java Keystore.

As the instructions provided by CyberSource are difficult to follow, we created an internal tool to generate the Java Keystore automatically. To create the Java Keystore:

  1. Make note of your CyberSource Merchant ID.
  2. Contact Zuora Global Support to create the CyberSource Java Keystore for you.
  3. Take the Java Keystore file and Keystore passphrase and continue to Step 2.

Enter CyberSource Credentials on the Zuora PMU Configuration Page

Navigate to Settings > Payments > Setup Payment Method Updater. On the Setup Payment Method Updater page, select CyberSource as the Updater Type and click the add payment method updater button. If you have already configured a payment method updater profile, make sure to set the one you want to use as the Default.

CyberSource PMU

Once the Add Payment Method Updater page is displayed, you can fill in the necessary information for your account updater profile. The image below shows an example of the information required. An example form filled out is displayed below.

Merchant ID and Business Center User Name must be the same as the Merchant ID used for your CyberSource payment gateway. This information is provided by CyberSource.

 CyberSource PMU configuration page.png

Field Descriptions

The following information discusses all the form fields from the image above.

Field Name Field Description
Basic Information  
Active Check this box to activate your CyberSource Account Updater in Zuora. Remember, from Step 1, you have to make sure the payment method updater profile you want to use is marked as the Default.
Updater Services Select the updater service(s) that you want to use: Visa Account Updater, Mastercard Automatic Billing Updater, or both. You must first be enrolled in the service(s) you want to use through the CyberSource Account Updater program.
Name A name for your CyberSource Account Updater. Choose any name you'd like.
Merchant ID This is a unique ID that identifies the merchant in the CyberSource System. It is the same ID that you use to log into the the CyberSource Business Center and must be the same as the Merchant ID used for your CyberSource payment gateway. This information is provided by CyberSource.
Billing Aggregator Sub  Merchant ID (Optional) Enter this information if it is provided by CyberSource. 
Business Center User Name

This is the user name for your CyberSource Business Center and is required so that you can download the CyberSource Account Updater files from within Zuora. The user name must be the same as the merchant ID. This information is provided by CyberSource.

Zuora recommends that you set the Business Center user name with the Report Download user role that enables you to download programmable reports. The password for downloading reports never expires. The Report Download role is not authorized to access the Business Center. Therefore, if you only have one user account, you should not convert your current account into this role. At least one Administrator account is required for ongoing maintenance.

To set a user account with the Report Download role in the CyberSource Business Center:

  1. Navigate to Account Management > User Administration.
  2. Click the user name in the table to enter the User Update page.
  3. Select Report Download from the User Role drop-down list.
  4. Click Update to save the change.
Business Center Password

This is the password that corresponds to the Business Center user name that you specified.

If you enter the wrong password three consecutive times in your console, CyberSource locks your account. Because CyberSource links the Merchant ID and Business Center User Name, the result is a halt of PMU functionality. Cybersource provides no auto password reset. You must call CyberSource to reset the password.

Shared Secret Key Id This is the Key Id for the shared secret key in CyberSource Business Center. For example, 6b432ff8-f1ed-7891-8629-ebc84w33cb16d.
Shared Secret Key

This is the shared secret key for your CyberSource merchant account in the Business Center. Follow the instructions in Creating a Shared Secret Key for HTTP Signature to generate a shared secret key. 

CyberSource Transaction Security Key

You need both a CyberSource Merchant ID and a Transaction Security Key to process transactions with Zuora. This is the same Transaction Security Key (also called Private Key) used to configure the CyberSource gateway. The Transaction Security Key validates that all transactions originate from your website and ensures that no one, not even CyberSource, can run transactions on your behalf by using your private key.

To create a Transaction Security Key:

  1. Log into your CyberSource Business Center account:
  2. Navigate to Payment Configuration > Key Management.
  3. Click + ADD > Generate Key > Simple Order Key
  4. Select the Simple Order Key Type and click Download in the Generate Key window. The downloaded JNLP File requires the Java Running Environment (JRE) from Oracle.
  5. After the JRE is installed on your computer, open the downloaded file. A dialog that prompts you to confirm running will be displayed.
  6. Click Run in the dialog to confirm running.
  7. Click Generate Certificate Request in the CyberSourceKeyGeneration dialog and save the key to your file system.
CyberSource Java Keystore See Step 1 for instructions for creating the Java Keystore. 
CyberSource Keystore Passphrase The password used during the creation of the Java Keystore.
Status Email

Once Zuora has successfully submitted the request file to CyberSource, CyberSource will keep the merchant updated of the file's status via one or more emails sent to the email address stored on the payment gateway updater (under Credentials > Status Email).

CyberSource will send emails regarding the status of the submitted request file. The email subject lines may have one of the following statuses:

  • Received: The request file was received successfully by CyberSource and CyberSource will proceed with validating the payment methods in the file before passing it on to the Visa and/or MasterCard networks to request updates. No action is required by the user at this time.
  • Validated: After CyberSource receives the request file, CyberSource will validate the syntax of the file and also check to ensure there are valid payment methods before submitting the payment methods over to the Visa and/or MasterCard networks.
  • Processing: This status means the request file is being processed by CyberSource.
  • Completed:This status means CyberSource has received a response back from Visa and/or MasterCard networks, and the response file is available for download by Zuora. 

Specify a value for the Payment Method Updater service to start several days prior to the Bill Cycle Day. 

Zuora recommends using a value of 5 to 7 days prior to the Bill Cycle Day, because the CyberSource Account Updater service will take approximately 5 days to process the credit card account information for updates.

Check Only update payment methods for customer accounts associated to this gateway/processor to include only the credit cards for customer accounts with CyberSource set as the payment gateway (under Billing and Payment Term). Disable this field to send all credit card information to CyberSource (the default value).

Download Public Key Click download and see step 3 below.

Create PGP Security Keys and Link CyberSource and Zuora Accounts

Click the Download link to download the PGP Public Key. You must copy the public key to the CyberSource Business Center into your CyberSource merchant account. This allows the Zuora payment method updater integration to decrypt the response files from CyberSource.

To upload the PGP Key to your CyberSource merchant account:

  1. Log into your CyberSource Business Center account:
  2. Navigate to Payment Management > PGP Security Settings.
  3. Paste the PGP Security key in the PGP Key Value text area.
  4. Click Add

Test the Updater

The following limitations apply when testing the Cybersource Account Updater in the Zuora sandbox environment:

  • The merchant can only verify the setting and connectivity to Cybersource.

  • The merchant can only test the process of submitting batches to CyberSource. 

The sandbox environment only supports testing the process of submitting batches. The process of retrieving the submitted batches is NOT supported at this time. 

If a CyberSource merchant account has been used in multiple tenants, you will get the Duplicate Batch ID error in the latter tenant(s). In order to avoid this error, test with different merchant accounts for different Zuora tenants, or contact Zuora Global Support to temporarily enable your sandbox environment to be connected to the CyberSource test environment.

Full Cybersource Account Updater functionality is supported in the Zuora Production environment. Although Zuora has tested the integration, it is recommended that you select a few actual payment methods and submit them to CyberSource to ensure that the Zuora PMU is working properly. For example, you can change the billing cycle days on the selected billing accounts and verify that the updater is working. 


The size limit for CyberSource PMU is 8000, which means up to 8000 records can be included in a single batch. It is a fixed number and cannot be configured. When the record number exceeds 8000, multiple batches will be automatically created.