Auto-detect an operator
With the /operators/auto-detect/phone/{phone}/countries/{iso}
endpoint, a user can retrieve the operator details of a mobile number and the ISO code of the country where the mobile number is registered
Auto-detect operator
GET
https://topups.reloadly.com/operators/auto-detect/phone/{phone}/countries/{countryisocode}
Path Parameters
countryIsoCode*
string
The ISO code of the country where the mobile number is registered
phone*
string
The mobile number whose operator is to be auto-detected
Query Parameters
suggested AmountsMap
boolean
Indicates if the suggestedAmountsMap
field should be returned. Default value is false
suggested Amounts
boolean
Indicates if the suggestedAmounts
field should be returned. Default value is false
Headers
Authorization*
string
Your access token is required as a bearer token in the request's header
Request samples
Response parameters
Parameter
Type
Description
id/operatorId
integer
This indicates the operator's ID
name
string
The operator's name
bundle
boolean
Indicates if the operator has any existing bundle plans
data
boolean
Indicates if the operator has any existing data plans
pin
boolean
Indicates if the operator supports PIN transactions
supportsLocal
Amounts
boolean
Indicates if the operator can make top-ups in local amounts
denominationType
string
Indicates if the operator makes top-ups through a fixed amount or a range of amounts. Options include FIXED
and RANGE
senderCurrencyCode
string
Indicates the currency code of the account where the top-up is being made from
senderCurrency
Symbol
string
Indicates the currency symbol of the account where the top-up is being made from
destination
CurrencyCode
string
Indicates the currency code of the mobile number where the top-up is being sent to
destination
CurrencySymbol
string
Indicates the currency symbol of the mobile number where the top-up is being sent to
commission
integer
Indicates if the operator offers a commission or discount
international
Discount
integer
Indicates if the operator offers a discount for top-ups made to foreign numbers
localDiscount
integer
Indicates if the operator offers a discount for top-ups made to local numbers
mostPopularAmount
integer
Indicates the amount that is often used to make a top-up
mostPopular
LocalAmount
integer
Indicates the amount that is often used to make a top-up locally
minAmount
integer
Indicates the minimum amount that can be used to make a top-up
maxAmount
integer
Indicates the maximum amount that can be used to make a top-up
localMinAmount
integer
Indicates the minimum amount that can be used to make a top-up locally
localMaxAmount
integer
Indicates the maximum amount that can be used to make a top-up locally
isoName
string
Indicates the country's ISO code
name
string
Indicates the country's name
rate
integer
Indicates the FX rate at which the top-up will be made
currencyCode
string
Indicates the code of the currency at which the top-up will be made
logoURLs
string
These are links to SVG images of the operator's logos
fixedAmounts
integer
Indicates the fixed amounts that a top-up can be made in with the operator
fixedAmounts
Description
string
Indicates the descriptions for the operator's fixed amounts
localFixedAmounts
integer
Indicates the local fixed amounts that a top-up can be made in with the operator
localFixedAmounts
Description
string
Indicates the descriptions for the operator's local fixed amounts
suggestedAmounts
integer
Indicates the suggested amounts that can be used to make a top-up with the operator
suggestedAmounts
Map
string
Indicates the suggested amounts that can be mapped through
promotions
string
Indicates the promotions currently offered by the operator
Last updated
Was this helpful?