Skip to main content
POST
/
v2
/
predict-provider
Predict Provider
curl --request POST \
  --url https://api.sandbox.pawapay.io/v2/predict-provider \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "+260 763-456789"
}
'
{
  "country": "ZMB",
  "provider": "MTN_MOMO_ZMB",
  "phoneNumber": "260763456789"
}
Predicts the provider for the specified phone number. 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%.
pen

Authorizations

​
Authorization
string
header
required

See Authentication.

Body

application/json
​
phoneNumber
string
required

The phone number (MSISDN) to predict the provider 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

Provider prediction was completed

​
country
string
required

The country in which the payment was initiated.

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

Required string length: 3
Example:

"ZMB"

​
provider
string
required

The provider represents the mobile money operator or processor that can process payments.

Find here a list of all the supported providers.

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

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

Example:

"MTN_MOMO_ZMB"

​
phoneNumber
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"