Introduction

Find out how to accept fast and secured Mobile Money payments with Chipdeals.

We wrote this documentation assuming that you are familiar with the principles of APIs and that you can perform queries. If you are new to the world of APIs, you should check out our article on API basics.

The basics

Our APIs give you access to virtually every feature you can use to develop your products to accept or make Mobile Money payments online

Supported operations

The Chipdeals API supports receiving funds from Mobile Money accounts and credit cards. It also allows the transfer of funds from your balance to Mobile Money accounts in the same receiving country.

To understand how to receive payments, read the documentation on how to accept payments.

To understand how to make payments, read the documentation on how to make payments

Before you do anything

You must create a free Chipdeals account. This will give you your test API keys to perform transactions.

Request Examples

We provide sample requests to our APIs using cURL. Just insert your own parameters and you can test queries from your command line. Check out this tutorial on using cURL with APIs

You can also use Postman if you are unfamiliar with cURL. Postman is an easy-to-use API development environment for making HTTP requests. Postman collections are available to start your tests with more ease.

You can also use REST Client if you are using the VSCode development environment. REST Client is a downloadable plugin to facilitate your HTTP requests directly from VSCode.

After installing the extension, download our .http file and open it in VSCode to directly start the tests with ready-to-use queries.

Responses format

Request data and response data are in JSON format. The content type for responses will always be application/json. Generally, all responses will be in the following format:

Response format

{
  "success": [boolean], // true only when your request has been validated
  "message": [string], //  Details of an operation. Usually empty.
  "errorCode": [string], //  Present only when the success property is false
  "anyObject": [array or object] // According to the request we add specific data
}

While we generally recommend developers use HTTP status codes provided in the header of each response to determine the outcome of a request, we've also provided a success property to let you know if the request was successful. treated or not.

The message property is a string that will contain a summary of the response and its status. For example, when trying to retrieve a transaction list, the message might say "Transactions Recovered." If there is an error, the message property will contain a description of the error.

The anyobject property is where you will find the result of your query. It can be either an object or an array depending on the query performed. For example, a request to retrieve a single transaction will return a transaction object in a transaction property, while the property would contain an array of transactions if a list is requested instead.

anyObject may vary depending on the query. For example for a query of your balance, anyObject becomes balances. On the other hand if it is your transactions that you are trying to recover, anyObject becomes transactions