EBANX 

Introduction 

EBANX is a payment gateway and financial technology company that focuses on facilitating local payments for businesses operating in Latin America. As a payment gateway, EBANX provides a range of services to enable international merchants to accept payments from customers in Latin American countries.

A key benefit of Ebanx is its capability to enable businesses to accept and process payments within Latin America locally, rather than as cross-border transactions, without the necessity of establishing a local entity in Latin American markets. By utilizing a domestic processor, businesses can potentially achieve higher payment authorization rates, minimize payment failures, and potentially save on processing and international fees. Moreover, this approach eliminates the expenses associated with setting up and maintaining a local entity solely for local payment processing purposes.

Supported Countries and Currencies 

This integration between EBANX and Chargebee supports the following countries and their currencies:

Supported Local Card Schemes 

In addition to supporting major global card schemes like Visa and Mastercard, our integration extends its capabilities to include popular local card schemes across Latin America. This expansion enhances your regional presence, granting access to a broader customer demographic. Notable schemes encompassed within this integration are Elo and Hipercard in Brazil, along with others such as CMR_FALABELLA, ARGENCARD, and CENCOSUD, providing comprehensive coverage across the region's diverse payment landscape.

Integration Options 

Chargebee offers the following options to integrate with EBANX:

• Chargebee Hosted Pages
• Chargebee API + EBANX
• Chargebee.js
• EBANX.js + Chargebee API

Review the table below for additional information:

Retrieve Information from your EBANX Account 

Follow the steps below to fetch the information that you will be required to enter during your gateway configuration in your Chargebee site:

1. Login to your EBANX account .

2. Click on your profile name to expand the drop-down menu, and click Account Settings.

   

3. Select the Integration tab on the Settings page.

   

4. Copy the Integration Key and Public Integration Key under the Test Integration Keys section. Save these for future use during the gateway configuration in your Chargebee site.

   

Configure EBANX in your Chargebee Site 

Follow the steps below to add and configure EBANX as a gateway in your Chargebee site:

1. Login to your Chargebee site .

2. Go to Settings > Configure Chargebee > Payment Gateways.

3. Click the Add Gateway button in the top right corner and select EBANX from the list of gateways.

   

4. Enter the Integration Key and Public Integration Key in the dedicated fields as copied from your EBANX account.

5. Click Connect. EBANX will be added to your account successfully if the added credentials are correct.

   

6. Click Manage to set up card-related settings on the Configure EBANX page.

   

7. Enable the following as per your requirements:

   • Card Verification: Enable this option if you wish to allow verification while the customer is adding a card.
   • Always retain card information in EBANX when customer updates it: Enable this option if you wish to save customer card information on EBANX.
   • Enable 3D Secure: Enable this option if you wish to enable authentication for payments made via cards.
     

8. Click Save and then click Apply on the Configure EBANX page.

Configure Webhooks 

Webhooks are indispensable when it comes to integrating Chargebee with EBANX as they pass crucial payment information such as payment status, based on which users can take action. Webhooks in this integration should be configured manually. In this integration, the webhooks are used for information regarding refunds and chargebacks.

Follow these steps to configure Webhooks:

1. Copy the Notification URL from the Configure EBANX page in your Chargebee site.

   

2. Move to your EBANX account, click on your profile name to expand the drop-down menu, and click Account Settings.

   

3. Select the Integration tab on the Settings page.

4. Paste the Notification URL copied from your Chargebee site into the Test Status Change Notification URL field under the Test Service URLs section.

5. Click Save Integration Settings.

   

Fraud Management 

Chargebee supports the use of EBANX Device Fingerprint as the Device ID for fraud management. This Device ID is linked to the payment. Anti-fraud tools utilize this information to detect potential fraud attempts. Learn more  about Device Fingerprint by EBANX.

This feature is supported if you are using the following integration options:

• Chargebee.js 
• Chargebee Hosted Pages 

Additional Mandatory Settings 

Ebanx integration mandatorily needs the following information, especially in Latin American region:

