Skip to main content
POST
/
api
/
v3
/
customer
/
mobile-money
Create a mobile money customer
curl --request POST \
  --url https://sandbox-api.kotanipay.com/api/v3/customer/mobile-money \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phone_number": "<string>",
  "country_code": "GH, KE, NG (or ISO-3: GHA, KEN, NGA)",
  "network": "MPESA or MTN or AIRTEL or VODAFONE",
  "account_name": "<string>",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "1990-01-01",
  "id_number": "123456789",
  "id_type": "NATIONAL_ID",
  "image": "<string>",
  "email": "[email protected]"
}
'
{
  "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": "[email protected]"
  }
}
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
string
required

Country code in ISO-2 format (accepts ISO-3 and auto-converts)

Example:

"GH, KE, NG (or ISO-3: GHA, KEN, NGA)"

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

"MPESA or MTN or AIRTEL or VODAFONE"

​
account_name
string
​
first_name
string
Example:

"John"

​
last_name
string
Example:

"Doe"

​
date_of_birth
string
Example:

"1990-01-01"

​
id_number
string
Example:

"123456789"

​
id_type
enum<string>
Available options:
NATIONAL_ID,
ECOWAS_ID
​
image
string
​
email
string

Response

​
success
boolean
Example:

true

​
message
string
Example:

"Customer has been successfully created."

​
data
object