CBE Connect Wallet Top-Up API Documentation
Welcome to the Wallet Top-Up API Documentation
Introduction
Welcome to the Wallet Top-Up API Documentation — your complete guide to integrating secure wallet funding functionality into your systems.
The Wallet Top-Up service enables partner institutions (agents) to connect their banking systems and provide their customers with real-time wallet funding.
With this integration, agents can:
- Search for wallet accounts by phone number or email
- Initiate secure top-up transactions
- Verify transaction status
Our APIs are REST-based, simple to integrate, and protected with Basic Authentication for secure access.
Who This Guide Is For
This documentation is intended for:
- Developers integrating wallet top-up functionality
- Technical teams at partner institutions
- Product engineers building financial workflows
First Step: Registration
Before using the Wallet Top-Up API, your institution must be registered by our 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:
- Account Lookup
- Top-Up 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 Account Lookup, Top-Up, and Status Check endpoints. Contact our team to obtain them before starting integration.
What We Expect From Your Side
During the top-up process, we expect your system to provide a Status Check endpoint.
This endpoint allows us to verify the status of payments from your side, ensuring reliable reconciliation between systems.