Skip to content

Commit b658bee

Browse files
Kshitij0307Kshitij0307
authored
Merge pull request #440 from SetuHQ/prepaid-recharge-fixes
Mobile Prepaid Recharge Doc Updates
2 parents 9306cd0 + c160847 commit b658bee

2 files changed

Lines changed: 110 additions & 70 deletions

File tree

‎api-references/payments/billpay/mobile-prepaid-recharge.json‎

Lines changed: 73 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@
127127
"example": "You are not authenticated to perform the requested action.",
128128
"description": "Error message"
129129
},
130-
"traceId": {
130+
"trace_id": {
131131
"type": "string",
132132
"example": "21fc3650-21c3-498a-b83e-543301045fcb",
133133
"description": "Unique identifier for tracing the request"
@@ -138,7 +138,7 @@
138138
"status": 401,
139139
"type": "",
140140
"message": "You are not authenticated to perform the requested action.",
141-
"traceId": "21fc3650-21c3-498a-b83e-543301045fcb"
141+
"trace_id": "21fc3650-21c3-498a-b83e-543301045fcb"
142142
}
143143
}
144144
}
@@ -280,7 +280,7 @@
280280
},
281281
"description": "Details for listing mobile number details required for fetching plans and recharge"
282282
},
283-
"traceId": {
283+
"trace_id": {
284284
"type": "string",
285285
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
286286
"description": "Identifier associated with this response for debug purposes"
@@ -637,61 +637,82 @@
637637
"properties": {
638638
"success": {
639639
"type": "boolean",
640-
"example": "true",
640+
"example": true,
641641
"description": "Status of API call"
642642
},
643643
"data": {
644-
"type": "object",
645-
"properties": {
646-
"plans": {
647-
"type": "array",
648-
"items": {
649-
"type": "object",
650-
"properties": {
651-
"talktime": {
652-
"type": "string",
653-
"example": "0.0",
654-
"description": "Talktime available with plan"
655-
},
656-
"plan_name": {
657-
"type": "string",
658-
"example": "Unlimited Talktime",
659-
"description": "Name of the prepaid plan"
660-
},
661-
"amount": {
662-
"type": "number",
663-
"example": 19900,
664-
"description": "Price of the plan in paise (1/100 of a rupee). For example, 19900 paise = 199 INR."
665-
},
666-
"validity": {
667-
"type": "string",
668-
"example": "28 days",
669-
"description": "Validity period of the plan"
670-
},
671-
"plan_description": {
672-
"type": "string",
673-
"example": "Unlimited calls with 1.5GB/day",
674-
"description": "Details of the plan benefits"
675-
},
676-
"service_provider": {
677-
"type": "string",
678-
"example": "Jio",
679-
"description": "Service Provider"
680-
}
681-
}
644+
"type": "array",
645+
"description": "List of available prepaid plans",
646+
"items": {
647+
"type": "object",
648+
"required": [
649+
"amount",
650+
"plan_name",
651+
"plan_description",
652+
"talktime",
653+
"validity",
654+
"service_provider"
655+
],
656+
"properties": {
657+
"amount": {
658+
"type": "number",
659+
"example": 1000,
660+
"description": "Plan amount"
661+
},
662+
"plan_name": {
663+
"type": "string",
664+
"example": "Talktime (top up voucher)",
665+
"description": "Name of the prepaid plan"
666+
},
667+
"plan_description": {
668+
"type": "string",
669+
"example": "Talktime : Rs 7.47",
670+
"description": "Details of the plan benefits"
671+
},
672+
"talktime": {
673+
"type": "string",
674+
"example": "7.47",
675+
"description": "Talktime available with plan"
676+
},
677+
"validity": {
678+
"type": "string",
679+
"example": "NA",
680+
"description": "Validity period of the plan"
682681
},
683-
"description": "List of available prepaid plans"
682+
"service_provider": {
683+
"type": "string",
684+
"example": "Airtel Prepaid",
685+
"description": "Service provider name"
686+
}
684687
}
685-
},
686-
"description": "Details for listing available plans for the mobile number"
688+
}
687689
},
688-
"traceId": {
690+
"trace_id": {
689691
"type": "string",
690692
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
691693
"description": "Identifier associated with this response for debug purposes"
692694
}
693695
}
694696
}
697+
,
698+
"examples": {
699+
"Fetch Plans": {
700+
"value": {
701+
"success": true,
702+
"data": [
703+
{
704+
"amount": 1000,
705+
"plan_name": "Talktime (top up voucher)",
706+
"plan_description": "Talktime : Rs 7.47",
707+
"talktime": "7.47",
708+
"validity": "NA",
709+
"service_provider": "Airtel Prepaid"
710+
}
711+
],
712+
"trace_id": "dMXpKMx4TBKsu8ro1559WeYZS21Og5"
713+
}
714+
}
715+
}
695716
}
696717
},
697718
"description": "Ok"
@@ -1058,7 +1079,7 @@
10581079
},
10591080
"paymentRefId": {
10601081
"type": "string",
1061-
"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."
1082+
"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."
10621083
},
10631084
"timestamp": {
10641085
"type": "string",
@@ -2382,7 +2403,7 @@
23822403
},
23832404
"description": "Details of the wallet balance"
23842405
},
2385-
"traceId": {
2406+
"trace_id": {
23862407
"type": "string",
23872408
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
23882409
"description": "Identifier associated with this response for debug purposes"
@@ -2560,15 +2581,15 @@
25602581
{
25612582
"required": [
25622583
"success",
2563-
"traceId"
2584+
"trace_id"
25642585
],
25652586
"type": "object",
25662587
"properties": {
25672588
"success": {
25682589
"type": "boolean",
25692590
"example": true
25702591
},
2571-
"traceId": {
2592+
"trace_id": {
25722593
"type": "string",
25732594
"example": "C3SFG0O6N88R6UI7EQ"
25742595
}
@@ -2579,15 +2600,15 @@
25792600
"successAndTracerDetails": {
25802601
"required": [
25812602
"success",
2582-
"traceId"
2603+
"trace_id"
25832604
],
25842605
"type": "object",
25852606
"properties": {
25862607
"success": {
25872608
"type": "boolean",
25882609
"example": true
25892610
},
2590-
"traceId": {
2611+
"trace_id": {
25912612
"type": "string",
25922613
"example": "C3SFG0O6N88R6UI7EQ"
25932614
}

0 commit comments

Comments
 (0)