Introduction
EllyPay is a platform that enables digital agents/merchants to purchase a wide range of services. The document describes the current version of the API.
EllyPay facilitates simple, fast and secure payments for digital services/products. The API enables the partner integrate these services in their online businesses. Our developer friendly API gives access to a variety of services including; airtime, voice bundles, internet bundles, utility payments (NWSC and Electricity bills), PayTV, Taxes and mobile money. The transactions performed on the platform can potentially earn the partner commissions depending on the contract terms.
The document is therefore dedicated to the EllyPay API partners and developers wishing to add these services to their existing platforms (web/mobile etc).
Platform Features
Customer Account Validation
The API emphasizes that the customer details are confirmed before the actual transaction is processed to make payment to the designated. This ensures that the payment is made to the correct account number and avoid reversal/reconciliation troubles. In the event the customer account has an outstanding balance, this information is equally provided under these validation details.
Service Variety
Your customers will be granted access to a wide range of services; Airtime (MTN, Airtel and Africell), Voice Bundles (MTN), Internet Bundles (MTN, Airtel, Africell, Smile, Roke, LycaMobile), Utility Services (UMEME and NWSC), PayTV (DSTV, GoTV, Startimes), URA payments, Tugende Payments and mobile money agency services (MTN and Airtel).
Transparency
EllyPay provides a management dashboard to all it's partners. The dashboard provides reports of all the account activity and how the float expenditure is done. In cases where transactions earn commissions, this is equally reflected in well structured account statements and reports.
Sandbox Environment
This is a utility platform built to allow API agents/merchants simulate the workflows of the production/live environment. The sandbox environment offers an API that the merchant/agent integrates first to test the platform and perform UATs. It offers test accounts that the merchant/agent can use to try out the different operations of the API without affecting customer funds in the real world. When all tests are done to the satisfaction of the merchant/agent and the EllyPay support staff, the merchant can then be approved to go live.
We intend to make your migration from sandbox to production very smooth. You'll strictly need to change the API base URL and obtain a new set of credentials (security keys). Everything else will work as expected.
Production Environment
Under this environment, real funds can be requested/sent from/to real customers. In order for the merchant/agent to be accepted to use the production environment, they will have completed the compliance/KYC phase and also integrated the sandbox API for all the required tests.
Async Processing
The EllyPay API is asynchronous; meaning the merchant/agent doesn't need to wait on the same request thread to obtain the new status of the transaction. The confirmation of the transaction status will be via a callback/webhook/IPN POST request. We will therefore require that you share the https URL for your callback endpoint and it will be configured on the merchant/agent account accordingly.
API Endpoint
The EllyPay API can be accessed using the following base URL;
This URL is for the sandbox platform. When you are ready to start live transactions, the base URL for the production environment will be shared via your registered email address.
Last updated