Bank Transfer

Bank Transfer is a trusted payment option offered by EBANX, allowing customers to make secure payments directly from their bank accounts. This method is particularly popular where bank transfers are widely accepted and familiar to customers. During checkout, customers select Bank Transfer as their payment method, and EBANX generates unique payment instructions, including the amount, bank details, and a reference code for tracking. The customer completes the transfer via their online banking platform or at a bank branch. Once the transfer is processed, EBANX receives a confirmation, updating the transaction status, and enabling the merchant to fulfill the order. This method provides a seamless, reliable payment experience, appealing to customers who prefer direct bank transactions without using a credit card.

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

• Payment request - You initiate a payment request via the EBANX API, specifying Bank Transfer as the payment method. EBANX generates the necessary bank transfer details and returns a voucher_url.
• Customer redirect - You provide the customer with the voucher_url, which includes detailed instructions for completing the transfer.
• Customer completes transfer - The customer accesses their online banking, mobile banking app, or ATM and uses the provided bank details to complete the transfer.
• Payment confirmation - Once the bank processes the transfer, EBANX confirms the payment. The confirmation time may vary, as bank transfers are typically not instantaneous and can take a few hours to a few days. Listen for status changes to confirm payment.
• Order fulfillment - After receiving the payment confirmation, you can proceed with fulfilling the customer’s order.

Instructions

Follow the steps below.

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

   Bank Transfer generates a payment voucher, so you’ll need to redirect your customer to a page displaying the voucher details. 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 Chile and Bank Transfer from the dropdown menues.

3. Sample request

   Use the following example to initiate a request.

   curl -X POST \
     --location 'https://sandbox.ebanx.com/ws/direct' \
     --header 'Content-Type: application/json' \
     --data '{
       "integration_key": "your_ebanx_integration_key",
       "operation": "request",
       "payment": {
         "name": "John Doe",
         "email": "john@example.com",
         "country": "cl",
         "payment_type_code": "banktransfer",
         "merchant_payment_code": "0x0W26De04-T02",
         "currency_code": "CLP",
         "amount_total": 100
       }
     }'

4. Sample response

   A successful request returns a response like the example below, with the bank redirect link provided in the payment.voucher_url parameter.

   
   

   "payment": {
     "hash": "67536c56e69d8ed136839d19d716dd5a8cabe84b0248f50c",
     "country": "cl",
     "merchant_payment_code": "0x0W26De04-T02",
     "order_number": null,
     "status": "PE",
     "status_date": null,
     "open_date": "2024-12-06 21:27:50",
     "confirm_date": null,
     "transfer_date": null,
     "amount_br": "100.00",
     "amount_ext": "100.00",
     "amount_iof": "0.00",
     "currency_rate": "1.0000",
     "currency_ext": "CLP",
     "due_date": "2024-12-09",
     "instalments": "1",
     "payment_type_code": "banktransfer",
     "voucher_url": "https:\/\/sandbox.ebanxpay.com\/print\/voucher\/execute?hash=67536c56e69d8ed136839d19d716dd5a8cabe84b0248f50c",
     "pre_approved": false,
     "capture_available": null,
     "banktransfer_detail": {
       "transfer_account": "15767250",
       "transfer_bank": "EBANX",
       "transfer_note": "Please make a bank transfer to EBANX devs"
     }
   },
     "status": "SUCCESS"
   }
   At this stage, the payment will appear as pending (PE) in your

   EBANX Dashboardchevron_right

5. Show voucher

   Direct your customer to the URL provided in the voucher_url. Your customer will be prompted to select a bank for the transfer. A voucher will be displayed with detailed payment instructions.

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 Bank Transfer.

   For more information, refer to the

   Direct API reference guidechevron_right

Resources

Use the following resources when testing in your sandbox environment.

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.