Updated the Request

This commit is contained in:
Azeez Muibi
2025-03-24 17:17:43 +01:00
parent 0c5b976117
commit c13d3f1767
10 changed files with 32 additions and 33 deletions
+8 -8
View File
@@ -44,8 +44,8 @@
}
},
{
"name": "LoanInformation",
"description": "Loan Information Request.",
"name": "LoanStatus",
"description": "Loan Status Request.",
"externalDocs": {
"description": "Find out more",
"url": "https://www.simbrellang.net"
@@ -174,8 +174,8 @@
"/ProvideLoan": {
"$ref": "./paths/ProvideLoan.json"
},
"/LoanInformation": {
"$ref": "./paths/LoanInformation.json"
"/LoanStatus": {
"$ref": "./paths/LoanStatus.json"
},
"/Repayment": {
"$ref": "./paths/Repayment.json"
@@ -234,11 +234,11 @@
"SelectOfferResponse": {
"$ref": "./schemas/SelectOfferResponse.json"
},
"LoanInformationRequest": {
"$ref": "./schemas/LoanInformationRequest.json"
"LoanStatusRequest": {
"$ref": "./schemas/LoanStatusRequest.json"
},
"LoanInformationResponse": {
"$ref": "./schemas/LoanInformationResponse.json"
"LoanStatusResponse": {
"$ref": "./schemas/LoanStatusResponse.json"
},
"RepaymentRequest": {
"$ref": "./schemas/RepaymentRequest.json"
@@ -1,7 +1,7 @@
{
"post": {
"tags": [
"LoanInformation"
"LoanStatus"
],
"summary": "Get information about customer's existing loans",
"description": "Loan Information Request to retrieve details about customer's existing loans",
@@ -11,17 +11,17 @@
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
"$ref": "../schemas/LoanStatusRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
"$ref": "../schemas/LoanStatusRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
"$ref": "../schemas/LoanStatusRequest.json"
}
}
},
@@ -33,12 +33,12 @@
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
"$ref": "../schemas/LoanStatusResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
"$ref": "../schemas/LoanStatusResponse.json"
}
}
}
+1 -8
View File
@@ -6,7 +6,6 @@
"countryCode",
"customerId",
"accountId",
"lienAmount",
"channel"
],
"properties": {
@@ -17,7 +16,7 @@
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"countryCode": {
@@ -40,12 +39,6 @@
"description": "User's mobile number in an international format",
"example": "2348012345678"
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Amount of lien placed on user's account",
"example": 4.0
},
"channel": {
"type": "string",
"description": "Request channel: USSD, MobApp, or Web",
+7 -1
View File
@@ -3,6 +3,7 @@
"required": [
"customerId",
"transactionId",
"countryCode",
"eligibleOffers",
"resultCode",
"resultDescription"
@@ -15,9 +16,14 @@
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"countryCode": {
"type": "string",
"description": "Unique country code. Please refer to “Country Codes” table",
"example": "NGR"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
@@ -10,11 +10,11 @@
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "LoanInformationRequest"
"example": "LoanStatusRequest"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"customerId": {
@@ -35,6 +35,6 @@
}
},
"xml": {
"name": "LoanInformationRequest"
"name": "LoanStatusRequest"
}
}
@@ -85,6 +85,6 @@
}
},
"xml": {
"name": "LoanInformationResponse"
"name": "LoanStatusResponse"
}
}
+1 -1
View File
@@ -13,7 +13,7 @@
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"customerId": {
+1 -1
View File
@@ -8,7 +8,7 @@
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
},
"customerId": {
+3 -3
View File
@@ -18,7 +18,7 @@
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "1231231321232"
},
"customerId": {
@@ -50,8 +50,8 @@
"channel": {
"type": "string",
"description": "Channel of incoming request",
"enum": ["USSD", "MobApp", "Web"],
"example": "USSD"
"enum": ["USSD", "FistMobile LitApp", "Web"],
"example": "100"
}
},
"xml": {
+1 -1
View File
@@ -17,7 +17,7 @@
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platform",
"example": "1231231321232"
},
"customerId": {