Skip to main content

Obtain the Public Key for Payment Pages 2.0

Zuora

Obtain the Public Key for Payment Pages 2.0

The public key is used to encrypt sensitive information in Payment Pages 2.0. You can generate the public key in Zuora UI or through the POST rsa-signatures REST request. 

Get the Public Key for Payment Pages

If you are in the Multi-entity environment, the public key is shared among all the entities in your organization. And the option to retrieve the public key in Zuora UI is only available in your root entity. If you do not have access to the root entity, contact the Zuora root entity admin to generate and share the public key.

To retrieve the public key in the Administration Settings:

In Zuora application, click your username at the top right.

  • Navigate to Settings > Administration.
  • Click Security Policies.
  • In the Security Keys section, click Get key next to the Public Key to retrieve your public key.
  • A text file containing your public key will be downloaded.

To retrieve the public key in the Hosted Pages list:

This option to retrieve the public key on the Hosted Pages list page is not available in the Multi-entity environments.

  1. In Zuora application, click your username at the top right.
  2. Navigate to Settings > Payments > Setup Payment Page and Payment Link.
  3. On the Payment Pages tab page, click Get HPM 2.0 Key in the Security Keys section.
  4. A text file containing your public key will be downloaded.

Regenerate the Public Key for Payment Pages

When your public key needs to be reset for security reasons, you can regenerate the public key as described in this section.

To regenerate your public key:

If you are in the Multi-entity environment, the option to regenerate the public key in Zuora UI is only available in your root entity. If you do not have access to the root entity, contact the Zuora root entity admin to regenerate and share the public key.

  1. In Zuora application, click your username at the top right.
  2. Browse to Settings > Administration.
  3. Click Security Policies.
  4. In the Security Keys section, click Regenerate key next to the Public Key to regenerate your public key.
  5. Click Yes to confirm.
  6. A text file containing the newly generated public key will be downloaded.

After you regenerate the public key, you must update the key client parameter in your Payment Pages 2.0 client code.