EBANX Payment Page
About this guide
This page explains how to process payments using EBANX Payment Page integration. The Payment page integration is basically the same for all Latin American countries and we will walk you through all the additional possibilities here.
If you are not integrated with EBANX Payment Page yet, please take a look in the product overview to check the available payment methods and features. Are you not sure if EBANX Payment Page is the best option for your e-commerce? Please, talk with one of our integration specialists.
What you will need
Before starting your integration, please make sure that you have:
- An EBANX Sandbox account. That's not the case? Please sign up for an Sandbox Account here;
- Payment methods configured in your EBANX Dashboard.
How it works
To complete an integration through EBANX Payment Page, please follow the steps below.
Enable your payment methods
You have a variety of payment methods to choose from with EBANX. So, the first step is to check which ones you want to activate in your EBANX Dashboard.
All set? We can go ahead to next step, otherwise, please get in touch with our integration specialists.
Call the /ws/request API to get the payment page link (server-side)
With EBANX Payment Page, your customers are redirected to a safe checkout page hosted by EBANX, with the most relevant payment methods from Latin America. To get this redirection link, you just need to call the end-point
ws/request(from your server) with the following required fields.Parameter Description integration_keyYour unique and secret integration key. nameCustomer name. emailCustomer email address. countryTwo-letter country code. payment_type_code_all, to have all the available payment methods or you can restrict it with the available payment methods per country belowcurrency_codeThe currency code of your transaction. amountTransaction amount, in the specified currency. E.g.,: 100.50 merchant_payment_codeUnique identifier for this payment (usually the order number from your system). API Reference
The complete API reference for the end-point
ws/requestcan be found here. We strongly recommend you to take a look in all the available options, such as installments for example.Available payment methods and currencies per country
🇦🇷 Argentina🇧🇴 Bolivia🇧🇷 Brazil🇨🇱 Chile🇨🇴 Colombia🇨🇷 Costa Rica🇪🇨 Ecuador🇪🇬 Egypt🇸🇻 El Salvador🇬🇭 Ghana🇬🇹 Guatemala🇰🇪 Kenya🇲🇽 Mexico🇵🇦 Panama🇵🇾 Paraguay🇵🇪 Peru🇿🇦 South Africa🇹🇿 Tanzania🇺🇬Uganda🇺🇾 Uruguay🇳🇬 Nigeria🇿🇲 ZambiaIn the example below, we are calling the end-point
/ws/requestusingcountryequal to br (Brazil) andcurrency_codeequal to BRL (Brazilian Reais), asking for all the available payment methods.curl --request POST 'https://sandbox.ebanxpay.com/ws/request' \--data-raw '{"integration_key": "{{integration_key}}","name": "José Silva","email": "josesilva@example.com","country": "br","payment_type_code": "_all","merchant_payment_code": "0x0W26D05-T10","currency_code": "BRL","amount": 1000}'A successful request will return a JSON response like the one below. The redirection link will be in the parameter
redirect_url.{"payment": {"hash": "5ef6208cc0ae84cee0a3850148e1417a0a2e70495c6b2807","pin": "844658402","country": "br","merchant_payment_code": "0x0W26D05-T10","order_number": null,"status": "OP","status_date": null,"open_date": "2020-06-26 16:21:31","confirm_date": null,"transfer_date": null,"amount_br": 1000,"amount_ext": 996.2143853357243,"amount_iof": 3.79,"amount_ext_requested": "1000.00","currency_rate": 1,"currency_ext": "BRL","due_date": "2020-06-29","instalments": 1,"payment_type_code": "_all","pre_approved": false,"capture_available": null},"redirect_url": "https://sandbox.ebanx.com/checkout?hash=5ef6208cc0ae84cee0a3850148e1417a0a2e70495c6b2807","status": "SUCCESS"}The parameter
redirect_urlcontains the url to redirect your customers in the next step.Redirect customer to EBANX Payment page using the returned URL
Redirect your customer to the URL returned in the parameter
redirect_url. Your customers will then see EBANX Payment Page:
Wait for the payment
Once your customer have completed the purchase, they are redirected to a "Thank you page" like the one below with the possibility to return to your Website.
info
The return URL can be configured into your Dashboard or sent as a parameter in the request to
ws/requestin the parameterredirect_url. Learn more about notifications hereIf your customers don't complete the payment, it will be automatically canceled.
Getting help
We hope this article was enlightening, but in case we’ve failed to take out your doubts you have the following options to keep on seeking for answers:
- If you’re not our partner yet and would like to know more about our prices and conditions please fill our this form and our commercial team will get in touch with you.
- In case you’re already our partner please get in touch with our support team at integration@ebanx.com.