get https://ssl.hot.co.zw/api/v3/products/
Get a list of Products available on the API
Overview
This method allows for one to query the API for the list of available products in the Hot Recharge system. The ProductId parameter can be provided to filter displayed product options. The API returns a list of all products when ProductId is not provided in the path or ProductId is "0".
{
"products": [
{
"productId": 100,
"name": "Airtime USD",
"accountTypeId": 3,
"requiredOptions": [],
"metaData": {
"TargetInfo": "The Target is the Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "300",
"TargetType": "Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "UndefinedCellular",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 101,
"name": "Econet USD Airtime",
"accountTypeId": 3,
"requiredOptions": [],
"metaData": {
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "300",
"TargetType": "Econet Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 102,
"name": "NetOne USD Airtime",
"accountTypeId": 3,
"requiredOptions": [],
"metaData": {
"AccountQuery": "Can query end user account balances",
"TargetInfo": "The Target is the Netone Mobile Number to recharge",
"RechargeType": "Partial Pinless",
"MinimumRecharge": "0.50",
"MaxRecharge": "300",
"TargetType": "Netone Mobile Number",
"StockQuery": "Can query available denominations",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "NetOne",
"NetworkPrefix": "71"
}
},
{
"productId": 103,
"name": "Telecel USD Airtime",
"accountTypeId": 3,
"requiredOptions": [],
"metaData": {
"AccountQuery": "Can query end user account balances",
"TargetInfo": "The Target is the Telecel Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "300",
"TargetType": "Telecel Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "Telecel",
"NetworkPrefix": "73",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 110,
"name": "Airtime ZiG",
"accountTypeId": 1,
"requiredOptions": [],
"metaData": {
"TargetInfo": "The Target is the Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "200000",
"TargetType": "Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "ZiG",
"Network": "UndefinedCellular",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 111,
"name": "Econet USD Data&Bundles",
"accountTypeId": 3,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Pinless",
"StockQuery": "Can query available data bundles",
"TargetType": "Econet Mobile Number",
"Currency": "USD",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 3,
"name": "Econet USD ",
"accountTypeId": 3,
"requiredOptions": [],
"metaData": {
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "300",
"StockQuery": "Can query available data bundles",
"TargetType": "Econet Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 4,
"name": "Econet Sasai",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Data",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Econet Mobile Number",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 6,
"name": "Telecel Airtime",
"accountTypeId": 1,
"requiredOptions": [],
"metaData": {
"TargetInfo": "The Target is the Telecel Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "200000",
"TargetType": "Telecel Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "ZiG",
"Network": "Telecel",
"NetworkPrefix": "73",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 7,
"name": "Econet Airtime",
"accountTypeId": 1,
"requiredOptions": [],
"metaData": {
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "200000",
"AccountQuery": "Can query end user account balances",
"TargetType": "Econet Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 11,
"name": "Telecel USD",
"accountTypeId": 3,
"requiredOptions": [],
"metaData": {
"AccountQuery": "Can query end user account balances",
"TargetInfo": "The Target is the Telecel Mobile Number to recharge",
"RechargeType": "Pinless",
"MinimumRecharge": "0.10",
"MaxRecharge": "300",
"TargetType": "Telecel Mobile Number",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "Telecel",
"NetworkPrefix": "73",
"RechargeTypeInformation": "Airtime"
}
},
{
"productId": 15,
"name": "Nyaradzo",
"accountTypeId": 2,
"requiredOptions": [
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"AccountQuery": "Can query Nyaradzo account details",
"TargetInfo": "The Target is the Policy Number for payment",
"RechargeType": "Utility",
"MinimumRecharge": "10",
"MaxRecharge": "10000000",
"Description": "This product is for Nyaradzo and to pay Funeral policy subscriptions",
"TargetType": "Nyaradzo Policy Number",
"RechargeAmountIncrement": "0.01",
"Currency": "ZiG",
"Network": "Nyaradzo",
"RechargeTypeInformation": "Utilities & Account Payments"
}
},
{
"productId": 16,
"name": "Econet Data",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Data",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Econet Mobile Number",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 17,
"name": "Econet WhatsApp",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Data",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Econet Mobile Number",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 18,
"name": "Econet Facebook",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Data",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Econet Mobile Number",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 19,
"name": "Econet Instagram",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Data",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Econet Mobile Number",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 20,
"name": "Econet Twitter",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
},
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Econet Mobile Number to recharge",
"RechargeType": "Data",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Econet Mobile Number",
"Currency": "ZiG",
"Network": "Econet",
"NetworkPrefix": "77",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 24,
"name": "ZETDC",
"accountTypeId": 2,
"requiredOptions": [
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"CustomSMSTagAccountName": "%ACOUNTNAME% - Account name of ZETDC Customer - available to use with product in a the CustomSMS string for a recharge",
"AccountQuery": "Can query ZETDC Meter account Details",
"TargetInfo": "The target is the 11 digit ZETDC Meter Number",
"MinimumRecharge": "10000",
"MaxRecharge": "10000000",
"RechargeType": "Utility",
"TargetType": "ZESA Meter Number",
"CustomSMSTagKwh": "%KWH% - Units for ZETDC Purchase - available to use with product in a the CustomSMS string for a recharge",
"CustomSMSTagMeterNumber": "%METERNUMBER% - ZETDC Customer meter number - available to use with product in a the CustomSMS string for a recharge ",
"RechargeAmountIncrement": "0.01",
"Currency": "ZiG",
"Network": "ZESA",
"RechargeTypeInformation": "Utilities & Account Payments"
}
},
{
"productId": 30,
"name": "Telone Voice",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "int",
"description": "ProductCode of the Telone bundle to recharge"
},
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Account Number or Telone number to credit",
"RechargeType": "Data",
"AccountQuery": "Can query Telone Account Details",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Telone Number",
"Currency": "ZiG",
"Network": "Telone",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 31,
"name": "Telone Broadband",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "int",
"description": "ProductCode of the Telone bundle to recharge"
},
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Account Number or Telone number to credit",
"RechargeType": "Data",
"AccountQuery": "Can query Telone Account Details",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Telone Number",
"Currency": "ZiG",
"Network": "Telone",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 32,
"name": "Telone LTE",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "int",
"description": "ProductCode of the Telone bundle to recharge"
},
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Account Number or Telone number to credit",
"RechargeType": "Data",
"AccountQuery": "Can query Telone Account Details",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Telone Number",
"Currency": "ZiG",
"Network": "Telone",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 33,
"name": "Telone Voip",
"accountTypeId": 1,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "int",
"description": "ProductCode of the Telone bundle to recharge"
},
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Account Number or Telone number to credit",
"RechargeType": "Data",
"AccountQuery": "Can query Telone Account Details",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Telone Number",
"Currency": "ZiG",
"Network": "Telone",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 35,
"name": "Netone USD",
"accountTypeId": 3,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "string",
"description": "ProductCode for the bundle to recharge"
}
],
"metaData": {
"AccountQuery": "Can query end user account balances",
"TargetInfo": "The Target is the Netone Mobile Number to recharge",
"RechargeType": "Partial Pinless",
"MinimumRecharge": "0.50",
"MaxRecharge": "300",
"TargetType": "Netone Mobile Number",
"StockQuery": "Can query available denominations",
"Currency": "USD",
"Network": "NetOne",
"NetworkPrefix": "71"
}
},
{
"productId": 40,
"name": "Telone USD",
"accountTypeId": 3,
"requiredOptions": [
{
"name": "ProductCode",
"parameterType": "int",
"description": "ProductCode of the Telone bundle to recharge"
}
],
"metaData": {
"StockQuery": "Can query available data bundles",
"TargetInfo": "The Target is the Account Number or Telone number to credit",
"RechargeType": "Data",
"AccountQuery": "Can query Telone Account Details",
"CustomSMSTagBundle": "%BUNDLE% - Data Bundle Name - available to use with product in a the CustomSMS string for a recharge set by the API caller",
"TargetType": "Telone Number",
"Currency": "USD",
"Network": "Telone",
"RechargeTypeInformation": "Data & Bundles"
}
},
{
"productId": 41,
"name": "ZETDC USD",
"accountTypeId": 4,
"requiredOptions": [
{
"name": "NotifyNumber",
"parameterType": "string",
"description": "Mobile Number to notify of transaction"
}
],
"metaData": {
"CustomSMSTagAccountName": "%ACOUNTNAME% - Account name of ZETDC Customer - available to use with product in a the CustomSMS string for a recharge",
"AccountQuery": "Can query ZETDC Meter account Details",
"TargetInfo": "The target is the 11 digit ZETDC Meter Number",
"MinimumRecharge": "5",
"MaxRecharge": "10000",
"RechargeType": "Utility",
"TargetType": "ZESA Meter Number",
"CustomSMSTagKwh": "%KWH% - Units for ZETDC Purchase - available to use with product in a the CustomSMS string for a recharge",
"CustomSMSTagMeterNumber": "%METERNUMBER% - ZETDC Customer meter number - available to use with product in a the CustomSMS string for a recharge",
"RechargeAmountIncrement": "0.01",
"Currency": "USD",
"Network": "ZESA",
"RechargeTypeInformation": "Utilities & Account Payments"
}
}
]
}
{
"products": []
}
Product Model
| Field name | Type | Description |
|---|---|---|
| ProductId | int | The Id of product |
| Name | string | Product name e.g. Econet USD |
| AccountTypeId | int | The AccountTypeId of the account that will be charge for purchases of the product |
| RequiredOptions | List of Recharge Options | Additional required fields to be added in a recharge request for the product |
| MetaData | Array of Meta Data e.g “parameter”:”value” | Additional information about the product that can help with understanding the product. |
Required Options
Additional required fields to be added in a recharge request for the product
| Field name | Type | Description |
|---|---|---|
| Name | string | Name of the required option |
| ParameterTypeId | string | Data type name eg. int, string, decimal |
| Description | string | A description of the requirements of this option |
Required Option Example
"RequiredOptions":
[
{
"Name":"ProductCode",
"ParameterTypeId":"string",
"Description":"Product code use in data bundle"
}
]
Meta Data
Additional information about the product that can help with understanding the product.
| Field name | Type | Description |
|---|---|---|
| Name | string | Name of the meta information |
| Data | string | Meta data information |
Meta Data Example
"Meta":
{
"TargetInfo":"The Target is the Mobile Number to recharge",
"RechargeType":"Data"
}
Parameter: ProductId
For TestingThe ProductId parameter below is listed as required but is it optional on the API. When the API returns a list of all products when ProductId is not provided in the path.
Example Product Ids
ProductId Products Returned 0 Returns all products 7 Returns Econet Product