• Customer Email ID is mandatorily needed.
• Billing Address and Customer Name: To gather the Billing Address details and Customer name from your customers, it is necessary to enable the full Billing Address fields for your Checkout flow and make it mandatory to be collected in Checkout. Further details can be found in the Billing Address section below.
• Document ID: Document ID needs to be collected from the customers for successful payment processing. It is mandatory in many Latin American countries. For more information, refer to the Document ID section below.

Let us dive deeper into each setting:

Billing Address 

Follow these steps to enable this from your Chargebee site:

1. Go to Settings > Configure Chargebee > Checkout and Self-Serve Portal.

2. Switch to the Fields tab and select Payments.
   You must enable the above-listed fields and make it mandatory including the First and Last name.

3. Click Publish. Address fields will appear only if None is selected from the In checkout, prefill address information from drop-down menu.

   

4. Choose to prefill address-related information from Billing or Shipping details by selecting the relevant option under the In checkout, prefill address information from drop-down menu.

   

Document ID 

Document ID is a unique number employed to verify an individual's identity, and its format varies based on the customer's country of origin. For instance, Argentina uses CDI and CUIL, while Brazil employs CNPJ and CPF, among others. Document ID is mandatory in certain Latin American markets for successful payment processing.

The Document ID is mandatorily needed for payment processing in the following countries:

• Brazil
• Mexico
• Chile
• Argentina
• Ecuador
• Peru
• Uruguay

Document ID Collection and Basic Validation

• When utilizing Chargebee Hosted Checkout, the Document ID becomes accessible within your checkout flow as an input field, facilitating its retrieval as customers complete their purchase. Chargebee seamlessly integrates this feature into the checkout form, dynamically adjusting based on the availability of Ebanx as a payment option, determined by your configured smart routing settings. There's no requirement for additional setup to collect the Document ID. Upon receipt, Chargebee automatically verifies the Document ID format using Ebanx.js, ensuring smooth processing.
• When utilizing Chargebee.js, it's essential to incorporate the collection of the Document ID into your checkout process and validate it before sending it through the Chargebee API.
• When utilizing the Chargebee API, ensure to include the document parameter in your API request. Within the Payment Sources document, locate the additional_information  parameter, then navigate to Ebanx > payer > document under it. It is advisable to perform validation for this parameter on your front end.

Learn more  about document validation.

Workflows 

• Chargeback Management: EBANX notifies only when the Chargeback is initiated.
• Account Updater: Account Updater is not supported in this integration.
• Migration Flow: When you are migrating into Chargebee and bringing in either existing tokens from Ebanx or moving cards from a different gateway to Ebanx, make sure to pass and send the Document ID and the Billing Address along with the permanent token in Chargebee which is mandatorily needed in many markets in Latin America to process payments successfully. This needs to be sent as Additional Info. To learn more about the migration process, refer to a detailed document on Migrating Cards .
• Stored Credential Parameters: For Customer-Initiated Payments (CIT), Chargebee will send provided as the value in the card_cvv_mode field to Ebanx. Conversely, for Merchant-Initiated Payments (MIT), Chargebee will send recurrent as the value in the card_cvv_mode field to Ebanx, ensuring proper classification as recurring/MIT payments.
• Statement Descriptor: Ebanx doesn't have an option to specify a dynamic Statement / Transaction Descriptor.

Checkout Flow 

Your customers perform the following steps through the checkout flow using EBANX:

1. Review the plan details and click Proceed to Checkout.

   

2. Enter the email address to proceed and click Next.

   

3. Enter relevant information for your Account Details and click Next.

   

4. Enter the relevant information for your Billing Address and click Next.

   

5. Select Credit Card as the payment method.

   

6. Enter the payment (credit card in this case) details, select the document type and enter the document number. Click Next. These document-related fields will be enabled only when EBANX is used as the payment gateway and appropriate smart routing settings have been done.

   

7. On the Complete Your Order page, review the plan and payment-related details and then click Pay and Subscribe to complete the purchase. On completing the payment, the subscription creation process will be initiated.