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

[update]:Documentation

Browse Source
This commit is contained in:
VivianDee
2025-03-19 17:58:02 +01:00
parent 39adbd9ec9
commit e2769472bb
1 changed files with 339 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
digifi_swagger.json
+339 -33
View File
@@ -1909,103 +1909,409 @@
"type": "object", "type": "object",
"properties": { "properties": {
"counter": { "counter": {
"type": "string" "type": "string",
"example": "2"
}, },
"TransactionId": { "TransactionId": {
"type": "string" "type": "string",
"example": "T002"
}, },
"RequestId": { "RequestId": {
"type": "string" "type": "string",
"example": "R02802"
}, },
"customerId": { "customerId": {
"type": "string" "type": "string",
"example": "CN621868"
}, },
"accountId": { "accountId": {
"type": "string" "type": "string",
"example": "2017821799"
}, },
"countryId": { "countryId": {
"type": "string" "type": "string",
"example": "01"
}, },
"transactionType": { "transactionType": {
"type": "string" "type": "string",
"example": "Disbursement"
} }
}, }
"required": ["counter", "TransactionId", "RequestId", "customerId", "accountId", "countryId", "transactionType"]
}, },
"TransactionVerifyResponse": { "TransactionVerifyResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
"$type": { "$type": {
"type": "string" "type": "string",
"example": "TransactionCheckResponse"
}, },
"nativeId": { "nativeId": {
"type": "string" "type": "string",
"example": "FBN20191031104405CN621868"
}, },
"customerId": { "customerId": {
"type": "string" "type": "string",
"example": "CN621868"
}, },
"accountId": { "accountId": {
"type": "string" "type": "string",
"example": "2017821799"
}, },
"providedAmount": { "providedAmount": {
"type": "number" "type": "number",
"example": 0.0
}, },
"collectedAmount": { "collectedAmount": {
"type": "number" "type": "number",
"example": 7.50
}, },
"resultCode": { "resultCode": {
"type": "string" "type": "string",
"example": "00"
}, },
"resultDescription": { "resultDescription": {
"type": "string" "type": "string",
"example": "Collect Status retrieved successfully."
} }
}, }
"required": ["$type", "nativeId", "customerId", "accountId", "providedAmount", "collectedAmount", "resultCode", "resultDescription"]
}, },
"PenalChargeRequest": { "PenalChargeRequest": {
"type": "object", "type": "object",
"properties": { "properties": {
"transactionId": { "transactionId": {
"type": "string" "type": "string",
"example": "T004"
}, },
"fbnTransactionId": { "fbnTransactionId": {
"type": "string" "type": "string",
"example": "Tr201712RK9232P115"
}, },
"debtId": { "debtId": {
"type": "string" "type": "string",
"example": "273194670"
}, },
"customerId": { "customerId": {
"type": "string" "type": "string",
"example": "CN621868"
}, },
"accountId": { "accountId": {
"type": "string" "type": "string",
"example": "2017821799"
}, },
"penalCharge": { "penalCharge": {
"type": "number" "type": "number",
"example": 1.2
}, },
"lienAmount": { "lienAmount": {
"type": "number" "type": "number",
"example": 101.2
}, },
"countryId": { "countryId": {
"type": "string" "type": "string",
"example": "01"
}, },
"comment": { "comment": {
"type": "string" "type": "string",
"example": "Testing PenalChargeRequest"
} }
}, }
"required": ["transactionId", "fbnTransactionId", "debtId", "customerId", "accountId", "penalCharge", "lienAmount", "countryId", "comment"]
}, },
"PenalChargeResponse": { "PenalChargeResponse": {
"type": "object", "type": "object",
"properties": { "properties": {
"resultCode": { "resultCode": {
"type": "string" "type": "string",
"example": "00"
}, },
"resultDescription": { "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": { "ApiResponse": {
"type": "object", "type": "object",