Skip to main content

Set up and configure a Helix payment gateway instance

Zuora

Set up and configure a Helix payment gateway instance

  1. Last updated
  2. Save as PDF

Set up and configure a Helix payment gateway instance by using the information in this article, including prerequisites, configuration procedure, descriptions of the configuration fields, and references for testing the payment gateway.

Prerequisites

Before you set up and configure a Helix payment gateway instance on your tenant, complete the following tasks:

  1. Enable the Helix payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.
  2. Complete the following steps to generate the Java keystore for the Helix payment gateway integration. The keystore will be required when configuring a Helix payment gateway instance in Zuora.
    1. Create a folder and put the following files in this folder. The following files can be obtained from J.P. Morgan during onboarding of the Merchant Payments API project.
      • CAT_X509.cer
      • privateKey.key
    2. Open your terminal and navigate to the folder that you created in step a.
    3. Run the following openssl command to generate the PKCS12 keystore file with .p12 as the extension: 
      openssl pkcs12 -export -out zuora-helix-keystore.p12 -inkey privateKey.key -in CAT_X509.cer -name zuora-helix -passout pass:zV0RaxLieh@2v34#

      Replace the following parts in the command according to your needs:

      • zuora-helix-keystore.p12: Replace it with a name for the keystore file that will be generated in the folder. The extension of the keystore file will be .p12.
      • Zuora-helix: Replace it with an alias of the keystore.
      • zV0RaxLieh@2v34#: Replace it with your keystore password.

Procedure

Complete the following steps to set up and configure a Helix payment gateway instance:

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

Configuration fields

Basic Information

  • Name: Specify a name for the gateway instance.
  • Use Gateway Test Environment: If you want the transactions to be processed by using the Helix test service endpoint, select this checkbox.

For more information about fields in the Basic Information section, see Common fields.

Credentials

  • Merchant Id: Enter the Merchant Id obtained from the J.P. Morgan Merchant_Payments API project.
  • Client Id: Enter the Client Id provided by J.P. Morgan during onboarding.
  • Resource Id: Enter the Resource Id provided by J.P. Morgan during onboarding.
  • Key Store: Upload the keystore file with .p12 as the extension. For how to generate the keystore file, see Prerequisites.
  • Key Store Password: Enter the Key Store password.

Rules

  • Cards Accepted: Select the credit cards that you accept.
  • Default Authorization Amount: Specify the minimum default amount used to process a payment. The default value of this field is 1.
  • 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.
  • 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 about fields in the Rules section, see Common fields.

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 J.P. Morgan’s documentation for details.