home

Zuora Payments

Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies
Zuora BillingZuora PaymentsZuora PlatformZuora CPQZephrZuora RevenueAccounts ReceivableRelease NotesBasicsEntitlementsSupport and policies

Welcome to Zuora Product Documentation

Explore our rich library of product information

Show Contents

thumbnailZuora Payments

Overview of EBANX payment gateway integration

Set up and configure an Ebanx payment gateway instance

Before you set up and configure an Ebanx payment gateway instance on your tenant, enable the Ebanx payment gateway integration for your tenant. See Enable payment gateway integrations for your tenant for instructions.

Set up and configure an Ebanx 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.

Complete the following steps to set up and configure an Ebanx payment gateway instance:

  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 Ebanx from the Gateway Type drop-down list.
  4. In the New Gateway page, specify values for the configuration 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.

  5. Under Basic Information, enter the following details:
    1. In the Name field, enter a name for the gateway instance.
    2. Enable the Use Gateway test Environment checkbox to use the payment gateway's test service URL when setting up the payment gateway integration.
  6. Under Credentials, enter the following details:
    1. In the Integration Key field, enter the Integration key that can be found in the EBANX dashboard.
    2. In the Public Integration Key field, enter the public integration key that can be found in the EBANX dashboard.
  7. Under Rules, enter or select the following details:
    1. Cards Accepted: Select the cards you want to accept. Make sure your gateway's merchant account is also configured to support the same cards you have configured in Zuora. If you submit a transaction for a card type that is not enabled in your merchant account, it will result in an error stating the CardType is not supported or that you are not signed up for that tender type.
    2. Default Authorization Amount: Specify the minimum default amount used to process a payment. The recommended default value is 0. You can specify 0 amount or an amount greater than 0.5 for all the supported currencies.
    3. 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.
    4. 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.
    5. Merchant Country: The country where payments will be made through this payment gateway.
    6. Auto-capture IP Address: If this field is selected, Zuora will automatically send the IP address to the gateway for fraud check.
    7. Processing Type: Select either of the following options to support cross-border or local payment processing. This field will be included in the requests for payment method, payment, and refund processing, and will be sent to the gateway.

      • CROSS-BORDER (default)

      • LOCAL

  8. Under Additional Metadata, define customized metadata for gateway requests.

    You can define your customized metadata in the Additional Metadata section for the following objects when you configure an EBANX payment gateway instance in Zuora. Your self-defined metadata will be added to the metadata tag in the request body and passed to the gateway. You can use the customized metadata for further analysis, reporting, or building custom rules to enhance your fraud protection.

    1. For the Payment object, customized metadata is supported for these transaction types: Credit Card, CC Reference Transaction, Bank Transfer, ACH, Apple Pay, and Google Pay.
    2. For the Payment Method object, customized metadata is supported for the validation operation with these transaction types: Credit Card, CC Reference Transaction, Apple Pay, and Google Pay.
    3. Customized metadata is also supported for the following transaction types when authorizing funds through the Create authorization API operation: Credit Card and Google Pay.
    4. To add a customized field, click Add New Metadata in the Additional Metadata section.
    5. In the Metadata Key field, enter a unique metadata field name. Use only alphanumeric characters and underscores, and define a maximum of 20 metadata fields.
    6. Select a field from the list to specify the metadata value.
  9. Click Save Gateway Information.

Last updated: October 28, 2025