Introduction

The EllyPay platform enables merchants (businesses and online platforms) to process payments across multiple payment options. The document describes the current version of the API.

Welcome to the EllyPay Gateway API. This API enables merchants (businesses and other online platforms) to integrate online payments into their business processes and support payments for goods and services. Our developer friendly API gives you access to mobile money in Uganda on MTN and Airtel networks. More options to be enabled in due course. With this platform, merchants are able to request payments from valid mobile money subscribers and visa/mastercard holders.

Platform Features

Sandbox Environment

This is a utility platform built to allow merchants simulate the workflows of the production/live environment. The sandbox environment offers an API that the merchant integrates first to test the platform and perform UATs. It offers test accounts that the merchant 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 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 from real customers. In order for the merchant 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 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 account accordingly.

Transparency

EllyPay provides a management portal to all merchants. This is the central point to manage your business. It allows for creation of multiple merchant accounts and provides reports for all the activity on the different accounts. It also offers accounts statements to reflect how the merchant balances have changed over time. For every merchant account, API settings can be configured to support the integration.

API Endpoint

The EllyPay API can be accessed using the following base URL;

https://gwapisdbx.ellypayapp.com/

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.