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

Worked on the Provide Loan Request and Provide Loan Response

Browse Source
This commit is contained in:
Azeez Muibi
2025-03-19 15:30:37 +01:00
parent 424aa818e2
commit 9cf9ace55a
1 changed files with 134 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
digifi_swagger.json
+134 -26
View File
@@ -175,29 +175,18 @@
},
"/ProvideLoan": {
"post": {
"tags": [
"ProvideLoan"
],
"summary": "Provide Loan Request ",
"summary": "Provide Loan Request",
"description": "Provide Loan Request",
"operationId": "startEligibilityCheck",
"operationId": "provideLoan",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"description": "Post JSON to provide loan",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EligibilityCheckRequest"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EligibilityCheckRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/EligibilityCheckRequest"
"$ref": "#/components/schemas/ProvideLoanRequest"
}
}
},
@@ -209,21 +198,16 @@
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EligibilityCheckResponse"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/EligibilityCheckResponse"
"$ref": "#/components/schemas/ProvideLoanResponse"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
"description": "Invalid request parameters"
},
"404": {
"description": "Pet not found"
"description": "Resource not found"
},
"422": {
"description": "Validation exception"
@@ -231,9 +215,7 @@
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
"basicAuth": [
]
}
]
@@ -680,6 +662,132 @@
}
}
},
"ProvideLoanRequest": {
"type": "object",
"required": [
"$type",
"transactionId",
"customerId",
"accountId",
"productId",
"requestedAmount",
"collectionType",
"loanType",
"channel"
],
"properties": {
"$type": {
"type": "string",
"example": "ProvideLoanRequest",
"description": "Value is fixed to 'ProvideLoanRequest'"
},
"requestId": {
"type": "string",
"example": "202111170001371256908",
"description": "Unique identifier of request"
},
"transactionId": {
"type": "string",
"example": "Tr201712RK9232P115",
"description": "Unique ID of customer’s USSD session. Must be consistent throughout whole USSD journey"
},
"customerId": {
"type": "string",
"example": "CN621868",
"description": "Unique identifier of a customer"
},
"accountId": {
"type": "string",
"example": "ACN8263457",
"description": "Specific identifier of a user's account"
},
"msisdn": {
"type": "string",
"example": "3451342",
"description": "User's mobile number in an international format"
},
"productId": {
"type": "string",
"example": "101",
"description": "Identifier of a product chosen by user"
},
"lienAmount": {
"type": "number",
"format": "double",
"example": 400,
"description": "Amount of lien"
},
"requestedAmount": {
"type": "number",
"format": "double",
"example": 900,
"description": "Amount of loan that requested by user"
},
"collectionType": {
"type": "integer",
"example": 1,
"description": "Type of collection that user is preferred. 0 – as soon as salary inflow occurs; 1- as soon as any new inflow occurs, 1 – collection after XX days"
},
"loanType": {
"type": "integer",
"example": 0,
"description": "Type of loan. 0 - simple; 1 - refinance"
},
"channel": {
"type": "string",
"example": "USSD",
"description": "Request channel: 'USSD' or 'MobileApp' or 'Web'"
}
}
},
"ProvideLoanResponse": {
"type": "object",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"resultCode",
"resultDescription"
],
"properties": {
"requestId": {
"type": "string",
"example": "202111170001371256908",
"description": "Unique identifier of request"
},
"transactionId": {
"type": "string",
"example": "Tr201712RK9232P115",
"description": "Unique ID of customer’s USSD session. Must be consistent throughout whole USSD journey"
},
"customerId": {
"type": "string",
"example": "CN621868",
"description": "Unique identifier of a customer"
},
"accountId": {
"type": "string",
"example": "ACN8263457",
"description": "Specific identifier of a user's account"
},
"msisdn": {
"type": "string",
"example": "3451342",
"description": "User's mobile number in an international format"
},
"resultCode": {
"type": "string",
"example": "00",
"description": "Result code of executed transaction"
},
"resultDescription": {
"type": "string",
"example": "Successful",
"description": "Description of provided result code"
}
}
},
"LoanInformationRequest": {
"type": "object",
"properties": {