From e2769472bb70b42d0e029ac95c7444bf650402d2 Mon Sep 17 00:00:00 2001
From: VivianDee <115420678+VivianDee@users.noreply.github.com>
Date: Wed, 19 Mar 2025 17:58:02 +0100
Subject: [PATCH] [update]:Documentation

---
 digifi_swagger.json | 372 ++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 339 insertions(+), 33 deletions(-)

diff --git a/digifi_swagger.json b/digifi_swagger.json
index a148ec9..a8e265e 100644
--- a/digifi_swagger.json
+++ b/digifi_swagger.json
@@ -1909,103 +1909,409 @@
         "type": "object",
         "properties": {
           "counter": {
-            "type": "string"
+            "type": "string",
+            "example": "2"
           },
           "TransactionId": {
-            "type": "string"
+            "type": "string",
+            "example": "T002"
           },
           "RequestId": {
-            "type": "string"
+            "type": "string",
+            "example": "R02802"
           },
           "customerId": {
-            "type": "string"
+            "type": "string",
+            "example": "CN621868"
           },
           "accountId": {
-            "type": "string"
+            "type": "string",
+            "example": "2017821799"
           },
           "countryId": {
-            "type": "string"
+            "type": "string",
+            "example": "01"
           },
           "transactionType": {
-            "type": "string"
+            "type": "string",
+            "example": "Disbursement"
           }
-        },
-        "required": ["counter", "TransactionId", "RequestId", "customerId", "accountId", "countryId", "transactionType"]
+        }
       },
       "TransactionVerifyResponse": {
         "type": "object",
         "properties": {
           "$type": {
-            "type": "string"
+            "type": "string",
+            "example": "TransactionCheckResponse"
           },
           "nativeId": {
-            "type": "string"
+            "type": "string",
+            "example": "FBN20191031104405CN621868"
           },
           "customerId": {
-            "type": "string"
+            "type": "string",
+            "example": "CN621868"
           },
           "accountId": {
-            "type": "string"
+            "type": "string",
+            "example": "2017821799"
           },
           "providedAmount": {
-            "type": "number"
+            "type": "number",
+            "example": 0.0
           },
           "collectedAmount": {
-            "type": "number"
+            "type": "number",
+            "example": 7.50
           },
           "resultCode": {
-            "type": "string"
+            "type": "string",
+            "example": "00"
           },
           "resultDescription": {
-            "type": "string"
+            "type": "string",
+            "example": "Collect Status retrieved successfully."
           }
-        },
-        "required": ["$type", "nativeId", "customerId", "accountId", "providedAmount", "collectedAmount", "resultCode", "resultDescription"]
+        }
       },
       "PenalChargeRequest": {
         "type": "object",
         "properties": {
           "transactionId": {
-            "type": "string"
+            "type": "string",
+            "example": "T004"
           },
           "fbnTransactionId": {
-            "type": "string"
+            "type": "string",
+            "example": "Tr201712RK9232P115"
           },
           "debtId": {
-            "type": "string"
+            "type": "string",
+            "example": "273194670"
           },
           "customerId": {
-            "type": "string"
+            "type": "string",
+            "example": "CN621868"
           },
           "accountId": {
-            "type": "string"
+            "type": "string",
+            "example": "2017821799"
           },
           "penalCharge": {
-            "type": "number"
+            "type": "number",
+            "example": 1.2
           },
           "lienAmount": {
-            "type": "number"
+            "type": "number",
+            "example": 101.2
           },
           "countryId": {
-            "type": "string"
+            "type": "string",
+            "example": "01"
           },
           "comment": {
-            "type": "string"
+            "type": "string",
+            "example": "Testing PenalChargeRequest"
           }
-        },
-        "required": ["transactionId", "fbnTransactionId", "debtId", "customerId", "accountId", "penalCharge", "lienAmount", "countryId", "comment"]
+        }
       },
       "PenalChargeResponse": {
         "type": "object",
         "properties": {
           "resultCode": {
-            "type": "string"
+            "type": "string",
+            "example": "00"
           },
           "resultDescription": {
-            "type": "string"
+            "type": "string",
+            "example": "Penal charge debited successfully"
+          }
+        }
+      },
+      "RevokeEnableConsentRequest": {
+        "type": "object",
+        "properties": {
+          "transactionId": {
+            "type": "string",
+            "example": "T0014"
+          },
+          "fbnTransactionId": {
+            "type": "string",
+            "example": "20171209232177"
+          },
+          "customerId": {
+            "type": "string",
+            "example": "CN621868"
+          },
+          "accountId": {
+            "type": "string",
+            "example": "2017821799"
+          },
+          "processTime": {
+            "type": "string",
+            "format": "date-time",
+            "example": "2019-10-18 14:26:21.063"
+          },
+          "consentType": {
+            "type": "string",
+            "example": "Revoke"
+          },
+          "countryId": {
+            "type": "string",
+            "example": "01"
+          },
+          "comment": {
+            "type": "string",
+            "example": "Testing RevokeEnableConsentRequest"
+          }
+        }
+      },
+      "RevokeEnableConsentResponse": {
+        "type": "object",
+        "properties": {
+          "$type": {
+            "type": "string",
+            "example": "RevokeEnableConsentResponse"
+          },
+          "customerId": {
+            "type": "string",
+            "example": "CN621868"
+          },
+          "accountId": {
+            "type": "string",
+            "example": "2017821799"
+          },
+          "resultCode": {
+            "type": "string",
+            "example": "00"
+          },
+          "resultDescription": {
+            "type": "string",
+            "example": "Success"
+          }
+        }
+      },
+      "TokenValidationRequest": {
+        "type": "object",
+        "properties": {
+          "UserId": {
+            "type": "string",
+            "example": "TMP0840"
+          },
+          "TokenCode": {
+            "type": "string",
+            "example": "32365214"
+          },
+          "RequestId": {
+            "type": "string",
+            "example": "SMB1234567"
+          },
+          "CountryId": {
+            "type": "string",
+            "example": "01"
+          }
+        }
+      },
+      "TokenValidationResponse": {
+        "type": "object",
+        "properties": {
+          "Authenticated": {
+            "type": "boolean",
+            "example": true
+          },
+          "AuthenticatedMessage": {
+            "type": "string",
+            "example": "The user Oluwole Olusoga has successfully authenticated!"
+          },
+          "ResponseCode": {
+            "type": "string",
+            "example": "00"
+          },
+          "ResponseMessage": {
+            "type": "string",
+            "example": "Successful"
+          },
+          "RequestId": {
+            "type": "string",
+            "example": "SMB1234567"
+          }
+        }
+      },
+      "NewTransactionCheckRequest": {
+        "type": "object",
+        "properties": {
+          "transactionId": {
+            "type": "string",
+            "example": "173021"
+          },
+          "debtId": {
+            "type": "string",
+            "example": "173021"
+          },
+          "transactionType": {
+            "type": "string",
+            "example": "Disbursement"
+          },
+          "fbnTransactionId": {
+            "type": "string",
+            "example": "FBN2411011411413A74960"
+          },
+          "origTransactionId": {
+            "type": "string",
+            "example": "2411011411413A74960"
+          },
+          "customerId": {
+            "type": "string",
+            "example": "CN621868"
+          }
+        }
+      },
+      "NewTransactionCheckResponse": {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "example": "Success"
+          },
+          "message": {
+            "type": "string",
+            "example": "Transaction check completed successfully."
+          }
+        }
+      },
+      "LienCheckRequest": {
+        "type": "object",
+        "properties": {
+          "transactionId": {
+            "type": "string",
+            "example": "SMB1234567"
+          },
+          "customerId": {
+            "type": "string",
+            "example": "123456"
+          },
+          "accountId": {
+            "type": "string",
+            "example": "E9F77222920BAAB1C5ACF2253C6D6113"
+          },
+          "countryId": {
+            "type": "string",
+            "example": "01"
+          }
+        }
+      },
+      "LienCheckResponse": {
+        "type": "object",
+        "properties": {
+          "lienAmount": {
+            "type": "number",
+            "example": 20000.0
+          },
+          "resultCode": {
+            "type": "string",
+            "example": "00"
+          },
+          "resultDescription": {
+            "type": "string",
+            "example": "Successful"
+          }
+        }
+      },
+      "SMSRequest": {
+        "type": "object",
+        "properties": {
+          "text": {
+            "type": "string",
+            "example": "This is a test message for SMS request method."
+          },
+          "dest": {
+            "type": "string",
+            "example": "+2348039409144"
+          },
+          "unicode": {
+            "type": "boolean",
+            "example": false
           }
         },
-        "required": ["resultCode", "resultDescription"]
+        "required": [
+          "text",
+          "dest",
+          "unicode"
+        ]
+      },
+      "SMSResponse": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "string",
+            "example": ""
+          },
+          "statusCode": {
+            "type": "integer",
+            "example": 200
+          },
+          "IsSuccessful": {
+            "type": "boolean",
+            "example": true
+          },
+          "errorMessage": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "example": null
+          }
+        }
+      },
+      "BulkSMSRequest": {
+        "type": "array",
+        "items": {
+          "type": "object",
+          "properties": {
+            "text": {
+              "type": "string",
+              "example": "This is a test message for SMS request method."
+            },
+            "dest": {
+              "type": "string",
+              "example": "+2348039409144"
+            },
+            "unicode": {
+              "type": "boolean",
+              "example": true
+            }
+          },
+          "required": [
+            "text",
+            "dest",
+            "unicode"
+          ]
+        }
+      },
+      "BulkSMSResponse": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "type": "string",
+            "example": ""
+          },
+          "statusCode": {
+            "type": "integer",
+            "example": 200
+          },
+          "IsSuccessful": {
+            "type": "boolean",
+            "example": true
+          },
+          "errorMessage": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "example": null
+          }
+        }
       },
       "ApiResponse": {
         "type": "object",