POST
/
v1
/
predict-correspondent
Predict Correspondent
curl --request POST \
  --url https://api.sandbox.pawapay.io/v1/predict-correspondent \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "msisdn": "+260 763-456789"
}'
{
  "country": "ZMB",
  "operator": "MTN",
  "correspondent": "MTN_MOMO_ZMB",
  "msisdn": "260763456789"
}
Predicts the correspondent (Mobile Money Operator) for the specified phone number (MSISDN). Average misprediction rate when using this endpoint is 0.12%.
Benin has a relatively high level of number portability and therefore has an average misprediction rate of 6%.

Authorizations

​
Authorization
string
header
required

See Authentication.

Body

application/json
​
msisdn
string
required

The phone number (MSISDN) to predict the correspondent of. Must contain the country code.

The input will be sanitized by:

  • removing the leading + sign
  • removing all whitespace
  • removing non-numeric characters
Example:

"+260 763-456789"

Response

Correspondent prediction was successful

​
country
string
required

The country in which the MMO operates.

Format is ISO 3166-1 alpha-3, three character country code in upper case. Read more from Wikipedia.

Example:

"ZMB"

​
operator
string
required

The name of the MMO associated with the specified MSISDN.

Example:

"MTN"

​
correspondent
string
required

The correspondent code refers to the specific MMO that the specified phone number (MSISDN) has an active mobile money wallet with.

You can find all the supported correspondents listed here.

The active configuration endpoint provides the list of correspondents configured for your account.

You can use the predict correspondent enpoint to predict the correct correspondent to use based on the phone number (MSISDN).

Example:

"MTN_MOMO_ZMB"

​
msisdn
string
required

The correctly formatted phone number (MSISDN) from your original request that is in a valid format for the rest of the pawaPay Merchant API.

Example:

"260763456789"