Getting started

The best payment solutions for rising markets.

To begin integrating EBANX into your platform, this guide will walk you through the essential steps, from obtaining the necessary credentials to setting up your environment. You will also learn about the different integration methods EBANX offers. By the end of this guide, you’ll be ready to securely and efficiently process payments with EBANX’s tools.

Requirements

Before you begin, ensure you have the following:

• API credentials - Ensure you have your EBANX Integration Key. If not, complete the Merchant Signup Form.
• Development environment - Set up your environment with your preferred programming language (e.g., PHP, JavaScript, Python) and ensure you can make HTTP requests.
• REST client - Use a REST client like Postman or Insomnia to test your API requests before going live.

1. Obtain credentials

   New User
   To start you first integration, please complete the Merchant Signup Form to create an EBANX account. After submitting the form, you will receive further instructions for accessing your account and the necessary credentials to begin the integration process. After receiving your login instructions, visit the EBANX Dashboard to retrieve your integration_key, which is required to make HTTP requests to EBANX.

   Existing User
   Log in to your EBANX Dashboard to obtain your integration_key.

   
   
   

2. Integrate and test

   Explore the following integration options to determine which is right for you. If you’re unsure, our Business Development Analysts can help guide you through the process.

   

   Direct API

   You control every detail of the checkout workflow.

   Click to Explore

   

   Payment Page

   Redirect customers to an EBANX hosted page.

   Click to Explore

   

   Payment Link

   Generate payment links and send to customers.

   Click to Explore

3. Go live

   Once you’ve thoroughly tested your integration in the sandbox environment and are confident that everything is working as expected, switch to production mode by using your production API key and production endpoint.

   
   

   • When your integration is complete and your website is ready to go live:

     • Please contact us for certification at sales.engineering@ebanx.com.
     • Be sure to include your company name and website URL used for the EBANX integration.
     • If your site is password-protected, please provide credentials.

   • Once EBANX has certified your integration:

     • Your production integration_key will be available within the EBANX Dashboard.
     • Afterwards, you are live and ready to start processing with transactions.
   
   

   Your integration key is unique and confidential. Please safeguard it accordingly.

Resources

Use the following resources when testing in Sandbox Mode. All transactions in sandbox mode simulate real transactions, but no actual funds are moved.

Sample Cards

Click here to view mock card data to validate your payment integration.

Click to explorechevron_right

API Reference

Click here to access detailed API documentation to integrate efficiently.

Click to explorechevron_right

Mock Customer Data

Click here to view mock customer data for testing and validating user flows.

Click to explorechevron_right

Error Codes

Click here to review common error codes to troubleshoot and resolve issues quickly.

Click to explorechevron_right

Still need help?

We hope this article was helpful. If you still have questions, you can explore the following options:

• Merchant support: Contact our support team at sales.engineering@ebanx.com for assistance.
• Not a partner yet? Please complete the Merchant Signup Form, and our commercial team will reach out to you.