Get paid anywhere in the world
With just one integration, your company can sell for new consumer bases in Brazil, Mexico, Argentina, Colombia, Chile, and Peru. By offering local payment options, you can significantly increase your revenue and sales.
Learning how it works
First things first, you need to create a test account through this link. Follow the steps and complete all the fields.
By doing this you can make some test transactions in order to understand better the payment flow and the payment methods. The test account has most of the functionality that a real account has.
The difference is that boletos bancários generated in a test account are not payable in the bank. Actually, in the test environment, no payment method is real, so no real money transfer is involved. No real bank, acquirer or issuer is integrated.
With the test account, you will also receive a test integration key. That can be used to execute tests with the same parameters of the production environment.
Attention: the only difference is the base URL. Instead of this endpoint:
Like we said at the beginning after you create the test account, access ebanx.com/business/en/dashboard for the Dashboard and the test environment.
Upon receiving the confirmation for your test account, you must setup your Status Change Notification URL in your Dashboard. It will be used to notify you website about payments that changed status.
This URL needs to be available on the Internet (public IP) because EBANX is going to connect to it to notify about status changes.
Certifying your integration
After you have verified that your integration is OK and your website is ready to go live, please send an email to firstname.lastname@example.org requesting EBANX to certify your website.
Write an email with:
- Your Name
- Your Email
- Your Merchant Name
- Your Public Test URL – a website where EBANX team can test the full integration, usually a test environment within your domain
- Any additional comments to help with the test
During your tests, you can find some error returned by our API.
For that reason, look below the messages that our API can return:
Ready to go live with EBANX?
Once the EBANX team has certified your website’s integration, you will receive the production info including:
- Production Integration Key: a sequence with numbers and letters that are unique and identify you as a merchant.
When you received your production info, you need to connect your website to the production environment. So just follow these final steps:
- Replace the test key by the production key
- Define your parameters in the production Dashboard (response and notification URLs, and logo image)
- Replace the URL prefix (from https://sandbox.ebanx.com to https://api.ebanx.com) in every web service call.
Done, now you’re ready to go live. Let’s start?