From 89964b4c7d8b3111d6d43d9e597a151695c001b0 Mon Sep 17 00:00:00 2001 From: arppp Date: Tue, 21 Jan 2025 11:00:06 +0530 Subject: [PATCH] minor-fix-recharge-status --- .../billpay/mobile-prepaid-recharge.json | 96 ++++++++++++++----- 1 file changed, 70 insertions(+), 26 deletions(-) diff --git a/api-references/payments/billpay/mobile-prepaid-recharge.json b/api-references/payments/billpay/mobile-prepaid-recharge.json index 752d39ef..e19a0c3f 100644 --- a/api-references/payments/billpay/mobile-prepaid-recharge.json +++ b/api-references/payments/billpay/mobile-prepaid-recharge.json @@ -1080,48 +1080,92 @@ "consumes": ["application/json"], "produces": ["application/json"], "responses": { - "200": { - "content": { - "application/json": { - "schema": { + "200": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": ["success", "data", "trace_id"], + "properties": { + "success": { + "type": "boolean", + "example": true, + "description": "Status of API call" + }, + "data": { "type": "object", - "required": ["success", "data", "trace_id"], "properties": { - "success": { - "type": "boolean", - "example": "true", - "description": "Status of the API call" + "error": { + "type": ["string", "null"], + "example": null, + "description": "Error details if any, otherwise null" }, - "data": { + "details": { "type": "object", "properties": { - "paymentRefId": { + "mobile_number": { "type": "string", - "example": "TEST62XD4XX04750702202402", - "description": "Reference ID for the payment transaction" + "example": "vi", + "description": "Mobile number associated with the transaction" }, - "status": { + "provider": { "type": "string", - "example": "SUCCESS", - "description": "Status of the recharge request (e.g., SUCCESS, PENDING, FAILED)" + "example": "vi", + "description": "Provider name" }, - "operatorResponse": { + "service_type": { "type": "string", - "example": "Transaction completed successfully", - "description": "Message returned by the operator for this request" + "example": "M", + "description": "Service type (e.g., Mobile)" + }, + "is_postpaid": { + "type": "boolean", + "example": false, + "description": "Indicates if the mobile number is postpaid" + }, + "is_special": { + "type": "boolean", + "example": false, + "description": "Indicates if this is a special service" } }, - "description": "Details of the recharge transaction status" + "description": "Additional details about the recharge" }, - "traceId": { + "amount": { + "type": "integer", + "example": 1900, + "description": "Recharge amount" + }, + "transactionRefId": { "type": "string", - "example": "dMXpKMx4TBKsu8ro1559WeYZS21Og5", - "description": "Identifier associated with this response for debug purposes" + "example": "CYJSTPM37695672", + "description": "Unique reference ID for the transaction" + }, + "status": { + "type": "string", + "example": "Success", + "description": "Status of the recharge transaction" + }, + "operatorRefId": { + "type": "string", + "example": "F3MV358Q19", + "description": "Reference ID provided by the operator" } - } - }}}, - "description": "Response indicating the status of the recharge transaction" + }, + "description": "Details of the recharge transaction" + }, + "trace_id": { + "type": "string", + "example": "cu7it2r6nmjg00e34e8g", + "description": "Identifier associated with this response for debugging purposes" + } } + } + } + }, + "description": "Ok" +} + }, "parameters": [