Skip to content

minor-fix-recharge-status-success-response #232

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.

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
merged 1 commit into from
Jan 26, 2025
Merged
Changes from all commits
Commits
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
96 changes: 70 additions & 26 deletions api-references/payments/billpay/mobile-prepaid-recharge.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
Loading