API Documentation
API Documentation
We Provide Online Recharge API Solution for Prepaid Operators like Airtel, Jio, Vi(Vodafone) & Bsnl Service Providers
To use this API, you need an API key.
Please login to your account and navigate to dashboard > API configuration
Learn how to authenticate the APIs.
Use the below endpoint to initiate a new transaction (supports all indian operators)
curl -X POST https://ippocloud.com/api/v1
/recharge/mobile/initiate-transaction
-H "Authorization: Basic bGl2ZV82MzAzZT...."
-H "Content-Type: application/json"
-d "{\"phone_number\":\"734843XXXX\", \"amount\":\"249\",
\"operator_code\":\"RP\", \"reference_id\":\"GlaV64Hla2GFavz\"$url = "https://ippocloud.com/api/v1
/recharge/mobile/initiate-transaction";
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$headers = array(
"Authorization: Basic bGl2ZV82MzAzZT....",
"Content-Type: application/json",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$data = '{"phone_number":"734843XXXX", "amount":"249",
"operator_code":"RP", "reference_id":"GlaV64Hla2GFavz"}';
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);var url = "https://ippocloud.com/api/v1
/recharge/mobile/initiate-transaction";
var xhr = new XMLHttpRequest();
xhr.open("POST", url);
xhr.setRequestHeader("Authorization", "Basic bGl2ZV82MzAzZT....");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.onreadystatechange = function () {
if (xhr.readyState === 4) {
console.log(xhr.status);
console.log(xhr.responseText);
}};
var data = '{"phone_number":"734843XXXX", "amount":"249",
"operator_code":"RP", "reference_id":"GlaV64Hla2GFavz"}';
xhr.send(data);import requests
from requests.structures import CaseInsensitiveDict
url = "https://ippocloud.com/api/v1
/recharge/mobile/initiate-transaction"
headers = CaseInsensitiveDict()
headers["Authorization"] = "Basic bGl2ZV82MzAzZT...."
headers["Content-Type"] = "application/json"
data = '{"phone_number":"734843XXXX", "amount":"249",
"operator_code":"RP", "reference_id":"GlaV64Hla2GFavz"}'
resp = requests.post(url, headers=headers, data=data)
print(resp.status_code)URL url = new URL("https://ippocloud.com/api/v1
/recharge/mobile/initiate-transaction");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Authorization", "Basic bGl2ZV82MzAzZT....");
http.setRequestProperty("Content-Type", "application/json");
String data = "{\"phone_number\":\"734843XXXX\", \"amount\":\"249\",
\"operator_code\":\"RP\", \"reference_id\":\"GlaV64Hla2GFavz\"}";
byte[] out = data.getBytes(StandardCharsets.UTF_8);
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
http.disconnect();var url = "https://ippocloud.com/api/v1
/recharge/mobile/initiate-transaction";
var httpRequest = (HttpWebRequest)WebRequest.Create(url);
httpRequest.Method = "POST";
httpRequest.Headers["Authorization"] = "Basic bGl2ZV82MzAzZT....";
httpRequest.ContentType = "application/json";
var data = "{\"phone_number\":\"734843XXXX\", \"amount\":\"249\",
\"operator_code\":\"RP\", \"reference_id\":\"GlaV64Hla2GFavz\"}";
using (var streamWriter = new StreamWriter(httpRequest.GetRequestStream()))
{
streamWriter.Write(data);
}
var httpResponse = (HttpWebResponse)httpRequest.GetResponse();
using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
var result = streamReader.ReadToEnd();
}
Console.WriteLine(httpResponse.StatusCode);{
"data": {
"entity": "mobile_recharge",
"transaction_id": 824023,
"operator": "Jio",
"type": "MOBILE",
"number": "734843XXXX",
"bill_amount": "₹249.00",
"discount": "₹8.70",
"paid": "₹240.30",
"transaction_status": "SUCCESS",
"reference_id": "GlaV64Hla2GFavz",
"datetime": "2022-10-02 02:28:48"
}
}| phone_number mandatory |
string 10 digits phone Number. For example, 734843XXXX |
| amount mandatory |
integer Amount to recharge. you can also use our recharge plans api to find appropriate amount for the operator |
| operator_code mandatory |
string The unique two-digit code of the operator. For example, RP |
| reference_id optional |
string a unique identifier assigned for the transaction by client. |
| data | object contains all the details such entity, transaction_id, operator, type, number |
| entity | string something that exists separately from something else and has its own identity |
| transaction_id | integer Unique transaction ID assigned by system for every transaction |
| operator | string Operator name |
| type | string Transaction type MOBILE |
| number | string 10 digits phone number 734843XXXX |
| bill_amount | string Recharged amount |
| discount | string Discount is an amount that you've received for making this transaction |
| paid | string Net amount that you've paid for this transaction after subtracted discount amount with bill amount |
| transaction_status | string Returns the transaction status
|
| reference_id | string a unique identifier assigned for the transaction by client |
| datetime | string current datetime of the transaction |
Operator code is a unique number assigned to every telecommunications operator
Operator Name |
Operator Code |
Range |
|---|---|---|
| Airtel | AT |
₹10 - 2500 |
| Vi | VI |
₹10 - 5000 |
| BSNL | BS |
₹10 - 2000 |
| Jio | RJ |
₹10 - 4999 |
Webhooks let you build or set up integrations that subscribe to certain events. When one of these events is triggered, we send an HTTP POST payload in JSON to the webhook's configured URL
To configure WebhooK URL, Please login to your account and navigate to dashboard > API configuration
Whenever the transaction status changed from PENDING to SUCCESS or FAILED, we will send an HTTP POST payload in JSON to the webhook's configured URL
Webhooks deliver the responses to your configured URL in JSON format. here's what a complete payload looks like when it's delivered to a webhook:
{
"data": {
"entity": "webhook",
"webhook_event": "event.mobile_recharge",
"webhook_password": "UzmyhfRVBAL0RAG",
"payload": {
"entity": "mobile_recharge",
"transaction_id": 824023,
"operator": "Jio",
"type": "MOBILE",
"number": "734843XXXX",
"bill_amount": "₹249.00",
"discount": "₹8.70",
"paid": "₹240.30",
"transaction_status": "SUCCESS",
"reference_id": "GlaV64Hla2GFavz",
"datetime": "2022-10-02 02:28:48"
}
}
}