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

Updated Docs

Browse Source
This commit is contained in:
Azeez Muibi
2025-03-25 10:10:29 +01:00
parent ce4079b2d2
commit 4e8fc9cd34
8 changed files with 51 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files
digifi_swagger.json
+8 -8
View File
@@ -108,8 +108,8 @@
}
},
{
"name": "NewTransactionCheck",
"description": "New Transaction Check",
"name": "StatusCall",
"description": "Status Call",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
@@ -166,8 +166,8 @@
"/LienCheck": {
"$ref": "./paths/LienCheck.json"
},
"/NewTransactionCheck": {
"$ref": "./paths/NewTransactionCheck.json"
"/StatusCall": {
"$ref": "./paths/StatusCall.json"
},
"/SMS": {
"$ref": "./paths/SMS.json"
@@ -232,11 +232,11 @@
"PenalChargeResponse": {
"$ref": "./schemas/PenalChargeResponse.json"
},
"NewTransactionCheckRequest": {
"$ref": "./schemas/NewTransactionCheckRequest.json"
"StatusCallRequest": {
"$ref": "./schemas/StatusCallRequest.json"
},
"NewTransactionCheckResponse": {
"$ref": "./schemas/NewTransactionCheckResponse.json"
"StatusCallResponse": {
"$ref": "./schemas/StatusCallResponse.json"
},
"LienCheckRequest": {
"$ref": "./schemas/LienCheckRequest.json"
paths/NewTransactionCheck.json → paths/StatusCall.json
+9 -9
View File
@@ -1,27 +1,27 @@
{
"post": {
"tags": [
"NewTransactionCheck"
"StatusCall"
],
"summary": "New Transaction Check Request",
"description": "This new Transaction Check will be utilized for checking status of transactions in new Asynchronous requests. Request will be sent by Simbrella to check the status of Transaction on FirstBank side if Simbrella doesn't receive callback notification 5 minutes after initial request. New list of resultCodes with corresponding resultDescriptions must be provided by FirstBank to notify Simbrella in which cases Simbrella should retry sending the 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"
}
}
}
@@ -32,12 +32,12 @@
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
"$ref": "../schemas/StatusCallResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
"$ref": "../schemas/StatusCallResponse.json"
}
}
}
schemas/EligibilityCheckRequest.json
+3 -9
View File
@@ -1,7 +1,6 @@
{
"type": "object",
"required": [
"$type",
"transactionId",
"countryCode",
"customerId",
@@ -9,11 +8,6 @@
"channel"
],
"properties": {
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "EligibilityCheckRequest"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
@@ -37,13 +31,13 @@
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "2348012345678"
"example": "8093451342"
},
"channel": {
"type": "string",
"description": "Request channel: USSD, MobApp, or Web",
"description": "Request channel: “USSD” or “MobApp” or “Web” type Channel",
"enum": ["USSD", "MobApp", "Web"],
"example": "USSD"
"example": "100"
}
},
"xml": {
schemas/EligibilityCheckResponse.json
+5 -5
View File
@@ -35,13 +35,13 @@
"items": {
"type": "object",
"properties": {
"minamount": {
"minAmount": {
"type": "number",
"format": "double",
"description": "Minimum loan amount",
"example": 5000
},
"maxamount": {
"maxAmount": {
"type": "number",
"format": "double",
"description": "Maximum loan amount",
@@ -50,14 +50,14 @@
"productId": {
"type": "string",
"description": "Product identifier",
"example": "101"
"example": "2030"
},
"offerid": {
"offerId": {
"type": "string",
"description": "Offer identifier",
"example": "101"
},
"Tenor": {
"tenor": {
"type": "integer",
"description": "Loan tenor in days",
"example": 30
schemas/SelectOfferRequest.json
+3 -3
View File
@@ -7,7 +7,7 @@
"accountId",
"msisdn",
"requestedAmount",
"productid",
"productId",
"channel"
],
"properties": {
@@ -42,7 +42,7 @@
"description": "Amount of loan requested by user",
"example": 10000.0
},
"productid": {
"productId": {
"type": "string",
"description": "Product ID",
"example": "101"
@@ -51,7 +51,7 @@
"type": "string",
"description": "Channel of incoming request",
"enum": ["USSD", "FistMobile LitApp", "Web"],
"example": "100"
"example": "USSD"
}
},
"xml": {
schemas/SelectOfferResponse.json
+7 -7
View File
@@ -5,7 +5,7 @@
"transactionId",
"customerId",
"accountId",
"offers",
"loan",
"resultCode",
"resultDescription"
],
@@ -36,9 +36,9 @@
"description": "Outstanding debt amount if any",
"example": 0
},
"offers": {
"loan": {
"type": "array",
"description": "Array of loan offers",
"description": "Array of loan loan",
"items": {
"type": "object",
"properties": {
@@ -67,7 +67,7 @@
"interestRate": {
"type": "number",
"format": "double",
"description": "Percentage of interest rate",
"description": "Percentage (%) of interest rate",
"example": 3.0
},
"Interest": {
@@ -79,7 +79,7 @@
"ManagementRate": {
"type": "number",
"format": "double",
"description": "Percentage of management fee",
"description": "Percentage (%) of management fee",
"example": 1.0
},
"ManagementFee": {
@@ -91,7 +91,7 @@
"InsuranceRate": {
"type": "number",
"format": "double",
"description": "Percentage of insurance",
"description": "Percentage (%) of insurance",
"example": 1.0
},
"InsuranceFee": {
@@ -103,7 +103,7 @@
"VATRate": {
"type": "number",
"format": "double",
"description": "Percentage of VAT",
"description": "Percentage (%) of VAT",
"example": 7.5
},
"VATamount": {
schemas/NewTransactionCheckRequest.json → schemas/StatusCallRequest.json
+15 -15
View File
@@ -1,10 +1,20 @@
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "RequestId for transaction sent by Simbrella within initial request to Firstbank API",
"example": "R02802"
},
"countryCode": {
"type": "string",
"description": "Unique country code.",
"example": "NGR"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of request in Simbrella system",
"example": "173021"
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
@@ -17,16 +27,6 @@
"enum": ["Disbursement", "Collection", "PenalCharge"],
"example": "Disbursement"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"example": "FBN2411011411413A74960"
},
"origTransactionId": {
"type": "string",
"description": "TransactionId sent by Simbrella within initial request to Firstbank API",
"example": "2411011411413A74960"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
@@ -34,14 +34,14 @@
}
},
"required": [
"requestId",
"countryCode",
"transactionId",
"debtId",
"transactionType",
"fbnTransactionId",
"origTransactionId",
"customerId"
],
"xml": {
"name": "NewTransactionCheckRequest"
"name": "StatusCallRequest"
}
}
schemas/NewTransactionCheckResponse.json → schemas/StatusCallResponse.json
+1 -1
View File
@@ -64,6 +64,6 @@
"resultDescription"
],
"xml": {
"name": "NewTransactionCheckResponse"
"name": "StatusCallResponse"
}
}