Skip to main content

Set up and configure an Nuvei Payment Gateway instance

Zuora

Set up and configure an Nuvei Payment Gateway instance

  1. Last updated
  2. Save as PDF
Describes how to create and configure an Nuvei Payment Gateway instance in Zuora.

Prerequisites  Edit section

Enable the Nuvei payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.

Procedure   Edit section

Perform the following steps to set up and configure an Nuvei gateway instance in Zuora tenant:

  1. Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway. 
  2. On the Payment Gateways page, click the Configure Gateway Instance tab and scroll to the bottom. 
  3. On the Configure Gateway Instance tab, select the payment gateway from the Gateway Type drop-down.
  4. From the Gateway Type list, select Nuvei and click Create Gateway.
  5. Click Create Gateway.
  6. In the New Gateway page, specify values for the configuration fields. See below for more information on the fields. Note that not all the configuration fields support the vertical line character "|". For password fields, if your gateway assigns a password containing this character, Zuora will display a validation error. To resolve this issue, contact your gateway provider to request a new password without the unsupported character. See the Configuration fields section for more details on field descriptions. 
  7. Click Save Gateway Information.

Configuration fields  Edit section

There are some common fields you must complete for every gateway configuration. Zuora recommends reviewing Setting Up Payment Gateways for information on these fields: 

Basic Information  Edit section

  • Name: The name of this payment gateway in Zuora.
  • Use Gateway Test Environment: Determines whether transactions are sent to the test environment or live environment of the Nuvei payment gateway.

Credentials  Edit section

  • Merchant Secret Key
  • Merchant ID
  • Merchant Site ID

Rules  Edit section

  • Default Authorization Amount: The amount to use when performing an authorization when creating or updating a card.
  • Verify new payment method: Required for CC Reference Transaction payment type. Verifies if the Token exists in the Nuvie payment gateway database and verifies that it has a registered card, or generates a new Token with a registered card.
  • Verify updated payment method: Triggers a credit card authorization when updating an existing card.

Test the configuration   Edit section

For basic guidance on how to test payment gateway integrations within a sandbox environment, see Test payment gateway integration.

Accessing Your gateway's Test Environment  Edit section

Some payment gateways provide separate credentials for merchants to access their testing environment, some gateways use the same credentials for testing as for the production (live) environment but direct test transactions to a different URL, and other gateways do a little of both. Moneris eSelectPLUS customers utilize a shared testing environment. 

Accessing Test or Production (Live) Mode from Zuora  Edit section

When configuring the Nuvei payment gateway in Zuora, you can indicate whether you would like to use the Nuvei test environment or the Nuvei production environment. 

  • If Use Gateway Test Environment is selected, Zuora will direct payment transactions to the Nuvei test environment.
  • If Use Gateway Test Environment is not selected (disabled), Zuora will direct payment transactions to the Nuvei production (live) environment. 

When using the Nuvei testing environment, you will need to use the testing credentials provided in the Nuvei documentation (see section below on Test Credit Cards and Testing Scenarios). Zuora ensures your payment transactions are routed to the right environment based on whether the Use Gateway Test Environment is selected.