Introduction
Welcome to the Bank Transfer API Documentation — your complete guide to integrating secure and seamless bank-to-bank transaction functionality into your systems.
The Bank Transfer service enables partner institutions (agents) to connect their platforms to our banking network and provide their customers with real-time fund transfers directly to bank accounts.
With this integration, agents can:
- Search and validate bank accounts using account numbers
- Initiate instant or scheduled transfers between banks
- Verify transaction and settlement status
First Step Registration
Before using the Bank Transfer API, your institution must be registered by our integration team.
Once registration is complete, we will provide you with:
- Basic Auth credentials (username and password)
These credentials are required to authenticate your requests to the API.
Authentication
The following endpoints require Basic Auth credentials:
- Bank Account Lookup
- Transfer Transaction
- Status Check
⚠️ Credentials are issued by our team upon agent registration. You will not be able to access these endpoints without them.
Note
Did you get your Basic Auth credentials?
You will need Basic Auth credentials to access the Bank Lookup, Transfer, and Status Check endpoints. Contact our team to obtain them before starting integration.
What We Expect From Your Side
During the transfer process, we expect your system to provide a Status Check endpoint.
This allows us to verify transaction results from your system, ensuring accurate reconciliation and transparency across platforms.