Aplazo

Aplazo is a leading Buy Now, Pay Later (BNPL) provider in Mexico, empowering customers to make secure, real-time payments directly from their bank accounts with a convenient and flexible financing option. By integrating Aplazo with EBANX, merchants can provide Mexican consumers with a trusted and efficient payment method for online transactions, driving higher conversion rates and delivering a smooth checkout experience. This partnership combines Aplazo’s localized BNPL expertise with EBANX’s robust payment infrastructure, ensuring a secure, reliable, and seamless solution tailored to the Mexican market.

Requirements

• API credentials - Ensure you have your EBANX integration key. If not, complete the Merchant Signup Form.
• Familiarity with EBANX Direct - This setup follows the same general structure as other payment methods, with a few unique parameters.

How It Works

1. Customer Initiates Payment - At checkout, the customer selects Aplazo as their preferred payment option.

2. Redirect Customer to Aplazo - The customer is redirected to the Aplazo interface, where they log in and authorize the payment using their credentials.

3. Payment Authorization & Processing

   • Aplazo evaluates the customer’s credit eligibility and either approves or declines the transaction.
   • If approved, Aplazo confirms the payment.

4. EBANX Notifies the Merchant - EBANX sends a payment status notification to the merchant’s system.

5. Order Fulfillment - Once the merchant receives the successful payment confirmation, the order is processed and shipped to the customer.

6. Settlement & Payout

   • Aplazo pays the full purchase amount upfront to EBANX.
   • EBANX settles the funds with the merchant.

Instructions

Follow these steps to integrate Aplazo using the EBANX Direct API:

1. Select your environment

   Select the appropriate environment for your integration. Use the sandbox environment for testing, or the production environment for live transactions. Use the URL for your HTTP requests based on your selection.

   SandboxProduction

   https://sandbox.ebanx.com/ws/direct

2. Define your parameters

   You you will need to redirect your customer to a redirect_url to authorize the payment. To obtain this redirection link, call the ws/direct endpoint with the required parameters.

   
   

   Defining API parameters

   You must provide required parameters for payment requests. These parameters ensure successful completion of transactions.
   
   

   Essential parameters

   • payment.payment_type_code - Specifies the payment method to be used for the transaction.
   • payment.currency_code - Three-letter code of the payment currency
   • payment.amount_total - Total amount to be charged.

   
   

   Additional parameters

   • EBANX Integration Key - Used to authenticate and authorize API requests.
   • Customer Information
     • Includes details such as the customer name, email, address and document number (Depends on the requirements of the payment method or local regulations).
     • While not mandatory for all countries or payment methods, providing this information can enhance security and increase the likelihood of successful processing.
   • Additional Context - Extra data for specific methods or countries.

   
   

   To learn more about API parameters, please refer to the

   API Reference Guide chevron_right

   At the API Reference Guide, select Mexico and Aplazo from the dropdown menus.

3. Sample request

   Use the following example to initiate a request.

     --location 'https://sandbox.ebanx.com/ws/direct' \
     --header 'Content-Type: application/json' \
     --data '{
      "integration_key": "your_ebanx_integration_key",
      "operation": "request",
      "payment": {
          "payment_type_code": "aplazo",
          "currency_code": "MXN",
          "amount_total": 1000,
          "name": "Juan Pérez",
          "email": "test_aplazo@test.com.mx",
          "document": "12351346801",
          "phone_number": "0405777687",
          "address": "Av. Reforma 123",
          "zipcode": "11000",
          "street_number": "123",
          "city": "Ciudad de México",
          "state": "CDMX",
          "country": "mx",
          "merchant_payment_code": "48ac7653-d224-454c-92bb", // Unique merchant payment code
          "redirect_url": "https://merchant.pageebanx.com"  // Your URL to redirect after payment
      }
   }

4. Sample response

   A successful request will return a JSON response like the example below. The payment.redirect_url parameter contains the URL that directs the customer to the third-party website for completing the payment.

   {
     "payment": {
       "hash": "6762fd24f79cc32b3fbe8d3f17828ebdb5c3189427ff1qe5",
       "country": "mx",
       "merchant_payment_code": "48ac7653-d224-454c-92bb",
       "order_number": null,
       "status": "PE",
       "status_date": null,
       "open_date": "2025-12-18 16:49:40",
       "confirm_date": null,
       "transfer_date": null,
       "amount_br": "1000.00",
       "amount_ext": "1000.00",
       "amount_iof": "0.00",
       "amount_ext_requested": "1000.00",
       "currency_rate": "1.0000",
       "currency_ext": "MXN",
       "due_date": "2025-12-21",
       "instalments": "1",
       "payment_type_code": "aplazo",
       "redirect_url": "https://api.ebanx.com/ws/redirect/execute?hash=6762fd24f79cc32b3fbe8d3f17828ebdb5c3189427ff1de5",
       "pre_approved": false,
       "capture_available": null,
       "customer": {
         "document": "12351346801",
         "email": "test_aplazo@test.com.mx",
         "name": "Juan Pérez",
         "birth_date": "1982-11-23"
       },
       "single_transaction": {
         "amount_local": "0.00",
         "amount_crossborder": "1000.00"
       },
       "requested_currency": "MXN",
       "currency_ext_base": "MXN"
     },
     "status": "SUCCESS",
     "redirect_url": "https://api.ebanx.com/ws/redirect/execute?hash=6762fd24f79cc32b3fbe8d3f17828ebdb5c3189427ff1de5"
   }
   At this stage, the payment will appear as pending (PE) in your

   EBANX Dashboardchevron_right

5. Redirect customer to the returned URL

   Redirect your customer to the URL returned in the parameter redirect_url. After the redirection, your customer will be at Aplazo’s platform with all the necessary purchase details to finalize their payment securely and easily.

   Testing Aplazo in a sandbox environment

   In our Sandbox environment, we provide a Aplazo simulation interface to test payments. This mock interface allows you to simulate different payment outcomes:

   • Simulate Authorized = YES: Confirms the payment as successful.
   • Simulate Authorized = NO: Denies the payment.
   • Leave Pending: Leaves the payment in a pending state.

   This simulation mimics the real production flow, where users are redirected to Aplazo to complete transactions, enabling you to thoroughly test authorized and unauthorized payments.

   
   
   
   Simulator UI May Vary

   The actual simulator UI may vary based on updates and enhancements.

6. Monitor payment for status changes

   Notifications

   • EBANX will send a notification whenever a payment status changes.

   • Make sure your system is set up to receive notifications from EBANX for any changes in payment status.

   • Learn more about Payment Notificationschevron_right

   Status

   • After receiving a notification that status has changed, retrieve the payment status.

   • When a payment is confirmed, the status will change from pending (PE) to confirmed (CO). If the customer does not complete the payment, the status will eventually change to cancelled (CA).

   • Learn more about Retrieving Payment Statuschevron_right

7. Congratulations!

   You have succesfully integrated Aplazo.

   For more information, refer to the

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

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.