Get all operators

The /operators endpoint allows you to retrieve information on any of the 700+ available operators that can be used to make top-ups with the Airtime API

Operators

GET https://topups.reloadly.com/operators

Query Parameters

Name	Type	Description
includeBundles	boolean	Indicates if any airtime and data bundles being offered by the operator should be included in the API response. Default value is true
includeData	boolean	Indicates if any airtime or data plans being offered by the operator should be included in the API response. Default value is true
includePin	boolean	Indicates if PIN details for the operator should be included in the API response. Default value is true
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
size	integer	This indicates the number of operators to be retrieved on a page. Default value is 200
page	integer	This indicates the page of the operator list being retrieved. Default value is 1

Headers

Name	Type	Description
Authorization*	string	Your access token is required as a bearer token in the request's header

200 This response is gotten when a successful request is made and a list of available operators is returned

JSON

{
  "content":[
    {
      "operatorId":88,
      "name":"Movistar Colombia",
      "bundle":false,
      "data":false,
      "pin":false,
      "supportsLocalAmounts":false,
      "denominationType":"RANGE",
      "senderCurrencyCode":"USD",
      "senderCurrencySymbol":"$",
      "destinationCurrencyCode":"COP",
      "destinationCurrencySymbol":"$",
      "commission":4.42,
      "internationalDiscount":4.42,
      "localDiscount":0.00,
      "mostPopularAmount":null,
      "minAmount":5.00,
      "maxAmount":50,
      "localMinAmount":null,
      "localMaxAmount":null,
      "country":{
        "isoName":"CO",
        "name":"Colombia"
      },
      "fx":{
        "rate":2192.1867,
        "currencyCode":"COP"
      },
      "logoUrls":[
        "https://s3.amazonaws.com/rld-operator/3f4a8bcd3268-size-1.png",
        "https://s3.amazonaws.com/rld-operator/3f4a8bcd3268-size-2.png",
        "https://s3.amazonaws.com/rld-operator/3f4a8bcd3268-size-3.png"
      ],
      "fixedAmounts":[
        
      ],
      "fixedAmountsDescriptions":[
        
      ],
      "localFixedAmounts":[
        
      ],
      "localFixedAmountsDescriptions":[
        
      ],
      "suggestedAmounts":[
        7,
        10,
        15,
        20,
        25,
        30,
        35,
        40,
        45,
        50,
        55,
        60,
        65
      ],
      "suggestedAmountsMap":{
        "7":19482.51,
        "10":27832.16,
        "15":41748.23,
        "20":55664.31,
        "25":69580.39,
        "30":83496.46,
        "35":97412.54,
        "40":111328.61,
        "45":125244.69,
        "50":139160.77,
        "55":153076.84,
        "60":166992.92,
        "65":180909.00
      },
      "promotions":[
        
      ]
    }
  ],
  "pageable":{
    "sort":{
      "unsorted":true,
      "sorted":false
    },
    "pageSize":1,
    "pageNumber":0,
    "offset":0,
    "paged":true,
    "unpaged":false
  },
  "totalPages":609,
  "totalElements":609,
  "last":false,
  "sort":{
    "unsorted":true,
    "sorted":false
  },
  "first":true,
  "numberOfElements":3,
  "size":3,
  "number":0
}

401 This response is gotten when an incorrect or expired access token is used to make a request

JSON

{
  "timeStamp":"2021-05-12 08:06:03",
  "message":"Full authentication is required to access this resource",
  "path":"/operators",
  "errorCode":"INVALID_TOKEN",
  "infoLink":null,
  "details":[
    
  ]
}

404 This request is gotten when a request is made to an incorrect URL path

JSON

{
  "timestamp":"2021-05-12T08:00:42.221+0000",
  "status":404,
  "error":"Not Found",
  "message":"No message available",
  "path":"/operator"
}

Request samples

cURL

curl --location --request GET 'https://topups.reloadly.com/operators' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE' \
--header 'Accept: application/com.reloadly.topups-v1+json' 

C#

using System;
using System.Threading.Tasks;
using System.Net.Http;
using System.Text;
using Newtonsoft.Json;

namespace WebAPIClient {
  class Program {

    static async Task Main(string[] args) {
      await ApiCall();
    }

    private static async Task ApiCall() {

      var message = new HttpRequestMessage(HttpMethod.Get, "https://topups.reloadly.com/operators");

      message.Headers.TryAddWithoutValidation("Authorization", "Bearer YOUR_ACCESS_TOKEN_HERE");
      message.Headers.TryAddWithoutValidation("Accept", "application/com.reloadly.topups-v1+json");

      using
      var httpClient = new HttpClient();
      var response = await httpClient.SendAsync(message);
      var responseBody = await response.Content.ReadAsStringAsync();
      var result = JsonConvert.DeserializeObject < dynamic > (responseBody);

      Console.WriteLine(result);
    }

  }
}

Golang

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://topups.reloadly.com/operators"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer YOUR_ACCESS_TOKEN_HERE")
  req.Header.Add("Accept", "application/com.reloadly.topups-v1+json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Java

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://topups.reloadly.com/operators")
  .method("GET", null)
  .addHeader("Authorization", "Bearer YOUR_ACCESS_TOKEN_HERE")
  .addHeader("Accept", "application/com.reloadly.topups-v1+json")
  .build();
Response response = client.newCall(request).execute();

Node JS

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://topups.reloadly.com/operators',
  'headers': {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN_HERE',
    'Accept': 'application/com.reloadly.topups-v1+json',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://topups.reloadly.com/operators',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer YOUR_ACCESS_TOKEN_HERE',
    'Accept: application/com.reloadly.topups-v1+json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Python

import requests
import json

url = "https://topups.reloadly.com/operators"

payload={}
headers = {
  'Authorization': 'Bearer YOUR_ACCESS_TOKEN_HERE',
  'Accept': 'application/com.reloadly.topups-v1+json',
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response parameters

Parameter	Type	Description
id/operatorId	integer	The ID of the operator
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
supports LocalAmounts	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
destinationCurrencyCode	string	Indicates the currency code of the mobile number where the top-up is being sent to
destinationCurrencySymbol	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
localFixed AmountsDescription	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
suggested AmountsMap	string	Indicates the suggested amounts that can be mapped through
promotions	string	Indicates the promotions currently offered by the operator