Get Mobile Top Up Catalog

With the Get Mobile Top Up Catalog API, you can retrieve a curated list of available operators and the plans.

Filter Reference Table

KeyValue TypeDescription
productNameStringProduct names to be included
countryStringCountries to be included
priceStringPrice range filters to be included
minPriceStringMaximum price of the products looked for
currencyCodeStringCurrency codes to be included
deliveryTypeStringDelivery type to the voucher (realtime or delayed)

Get Voucher API Schema

ParameterTypeDescription
limitIntNumber of results to return per page (used for pagination).
pageIntPage number of results to fetch when using pagination.
includeProductsStringComma-separated list of product IDs to explicitly include in the response.
excludeProductsStringComma-separated list of product IDs to explicitly exclude from the response.
sortSortDataSorting configuration (e.g., by price, name, popularity).
sort.fieldStringThe field name to sort by (e.g., "name")
sort.orderStringSorting order → "ASC" for ascending or "DESC" for descending.
filtersArray of ObjectList of filters to apply. Each filter object should contain a key and value.
filters.keyStringThe filter key (e.g., country, currency, product_category).
filters.valueStringThe filter value corresponding to the key (e.g., IN, USD, Electronics).

Filter Reference Table

KeyValue TypeDescription
productNameStringProduct names to be included
countryStringCountries to be included
priceStringPrice range filters to be included
minPriceStringMinimum price of the products looked for
maxPriceStringMaximum price of the products looked for
currencyCodeStringCurrency codes to be included
deliveryTypeStringDelivery type to the voucher (realtime or delayed

Implementation Notes

  1. To fetch exchangeRate in the GetVouchersAPI, pass "exchangeRate": 1 in the request body
  2. To fetch the list of filters, use GetFiltersAPI
  3. To fetch the list of mobile top-up operators, pass "categoryType": "topup" in the GetVouchersAPI request body.
  4. To fetch the list of operators under a specific mobile top-up product, pass both "categoryType": "topup" and "parentProductId": "" in the request body — where is the ID received when fetching products with "categoryType": "topup".
  5. If the value type for a product is "open_value", please refer to the "minValue" and the "maxValue" parameters
  6. The values passed in the "fee" and "discount" parameters are in percentage (%)
  7. We recommend you cache the response from GetVouchersAPI in your database every time you sync our catalog
  8. Use filters “minPrice” and “maxPrice” along with “currencyCode”, as this allows you to search prices with respect to a specific currency. If "currencyCode" code is not added, the filter will be applicable for all currencies.

Learn about Error Handling, Rate limiting and Best Practice .

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!