API Reference

Clients can use the MNO Lookup API to derive the specific MNO for the specified MSISDN.

Country Prefix Lookup

Lookup the country dialing code based on the ISO country code.

Country prefix lookup

get

Country dialing code lookup based on ISO country code

Authorizations
Query parameters
countryCodestring · max: 2Optional

ISO Alpha 2 coutry code

Example: NG
Responses
200

successful operation

application/json
get
/lookupCountryPrefix/1.0/
GET /apiman-gateway/PaydServices/lookupCountryPrefix/1.0/ HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "countryName": "South Africa",
    "dialingPrefix": 27,
    "countryCode": "ZA"
  }
]

MNO Lookup

get

Clients can call the MNO Lookup endpoint to derive the specific MNO for the specified MSISDN

Authorizations
Query parameters
clientIdinteger · max: 20Required

This is the unique client ID assigned by Clickatell during the integration process

Example: 111
msisdnstring · max: 32Required

The MSISDN of the customer making the request in international format

Example: 27826740000
countryCallingCodeinteger · min: 1 · max: 999Required

Country calling codes or country dial-in codes are telephone dialing prefixes for the member countries or regions of the International Telecommunication Union (ITU)

Example: 27
clientTxnRefstring · max: 64Optional

Unique client transaction reference. Clients can populate this field if they want to tie an MNO lookup request to a specific transaction reference

Example: 13423423-234234-234234
channelIdinteger · min: 1 · max: 999Optional

The channel is the user interface, platform or service that the buyer used to initiate a purchase from. The following codes are reserved: 1 Point of Sale 2 Internet 3 Mobile 4 ATM 6 SMS 7 USSD 8 WhatsApp

Example: 7
Responses
200

successful operation

application/json
get
/mnoLookup/1.0/
GET /apiman-gateway/PaydServices/mnoLookup/1.0/?clientId=1&msisdn=text&countryCallingCode=1 HTTP/1.1
Host: api-uat.payd.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "msisdn": "27826740000",
    "internationalNumberFormat": "text",
    "countryCallingCode": "27",
    "countryCode": "NG",
    "operatorCode": "SOUVXP",
    "operatorName": "Vodacom",
    "lookupRef": "be061217-5e3f-4492-8ac1-f0c664490f21",
    "clientTxnRef": "13423423-234234-234234",
    "responseCode": "9010",
    "responseMessage": "Unable to identify operator"
  }
]

PreviousMNO Lookup APINextNotifications API

Last updated