Skip to content

Commit d4b10de

Browse files
authored
minor-fix-recharge-status (#232)
1 parent 0343f65 commit d4b10de

File tree

1 file changed

+70
-26
lines changed

1 file changed

+70
-26
lines changed

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

+70-26
Original file line numberDiff line numberDiff line change
@@ -1080,48 +1080,92 @@
10801080
"consumes": ["application/json"],
10811081
"produces": ["application/json"],
10821082
"responses": {
1083-
"200": {
1084-
"content": {
1085-
"application/json": {
1086-
"schema": {
1083+
"200": {
1084+
"content": {
1085+
"application/json": {
1086+
"schema": {
1087+
"type": "object",
1088+
"required": ["success", "data", "trace_id"],
1089+
"properties": {
1090+
"success": {
1091+
"type": "boolean",
1092+
"example": true,
1093+
"description": "Status of API call"
1094+
},
1095+
"data": {
10871096
"type": "object",
1088-
"required": ["success", "data", "trace_id"],
10891097
"properties": {
1090-
"success": {
1091-
"type": "boolean",
1092-
"example": "true",
1093-
"description": "Status of the API call"
1098+
"error": {
1099+
"type": ["string", "null"],
1100+
"example": null,
1101+
"description": "Error details if any, otherwise null"
10941102
},
1095-
"data": {
1103+
"details": {
10961104
"type": "object",
10971105
"properties": {
1098-
"paymentRefId": {
1106+
"mobile_number": {
10991107
"type": "string",
1100-
"example": "TEST62XD4XX04750702202402",
1101-
"description": "Reference ID for the payment transaction"
1108+
"example": "vi",
1109+
"description": "Mobile number associated with the transaction"
11021110
},
1103-
"status": {
1111+
"provider": {
11041112
"type": "string",
1105-
"example": "SUCCESS",
1106-
"description": "Status of the recharge request (e.g., SUCCESS, PENDING, FAILED)"
1113+
"example": "vi",
1114+
"description": "Provider name"
11071115
},
1108-
"operatorResponse": {
1116+
"service_type": {
11091117
"type": "string",
1110-
"example": "Transaction completed successfully",
1111-
"description": "Message returned by the operator for this request"
1118+
"example": "M",
1119+
"description": "Service type (e.g., Mobile)"
1120+
},
1121+
"is_postpaid": {
1122+
"type": "boolean",
1123+
"example": false,
1124+
"description": "Indicates if the mobile number is postpaid"
1125+
},
1126+
"is_special": {
1127+
"type": "boolean",
1128+
"example": false,
1129+
"description": "Indicates if this is a special service"
11121130
}
11131131
},
1114-
"description": "Details of the recharge transaction status"
1132+
"description": "Additional details about the recharge"
11151133
},
1116-
"traceId": {
1134+
"amount": {
1135+
"type": "integer",
1136+
"example": 1900,
1137+
"description": "Recharge amount"
1138+
},
1139+
"transactionRefId": {
11171140
"type": "string",
1118-
"example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5",
1119-
"description": "Identifier associated with this response for debug purposes"
1141+
"example": "CYJSTPM37695672",
1142+
"description": "Unique reference ID for the transaction"
1143+
},
1144+
"status": {
1145+
"type": "string",
1146+
"example": "Success",
1147+
"description": "Status of the recharge transaction"
1148+
},
1149+
"operatorRefId": {
1150+
"type": "string",
1151+
"example": "F3MV358Q19",
1152+
"description": "Reference ID provided by the operator"
11201153
}
1121-
}
1122-
}}},
1123-
"description": "Response indicating the status of the recharge transaction"
1154+
},
1155+
"description": "Details of the recharge transaction"
1156+
},
1157+
"trace_id": {
1158+
"type": "string",
1159+
"example": "cu7it2r6nmjg00e34e8g",
1160+
"description": "Identifier associated with this response for debugging purposes"
1161+
}
11241162
}
1163+
}
1164+
}
1165+
},
1166+
"description": "Ok"
1167+
}
1168+
11251169

11261170
},
11271171
"parameters": [

0 commit comments

Comments
 (0)