Skip to main content

Overview of Ebanx payment gateway integration

Zuora

Overview of Ebanx payment gateway integration

Zuora integrates with the EBANX payment services to provide a gateway integration called Ebanx for processing Credit Card and PIX transactions.

Supported features

The following table provides a quick reference for the supported features. For details about each feature, see the later sections in this article.

Supported payment methods Credit Card/Gift Card/Prepaid Card, PIX
Supported payment operations
  • Validate (both zero and non-zero amounts)
  • Payment
  • Payment cancel
  • Referenced refund

The supported payment operations vary by payment method. See Supported payment methods and operations for details.

Support 3D Secure 2.0 Yes for Credit Card
Support Delayed Capture Yes for Credit Card
Support Level 2 and Level 3 card data No
Support stored credential transactions Yes for Credit Card
Support Gateway Options fields No
Gateway provider’s API version 1.0.0
Gatetway provider’s production endpoint used for Zuora gateway integration service

https://api.ebanxpay.com

Support Gateway Reconciliation No
Support Real-Time Reconciliation No
Support Payment Method Updater No
Support inquiry calls for retrying a transaction request automatically Yes. See Electronic payment processing for details.

Supported payment methods and operations

The Ebanx payment gateway integration supports the following payment methods and operations:

Country Payment Method Payment Operation
Brazil Credit Card, including the following card brands:
  • Visa
  • Mastercard
  • American Express
  • Diners Club
  • Payment method validation
  • Payment
  • Payment cancel
  • Referenced refund
PIX
  • Payment
  • Referenced refund
Mexico Credit Card, including the following card brands:
  • Visa
  • Mastercard
  • American Express
  • Payment method validation
  • Payment
  • Payment cancel
  • Referenced refund
  • Argentina
  • Chile
  • Colombia
  • Peru
  • Uruguay
Credit Card, including the following card brands:
  • Visa
  • Mastercard
  • American Express
  • Diners Club
  • Costa Rica
  • Dominican Republic
  • El Salvador
  • Guatemala
  • Nigeria
  • Panama
  • Paraguay
  • South Africa
Credit Card, including the following card brands:
  • Visa
  • Mastercard

For more information about setting up payment methods in Zuora, see Define and set up payment methods.

For more information about the supported currencies, see Supported Currencies by Gateway.

For more information about each supported payment method, see the following sections.

Credit Card

Credit Card payment methods on the Ebanx integration can be created through any of the following methods:

  • Zuora UI
  • Hosted Payment Pages
  • REST APIs for creating payment methods

For credit card transactions, the validation and authorization amount can be 0 or a non-zero value, depending on the supported currencies and country-specific authorization rules. The recommended value is 0. If the 0 amount is not supported, $1 might be used in authorization even if the default value is set to 0. For 3DS2 payment method validation, 0 amount is not supported.

PIX

To enable the PIX payment method type on your tenant, submit a request at Zuora Global Support.

PIX payment methods on Ebanx can be created through the one-time payment flow of Payment Pages 2.0. The creation of PIX payment methods through Zuora UI or API operations is not supported.

When your customers select PIX to pay, the hosted payment page that you created will be loaded. After your customers enter the customer information on the payment page and submit the page, a barcode will be displayed. Your customers can then use the bank application to scan the barcode and pay. The payment method data will not be stored in Zuora.

Zuora is also looking to add support for PIX to Payment Link in the future.

Support for stored credential profiles

The Ebanx payment gateway integration includes support for the Stored Credential Transactions framework for Credit Card payment methods. For details, see Support for stored credential transactions overview.

Note that the Ebanx payment gateway integration does not support the sharing NTI feature, so existing payment methods that were previously created through other payment gateway integrations cannot be used to process payments through Ebanx. To process payments through Ebanx, you must create a payment method through the Ebanx payment gateway integration.

Support for 3D Secure 2.0

3D Secure 2.0 (3DS2) is a solution for Strong Customer Authentication (SCA) under PSD2 to reduce fraud and increase authorization approvals. The Ebanx payment gateway integration supports 3DS2 for Credit Card payment methods. See the following articles for more information:

Support for Delayed Capture

The Delayed Capture feature allows you to authorize the availability of funds for a transaction but delay the capture of funds until a later time. The Ebanx payment gateway integration supports Delayed Capture for Credit Card payment methods. For how to use the Delayed Capture feature, see Payment Authorization in Zuora API Reference.

Limitations

Non-referenced refunds are not supported.