Unified-API Developer Labs
Our API offers our partners a more smarter and seamless way to integrate, collect and process payment transactions. We offers a wide range of payment channels including digital Wallet payments, Qr (EcobankPay), Cards, Account transactions and more. Please visit our Online Portal for more informative details
Unified-API Developer Labs allow developers to test previews of our Payment API features. The endpoints, documentation, and resources for Labs will be updated as we incorporate more alternate and excited payment/channels from our innovative software team.
Postman collection for Unified-API Developer Labs
This is a Postman collection for the developer previews in Unified API- Developer Labs.
For more details, read the Ecobank Unified Developer Labs documentation.
Remember: The endpoints we release in Labs will be previews and are likely to change before they are released broadly, so we encourage you to take that into consideration as you build.
END TO END INTEGRATION STEPS.
1- Register for Sandbox Access: Register by filling all required details to be given access details to our sandbox. Remember the username and password you will be giving will be required for authentication during the request for Go live access.
2- Email confirmation:
You will receive an email confirmation upon successful registration during the sandbox access request. This email will contain the following:
UserID: This will be required for the token generation request.
Password: This will be required for the token generation request.
Lab key: This will be required to generate the secureHash as a parameter.
Documentation link: This will take you to our service documentation where you will find all relevant details.
Test case file: You will need to populate it based on your actual result on the sandbox testing. This document will have to be uploaded as part of the request for go live process.
3- Sandbox Integration: Build your logic based on the sandbox services and requirements. At this stage you will be expected to do the following:
a- Token generation: Generate a token using the Token generation endpoint under the collection section, by passing the userId and password which would have been sent to you via email when registering for the sandbox access.
b- Hashing algorithm: This needs to be tested in isolation under the sandbox, the endpoint can be found under the collection Hashing Service , full details on how to do the computation available under the said collection.
c- Sending the request: Before sending the request ensure you had appended the generated token stated in the section a of this documentation on the authorisation of parameter of your JSON request, and also ensure the default origin is included in the header side of your request (developer.ecobank.com).
PS ---- For the purpose of testing on the sandbox you are not expected to change the body of your json request but only to make use of the predefined data.
4- Complete the test case document: the test cases document received after the successful registration for the sandbox access needs to be completed based on the actual result of the test conducted on the sandbox. This will be required for upload during the request for go live phase.
5- Request for Go live: Go back to our developer's portal and click on Register for Go live. You will be required to login with the credentials that you chose during the registration for sandbox access phase. Once successfully authenticated you will be required to complete all basic KYC information and finally upload the the completed test case document and submit for review and approval.
6- Review & Approval: At this point we will receive your request for Go live and will contact you accordingly for any addition details or information to get you going on our production platform.
Quick install
Just click the Run in Postman button. You're all set!
Environment
This collection includes a environment variables that are needed to authenticate each request. You will need to add values to each variable.
To find these values:
Open your Developer dashboard.
Head over the Register tab.
Enter the required information and click register.
You credentials will be sent via email.
Copy the values into each variable.
To add these values to your Postman environment:
Select the ⚙️ icon next to the Unified-API Developer Labs environment name.
Click Unified-API Developer Labs.
For each variable, add the values from your app dashboard in the Current value column.
When you're done adding all values, click Update.
Postman will set up your requests to be authenticated using OAuth 2.0 (Bearer token) authentication.
Get help
If you need help, ask a question in the Labs community forums.
Submit feedback
Your ideas matter! Help us develop the next generation of the Unified-API Developer Labs by sharing your feedback.
We know the best future version of our API will come from creating it together with the people who use it most.