⚙️
GovNet Gateway API Documentation
  • Introduction
  • Getting Started
    • Registration
    • Error Handling
    • Authentication
    • Merchant Account Credentials
      • Generate Secret Key
      • Generate New Keys
    • Supported Countries
    • Sandbox Test Accounts
  • Utility Functions
    • Balance Inquiry
    • Payment Options
    • Handling Notifications/Callbacks
      • Callback Events
    • Handling Card Redirects
  • Collections
    • Getting Started
    • Request Mobile Money Payment
    • Request Card Payment
    • Collect For Payment
  • Callbacks & Redirects
    • HMAC Signature Verification
    • RSA Signature Verification
Powered by GitBook
On this page
  • Platform Features
  • Sandbox Environment
  • Production Environment
  • Async Processing
  • Transparency
  • API Endpoint
  • API Versioning

Introduction

The GovBill platform enables businesses and MDAs (Ministries, Departments and Authorities) to process payments across multiple payment options. The document describes the current version of the API.

Welcome to the GovBill API. This API enables businesses and MDAs (herein referred to as merchants) to integrate online payments into their business processes and support payment of government services. Our developer friendly API gives you access to mobile money in Uganda on MTN and Airtel networks as well as Card (Visa and Mastercard). 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 GovBill 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 GovBill 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

GovBill 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 GovBill API can be accessed using the following base URL;

https://gwapisdbx.govbill.ug

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.

API Versioning

GovBill API versioning is handled using a mandatory special header x-api-version which would need to passed for every request made to the API. At the moment, the accepted value is 1 and whenever new versions are enabled, the document will be updated accordingly.

NextRegistration

Last updated 11 months ago