Skip to main content

Set up and configure a Worldline Global Collect gateway instance

Zuora

Set up and configure a Worldline Global Collect gateway instance

Set up and configure a Worldline Global Collect gateway instance by using the information in this article, including prerequisites, configuration procedure, and references for testing the payment gateway.

Prerequisites 

If you are interested in using the Worldline Global Collect functionality, you must go through a series of procedures to ensure that the feature can be used. 

  • You must obtain the following information from the configuration center of your Worldline Global Collect merchant account.
    • Merchant ID: This is needed to configure gateway instances. If you use the custom merchant ID hierarchy option, you must set up a valid merchant ID custom field on the Payment or Account object, or use the merchantId gateway option field in API requests.
    • API Key ID: A unique identifier used to determine API access permission for the Worldline Global Collect merchant account.
    • Secret API Key: An encryption and decryption key unique to the merchant account and is used to receive or retrieve data.
  • You must work with the Worldline Global Collect merchant account manager or merchant support to turn on the Delayed Capture setting for your Worldline Global Collect merchant account. 

  • You must work with the Worldline Global Collect merchant account manager or merchant support to turn on the autonomous decline setting for payments challenged by fraud tools.

  • Enable the Worldline Global Collect payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.

Procedure

Take the following steps to set up and configure a Worldline Global Collect gateway instance:

  1. Click your username at the top right and navigate to Settings > Payments > Setup Payment Gateway
  2. On the Configure Gateway Instance tab, select Ingenico ePayments from the Gateway Type drop-down list.
  3. Click Create Gateway.
  4. Complete the information for the gateway instance. See below for more information on the fields.
  5. Click save gateway information after entering the necessary information.

Configuration fields

Basic Information

  • In the Name field, specify a name for the gateway instance.
  • If you want to use the Worldline Global Collect test environment, select the Use Gateway Test Environment check box.

Credentials

The multiple Merchant IDs feature is an Early Adopter feature. We are actively soliciting feedback from a small set of early adopters before releasing it as generally available.

  • Merchant ID: You can obtain the merchant ID by logging into the Worldline Global Collect configuration center. If you use the custom merchant ID hierarchy option, you can enter either a real Merchant ID or a dummy value. Zuora will default to the value configured in this field if the merchantId gateway option field is not specified and the Merchant ID custom fields on the Payment and Account objects are blank.
  • (Optional) Enable Custom Merchant ID Hierarchy: Select this check box if you want to use a hierarchy for the Merchant ID. With the custom Merchant ID hierarchy enabled, Zuora will look for and use the merchant ID in the following order:
    1. The merchantId gateway option field in API requests.
    2. The Merchant ID custom field on the Payment object.
    3. The Merchant ID custom field on the Account object.
    4. The value specified in the Merchant ID gateway setting.
  • (Optional) Payment Custom Field - Merchant ID: Enter the API name (without __c) of the Merchant ID custom field configured on the Payment object.
  • (Optional) Account Custom Field - Merchant ID: Enter the API name (without __c) of the Merchant ID custom field configured on the Account object.
  • In the API Key ID field, enter the unique API Key ID obtained from the Worldline Global Collect gateway.
  • In the Secret API Key field, enter the secret API key obtained from the Worldline Global Collect gateway.
  • (Optional) In the MFTP Username field, enter the username of the MFTP server used for reconciliation. This field is required if you want to enable Gateway Reconciliation. For more information about prerequisite for enabling Gateway Reconciliation, see Overview of Worldline Global Collect gateway integration.
  • (Optional) In the MFTP Password field, enter the password of the MFTP server used for reconciliation. This field is required if you want to enable Gateway Reconciliation.

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. For American Express payments, a minimum of $1.00 is required. 
  • Verify new payment method: If you want to verify new payment methods, select this check box.
    By default, this check box is selected.
  • Verify updated payment method: If you want to verify updated payment methods, select this check box.
    By default, this check box is selected.
  • Ingenico Platform: Select GlobalCollect.
  • (Optional) Complete the Level 2 and Level 3 card fields. See Level 2 and Level 3 card data for more information. The first 17 characters of the Account Number is mapped to the customerReference field on the gateway side for Level 2 and Level 3 data processing.
    • Enable Level 2 Processing
    • Enable Level 3 Processing
    • ProductCode Custom Field API Name 
  • (Optional) Enable AVS Filtering: If selected, Zuora will decline Credit Card transactions for certain AVS response codes returned by the gateway even though the gateway has approved the transaction.
  • (Optional) Enable CVV Filtering: If selected, Zuora will decline Credit Card transactions for certain CVV response codes returned by the gateway even though the gateway has approved the transaction.
  • (Optional) Enable Gateway Reconciliation: Select this checkbox if you want to enable the Gateway Reconciliation feature.
  • Specify the 3DS2 order amount by using either of the following fields:

    If you do not use either of these fields to specify the 3DS2 order amount, the default value, 100 for American Express credit cards and 0 for the other card brands, will be applied and sent to the gateway.

    If both of these 2 fields are used, the value in the 3DS2 Order Amount field will not be applied.

    • Use Authorization Amount as 3DS2 Order Amount: By selecting this checkbox, the 3DS2 order amount is 100 times that of the authorization amount. For example, if the authorization amount is 30, the 3DS2 order amount sent to the gateway is 3000.
    • 3DS2 Order Amount: Enter the order amount for 3D Secure 2.0 authorization. The value must be an integer less than or equal to 100 times that of Default Authorization Amount. For example, if Default Authorization Amount is 3, the value of 3DS2 Order Amount must be less than or equal to 300.

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 real information. 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 testing payment methods provided by Worldline Global Collect to test your integration. See Worldline Global Collect Documentation for details.