Skip to content

Mobile Prepaid Recharge Doc Updates #440

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Kshitij0307 merged 3 commits into from
Apr 27, 2026
Merged

Mobile Prepaid Recharge Doc Updates #440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
368fcf8
Mobile Prepaid Recharge Doc Updates
pragati-setu Apr 24, 2026
d2feb3e
Fix trace_id formatting
pragati-setu Apr 24, 2026
c160847
Update webhook description
pragati-setu Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 73 additions & 52 deletions api-references/payments/billpay/mobile-prepaid-recharge.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
"example": "You are not authenticated to perform the requested action.",
"description": "Error message"
},
"traceId": {
"trace_id": {
"type": "string",
"example": "21fc3650-21c3-498a-b83e-543301045fcb",
"description": "Unique identifier for tracing the request"
Expand All @@ -138,7 +138,7 @@
"status": 401,
"type": "",
"message": "You are not authenticated to perform the requested action.",
"traceId": "21fc3650-21c3-498a-b83e-543301045fcb"
"trace_id": "21fc3650-21c3-498a-b83e-543301045fcb"
}
}
}
Expand Down Expand Up @@ -280,7 +280,7 @@
},
"description": "Details for listing mobile number details required for fetching plans and recharge"
},
"traceId": {
"trace_id": {
"type": "string",
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
"description": "Identifier associated with this response for debug purposes"
Expand Down Expand Up @@ -637,61 +637,82 @@
"properties": {
"success": {
"type": "boolean",
"example": "true",
"example": true,
"description": "Status of API call"
},
"data": {
"type": "object",
"properties": {
"plans": {
"type": "array",
"items": {
"type": "object",
"properties": {
"talktime": {
"type": "string",
"example": "0.0",
"description": "Talktime available with plan"
},
"plan_name": {
"type": "string",
"example": "Unlimited Talktime",
"description": "Name of the prepaid plan"
},
"amount": {
"type": "number",
"example": 19900,
"description": "Price of the plan in paise (1/100 of a rupee). For example, 19900 paise = 199 INR."
},
"validity": {
"type": "string",
"example": "28 days",
"description": "Validity period of the plan"
},
"plan_description": {
"type": "string",
"example": "Unlimited calls with 1.5GB/day",
"description": "Details of the plan benefits"
},
"service_provider": {
"type": "string",
"example": "Jio",
"description": "Service Provider"
}
}
"type": "array",
"description": "List of available prepaid plans",
"items": {
"type": "object",
"required": [
"amount",
"plan_name",
"plan_description",
"talktime",
"validity",
"service_provider"
],
"properties": {
"amount": {
"type": "number",
"example": 1000,
"description": "Plan amount"
},
"plan_name": {
"type": "string",
"example": "Talktime (top up voucher)",
"description": "Name of the prepaid plan"
},
"plan_description": {
"type": "string",
"example": "Talktime : Rs 7.47",
"description": "Details of the plan benefits"
},
"talktime": {
"type": "string",
"example": "7.47",
"description": "Talktime available with plan"
},
"validity": {
"type": "string",
"example": "NA",
"description": "Validity period of the plan"
},
"description": "List of available prepaid plans"
"service_provider": {
"type": "string",
"example": "Airtel Prepaid",
"description": "Service provider name"
}
}
},
"description": "Details for listing available plans for the mobile number"
}
},
"traceId": {
"trace_id": {
"type": "string",
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
"description": "Identifier associated with this response for debug purposes"
}
}
}
,
"examples": {
"Fetch Plans": {
"value": {
"success": true,
"data": [
{
"amount": 1000,
"plan_name": "Talktime (top up voucher)",
"plan_description": "Talktime : Rs 7.47",
"talktime": "7.47",
"validity": "NA",
"service_provider": "Airtel Prepaid"
}
],
"trace_id": "dMXpKMx4TBKsu8ro1559WeYZS21Og5"
}
}
}
}
},
"description": "Ok"
Expand Down Expand Up @@ -1058,7 +1079,7 @@
},
"paymentRefId": {
"type": "string",
"description": "Unique reference ID for the payment transaction. This must be unique for each transaction and is used for status checks.Must be a alphanumeric string with length between 5 and 30 characters."
"description": "Unique reference ID for the payment transaction. This must be unique for each transaction and is used for status checks.Must be a alphanumeric string with length between 6 and 30 characters."
},
"timestamp": {
"type": "string",
Expand Down Expand Up @@ -2382,7 +2403,7 @@
},
"description": "Details of the wallet balance"
},
"traceId": {
"trace_id": {
"type": "string",
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
"description": "Identifier associated with this response for debug purposes"
Expand Down Expand Up @@ -2560,15 +2581,15 @@
{
"required": [
"success",
"traceId"
"trace_id"
],
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"traceId": {
"trace_id": {
"type": "string",
"example": "C3SFG0O6N88R6UI7EQ"
}
Expand All @@ -2579,15 +2600,15 @@
"successAndTracerDetails": {
"required": [
"success",
"traceId"
"trace_id"
],
"type": "object",
"properties": {
"success": {
"type": "boolean",
"example": true
},
"traceId": {
"trace_id": {
"type": "string",
"example": "C3SFG0O6N88R6UI7EQ"
}
Expand Down
Loading
Loading