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.
- Redirect to bank transfer instructions - 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.
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.
https://sandbox.ebanx.com/ws/directDefine 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 following required fields.
Basic parameters:
Parameter Description operationSet to requestintegration_keyYour EBANX integration key payment_type_codeSet to banktransfercountrySet to ngfor NigeriaCustomer data:
Parameter Description nameCustomer name emailCustomer email Charge parameters:
Parameter Description merchant_payment_codeUnique merchant payment code currency_codeSupported value: NGNamount_totalTotal amount to be charged 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": "email@example.com",
"country": "ng",
"payment_type_code": "banktransfer",
"merchant_payment_code": "13a7460fe0b1d46a",
"currency_code": "NGN",
"amount_total": "500"
}
}'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": "63e2aaadf13ce708e12d84d7a46de23ecc3c75eb645b92b6",
"country": "ng",
"merchant_payment_code": "13a7460fe0b1d46a",
"order_number": "1234567",
"status": "PE",
"status_date": null,
"open_date": "2023-01-01 01:01:01",
"confirm_date": null,
"transfer_date": null,
"amount_br": "500.00",
"amount_ext": "500.00",
"amount_iof": "0.00",
"currency_rate": "1.0000",
"currency_ext": "NGN",
"due_date": "2023-01-01",
"instalments": "1",
"payment_type_code": "banktransfer",
"voucher_url": "https://sandbox.ebanx.com/print/voucher/execute?hash=63e2aaadf13ce708e12d84d7a46de23ecc3c75eb645b92b6",
"pre_approved": false,
"capture_available": null,
},
"status": "SUCCESS"
}At this stage, the payment will appear as pending (PE) in yourEBANX Dashboardchevron_rightRedirect customer to the returned URL
Redirect your customer to the
voucher_url. After the redirection, your customer will be able to see the voucher with instructions to complete the transaction.Your customer makes a payment.
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.
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).
After receiving a notification, retrieve the payment status.
Congratulations!
You have succesfully integrated Bank Transfer.
For more information, refer to theDirect 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.
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.