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

Worked on the Select Offers Request and Select Offers Response

Browse Source
This commit is contained in:
Azeez Muibi
2025-03-19 15:19:19 +01:00
parent 903082506e
commit 424aa818e2
1 changed files with 139 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
digifi_swagger.json
+139 -50
View File
@@ -82,7 +82,7 @@
"tags": [ "tags": [
"EligibilityCheck" "EligibilityCheck"
], ],
"summary": "Start the process - initiate steps to eligibility RAC Checks ", "summary": "Start the process - initiate steps to eligibility RAC Checks",
"description": "Initiate Eligibility Check Request", "description": "Initiate Eligibility Check Request",
"operationId": "startEligibilityCheck", "operationId": "startEligibilityCheck",
"requestBody": { "requestBody": {
@@ -127,30 +127,19 @@
}, },
"/SelectOffer": { "/SelectOffer": {
"post": { "post": {
"tags": [ "tags": [
"SelectOffer" "SelectOffer"
], ],
"summary": "This method is used the send the offer the customer selected to Simbrella ", "summary": "This method is used to send the offer the customer selected to Simbrella",
"description": "This method is used the send the offer the customer selected to Simbrella", "description": "This method is used to send the offer the customer selected to Simbrella",
"operationId": "startEligibilityCheck", "operationId": "selectOffer",
"requestBody": { "requestBody": {
"description": "Post JSON to conduct eligibility tests", "description": "Post JSON with selected offer details",
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/SelectOffersRequest" "$ref": "#/components/schemas/SelectOffersRequest"
} }
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SelectOffersRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/SelectOffersRequest"
}
} }
}, },
"required": true "required": true
@@ -163,16 +152,11 @@
"schema": { "schema": {
"$ref": "#/components/schemas/SelectOffersResponse" "$ref": "#/components/schemas/SelectOffersResponse"
} }
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/SelectOffersResponse"
}
} }
} }
}, },
"400": { "400": {
"description": "Invalid ID supplied" "description": "Invalid request parameters"
}, },
"404": { "404": {
"description": "Offers not found" "description": "Offers not found"
@@ -183,9 +167,7 @@
}, },
"security": [ "security": [
{ {
"petstore_auth": [ "basicAuth": [
"write:pets",
"read:pets"
] ]
} }
] ]
@@ -516,79 +498,186 @@
}, },
"SelectOffersRequest": { "SelectOffersRequest": {
"type": "object", "type": "object",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"msisdn",
"requestedAmount",
"productid",
"channel"
],
"properties": { "properties": {
"requestId": { "requestId": {
"type": "string", "type": "string",
"example": "202111170001371256908" "example": "202111170001371256908",
"description": "Unique identifier of request"
}, },
"transactionId": { "transactionId": {
"type": "string", "type": "string",
"example": "1231231321232" "example": "1231231321232",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey"
}, },
"customerId": { "customerId": {
"type": "string", "type": "string",
"example": "CN621868" "example": "1256907",
"description": "Unique identifier of a customer"
},
"accountId": {
"type": "string",
"example": "5948306019",
"description": "Specific identifier of a user's account"
}, },
"msisdn": { "msisdn": {
"type": "string", "type": "string",
"example": "123456789" "example": "123456789",
"description": "User's mobile number in an international format"
}, },
"requestedAmount": { "requestedAmount": {
"type": "number", "type": "number",
"format": "double", "format": "double",
"example": 10000.55 "example": 10000.0,
}, "description": "Amount of loan requested by user"
"accountId": {
"type": "string",
"example": "ACN8263457"
}, },
"productid": { "productid": {
"type": "string", "type": "string",
"example": "101" "example": "101",
"description": "Product ID"
}, },
"channel": { "channel": {
"type": "string", "type": "string",
"example": "USSD" "example": "USSD",
"description": "Channel of incoming request: USSD"
} }
},
"xml": {
"name": "SelectOffersRequest"
} }
}, },
"SelectOffersResponse": { "SelectOffersResponse": {
"type": "object", "type": "object",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"offers",
"resultCode",
"resultDescription"
],
"properties": { "properties": {
"outstandingDebtAmount": {
"type": "number",
"format": "double",
"example": 0
},
"requestId": { "requestId": {
"type": "string", "type": "string",
"example": "202111170001371256908" "example": "202111170001371256908",
"description": "Unique identifier of request"
}, },
"transactionId": { "transactionId": {
"type": "string", "type": "string",
"example": "1231231321232" "example": "1231231321232",
"description": "Unique ID of customer's USSD session"
}, },
"customerId": { "customerId": {
"type": "string", "type": "string",
"example": "CN621868" "example": "1256907",
"description": "Unique identifier of a customer"
}, },
"accountId": { "accountId": {
"type": "string", "type": "string",
"example": "ACN8263457" "example": "5948306019",
"description": "Specific identifier of a user's account"
}, },
"offers": { "offers": {
"type": "string", "type": "array",
"example": "ARRAY of Offers" "items": {
"type": "object",
"properties": {
"offerId": {
"type": "string",
"example": "14451"
},
"productId": {
"type": "string",
"example": "2030"
},
"amount": {
"type": "number",
"format": "double",
"example": 10000.0
},
"upfrontPayment": {
"type": "number",
"format": "double",
"example": 1000.0
},
"interestRate": {
"type": "number",
"format": "double",
"example": 3.0
},
"ManagementRate": {
"type": "number",
"format": "double",
"example": 1.0
},
"ManagementFee": {
"type": "number",
"format": "double",
"example": 1.0
},
"InsuranceRate": {
"type": "number",
"format": "double",
"example": 1.0
},
"InsuranceFee": {
"type": "number",
"format": "double",
"example": 100.0
},
"VATRate": {
"type": "number",
"format": "double",
"example": 7.5
},
"VATamount": {
"type": "number",
"format": "double",
"example": 100.0
},
"recommendedRepaymentDates": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"2022-11-30"]
},
"installmentAmount": {
"type": "number",
"format": "double",
"example": 11000.0
},
"totalRepaymentAmount": {
"type": "number",
"format": "double",
"example": 11000.0
}
}
}
}, },
"resultCode": { "resultCode": {
"type": "string", "type": "string",
"example": "00" "example": "00",
"description": "Result code of executed transaction"
}, },
"resultDescription": { "resultDescription": {
"type": "string", "type": "string",
"example": "Successful" "example": "Successful",
"description": "Description of provided result code"
} }
},
"xml": {
"name": "SelectOffersResponse"
} }
}, },
"LoanInformationRequest": { "LoanInformationRequest": {