Skip to main content
POST
/
api
/
v3
/
customer
/
mobile-money
Create a mobile money customer
curl --request POST \
  --url https://sandbox-api.kotanipay.io/api/v3/customer/mobile-money \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "country_code": "GHA or KE",
  "network": "MPESA or MTN or AIRTEL or VODAFONE",
  "account_name": "<string>"
}
'
{
  "success": true,
  "message": "Customer has been successfully created.",
  "data": {
    "phone_number": "<string>",
    "country_code": "GHA or KE",
    "id": "<string>",
    "network": "MPESA or MTN or AIRTEL or VODAFONE",
    "customer_key": "<string>",
    "account_name": "<string>",
    "integrator": "<string>"
  }
}
An integrator can use this endpoint to create customers who will be either receiving or sending money using mobile money.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
phone_number
string
required
​
country_code
enum<string>
required
Available options:
GHA,
NG,
KE,
ZA,
CIV,
ZM,
CMR,
COD,
SEN,
TZ,
MWI,
UG,
EG,
RW,
US
Example:

"GHA or KE"

​
network
enum<string>
Available options:
MTN,
AIRTEL,
VODAFONE,
TIGO,
ORANGE,
NOT_SUPPORTED,
ZAMTEL,
MPESA,
CHECKOUT,
BKTRX,
CRDTRX,
MOOV,
TMONEY,
FREE,
EXPRESSO,
HALOPESA,
VODACOM,
TNM
Example:

"MPESA or MTN or AIRTEL or VODAFONE"

​
account_name
string

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Customer has been successfully created."

​
data
object