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", "name": "LoanStatus",
"description": "Loan Information Request.", "description": "Loan Status Request.",
"externalDocs": { "externalDocs": {
"description": "Find out more", "description": "Find out more",
"url": "https://www.simbrellang.net" "url": "https://www.simbrellang.net"
@@ -174,8 +174,8 @@
"/ProvideLoan": { "/ProvideLoan": {
"$ref": "./paths/ProvideLoan.json" "$ref": "./paths/ProvideLoan.json"
}, },
"/LoanInformation": { "/LoanStatus": {
"$ref": "./paths/LoanInformation.json" "$ref": "./paths/LoanStatus.json"
}, },
"/Repayment": { "/Repayment": {
"$ref": "./paths/Repayment.json" "$ref": "./paths/Repayment.json"
@@ -234,11 +234,11 @@
"SelectOfferResponse": { "SelectOfferResponse": {
"$ref": "./schemas/SelectOfferResponse.json" "$ref": "./schemas/SelectOfferResponse.json"
}, },
"LoanInformationRequest": { "LoanStatusRequest": {
"$ref": "./schemas/LoanInformationRequest.json" "$ref": "./schemas/LoanStatusRequest.json"
}, },
"LoanInformationResponse": { "LoanStatusResponse": {
"$ref": "./schemas/LoanInformationResponse.json" "$ref": "./schemas/LoanStatusResponse.json"
}, },
"RepaymentRequest": { "RepaymentRequest": {
"$ref": "./schemas/RepaymentRequest.json" "$ref": "./schemas/RepaymentRequest.json"
@@ -1,7 +1,7 @@
{ {
"post": { "post": {
"tags": [ "tags": [
"LoanInformation" "LoanStatus"
], ],
"summary": "Get information about customer's existing loans", "summary": "Get information about customer's existing loans",
"description": "Loan Information Request to retrieve details about customer's existing loans", "description": "Loan Information Request to retrieve details about customer's existing loans",
@@ -11,17 +11,17 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "../schemas/LoanInformationRequest.json" "$ref": "../schemas/LoanStatusRequest.json"
} }
}, },
"application/xml": { "application/xml": {
"schema": { "schema": {
"$ref": "../schemas/LoanInformationRequest.json" "$ref": "../schemas/LoanStatusRequest.json"
} }
}, },
"application/x-www-form-urlencoded": { "application/x-www-form-urlencoded": {
"schema": { "schema": {
"$ref": "../schemas/LoanInformationRequest.json" "$ref": "../schemas/LoanStatusRequest.json"
} }
} }
}, },
@@ -33,12 +33,12 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "../schemas/LoanInformationResponse.json" "$ref": "../schemas/LoanStatusResponse.json"
} }
}, },
"application/xml": { "application/xml": {
"schema": { "schema": {
"$ref": "../schemas/LoanInformationResponse.json" "$ref": "../schemas/LoanStatusResponse.json"
} }
} }
} }
+1 -8
View File
@@ -6,7 +6,6 @@
"countryCode", "countryCode",
"customerId", "customerId",
"accountId", "accountId",
"lienAmount",
"channel" "channel"
], ],
"properties": { "properties": {
@@ -17,7 +16,7 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "Tr201712RK9232P115"
}, },
"countryCode": { "countryCode": {
@@ -40,12 +39,6 @@
"description": "User's mobile number in an international format", "description": "User's mobile number in an international format",
"example": "2348012345678" "example": "2348012345678"
}, },
"lienAmount": {
"type": "number",
"format": "double",
"description": "Amount of lien placed on user's account",
"example": 4.0
},
"channel": { "channel": {
"type": "string", "type": "string",
"description": "Request channel: USSD, MobApp, or Web", "description": "Request channel: USSD, MobApp, or Web",
+7 -1
View File
@@ -3,6 +3,7 @@
"required": [ "required": [
"customerId", "customerId",
"transactionId", "transactionId",
"countryCode",
"eligibleOffers", "eligibleOffers",
"resultCode", "resultCode",
"resultDescription" "resultDescription"
@@ -15,9 +16,14 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "Tr201712RK9232P115"
}, },
"countryCode": {
"type": "string",
"description": "Unique country code. Please refer to “Country Codes” table",
"example": "NGR"
},
"msisdn": { "msisdn": {
"type": "string", "type": "string",
"description": "User's mobile number in an international format", "description": "User's mobile number in an international format",
@@ -10,11 +10,11 @@
"$type": { "$type": {
"type": "string", "type": "string",
"description": "Fixed value to identify request type", "description": "Fixed value to identify request type",
"example": "LoanInformationRequest" "example": "LoanStatusRequest"
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "Tr201712RK9232P115"
}, },
"customerId": { "customerId": {
@@ -35,6 +35,6 @@
} }
}, },
"xml": { "xml": {
"name": "LoanInformationRequest" "name": "LoanStatusRequest"
} }
} }
@@ -85,6 +85,6 @@
} }
}, },
"xml": { "xml": {
"name": "LoanInformationResponse" "name": "LoanStatusResponse"
} }
} }
+1 -1
View File
@@ -13,7 +13,7 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "Tr201712RK9232P115"
}, },
"customerId": { "customerId": {
+1 -1
View File
@@ -8,7 +8,7 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "Tr201712RK9232P115"
}, },
"customerId": { "customerId": {
+3 -3
View File
@@ -18,7 +18,7 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "1231231321232"
}, },
"customerId": { "customerId": {
@@ -50,8 +50,8 @@
"channel": { "channel": {
"type": "string", "type": "string",
"description": "Channel of incoming request", "description": "Channel of incoming request",
"enum": ["USSD", "MobApp", "Web"], "enum": ["USSD", "FistMobile LitApp", "Web"],
"example": "USSD" "example": "100"
} }
}, },
"xml": { "xml": {
+1 -1
View File
@@ -17,7 +17,7 @@
}, },
"transactionId": { "transactionId": {
"type": "string", "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" "example": "1231231321232"
}, },
"customerId": { "customerId": {