Set up and configure a Moneris payment gateway instance
Set up and configure a Moneris payment gateway instance by using the information in this article, including the configuration procedure, descriptions of the configuration fields, and reference for testing the payment gateway.
Prerequisites
Enable the Moneris payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.
Procedure
Complete the following steps to set up and configure a Moneris payment gateway instance:
- Click your username in the upper right and navigate to Settings > Payments > Setup Payment Gateway.
- On the Configure Gateway Instance tab, select Moneris from the Gateway Type drop-down list.
- Click Create Gateway.
- On the gateway settings page, specify values for the configuration fields. See the following “Configuration fields” section for more information on the fields.
- Click Save Gateway Information.
Configuration fields
Basic Information
- Name: Specify a name for the gateway instance.
- Use Gateway Test Environment: If you want to use the Moneris gateway test environment, select this checkbox.
For more information about fields in the Basic Information section, see Common fields.
Credentials
- Store ID: The Store ID provided by Moneris when you sign up for a Moneris account.
- API Token: This API token is available in your Moneris account > Admin > Store settings. Copy the API token from Moneris to this Zuora gateway configuration field.
- Enable Custom Store ID and API Token: If you select this field, Zuora will use a Moneris Store ID and an API Token in the following Store Id Custom Field and API Token Custom Field fields.
- Store Id Custom Field: Before populating this field, create a custom field on the Zuora Account object for saving a store_id. When this setting is populated, the custom field value from the Zuora account will be used for all Moneris API requests, instead of the regular Store ID gateway setting.
- API Token Custom Field: Before populating this field, create a custom field on the Zuora Account object for saving an AES256 encrypted api_token. When this setting is populated, the custom field value from the Zuora account will be decrypted by Zuora and used for all Moneris API requests, instead of the regular API Token gateway setting.
- Secret Key for API Token Custom Field: Enter the secret key that Zuora should use to decrypt your encrypted api_token value(s) from the preceding custom field on the Zuora Account.
- eFraud: Moneris supports eFraud tools that include AVS (address verification services), CVV (card verification value) code checking, as well as the Verified by Visa and MasterCard SecureCode services. If you have the eFraud feature enabled in your Moneris merchant account, select this eFraud field as well in Zuora.
- Crypt: Select the crypt type that is most applicable for your payment transactions. If you are not sure which option to select, work with your Moneris support team to confirm the most appropriate option for your merchant account.
Rules
- Default Authorization Amount: Specify the minimum default amount used to process a payment. The default value of this field is 1. For more information, see Common fields.
- Verify new payment method: If you want the payment methods to be verified when creating them, select this checkbox. By default, this checkbox is selected. For more information, see Common fields.
- Verify updated payment method: If you want the payment methods to be verified when updating them, select this checkbox. By default, this checkbox is selected. For more information, see Common fields.
- Soft Descriptor: Enter the text you want to display on the bill for your end-customer to better recognize the charge. This field is mapped to the
dynamic_descriptor
field in Moneris. - Enable Variable Amount Indicator: To process variable-amount recurring transactions for MasterCard payments, this setting must be selected. Zuora will populate
V
in thepayment_indicator
field and pass it to the gateway on payments where the card network is MasterCard. Otherwise, the standard recurring payment indicatorR
will be populated and sent to the gateway.
Test the configuration
We recommend that you test your 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.
You can use the test card information and testing scenarios provided by the gateway vendor to test your integration. See Moneris Merchant Resource Center for details.