From 8d89051c51bcd53f1827c3c77ac430727e557d80 Mon Sep 17 00:00:00 2001
From: VivianDee <115420678+VivianDee@users.noreply.github.com>
Date: Mon, 24 Mar 2025 13:27:36 +0100
Subject: [PATCH] [update]: Swagger documentation

---
 app/swagger/paths/CollectLoan.json                |  5 ++++-
 app/swagger/paths/CustomerConsent.json            |  5 ++++-
 app/swagger/paths/Disbursement.json               |  5 ++++-
 app/swagger/paths/LienCheck.json                  |  5 ++++-
 app/swagger/paths/NewTransactionCheck.json        |  5 ++++-
 app/swagger/paths/PenalCharge.json                |  5 ++++-
 app/swagger/paths/RACCheck.json                   |  5 ++++-
 app/swagger/paths/RevokeEnableConsent.json        |  5 ++++-
 app/swagger/paths/TokenValidation.json            |  5 ++++-
 app/swagger/paths/TransactionVerify.json          |  5 ++++-
 app/swagger/schemas/CollectLoanRequest.json       |  5 +++++
 app/swagger/schemas/DisbursementRequest.json      | 10 +++++-----
 app/swagger/schemas/TransactionVerifyRequest.json |  4 ++--
 13 files changed, 52 insertions(+), 17 deletions(-)

diff --git a/app/swagger/paths/CollectLoan.json b/app/swagger/paths/CollectLoan.json
index 16fee80..0ca0636 100644
--- a/app/swagger/paths/CollectLoan.json
+++ b/app/swagger/paths/CollectLoan.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/CustomerConsent.json b/app/swagger/paths/CustomerConsent.json
index 29d7cc0..f246704 100644
--- a/app/swagger/paths/CustomerConsent.json
+++ b/app/swagger/paths/CustomerConsent.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/Disbursement.json b/app/swagger/paths/Disbursement.json
index ca4b85e..e84f28d 100644
--- a/app/swagger/paths/Disbursement.json
+++ b/app/swagger/paths/Disbursement.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/LienCheck.json b/app/swagger/paths/LienCheck.json
index 15069ad..4cff841 100644
--- a/app/swagger/paths/LienCheck.json
+++ b/app/swagger/paths/LienCheck.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/NewTransactionCheck.json b/app/swagger/paths/NewTransactionCheck.json
index 57227a9..9e79b00 100644
--- a/app/swagger/paths/NewTransactionCheck.json
+++ b/app/swagger/paths/NewTransactionCheck.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/PenalCharge.json b/app/swagger/paths/PenalCharge.json
index 7f0bebb..7ea784a 100644
--- a/app/swagger/paths/PenalCharge.json
+++ b/app/swagger/paths/PenalCharge.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/RACCheck.json b/app/swagger/paths/RACCheck.json
index 4536da9..2a85879 100644
--- a/app/swagger/paths/RACCheck.json
+++ b/app/swagger/paths/RACCheck.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/RevokeEnableConsent.json b/app/swagger/paths/RevokeEnableConsent.json
index 59389df..edb494e 100644
--- a/app/swagger/paths/RevokeEnableConsent.json
+++ b/app/swagger/paths/RevokeEnableConsent.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/TokenValidation.json b/app/swagger/paths/TokenValidation.json
index 07c5b80..7f41d23 100644
--- a/app/swagger/paths/TokenValidation.json
+++ b/app/swagger/paths/TokenValidation.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/paths/TransactionVerify.json b/app/swagger/paths/TransactionVerify.json
index 1238d8d..cad3f8e 100644
--- a/app/swagger/paths/TransactionVerify.json
+++ b/app/swagger/paths/TransactionVerify.json
@@ -43,7 +43,10 @@
           }
         },
         "400": {
-          "description": "Invalid request parameters"
+          "description": "Invalid request"
+        },
+        "422": {
+          "description": "Validation exception"
         },
         "500": {
           "description": "Internal server error"
diff --git a/app/swagger/schemas/CollectLoanRequest.json b/app/swagger/schemas/CollectLoanRequest.json
index 5409b8f..14b67bf 100644
--- a/app/swagger/schemas/CollectLoanRequest.json
+++ b/app/swagger/schemas/CollectLoanRequest.json
@@ -5,6 +5,10 @@
             "type": "string",
             "example": "T002"
         },
+        "fbnTransactionId": {
+                    "type": "string",
+                    "example": "FBN20231123"
+                },
         "debtId": {
             "type": "string",
             "example": "273194670"
@@ -51,6 +55,7 @@
     },
     "required": [
         "transactionId",
+        "fbnTransactionId",
         "debtId",
         "customerId",
         "accountId",
diff --git a/app/swagger/schemas/DisbursementRequest.json b/app/swagger/schemas/DisbursementRequest.json
index 88ce7a6..0c7000b 100644
--- a/app/swagger/schemas/DisbursementRequest.json
+++ b/app/swagger/schemas/DisbursementRequest.json
@@ -1,14 +1,14 @@
 {
     "type": "object",
     "properties": {
+        "requestId": {
+            "type": "string",
+            "example": "7876786"
+        },
         "transactionId": {
             "type": "string",
             "example": "T001"
         },
-        "TransactionId": {
-            "type": "string",
-            "example": "Tr201712RK9232P115"
-        },
         "debtId": {
             "type": "string",
             "example": "273194670"
@@ -60,8 +60,8 @@
         }
     },
     "required": [
+        "requestId",
         "transactionId",
-        "TransactionId",
         "debtId",
         "customerId",
         "accountId",
diff --git a/app/swagger/schemas/TransactionVerifyRequest.json b/app/swagger/schemas/TransactionVerifyRequest.json
index beff068..fce9a28 100644
--- a/app/swagger/schemas/TransactionVerifyRequest.json
+++ b/app/swagger/schemas/TransactionVerifyRequest.json
@@ -5,11 +5,11 @@
             "type": "string",
             "example": "2"
         },
-        "TransactionId": {
+        "transactionId": {
             "type": "string",
             "example": "T002"
         },
-        "RequestId": {
+        "requestID": {
             "type": "string",
             "example": "R02802"
         },