DigiFi/digifi-BankEmulator
1
0
Fork 0
Code Issues Pull Requests Releases Activity

[add]: Swagger Documentation

Browse Source
This commit is contained in:
VivianDee
2025-03-24 08:44:57 +01:00
parent 7a4a9a9b99
commit dad8e68c9f
72 changed files with 1679 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/swagger/schemas/ApiResponse.json
+18
View File
@@ -0,0 +1,18 @@
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string"
},
"message": {
"type": "string"
}
},
"xml": {
"name": "##default"
}
}
app/swagger/schemas/CollectLoanRequest.json
+65
View File
@@ -0,0 +1,65 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T002"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"example": 80000.0
},
"penalCharge": {
"type": "number",
"format": "double",
"example": 0.0
},
"collectionMethod": {
"type": "integer",
"example": 1
},
"lienAmount": {
"type": "number",
"format": "double",
"example": 80000.0
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing CollectionLoanRequest"
}
},
"required": [
"transactionId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"penalCharge",
"collectionMethod",
"lienAmount",
"countryId",
"comment"
]
}
app/swagger/schemas/CollectLoanResponse.json
+70
View File
@@ -0,0 +1,70 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T002"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"example": 60000.0
},
"penalCharge": {
"type": "number",
"format": "double",
"example": 0.0
},
"lienAmount": {
"type": "number",
"format": "double",
"example": 20000.0
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing CollectionLoanRequest"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Loan Collection Successful"
}
},
"required": [
"transactionId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"penalCharge",
"lienAmount",
"countryId",
"comment",
"resultCode",
"resultDescription"
]
}
app/swagger/schemas/CustomerConsentRequest.json
+43
View File
@@ -0,0 +1,43 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"example": "CustomerConsentRequest"
},
"transactionId": {
"type": "string",
"example": "20171209232177"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2019-10-18 14:26:21.063"
},
"consentType": {
"type": "string",
"example": "Revoke"
},
"channel": {
"type": "string",
"example": "USSD"
}
},
"required": [
"$type",
"transactionId",
"customerId",
"accountId",
"requestTime",
"consentType",
"channel"
]
}
app/swagger/schemas/CustomerConsentResponse.json
+17
View File
@@ -0,0 +1,17 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Request is received"
}
},
"required": [
"resultCode",
"resultDescription"
]
}
app/swagger/schemas/DisbursementRequest.json
+77
View File
@@ -0,0 +1,77 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T001"
},
"TransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"example": 100000.0
},
"collectAmountInterest": {
"type": "number",
"format": "double",
"example": 5000.0
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"example": 75.0
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing LoanRequest"
}
},
"required": [
"transactionId",
"TransactionId",
"debtId",
"customerId",
"accountId",
"productId",
"provideAmount",
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"comment"
]
}
app/swagger/schemas/DisbursementResponse.json
+82
View File
@@ -0,0 +1,82 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T001"
},
"TransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"example": 100000.0
},
"collectAmountInterest": {
"type": "number",
"format": "double",
"example": 5000.0
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"example": 75.0
},
"countryId": {
"type": "string",
"example": "01"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Loan Request Completed Successfully!"
}
},
"required": [
"transactionId",
"TransactionId",
"debtId",
"customerId",
"accountId",
"productId",
"provideAmount",
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"resultCode",
"resultDescription"
]
}
app/swagger/schemas/LienCheckRequest.json
+21
View File
@@ -0,0 +1,21 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "SMB1234567"
},
"customerId": {
"type": "string",
"example": "123456"
},
"accountId": {
"type": "string",
"example": "E9F77222920BAAB1C5ACF2253C6D6113"
},
"countryId": {
"type": "string",
"example": "01"
}
}
}
app/swagger/schemas/LienCheckResponse.json
+17
View File
@@ -0,0 +1,17 @@
{
"type": "object",
"properties": {
"lienAmount": {
"type": "number",
"example": 20000.0
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Successful"
}
}
}
app/swagger/schemas/NewTransactionCheckRequest.json
+29
View File
@@ -0,0 +1,29 @@
{
"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"
}
}
}
app/swagger/schemas/NewTransactionCheckResponse.json
+13
View File
@@ -0,0 +1,13 @@
{
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "Success"
},
"message": {
"type": "string",
"example": "Transaction check completed successfully."
}
}
}
app/swagger/schemas/PenalChargeRequest.json
+41
View File
@@ -0,0 +1,41 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T004"
},
"fbnTransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"penalCharge": {
"type": "number",
"example": 1.2
},
"lienAmount": {
"type": "number",
"example": 101.2
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing PenalChargeRequest"
}
}
}
app/swagger/schemas/PenalChargeResponse.json
+13
View File
@@ -0,0 +1,13 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Penal charge debited successfully"
}
}
}
app/swagger/schemas/RACCheckRequest.json
+91
View File
@@ -0,0 +1,91 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T001"
},
"fbnTransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"RAC_Array": {
"type": "array",
"items": {
"type": "object",
"properties": {
"salaryAccount": {
"type": "boolean",
"example": true
},
"bvn": {
"type": "string",
"example": "12345678901"
},
"crc": {
"type": "boolean",
"example": false
},
"crms": {
"type": "boolean",
"example": true
},
"accountStatus": {
"type": "string",
"example": "active"
},
"lien": {
"type": "boolean",
"example": false
},
"noBouncedCheck": {
"type": "boolean",
"example": true
},
"existingLoan": {
"type": "boolean",
"example": false
},
"whitelist": {
"type": "boolean",
"example": true
},
"noPastDueSalaryLoan": {
"type": "boolean",
"example": true
},
"noPastDueOtherLoans": {
"type": "boolean",
"example": false
}
}
},
"example": [
{
"salaryAccount": true,
"bvn": "12345678901",
"crc": false,
"crms": true,
"accountStatus": "active",
"lien": false,
"noBouncedCheck": true,
"existingLoan": false,
"whitelist": true,
"noPastDueSalaryLoan": true,
"noPastDueOtherLoans": false
}
]
}
},
"xml": {
"name": "RACCheckRequest"
}
}
app/swagger/schemas/RACCheckResponse.json
+65
View File
@@ -0,0 +1,65 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"example": "00"
},
"RACResponse": {
"type": "object",
"properties": {
"Salary account": {
"type": "string",
"example": "1"
},
"BVN": {
"type": "string",
"example": "1"
},
"BVNAttachedtoAccount": {
"type": "string",
"example": "1"
},
"CRMS": {
"type": "string",
"example": "1"
},
"CRC": {
"type": "string",
"example": "1"
},
"AccountStatus": {
"type": "string",
"example": "1"
},
"Lien": {
"type": "string",
"example": "1"
},
"NoBouncedCheck": {
"type": "string",
"example": "1"
},
"Whitelist": {
"type": "string",
"example": "1"
},
"NoPastDueSalaryLoan": {
"type": "string",
"example": "1"
},
"NoPastDueOtherLoan": {
"type": "string",
"example": "1"
}
}
},
"resultDescription": {
"type": "string",
"example": "RAC Check Successful"
}
},
"xml": {
"name": "RACCheckResponse"
}
}
app/swagger/schemas/RevokeEnableConsentRequest.json
+38
View File
@@ -0,0 +1,38 @@
{
"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"
}
}
}
app/swagger/schemas/RevokeEnableConsentResponse.json
+25
View File
@@ -0,0 +1,25 @@
{
"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"
}
}
}
app/swagger/schemas/TokenValidationRequest.json
+21
View File
@@ -0,0 +1,21 @@
{
"type": "object",
"properties": {
"UserId": {
"type": "string",
"example": "TMP0840"
},
"TokenCode": {
"type": "string",
"example": "32365214"
},
"RequestId": {
"type": "string",
"example": "SMB1234567"
},
"CountryId": {
"type": "string",
"example": "01"
}
}
}
app/swagger/schemas/TokenValidationResponse.json
+25
View File
@@ -0,0 +1,25 @@
{
"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"
}
}
}
app/swagger/schemas/TransactionVerifyRequest.json
+33
View File
@@ -0,0 +1,33 @@
{
"type": "object",
"properties": {
"counter": {
"type": "string",
"example": "2"
},
"TransactionId": {
"type": "string",
"example": "T002"
},
"RequestId": {
"type": "string",
"example": "R02802"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"countryId": {
"type": "string",
"example": "01"
},
"transactionType": {
"type": "string",
"example": "Disbursement"
}
}
}
app/swagger/schemas/TransactionVerifyResponse.json
+37
View File
@@ -0,0 +1,37 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"example": "TransactionCheckResponse"
},
"nativeId": {
"type": "string",
"example": "FBN20191031104405CN621868"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"providedAmount": {
"type": "number",
"example": 0.0
},
"collectedAmount": {
"type": "number",
"example": 7.50
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Collect Status retrieved successfully."
}
}
}