Documentation

IMPORTANT

This is the outdated SI-documentation which will be adapted soon. A huge part may be obsolete!

Ebanx

EBANX offers complete payment solutions for markets in Latin America. With just one integration, your company can sell to consumers based in Brasilien, Mexico, Argentina, Kolumbien, Chile, Peru, and Ecuador. Offering local payment options is an excellent opportunity to increase your sales and reach even more customers.

Setting Up EBANX

EBANX requires user to create an account with them. Navigate to EBANX Business Page, select your business model and answer a few questions. EBANX Business Development Analysts will get in touch shortly.

Payment Features

Currently EBANX payment method supports the following payment features:

One-time Payments
Recurring Payments
Refund Payments

Merchant Integration Key

On the new page, you'll find your Test Integration Keys and Live Integration Keys in the Integration tab on the top menu.

IMPORTANT: If you're first time registering and configuring EBANX, you'll only have access to Test Integration Keys. Please read this I have finished my integration, can I go into production documentation.

Handling Notification

When a payment status is changed, EBANX sends a notification to your site through Notification URL that you have configured in your dashboard. By doing this, you'll know the status and more information about that payment. Notifications are important since they is used to indicate when you can deliver your product/service to your customer.

Don't forget to configure your notification URL when moving from testing to production environment. Make sure that you're using the correct URL for your production instead of using URL for testing environment.

Notification URL: https://yoursite.com/index.php?option=com_payplans&gateway=ebanx&view=payment&task=notify
Response URL: https://yoursite.com/index.php?option=com_payplans&gateway=ebanx&view=payment&task=complete&action=success

IMPORTANT: Please make sure you're using https:// instead of http://.

Please use this Getting Started documentation as a guide in creating your application.

EBANX Configuration

Payment gateway integration guide can be read at New Payment Gateways Integration

The General options for EBANX are fairly the same among all payment methods. You'll need to give a suitable title, determine whether to be published or unpublished and the appropriate description for this payment method. You may set this payment method to be applied on all plans or only on selected plans. The Parameters section are the specific options needed when configuring EBANX integration. Details of each options are described below.

Merchant Integration Key : Enter your Test Integration Keys when testing in sandbox or Live Integration Keys when going live into this section.
Sandbox : Sandbox is a testing environment simulates a behavior of a payment method. This option is used in development phase. Always set to No when in the production.

When everything are in order, click on Save button to store the configuration.

Known Issues & FAQs

I have finished my integration, can I go into production?

Not quite yet! Once you have completed your tests, please contact EBANX through integration@ebanx.com and they will run some tests on your behalf to check if your integration is working properly (don’t worry, this requests is usually handled very quickly!). After that, they will create your production account and send you your credentials to go live.

I just received my live integration keys. What should I do now?

First, you should replace your test integration key with the new "live" integration key, so that all payments can be redirected to your live account. Also, you might need to turn off the sandbox mode in your integration.

What is the difference between the Integration Key and the Public Integration Key?

The Integration Key is used to make requests to EBANX API operations. Keep it safe and do not expose this information.

The Public Integration Key is used to make token operations from your customer’s client (browser, app, etc.). By doing this, you don’t have to deal directly with your customer’s credit card sensitive information.

I am having problems with my integration key, such as invalid integration key error. What can I do?

Please check that you are using the right integration key in the right environment. A common mistake is to use a test integration key in the production environment and vice-versa. If the error persists, please contact integration@ebanx.com.