Please wait...

API Overview

Introduction

Are you looking for a simple way to have your clients pay for your goods and services? Are you looking for an efficient way to pay salary and your business clients?

Welcome to the Dibon API Developer Hub. You’ll find comprehensive guides and documentation to help you start working with Dibon API as quickly as possible, as well as support if you get stuck. Let’s jump right in!

The Dibon Payments Platform is designed to help developers integrate third-party applications with Our Payments Platform.

The platform enables you to securely receive and process real-time notifications of transactions made to or by you from various mobile money options including M-Pesa, Airtel Money, card payment options such as VISA and Mastercard.

Features

If you don't have a Dibon account yet, please visit our Sign-up page and create your free account.

Getting started?

Getting started is easy. All you will need is a Payment Product configuration in your Dibon's account. You can have as many products as you wish, and each will be linked to a payment provider (such as Safaricom's M-PESA) through one of their payment channels.

Integration

This documentation is intended to guide third party application developers interact with the Dibon Payments platform in an easy way using HTTP Post and JSON.


HTTP Response Codes

The API will return one of the following HTTP response codes with each request. If the response is anything other than a 200 OK, an API error code and message will also be returned (see API Response Errors, below).

status_code Text description
200 OK Success!
400 Bad Request Requests without all parameters are considered invalid and will yield this response.
401 Unauthorized Missing or incorrect authentication credentials. Invalid Credentials
406 Not Acceptable Returned when Unkown Parameters are on the Request Body.
429 Too Many Requests Returned when a request cannot be served due to the application’s rate limit having been exhausted for the resource.
502 Bad Gateway Dibon API is down or being upgraded.
503 Service Unavailable Dibon servers are up, but overloaded with requests. Try again later.
504 Gateway timeout Dibon servers are up, but the request couldn’t be serviced due to some failure within our stack. Try again later.

Transaction Notifications

Notifications are at the heart of our Payment APIs. They allow you to implement simple endpoints that sit and wait for us to receive payment notifications from the service providers. Once we receive a payment notification, we will process it and send you a simple post request notifying you about the completion of the transaction.

The response from the Dibon API will be a JSON object which your application can process.