
Employers can use the GSMA API specification to distribute salaries to their employees.
This is particular useful in countries where there is a large uptake of mobile money and where employees value the convenience of receiving their salaries directly in their mobile phones.
The Disbursement Mobile Money APIs allow organisations to disburse funds to mobile money recipients.
For further reading, please refer to the following:
All documentation can be found on the GSMA Mobile Money API Developer Portal.
| Audience | Usage | Role |
|---|---|---|
| Mobile Money Providers | To understand how to implement the Mobile Money API to allow organisations to disburse payments in singular and in bulk. | API Provider |
| NGOs | To understand how to implement the Mobile Money API to provide aid payments to mobile money recipients. | API Consumer |
| Government Departments | To understand how to implement the Mobile Money API to provide social credit payments to mobile money recipients. | API Consumer |
| Employers | To understand how to implement the Mobile Money API to provide salary payments to mobile money recipients. | API Consumer |
This diagram illustrates an individual disbursement using an asynchronous flow with the notification provided via a callback.
In this example, an asynchronous flow is used with a final callback that contains the reason for failure.
This diagram illustrates the flow for a ‘one-shot’ bulk disbursement.
In this example, an asynchronous flow is used with a final callback that contains the reason for failure to process the bulk request.
This flow allows a bulk request to be processed in two steps. The first step involves the ‘maker’ system loading the request into the mobile money provider. The second step involves the ‘checker’ system approving the request.
In this diagram, an asynchronous flow is used with the polling method. The client polls against the request state object to determine the outcome of the individual disbursement request.
In some failure scenarios, a organisation may need to reverse an individual disbursement transaction. This diagram illustrates a reversal with the final result communicated via the callback.
This diagram illustrates use of a cursor mechanism to retrieve all transactions for a disbursement organisation via multiple requests.
The Heartbeat API is used for monitoring purposes and establishes whether the mobile money provider is in a state that enables a client to submit a request for processing.
This API can be used by the disbursement organisation to retrieve a link to the final representation of the resource for which it attempted to create. Use this API when a callback is not received from the mobile money provider.