Skip to main content

Set up and configure a Merchant e-Solutions gateway instance


Set up and configure a Merchant e-Solutions gateway instance

Set up and configure a Merchant e-Solutions instance by using the information in this article, including configuration procedure, descriptions of the configuration fields, and reference for testing the payment gateway.


Enable the Merchant e-Solutions payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.


Enable the Merchant e-Solutions gateway integration for your tenant by contacting Zuora Global Support.


Perform the following steps to set up and configure a Merchant e-Solutions gateway instance in Zuora:

  1. Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway
  2. On the Configure Gateway Instance tab, select Merchant eSolutions from the Gateway Type drop-down list.
  3. Click Create Gateway.
  4. On the gateway settings page, specify values for the configuration fields. See below for more information on the fields.
  5. Click Save Gateway Information.

Configuration fields

Common configuration fields

There are some common fields you must complete for every gateway configuration. We recommend reviewing our Setup Payment Gateway documentation for information on these common fields:

  • Name
  • Use Gateway Test Environment
  • Credit Cards Accepted
  • Default Authorization Amount
  • Verify new payment method (optional)
  • Verify updated payment method (optional)


In addition to the common fields, every gateway has unique requirements and information (such as credentials and certain rules) that you must provide to configure the gateway in Zuora. 

Profile ID

A 20 digit number that identifies the source of the transaction requests. This is similar to a merchant ID in that it identifies which merchant account payment transactions are coming from.

Profile Key 

A 32 character, alphanumeric password for the Profile ID.

SEC Code 

This is the Security Entry Class (SEC) code used to identify the authorization type for an ACH transaction. You can select the SEC code you want to use for the non-referenced refund transactions in this field. Zuora advises you to reach out to your Cielo (Merchant e-Solutions) account representative when selecting the code because each type has unique characteristics and requirements, and different funding timetables.

  • Prearranged Payment and Deposit Entry (PPD): Used to credit or debit a consumer account.
  • Corporate Cash Disbursement (CCD): Primarily used for business-to-business transactions.

IP Address 

This is the IP address from which the payment transaction is sent to Merchant e-Solutions.

Use the Zuora IP address that corresponds to the Zuora environment (Production or API Sandbox) that you are using. If you are accessing your tenant using (Production), use the IP address: If you are accessing your tenant using (API Sandbox) then use the IP address: 

Moto eCommerce Indicator 

Moto stands for non-card-present Mail/Telephone Order. From the pick list, select the method of acceptance for which your payment transactions are originating. This is a requirement from credit card networks as different methods of acceptance may result in higher or lower transaction fees. For example, card present transactions (where the magnetic stripe on a card is read by a card reader) may have lower transaction fees than a card not present (telephone, online) transaction since the former has a lower fraud risk. The default to use is "eCommerce Transaction" however, when in doubt, check with your Merchant e-Solutions account manager or support team:

  • Not a Mail/Telephone Order Transaction
  • One Time Mail/Telephone Order Transaction
  • Installment Payment of a Mail/Telephone Order Transaction
  • Secure Electronic Commerce Transaction: A sale conducted through the internet using secure socket layers (SSL) with encryption strength of at least 128-bit.
  • Non-Authenticated Security Transaction at a 3-D secure-capable merchant
  • e-Commerce Transaction (Default): A sale conducted through the internet
  • Non-secure e-Commerce transaction: A sale conducted through the internet that is not secure. MeS documentation states that all e-Commerce transactions should be processed securely. 

Enable Level 2 Card Data 

This setting determines whether to send the following additional fields to the gateway for a lowered interchange rate if you have set up an account on the Merchant e-Solutions side:

  • Tax Amount
  • Invoice Number 

For more information about Zuora's support for Level 2 data, see Level 2 and Level 3 Card Data.

Test the configuration 

We recommend testing your selected payment gateway using both your payment gateway's test and production (live) environments.  Once you have completed testing in the gateway's test environment, it is recommended that you perform a test in your live production environment with a real credit card. If there are any differences in the configuration of your testing and production accounts, testing in production ensures your production merchant account is set up properly and can successfully connect to the production environment.

Accessing Your Gateway's Test Environment

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. 

To access the Merchant e-Solutions test environment, request access to a Merchant e-Solutions test environment that is shared with other Merchant e-Solutions merchants. To make this request, complete the certification request form online and Merchant e-Solutions will process the request and provide you with a test ID.

Accessing Test or Production (Live) Mode from Zuora

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

If Use Gateway Test Environment is selected, Zuora will direct payment transactions to the Merchant e-Solutions test environment.

The credentials used for this test environment are unique and different from the credentials used to access your Merchant e-Solutions production environment. If you are configuring the test account in API Sandbox, please use the Zuora API Sandbox IP address ( in your configuration.

If Use Gateway Test Environment is not selected (disabled), Zuora will direct payment transactions to the Merchant e-Solutions production (live) environment. 

Test Credit Cards and Testing Scenarios

Test credit cards and test scenarios are available here.

For additional guidance on testing, feel free to contact your Merchant e-Solutions Support team for assistance. 

General Testing Information

Integration Testing

Zuora has been certified with Merchant e-Solutions as an integration partner and maintains the integration on an ongoing basis, thoroughly testing the integration with every new release. The Merchant e-Solutions integration documentation is helpful if you are integrating the gateway directly with your website, however, you do not need to perform any integration or certification testing to submit transactions to the Merchant e-Solutions gateway via the Zuora application. The intended audience for the integration guides are technical integrators, however, these documents can be helpful to non-technical integrators who can refer to it for information on testing and troubleshooting gateway errors (as described below).

Performance and Volume Testing

In general, gateway testing environments are intended to give merchants the opportunity to test their gateway and integrations to their gateway, in order to work out any bugs before going to the production environment. Some gateway test environments are shared amongst multiple merchants, and other gateways provide unique testing environments for each merchant. Additionally, gateway test environments (also referred to as certification or sandbox environments) do not have the same high availability or performance capability as production environments. As such, they are not intended for load testing. Merchants performing high volumes of load testing that puts a stress on a shared test environment may receive a warning from the gateway or have their access to the testing environment suspended.

Troubleshooting gateway errors

There are several ways to obtain information on gateway errors:

  1. See Merchant e-Solutions Payment Gateway Testing for information on the payment gateway error codes. 
  2. Look up the transaction by the transaction ID number (in the Zuora payment detail page, this is the Reference ID and Secondary Reference ID numbers) in virtual terminal to see if more information is provided; often you will see more than just the response (reasons) code and response message in Zuora.
  3. For further assistance with gateway errors, you can contact the Merchant e-Solutions Support team for assistance. 

Make Sure You Are Not Re-Trying an Invalid Card Too Many Times

Zuora recommends that you check the payment in Zuora to see how many times the same payment method has been retried for payment and failed. If there have been several retries, check the error messages from the beginning with the first failure and the more recent failures to determine if the error message is the same. If a merchant tries to process a payment against the same credit card too many times despite receiving errors, this could trigger warnings to the card-issuing bank. The card-issuing bank may place an alert on the account and not allow any further transactions from the merchant using that payment method. When a merchant has been flagged, the error received on the payment may be not state the reason why, instead it might be a generic error decline error. In this case, the merchant (Zuora customer) should work with Merchant e-Solutions to see if they can identify the problem with the payment method. If the processor does not know, then the merchant and/or the card holder can try calling their card-issuing bank to look into the issue.