Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Customer has been successfully created.",
"data": {
"phone_number": "<string>",
"country_code": "GH, KE, NG (or ISO-3: GHA, KEN, NGA)",
"id": "<string>",
"network": "MPESA or MTN or AIRTEL or VODAFONE",
"customer_key": "<string>",
"account_name": "<string>",
"integrator": "<string>",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1990-01-01",
"id_number": "123456789",
"id_type": "NATIONAL_ID",
"image": "<string>",
"email": "john.doe@example.com"
}
}{
"success": false,
"message": "Bad Request",
"data": {}
}{
"success": false,
"message": "Unauthorized",
"data": {}
}Customer Management
Create Mobile Money Customer
An integrator can use this endpoint to create the customers who will be either receiving or sending money using mobile money.
POST
/
api
/
v3
/
customer
/
mobile-money
Error
A valid request URL is required to generate request examples{
"success": true,
"message": "Customer has been successfully created.",
"data": {
"phone_number": "<string>",
"country_code": "GH, KE, NG (or ISO-3: GHA, KEN, NGA)",
"id": "<string>",
"network": "MPESA or MTN or AIRTEL or VODAFONE",
"customer_key": "<string>",
"account_name": "<string>",
"integrator": "<string>",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1990-01-01",
"id_number": "123456789",
"id_type": "NATIONAL_ID",
"image": "<string>",
"email": "john.doe@example.com"
}
}{
"success": false,
"message": "Bad Request",
"data": {}
}{
"success": false,
"message": "Unauthorized",
"data": {}
}An integrator can use this endpoint to create customers who will be either receiving or sending money using mobile money.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Country code in ISO-2 format (accepts ISO-3 and auto-converts)
Example:
"GH, KE, NG (or ISO-3: GHA, KEN, NGA)"
Available options:
MTN, AIRTEL, VODAFONE, TIGO, YAS, ORANGE, NOT_SUPPORTED, ZAMTEL, MPESA, CHECKOUT, BKTRX, CRDTRX, MOOV, TMONEY, FREE, EXPRESSO, HALOPESA, VODACOM, WAVE Example:
"MPESA or MTN or AIRTEL or VODAFONE"
Example:
"John"
Example:
"Doe"
Example:
"1990-01-01"
Example:
"123456789"
Available options:
NATIONAL_ID, ECOWAS_ID Example:
"john.doe@example.com"