post https://accounts.xoxoday.com/chef/v1/oauth/api/
With the Get Mobile Top Up Catalog API, you can retrieve a curated list of available operators and the plans.
Filter Reference Table
Key | Value Type | Description |
---|---|---|
productName | String | Product names to be included |
country | String | Countries to be included |
price | String | Price range filters to be included |
minPrice | String | Maximum price of the products looked for |
currencyCode | String | Currency codes to be included |
deliveryType | String | Delivery type to the voucher (realtime or delayed) |
Get Voucher API Schema
Parameter | Type | Description |
---|---|---|
limit | Int | Number of results to return per page (used for pagination). |
page | Int | Page number of results to fetch when using pagination. |
includeProducts | String | Comma-separated list of product IDs to explicitly include in the response. |
excludeProducts | String | Comma-separated list of product IDs to explicitly exclude from the response. |
sort | SortData | Sorting configuration (e.g., by price, name, popularity). |
sort.field | String | The field name to sort by (e.g., "name") |
sort.order | String | Sorting order → "ASC" for ascending or "DESC" for descending. |
filters | Array of Object | List of filters to apply. Each filter object should contain a key and value. |
filters.key | String | The filter key (e.g., country , currency , product_category ). |
filters.value | String | The filter value corresponding to the key (e.g., IN , USD , Electronics ). |
Filter Reference Table
Key | Value Type | Description |
---|---|---|
productName | String | Product names to be included |
country | String | Countries to be included |
price | String | Price range filters to be included |
minPrice | String | Minimum price of the products looked for |
maxPrice | String | Maximum price of the products looked for |
currencyCode | String | Currency codes to be included |
deliveryType | String | Delivery type to the voucher (realtime or delayed |
Implementation Notes
- To fetch exchangeRate in the GetVouchersAPI, pass "exchangeRate": 1 in the request body
- To fetch the list of filters, use GetFiltersAPI
- To fetch the list of mobile top-up operators, pass "categoryType": "topup" in the GetVouchersAPI request body.
- 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".
- If the value type for a product is "open_value", please refer to the "minValue" and the "maxValue" parameters
- The values passed in the "fee" and "discount" parameters are in percentage (%)
- We recommend you cache the response from GetVouchersAPI in your database every time you sync our catalog
- 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 .