Welcome to Zuora Product Documentation

Explore our rich library of product information

Field descriptions for PMU Configuration page

This document provides detailed field descriptions for configuring the CyberSource Account Updater in Zuora, including setup instructions for merchant IDs, shared secret keys, and transaction security keys.

Field NameField Description
Basic Information

Active: Select this checkbox to activate your CyberSource Account Updater in Zuora. Make sure the payment method updater profile you want to use is marked as Default on the Setup Payment Method Updater page.

Name: A name for your CyberSource Account Updater. Choose any name you'd like.

Updater ServicesSelect 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.
Merchant IDThis 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. The user name must be the same as the merchant ID. This information is provided by CyberSource.

According to the CyberSource documentation, to download programmable reports, the Business Center user name must be granted a user role with required permissions. If you have any questions about the user roles, please contact CyberSource.

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 IdThis 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, follow the instructions in CyberSource developer document.

CyberSource Transaction Security Key Password

The password set by yourself during the generation of the Transaction Security Key to secure the P12 key.

You can create this password in your CyberSource account by navigating to Key Management > Generate Key > Simple Order API, and then clicking Generate > Download. In the popup dialog, specify a password.

Note down your password and enter it in this CyberSource Transaction Security Key Password field in Zuora.

If this password is not provided, Zuora will use your CyberSource Merchant ID and Transaction Security Key to process transactions.

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.
Rules

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.

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 CyberSource.

  • The default payment gateway of the customer account is set to CyberSource (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 CyberSource.

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.

Download Public KeyClick Download and follow the instructions in Create PGP Security Keys and Link CyberSource and Zuora Accounts.