Version: current

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 throught 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:

  1. An EBANX Sandbox account. That's not the case? Please sign up for an Sandbox Account here;
  2. Payment methods configured in your EBANX Dashboard.

How it works

To complete an integration throught EBANX Payment Page, please follow the steps below.

  1. 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.

  2. 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.

    ParameterDescription
    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 below
    currency_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/request can 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

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • rapipago: Rapipago
    • pagofacil: PagoFacil.
    • cupon: Cupon de Pagos.
    • _creditcard: Credit Cards
    Available currencies
    • ARS: Argentine Pesos
    • USD: US Dollars

    🇧🇴 Bolivia

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • pagosnet: Pagosnet.
    Available currencies
    • BOB: Boliviano
    • USD: US Dollars

    🇧🇷 Brazil

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • boleto: Boleto Bancário.
    • banktransfer: Bank transfer.
    • _tef: Bank transfer (TEF).
    • _creditcard: Credit Cards
    • debitcard: Debit Cards
    • mercadopago: Mercado Pago
    • paypal: PayPal
    Available currencies
    • BRL: Brazillian Reais
    • EUR: Euros
    • USD: US Dollars

    🇨🇱 Chile

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • servipag: Servipag;
    • sencillito: Sencillito cash payment voucher;
    • webpay: Webpay payment method;
    • multicaja: Multicaja payment method.
    Available currencies
    • CLP: Chilean Pesos;
    • EUR: Euros;
    • USD: US Dollars.

    🇨🇴 Colombia

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • eft: Colombian bank transfer;
    • baloto: BALOTO cash payment;
    • efecty: Efecty cash payment;
    • _creditcard: Credit cards
    • nequi: Nequi
    Available currencies
    • COP: Colombian Pesos;
    • EUR: Euros;
    • USD: US Dollars.

    🇪🇨 Ecuador

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • safetypay: SafetyPay, will offer the customer to choose between SafetyPay Cash and SafetyPay Online.
    Available currencies
    • USD: US Dollars.

    🇲🇽 Mexico

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • spei: Spei;
    • oxxo: Oxxo;
    • _creditcard: Credit cards;
    Available currencies
    • MXN: Mexican Pesos;
    • USD: US Dollars.

    🇵🇪 Peru

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • pagoefectivo: PagoEfectivo;
    • safetypay: SafetyPay, will offer the customer to choose between SafetyPay Cash and SafetyPay Online.;
    • _creditcard: Credit cards;
    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • PEN: Nuevo Sol;
    • USD: US Dollars.
    Available currencies

    🇺🇾 Uruguay

    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • creditcard: Credit cards;
    Available payment methods

    You can inform the values below in the parameter payment_type_code in order to restrict payment page to a specific payment method, or just use _all to the all the available payment methods for the merchant account in this country.

    • UYO: Peso Uruguayo;
    • USD: US Dollars.
    Available currencies

    In the example below, we are calling the end-point /ws/request using country equal to br (Brazil) and currency_code equal 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,
    "customer": null
    },
    "redirect_url": "https://sandbox.ebanx.com/checkout?hash=5ef6208cc0ae84cee0a3850148e1417a0a2e70495c6b2807",
    "status": "SUCCESS"
    }

    The parameter redirect_url contains the url to redirect your customers in the next step.

  3. 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:

    EBANX Payment page

  4. 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.

    EBANX Payment page

    info

    The return URL can be configured into your Dashboard or sent as a parameter in the request to ws/request in the parameter redirect_url. Learn more about notifications here

    If 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 ou this form and our comercial 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.
Last updated on by Fernando Pankiewicz Gomes