Pay-in Guide
This guide walks you through integrating EBANX Pay-in, from setting up your credentials to building, testing, and going live with your payment flows.
Customer Checkout
The customer selects their preferred local payment method (e.g., cards, Pix, OXXO) from a wide range of over 100 supported payment options.
Payment Request
We receive a payment request with the transaction details and customer information. Your system sends this data via our API, and we process the request in real time.
API Processing
EBANX connects to payment providers to authorize the transaction, handle the money flow, and sync the status. All processing runs seamlessly and in real time.
Settlement
EBANX collects the local funds, performs the FX conversion, and settles the amount directly into your international merchant account.
1) Pay-in Solutions
EBANX Pay-in offers multiple integration models, allowing you to choose the right balance between control, speed, and implementation effort. Review the options below to select the integration approach that best fits your business and technical requirements.
| EBANX Solutions | Description | Set up | Use Case |
|---|---|---|---|
| EBANX Pay-in Direct → | Direct API integration that gives you full control over the checkout experience and payment logic, including how payment methods are displayed, tokenized, and processed. | Best for merchants optimizing conversion at scale, running custom checkout experiences, or managing advanced flows such as subscriptions, retries, and tokenization. | |
| EBANX Payment Page → | Hosted checkout page managed by EBANX. You send the payment parameters, and EBANX handles the full payment flow, including UI, validation, and processing. | Ideal for fast go-live scenarios where you want to start accepting payments quickly without building and maintaining a checkout experience. | |
| EBANX Payment Link → | No-code solution where payments are created via the EBANX dashboard and shared directly with customers through a link. | Suitable for manual operations, low transaction volumes, or use cases like invoicing, customer support, payments, or one-off transactions. | |
| EBANX Drop-in → | Pre-built UI component that embeds payment methods into your checkout while EBANX handles sensitive data and payment logic. | Best for merchants who want a native checkout experience with less development effort and reduced compliance complexity. | |
| EBANX's Channels and Partners | Integration through partner platforms or PSPs, where EBANX extends payment coverage while the partner manages the primary integration layer. | Ideal for merchants already integrated with a platform or PSP who want to expand into emerging markets without changing their existing setup. |
Get expert guidance by completing the Signup Form and our Business Development Team will assist you in finding the best solution for your business. Also, try the Payment Bundles section to understand how easy it is to scale with EBANX by reusing payloads from your payment integrations.
2) Technical Readiness
Before you start, make sure you have the following:
EBANX Merchant Area – Use the EBANX Merchant Area to manage your integration keys, monitor balances, and track payout status. For new merchants, start by completing the Signup Form to create an EBANX account and follow the next steps of obtaining credentials.
Authentication – EBANX currently supports two authentication methods for server-side API requests:
- JSON Web Signature - JWS (recommended): Uses an RSA key pair to sign each request. Your private key remains secure in your infrastructure, and the public key must be registered with EBANX. You must generate your own RSA key pair and register your public key with EBANX, for detailed instructions, refer to the API Authentication section.
- Integration Key: Uses a shared secret included in the request body. This method is being phased out and should only be used for existing integrations. You can find your integration_key in the EBANX Merchant Area (Settings > Integration).
Develop and test – Set up your development environment using your preferred language (e.g., JavaScript, Python, PHP) and test API requests using tools like Postman or Insomnia.
Whether you are using the Test or Live Integration Keys, or managing your RSA private key for JWS authentication, ensure they are stored securely. These credentials are unique to your account and should never be shared or exposed in public repositories.
3) Sandbox Environment
Use the following resources when testing in the Sandbox Environment. All transactions will simulate real transactions, but no actual funds will be moved. Choose your authentication method to get started:
- JWS (recommended): Use your Sandbox key pair – sign requests with your private key and register your public key with EBANX.
- Integration Key: Use your unique Test Integration Key.
Sandbox endpoint
Test payment flows in a controlled environment before production.
Explore endpoints, request and response structures, and authentication methods.
Send ready-to-use requests to quickly test EBANX APIs.
Review error codes and implement validations and error handling.
4) Going Live
After testing your integration in the Sandbox Environment and confirming everything works as expected, your checkout is on the final step before going live. Please contact us at sales.engineering@ebanx.com to request an Integration Review.
Include your company name and the URL of your integration. If access is restricted, provide credentials so the EBANX team can review your implementation.
We will analyze and validate the integration. Once approved, you can switch to Production Mode and start sending requests to the Production Endpoint.
- JWS (recommended): Generate a production RSA key pair (if different from sandbox), register your public key with EBANX, and sign requests using your private key.
- Integration Key: Use your Live Integration Key.
Production endpoint
You're good to go! You can now start processing transactions with EBANX :)
