Digital Wallet integration with EBANX provides a seamless and secure way for businesses to offer popular wallet-based payment options like Nequi, Mercado Pago, and others. This integration allows customers to pay quickly using their preferred digital wallet, enhancing their checkout experience and improving conversion rates. With support for one-time and Recurring Payments, EBANX simplifies the process of integrating digital wallets into your platform while ensuring compliance with local regulations. Through a robust API, real-time status updates, and customizable options, the Digital Wallet integration empowers businesses to tap into growing markets where wallet payments are a preferred method.
Requirements
- API credentials - Make sure you have your EBANX integration key. If not, complete the Merchant Signup Form.
Availability
The following digital wallets are available by country.
| Country | Available digital wallets |
|---|---|
 Argentina |  Mercado Pago |
 Brazil |  PayPal  Picpay  Nupay Mercado Pago |
 Chile |  MACH Pay Mercado Pago |
 Colombia |  Nequi |
 Mexico | Mercado Pago |
 Uruguay | Mercado Pago |
Instructions
Follow the steps below.
Retrieve available Digital Wallets
Check which wallets are available by selected country.
Method: POST
Endpoint: /ws/ewallet-availableewalletsExample request
curl -X POST
--location 'https://api.ebanx.com/ws/ewallet-availableEWallets' \
--header 'Content-Type: application/json' \
--data '{
"integration_key": "your_ebanx_integration_key",
"operation": "request",
"country": "co" // country code
}'Example response
The API call will return an array of digital wallets available for the customer’s country.
// Sample response: an array of digital-wallet objects.
[
{
"code": "nequi",
"name": "Nequi",
"icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png",
"promotional_text": "This is promotional text"
},
{
"code": "paypal",
"name": "PayPal",
"icon_url": "https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/paypal/icon.png",
"promotional_text": "Pay easily with PayPal."
}
]For more information, refer to theAPI reference for digital walletschevron_rightRender digital wallets options
Once you have retrieved the available digital wallets, you can render them on your checkout page using the information provided in the API response.
- Display the icon_url to show the wallet’s logo.
- Use the promotional_text to display a message for each digital wallet.
Example HTML
<div class="digital-wallet">
<img src="https://s3-sa-east-1.amazonaws.com/assets.ebanx.com/gateway/nequi/icon.png" alt="Nequi">
<p>Nequi: Fast and secure payments.</p>
</div>Get the digital wallet code
Each digital wallet in the response contains a unique code that identifies the wallet (e.g., "nequi", "paypal"). You’ll need this code to create a payment.
Create a payment with the digital wallet
Now that you have the digital wallet code, initiate a payment request using the EBANX Direct API. Assign the
payment_type_codeparameter to the digital wallet code you received earlier.API endpoint
• Method: POST
• Endpoint: /ws/directSample request
curl -X POST \
--location 'https://api.ebanx.com/ws/direct' \
--header 'Content-Type: application/json' \
--data '{
"integration_key": "your-integration-key",
"operation": "request",
"payment": {
"amount_total": 100.00,
"currency_code": "COP",
"name": "John Doe",
"email": "john.doe@example.com",
"country": "co",
"payment_type_code": "nequi", // The digital wallet code
"merchant_payment_code": "12345",
"redirect_url": "https://your-call-back-url.com",
}
}'Handle the payment response
After submitting the payment request, you’ll receive a response from EBANX similar to the example below.
{
"payment": {
"hash": "5ec27f3b86fa8e3123452345626aec3989aa2ceccdb7",
"country": "co",
"merchant_payment_code": "xyz-123-1001",
"order_number": null,
"status": "PE",
"status_date": null,
"open_date": "2020-05-18 12:27:38",
"confirm_date": null,
"transfer_date": null,
"amount_br": "1.00",
"amount_ext": "1.00",
"amount_iof": "0.00",
"currency_rate": "1.0000",
"currency_ext": "COP",
"due_date": "2020-05-21",
"instalments": "1",
"payment_type_code": "nequi",
"pre_approved": false,
"capture_available": null
},
"status": "SUCCESS",
"redirect_url": "https://api.ebanxpay.com/ws/redirect/execute?hash=5ec27f3b86fa8e318dd345234523553626aec3989aa2ceccdb7"
}If the response includes a redirect_url, you may need to redirect the user to complete the payment.
Redirect customer
Redirect the customer to the link provided in the response.
"redirect_url": "https://api.ebanxpay.com/ws/redirect/execute?hash=5ec27f3b86fa8e318ddcc9727453626aec3989aa2ceccdb7",Below is an example of the content on the redirection page:
Once EBANX confirms the payment, the customer will be automatically redirected to the callback URL provided in your direct request.
Congratulations!
You have completed the necessary steps to create a Digital Wallet payment.
For more information, refer to theDirect API reference guidechevron_right
Resources
Use the following resources when testing in your sandbox environment.
API Reference
Click here to access detailed API documentation to integrate efficiently.
Mock Customer Data
Click here to view mock customer data for testing and validating user flows.
Error Codes
Click here to review common error codes to troubleshoot and resolve issues quickly.
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.