EBANX Direct API

Customizable and powerful API

The Direct API of EBANX allows you to accept all payment methods – Boleto Bancário, Bank Transfers, and Credit/Debit Cards – directly on your domain.

By integrating with EBANX Direct API you are providing the best purchase experience for your customer, once they can complete the checkout without needing to leave the store’s front end.

Get Started
  • cUrl
  • Node.js
  • PHP
  • Ruby
  •                 curl -X POST 'https://sandbox.ebanxpay.com/ws/request' \
      -d 'integration_key=your_test_integration_key_here' \
      -d 'name=José Silva' \
      -d 'email=josesilva@example.com' \
      -d 'country=br' \
      -d 'payment_type_code=_all' \
      -d 'merchant_payment_code=d59cb7166e7' \
      -d 'currency_code=BRL' \
      -d 'amount=100'
                  
  •                  const module = require('ebanx');
     const ebanx = new module();
    
     ebanx.configure({
       integrationKey: "your_test_integration_key_here",
       testMode: true
     });
    
     const params = {
       name : "José Silva",
       email : "josesilva@example.com",
       country : "br",
       payment_type_code : "_all",
       merchant_payment_code : "8a61e0ce488",
       currency_code : "BRL",
       amount : "100.00"
     };
    
     ebanx.request(params, (err, reply) => {
       if (err) console.error(err);
       else console.log(reply);
     });
                  
  •                 $config = new Config([
       'sandboxIntegrationKey' => 'your_test_integration_key_here',
       'isSandbox' => true,
       'baseCurrency' => Currency::USD
     ]);
    
     $payment = new Request([
       'person' => new Person([
         'email' => 'josesilva@example.com',
         'name' => 'José Silva',
       ]),
       'address' => new Address([
         'country' => Country::BRAZIL
       ]),
       'amount' => 100.00,
       'merchantPaymentCode' => 'd59cb7166e7',
       'type' => '_all',
     ]);
    
     $result = EBANX($config)->hosted()->create($payment);
                  
  •                 require 'ebanx'
    
     Ebanx.tap do |e|
       e.integration_key = 'your_test_integration_key_here'
       e.test_mode = true
     end
    
     response = Ebanx.do_request({
       name: "José Silva",
       email: "josesilva@example.com",
       country: "br",
       payment_type_code: "_all",
       merchant_payment_code: "88e8870aee4",
       currency_code: "BRL",
       amount: "100.00"
     })
                  
 

EBANX Direct API is a moldable solution to any kind of business

A solution recommended for those who want a seamless integration and wish to control everything about the payment flow.

Learn more about EBANX Direct API

Access our comprehensive guides of payments operations in EBANX Developers Academy.

  •  

    Create, capture and cancel payments.

  •  

    Query all information of a payment.

  •  

    Get a list of available banks for TEF or EFT.

  •  

    Refund a payment and cancel refunds.

  •  

    Create FX Token and use them to create payments.

  •  

    Use sub-accounts and device fingerprint.

How Direct API works for your customer

The Direct API is implemented in the store’s checkout process.

The Direct API is implemented in the store’s checkout process.

After the customer has verified the shopping cart and provided his personal and shipping information, he should input the data to conclude the payment.

After the customer has verified the shopping cart and provided his personal and shipping information, he should input the data to conclude the payment.

A confirmation page appears according to the payment status.

A confirmation page appears according to the payment status.

 

Keep on track of every payment

The payment status is always available for you, and once it is modified, you get an automatic notification sent by our server.

 

Testing and going live with EBANX

The integration with EBANX includes a test account so that you can test all the functionalities in a simulated environment before you get started.

Discover more Integration Methods

Access all integration methods available with EBANX here.

 

Payment Page

A simple integration where you redirect your customers to EBANX Payment Page and let us do the rest.

Read More
 

Payment by Link

With on-demand payments, you can manually generate payment links on EBANX Dashboard and send it to your customers.

Read More

Increase sales in Latin America with EBANX.

Get Started