diff --git a/digifi_swagger.json b/digifi_swagger.json index 9596e63..4fa8387 100644 --- a/digifi_swagger.json +++ b/digifi_swagger.json @@ -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" diff --git a/paths/LoanInformation.json b/paths/LoanStatus.json similarity index 80% rename from paths/LoanInformation.json rename to paths/LoanStatus.json index b6b978b..1081840 100644 --- a/paths/LoanInformation.json +++ b/paths/LoanStatus.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" } } } diff --git a/schemas/EligibilityCheckRequest.json b/schemas/EligibilityCheckRequest.json index 07819c4..7d28251 100644 --- a/schemas/EligibilityCheckRequest.json +++ b/schemas/EligibilityCheckRequest.json @@ -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", diff --git a/schemas/EligibilityCheckResponse.json b/schemas/EligibilityCheckResponse.json index db7398c..db3c0a3 100644 --- a/schemas/EligibilityCheckResponse.json +++ b/schemas/EligibilityCheckResponse.json @@ -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", diff --git a/schemas/LoanInformationRequest.json b/schemas/LoanStatusRequest.json similarity index 82% rename from schemas/LoanInformationRequest.json rename to schemas/LoanStatusRequest.json index c545af7..3867395 100644 --- a/schemas/LoanInformationRequest.json +++ b/schemas/LoanStatusRequest.json @@ -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" } } \ No newline at end of file diff --git a/schemas/LoanInformationResponse.json b/schemas/LoanStatusResponse.json similarity index 98% rename from schemas/LoanInformationResponse.json rename to schemas/LoanStatusResponse.json index 38c5ba3..d749d3b 100644 --- a/schemas/LoanInformationResponse.json +++ b/schemas/LoanStatusResponse.json @@ -85,6 +85,6 @@ } }, "xml": { - "name": "LoanInformationResponse" + "name": "LoanStatusResponse" } } \ No newline at end of file diff --git a/schemas/ProvideLoanRequest.json b/schemas/ProvideLoanRequest.json index 90a7452..8e5b37b 100644 --- a/schemas/ProvideLoanRequest.json +++ b/schemas/ProvideLoanRequest.json @@ -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": { diff --git a/schemas/ProvideLoanResponse.json b/schemas/ProvideLoanResponse.json index 5769398..701d80b 100644 --- a/schemas/ProvideLoanResponse.json +++ b/schemas/ProvideLoanResponse.json @@ -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": { diff --git a/schemas/SelectOfferRequest.json b/schemas/SelectOfferRequest.json index 24e6dea..3ae4683 100644 --- a/schemas/SelectOfferRequest.json +++ b/schemas/SelectOfferRequest.json @@ -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": { diff --git a/schemas/SelectOfferResponse.json b/schemas/SelectOfferResponse.json index 2e55fdb..8e56f25 100644 --- a/schemas/SelectOfferResponse.json +++ b/schemas/SelectOfferResponse.json @@ -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": {