[add]: eco endpoints and dummy responses

2025-07-30 05:16:47 +01:00
parent cfc40b89dc
commit 038c5323b0
41 changed files with 998 additions and 7 deletions
@@ -0,0 +1,32 @@
+{
+  "post": {
+    "tags": ["Authentication"],
+    "summary": "EcoBank Authentication",
+    "description": "Get bearer token from EcoBank",
+    "operationId": "authenticate",
+    "requestBody": {
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "../../schemas/eco/AuthenticationRequest.json"
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Authentication Successful",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../../schemas/eco/AuthenticationResponse.json"
+            }
+          }
+        }
+      },
+      "400": { "description": "Invalid request" },
+      "500": { "description": "Internal server error" }
+    }
+  }
+}
@@ -0,0 +1,33 @@
+{
+  "post": {
+    "tags": ["CollectLoan"],
+    "summary": "Collect Loan Repayment",
+    "description": "Collect repayment amount from EcoBank customer",
+    "operationId": "collectLoan",
+    "requestBody": {
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "../../schemas/eco/CollectLoanRequest.json"
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Loan Collection Successful",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../../schemas/eco/CollectLoanResponse.json"
+            }
+          }
+        }
+      },
+      "400": { "description": "Invalid request" },
+      "422": { "description": "Validation exception" },
+      "500": { "description": "Internal server error" }
+    }
+  }
+}
@@ -0,0 +1,33 @@
+{
+  "post": {
+    "tags": ["DebtClosureNotification"],
+    "summary": "Debt Closure Notification",
+    "description": "Notify EcoBank that debt has been fully repaid",
+    "operationId": "notifyDebtClosure",
+    "requestBody": {
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "../../schemas/eco/DebtClosureNotificationRequest.json"
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Debt Closure Acknowledged",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../../schemas/eco/DebtClosureNotificationResponse.json"
+            }
+          }
+        }
+      },
+      "400": { "description": "Invalid request" },
+      "422": { "description": "Validation exception" },
+      "500": { "description": "Internal server error" }
+    }
+  }
+}
@@ -0,0 +1,33 @@
+{
+  "post": {
+    "tags": ["Disbursement"],
+    "summary": "Loan Disbursement",
+    "description": "Disburse loan to EcoBank customer account",
+    "operationId": "disburseLoan",
+    "requestBody": {
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "../../schemas/eco/DisbursementRequest.json"
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "Disbursement Successful",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../../schemas/eco/DisbursementResponse.json"
+            }
+          }
+        }
+      },
+      "400": { "description": "Invalid request" },
+      "422": { "description": "Validation exception" },
+      "500": { "description": "Internal server error" }
+    }
+  }
+}
@@ -0,0 +1,33 @@
+{
+  "post": {
+    "tags": ["SendSMS"],
+    "summary": "Send SMS Notification",
+    "description": "Send a message to one or more EcoBank customers",
+    "operationId": "sendSms",
+    "requestBody": {
+      "required": true,
+      "content": {
+        "application/json": {
+          "schema": {
+            "$ref": "../../schemas/eco/SendSMSRequest.json"
+          }
+        }
+      }
+    },
+    "responses": {
+      "200": {
+        "description": "SMS Sent Successfully",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "../../schemas/eco/SendSMSResponse.json"
+            }
+          }
+        }
+      },
+      "400": { "description": "Invalid request" },
+      "422": { "description": "Validation exception" },
+      "500": { "description": "Internal server error" }
+    }
+  }
+}