diff --git a/digifi_swagger.json b/digifi_swagger.json index 0f6fd1e..4f4cbc4 100644 --- a/digifi_swagger.json +++ b/digifi_swagger.json @@ -108,8 +108,8 @@ } }, { - "name": "NewTransactionCheck", - "description": "New Transaction Check", + "name": "StatusCall", + "description": "Status Call", "externalDocs": { "description": "Find out more", "url": "https://www.simbrellang.net" @@ -166,8 +166,8 @@ "/LienCheck": { "$ref": "./paths/LienCheck.json" }, - "/NewTransactionCheck": { - "$ref": "./paths/NewTransactionCheck.json" + "/StatusCall": { + "$ref": "./paths/StatusCall.json" }, "/SMS": { "$ref": "./paths/SMS.json" @@ -232,11 +232,11 @@ "PenalChargeResponse": { "$ref": "./schemas/PenalChargeResponse.json" }, - "NewTransactionCheckRequest": { - "$ref": "./schemas/NewTransactionCheckRequest.json" + "StatusCallRequest": { + "$ref": "./schemas/StatusCallRequest.json" }, - "NewTransactionCheckResponse": { - "$ref": "./schemas/NewTransactionCheckResponse.json" + "StatusCallResponse": { + "$ref": "./schemas/StatusCallResponse.json" }, "LienCheckRequest": { "$ref": "./schemas/LienCheckRequest.json" diff --git a/paths/NewTransactionCheck.json b/paths/StatusCall.json similarity index 50% rename from paths/NewTransactionCheck.json rename to paths/StatusCall.json index 1497214..7fb1289 100644 --- a/paths/NewTransactionCheck.json +++ b/paths/StatusCall.json @@ -1,27 +1,27 @@ { "post": { "tags": [ - "NewTransactionCheck" + "StatusCall" ], - "summary": "New Transaction Check Request", - "description": "This new Transaction Check will be utilized for checking status of transactions in new Asynchronous requests. Request will be sent by Simbrella to check the status of Transaction on FirstBank side if Simbrella doesn't receive callback notification 5 minutes after initial request. New list of resultCodes with corresponding resultDescriptions must be provided by FirstBank to notify Simbrella in which cases Simbrella should retry sending the request.", - "operationId": "newTransactionCheck", + "summary": "Status Call Request", + "description": "This will be used to check the status of a transaction by Simbrella to Firstabank if there is no initial response after 2mins.", + "operationId": "statusCall", "requestBody": { "required": true, "content": { "application/json": { "schema": { - "$ref": "../schemas/NewTransactionCheckRequest.json" + "$ref": "../schemas/StatusCallRequest.json" } }, "application/xml": { "schema": { - "$ref": "../schemas/NewTransactionCheckRequest.json" + "$ref": "../schemas/StatusCallRequest.json" } }, "application/x-www-form-urlencoded": { "schema": { - "$ref": "../schemas/NewTransactionCheckRequest.json" + "$ref": "../schemas/StatusCallRequest.json" } } } @@ -32,12 +32,12 @@ "content": { "application/json": { "schema": { - "$ref": "../schemas/NewTransactionCheckResponse.json" + "$ref": "../schemas/StatusCallResponse.json" } }, "application/xml": { "schema": { - "$ref": "../schemas/NewTransactionCheckResponse.json" + "$ref": "../schemas/StatusCallResponse.json" } } } diff --git a/schemas/EligibilityCheckRequest.json b/schemas/EligibilityCheckRequest.json index 7d28251..652469d 100644 --- a/schemas/EligibilityCheckRequest.json +++ b/schemas/EligibilityCheckRequest.json @@ -1,7 +1,6 @@ { "type": "object", "required": [ - "$type", "transactionId", "countryCode", "customerId", @@ -9,11 +8,6 @@ "channel" ], "properties": { - "$type": { - "type": "string", - "description": "Fixed value to identify request type", - "example": "EligibilityCheckRequest" - }, "transactionId": { "type": "string", "description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms", @@ -37,13 +31,13 @@ "msisdn": { "type": "string", "description": "User's mobile number in an international format", - "example": "2348012345678" + "example": "8093451342" }, "channel": { "type": "string", - "description": "Request channel: USSD, MobApp, or Web", + "description": "Request channel: “USSD” or “MobApp” or “Web” type Channel", "enum": ["USSD", "MobApp", "Web"], - "example": "USSD" + "example": "100" } }, "xml": { diff --git a/schemas/EligibilityCheckResponse.json b/schemas/EligibilityCheckResponse.json index db3c0a3..15b4415 100644 --- a/schemas/EligibilityCheckResponse.json +++ b/schemas/EligibilityCheckResponse.json @@ -35,13 +35,13 @@ "items": { "type": "object", "properties": { - "minamount": { + "minAmount": { "type": "number", "format": "double", "description": "Minimum loan amount", "example": 5000 }, - "maxamount": { + "maxAmount": { "type": "number", "format": "double", "description": "Maximum loan amount", @@ -50,14 +50,14 @@ "productId": { "type": "string", "description": "Product identifier", - "example": "101" + "example": "2030" }, - "offerid": { + "offerId": { "type": "string", "description": "Offer identifier", "example": "101" }, - "Tenor": { + "tenor": { "type": "integer", "description": "Loan tenor in days", "example": 30 diff --git a/schemas/SelectOfferRequest.json b/schemas/SelectOfferRequest.json index 3ae4683..ff35ae8 100644 --- a/schemas/SelectOfferRequest.json +++ b/schemas/SelectOfferRequest.json @@ -7,7 +7,7 @@ "accountId", "msisdn", "requestedAmount", - "productid", + "productId", "channel" ], "properties": { @@ -42,7 +42,7 @@ "description": "Amount of loan requested by user", "example": 10000.0 }, - "productid": { + "productId": { "type": "string", "description": "Product ID", "example": "101" @@ -51,7 +51,7 @@ "type": "string", "description": "Channel of incoming request", "enum": ["USSD", "FistMobile LitApp", "Web"], - "example": "100" + "example": "USSD" } }, "xml": { diff --git a/schemas/SelectOfferResponse.json b/schemas/SelectOfferResponse.json index 8e56f25..8b86a3c 100644 --- a/schemas/SelectOfferResponse.json +++ b/schemas/SelectOfferResponse.json @@ -5,7 +5,7 @@ "transactionId", "customerId", "accountId", - "offers", + "loan", "resultCode", "resultDescription" ], @@ -36,9 +36,9 @@ "description": "Outstanding debt amount if any", "example": 0 }, - "offers": { + "loan": { "type": "array", - "description": "Array of loan offers", + "description": "Array of loan loan", "items": { "type": "object", "properties": { @@ -67,7 +67,7 @@ "interestRate": { "type": "number", "format": "double", - "description": "Percentage of interest rate", + "description": "Percentage (%) of interest rate", "example": 3.0 }, "Interest": { @@ -79,7 +79,7 @@ "ManagementRate": { "type": "number", "format": "double", - "description": "Percentage of management fee", + "description": "Percentage (%) of management fee", "example": 1.0 }, "ManagementFee": { @@ -91,7 +91,7 @@ "InsuranceRate": { "type": "number", "format": "double", - "description": "Percentage of insurance", + "description": "Percentage (%) of insurance", "example": 1.0 }, "InsuranceFee": { @@ -103,7 +103,7 @@ "VATRate": { "type": "number", "format": "double", - "description": "Percentage of VAT", + "description": "Percentage (%) of VAT", "example": 7.5 }, "VATamount": { diff --git a/schemas/NewTransactionCheckRequest.json b/schemas/StatusCallRequest.json similarity index 61% rename from schemas/NewTransactionCheckRequest.json rename to schemas/StatusCallRequest.json index 4885cef..14d5035 100644 --- a/schemas/NewTransactionCheckRequest.json +++ b/schemas/StatusCallRequest.json @@ -1,10 +1,20 @@ { "type": "object", "properties": { + "requestId": { + "type": "string", + "description": "RequestId for transaction sent by Simbrella within initial request to Firstbank API", + "example": "R02802" + }, + "countryCode": { + "type": "string", + "description": "Unique country code.", + "example": "NGR" + }, "transactionId": { "type": "string", - "description": "Unique identifier of request in Simbrella system", - "example": "173021" + "description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms", + "example": "Tr201712RK9232P115" }, "debtId": { "type": "string", @@ -17,16 +27,6 @@ "enum": ["Disbursement", "Collection", "PenalCharge"], "example": "Disbursement" }, - "fbnTransactionId": { - "type": "string", - "description": "Unique id of the transaction received from FBN in Eligibility or Provision requests", - "example": "FBN2411011411413A74960" - }, - "origTransactionId": { - "type": "string", - "description": "TransactionId sent by Simbrella within initial request to Firstbank API", - "example": "2411011411413A74960" - }, "customerId": { "type": "string", "description": "Unique identifier of a user", @@ -34,14 +34,14 @@ } }, "required": [ + "requestId", + "countryCode", "transactionId", "debtId", "transactionType", - "fbnTransactionId", - "origTransactionId", "customerId" ], "xml": { - "name": "NewTransactionCheckRequest" + "name": "StatusCallRequest" } } \ No newline at end of file diff --git a/schemas/NewTransactionCheckResponse.json b/schemas/StatusCallResponse.json similarity index 98% rename from schemas/NewTransactionCheckResponse.json rename to schemas/StatusCallResponse.json index f88c4e5..9ad4169 100644 --- a/schemas/NewTransactionCheckResponse.json +++ b/schemas/StatusCallResponse.json @@ -64,6 +64,6 @@ "resultDescription" ], "xml": { - "name": "NewTransactionCheckResponse" + "name": "StatusCallResponse" } } \ No newline at end of file