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

Updated Docs

Browse Source
This commit is contained in:
Azeez Muibi
2025-03-26 14:48:32 +01:00
parent 9ed359d307
commit 183c1bf46f
59 changed files with 2513 additions and 390 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/swagger/paths/BulkSMS.json
+58
View File
@@ -0,0 +1,58 @@
{
"post": {
"tags": [
"BulkSMS"
],
"summary": "Send Bulk SMS",
"description": "This request is used to send Bulk SMS messages to multiple customers. The max length of the array should equal 20. The API is hosted in FIRSTBANK and it is the HTTP wrapper for the real SMS sending interface.",
"operationId": "bulkSmsNotification",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/BulkSMSRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/BulkSMSRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/BulkSMSRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "Bulk SMS sent successfully",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/BulkSMSResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/BulkSMSResponse.json"
}
}
}
},
"400": {
"description": "Unsuccessful Response with Client Error"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"api_key": []
}
]
}
}
app/swagger/paths/CollectLoan.json
+10 -8
View File
@@ -4,8 +4,8 @@
"CollectLoan"
],
"summary": "Collect Loan Request",
"description": "Collect Loan Request",
"operationId": "CollectLoan",
"description": "This request is to collect money from user accounts. When request is received, FIRSTBANK should check all user accounts and collect as much as possible money to cover existing loan either partially or fully. In response, FIRSTBANK should return total amount that is actually collected from user accounts. First FBN collects body amount, then penal charge. If requested amount is not collected or collected partially FBN places a lien on user account. FBN places lien for body amount and penal charge separately.",
"operationId": "collectLoan",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "CollectLoan Successful",
"description": "Loan Collection Successful",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/CustomerConsent.json
+10 -8
View File
@@ -4,8 +4,8 @@
"CustomerConsent"
],
"summary": "Customer Consent Request",
"description": "Customer Consent Request",
"operationId": "CustomerConsent",
"description": "This endpoint allows FirstBank to send customer consent requests to Simbrella",
"operationId": "customerConsent",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "Successful",
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"basic_auth": []
}
]
}
}
}
app/swagger/paths/Disbursement.json
+11 -9
View File
@@ -3,9 +3,9 @@
"tags": [
"Disbursement"
],
"summary": "Disbursement Request",
"description": "Disbursement Request",
"operationId": "Disbursement",
"summary": "Loan Disbursement Request",
"description": "This request should be executed as a simultaneous operation where loan provision and collection are executed together in same API call. If one of the operations is failed, the whole transaction should be rolled back.",
"operationId": "disbursement",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "Disbursement Successful",
"description": "Disbursement request accepted",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/EligibilityCheck.json
+62
View File
@@ -0,0 +1,62 @@
{
"post": {
"tags": [
"EligibilityCheck"
],
"summary": "Check customer eligibility for loan products",
"description": "This endpoint is used by FirstBank to check if a customer is eligible for loan products and returns available offers",
"operationId": "eligibilityCheck",
"requestBody": {
"description": "Customer information for eligibility check",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"401": {
"description": "Authentication failed"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"basic_auth": []
}
]
}
}
app/swagger/paths/LienCheck.json
+10 -8
View File
@@ -4,8 +4,8 @@
"LienCheck"
],
"summary": "Lien Check Request",
"description": "Lien Check Request",
"operationId": "LienCheck",
"description": "This method is to check the amount of the lien on a specific account",
"operationId": "lienCheck",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "LienCheck Successful",
"description": "Lien check successful",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/LoanStatus.json
+65
View File
@@ -0,0 +1,65 @@
{
"post": {
"tags": [
"LoanStatus"
],
"summary": "Get information about customer's existing loans",
"description": "Loan Information Request to retrieve details about customer's existing loans",
"operationId": "loanInformation",
"requestBody": {
"description": "Customer information for loan details",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanStatusRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanStatusRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LoanStatusRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanStatusResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanStatusResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"401": {
"description": "Authentication failed"
},
"404": {
"description": "No loans found"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"basic_auth": []
}
]
}
}
app/swagger/paths/NotificationCallback.json
+59
View File
@@ -0,0 +1,59 @@
{
"post": {
"tags": [
"NotificationCallback"
],
"summary": "Notification Callback",
"description": "This new feature will be used for informing Simbrella about status of the transactions that FBN have processed. Retry mechanism should be implemented by FirstBank in case of connection issues, sending notification should be repeated for 5 minutes in case of there is connection issues, after which Simbrella will try to check the status of transaction with New Transaction Check endpoint.",
"operationId": "notificationCallback",
"requestBody": {
"description": "Transaction status notification from FirstBank to Simbrella",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NotificationCallbackRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NotificationCallbackRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/NotificationCallbackRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Notification received successfully",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NotificationCallbackResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NotificationCallbackResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"basic_auth": []
}
]
}
}
app/swagger/paths/PenalCharge.json
+10 -8
View File
@@ -4,8 +4,8 @@
"PenalCharge"
],
"summary": "Penal Charge Request",
"description": "Penal Charge Request",
"operationId": "PenalCharge",
"description": "This request is used to charge customers for penalty as per existing debt",
"operationId": "penalCharge",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "PenalCharge Successful",
"description": "Penal Charge Request Accepted",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/ProvideLoan.json
+59
View File
@@ -0,0 +1,59 @@
{
"post": {
"tags": [
"ProvideLoan"
],
"summary": "Provide Loan Request",
"description": "This endpoint is used by FirstBank to request a loan provision for a customer. It allows FirstBank to specify the loan details including the amount, collection type, and loan type.",
"operationId": "provideLoan",
"requestBody": {
"description": "Loan provision request details",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/ProvideLoanRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/ProvideLoanRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/ProvideLoanRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Loan provision request processed successfully",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/ProvideLoanResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/ProvideLoanResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"basic_auth": []
}
]
}
}
app/swagger/paths/RACCheck.json
+8 -6
View File
@@ -4,7 +4,7 @@
"RACCheck"
],
"summary": "Risk Acceptance Criteria Check",
"description": "Check if a customer passes the Risk Acceptance Criteria defined by the bank",
"description": "This request is used to check if a customer passes the Risk Acceptance Criteria defined by the bank",
"operationId": "racCheck",
"requestBody": {
"required": true,
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/Repayment.json
+65
View File
@@ -0,0 +1,65 @@
{
"post": {
"tags": [
"Repayment"
],
"summary": "Process a loan repayment request",
"description": "Repayment Request to initiate loan repayment",
"operationId": "repayment",
"requestBody": {
"description": "Repayment request details",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RepaymentRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RepaymentRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/RepaymentRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Repayment Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RepaymentResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RepaymentResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"401": {
"description": "Authentication failed"
},
"404": {
"description": "Debt not found"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"basic_auth": []
}
]
}
}
app/swagger/paths/RevokeEnableConsent.json
+11 -9
View File
@@ -3,9 +3,9 @@
"tags": [
"RevokeEnableConsent"
],
"summary": "Revoke Enable Consent Request",
"description": "Revoke Enable Consent Request",
"operationId": "RevokeEnableConsent",
"summary": "Revoke or Enable Consent Request",
"description": "This endpoint is used to notify FirstBank about the processing of a customer consent request. It allows Simbrella to inform FirstBank when a customer's consent has been either enabled or revoked.",
"operationId": "revokeEnableConsent",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "RevokeEnableConsent Successful",
"description": "Consent status update successful",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/SMS.json
+58
View File
@@ -0,0 +1,58 @@
{
"post": {
"tags": [
"SMS"
],
"summary": "Send Single SMS",
"description": "This request is used to send a single SMS message to a customer. The API is hosted in FIRSTBANK and it is the HTTP wrapper for the real SMS sending interface.",
"operationId": "smsNotification",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SMSRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SMSRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/SMSRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "SMS sent successfully",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SMSResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SMSResponse.json"
}
}
}
},
"400": {
"description": "Unsuccessful Response with Client Error"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"api_key": []
}
]
}
}
app/swagger/paths/SelectOffer.json
+62
View File
@@ -0,0 +1,62 @@
{
"post": {
"tags": [
"SelectOffer"
],
"summary": "Send the offer the customer selected to Simbrella",
"description": "This method is used to send the offer the customer selected to Simbrella",
"operationId": "selectOffer",
"requestBody": {
"description": "Customer selected offer details",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SelectOfferRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SelectOfferRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/SelectOfferRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SelectOfferResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SelectOfferResponse.json"
}
}
}
},
"400": {
"description": "Invalid request parameters"
},
"401": {
"description": "Authentication failed"
},
"500": {
"description": "Internal server error"
}
},
"security": [
{
"basic_auth": []
}
]
}
}
app/swagger/paths/NewTransactionCheck.json → app/swagger/paths/StatusCall.json
+17 -15
View File
@@ -1,43 +1,43 @@
{
"post": {
"tags": [
"NewTransactionCheck"
"StatusCall"
],
"summary": "New Transaction Check Request",
"description": "New Transaction Check Request",
"operationId": "NewTransactionCheck",
"summary": "Status Call Request",
"description": "This will be used to check the status of a transaction by Simbrella to Firstabank if there is no initial response after 2mins.",
"operationId": "statusCall",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
"$ref": "../schemas/StatusCallRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
"$ref": "../schemas/StatusCallRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
"$ref": "../schemas/StatusCallRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "NewTransactionCheck Successful",
"description": "Transaction check successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
"$ref": "../schemas/StatusCallResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
"$ref": "../schemas/StatusCallResponse.json"
}
}
}
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/TokenValidation.json
+10 -8
View File
@@ -4,8 +4,8 @@
"TokenValidation"
],
"summary": "Token Validation Request",
"description": "Token Validation Request",
"operationId": "TokenValidation",
"description": "This method is used while users from FBN access Customer Care Portal. User will enter soft/hard token code. This will be captured and sent to this endpoint for validation.",
"operationId": "validateToken",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "TokenValidation Successful",
"description": "Token validation successful",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}
app/swagger/paths/TransactionVerify.json
+11 -9
View File
@@ -3,9 +3,9 @@
"tags": [
"TransactionVerify"
],
"summary": "Transaction Verify Request",
"description": "Transaction Verify Request",
"operationId": "TransactionVerify",
"summary": "Transaction Verification Request",
"description": "This request is to double check the response received from DisburseLoan and CollectLoan Synchronous APIs. This request is required to check transaction results on FIRSTBANK.",
"operationId": "transactionVerify",
"requestBody": {
"required": true,
"content": {
@@ -28,7 +28,7 @@
},
"responses": {
"200": {
"description": "TransactionVerify Successful",
"description": "Transaction Verification Successful",
"content": {
"application/json": {
"schema": {
@@ -45,12 +45,14 @@
"400": {
"description": "Invalid request"
},
"422": {
"description": "Validation exception"
},
"500": {
"description": "Internal server error"
}
}
},
"security": [
{
"api_key": []
}
]
}
}
}