diff --git a/paths/PenalCharge.json b/paths/PenalCharge.json index a491e08..202c8ce 100644 --- a/paths/PenalCharge.json +++ b/paths/PenalCharge.json @@ -4,7 +4,7 @@ "PenalCharge" ], "summary": "Penal Charge Request", - "description": "This request is used to charge customer for penalty as per existing debt. Results of requests sent to this endpoint will be received from NotificationCallback endpoint.", + "description": "This request is used to charge customers for penalty as per existing debt", "operationId": "penalCharge", "requestBody": { "required": true, diff --git a/paths/TransactionVerify.json b/paths/TransactionVerify.json index 5e5547a..940364c 100644 --- a/paths/TransactionVerify.json +++ b/paths/TransactionVerify.json @@ -4,7 +4,7 @@ "TransactionVerify" ], "summary": "Transaction Verification Request", - "description": "This request is to double check the response received from DisburseLoan and CollectLoan Synchronous APIs. This request is required to check transaction result on FIRSTBANK.", + "description": "This request is to double check the response received from DisburseLoan and CollectLoan Synchronous APIs. This request is required to check transaction results on FIRSTBANK.", "operationId": "transactionVerify", "requestBody": { "required": true, diff --git a/schemas/PenalChargeRequest.json b/schemas/PenalChargeRequest.json index 8de7122..067fc26 100644 --- a/schemas/PenalChargeRequest.json +++ b/schemas/PenalChargeRequest.json @@ -38,11 +38,6 @@ "description": "Aggregated (summed up) lien amount", "example": 101.2 }, - "countryId": { - "type": "string", - "description": "Set to static value '01'", - "example": "01" - }, "comment": { "type": "string", "description": "Any additional comment for provided loan operation", @@ -56,8 +51,7 @@ "customerId", "accountId", "penalCharge", - "lienAmount", - "countryId" + "lienAmount" ], "xml": { "name": "PenalChargeRequest" diff --git a/schemas/RepaymentRequest.json b/schemas/RepaymentRequest.json index 3dc5139..ce7803a 100644 --- a/schemas/RepaymentRequest.json +++ b/schemas/RepaymentRequest.json @@ -8,7 +8,7 @@ "customerId", "accountId", "productId", - "collectAmount", + "collectedAmount", "collectionMethod", "lienAmount" ], @@ -48,7 +48,7 @@ "description": "Identifier of a product for which collection to be made", "example": "101" }, - "collectAmount": { + "collectedAmount": { "type": "number", "format": "double", "description": "Amount to be collected from user's account (penalCharge is not included)", @@ -86,7 +86,7 @@ "customerId": "CN621868", "accountId": "2017821799", "productId": "101", - "collectAmount": 80000.00, + "collectedAmount": 80000.00, "penalCharge": 0, "collectionMethod": 1, "lienAmount": 80000.00, diff --git a/schemas/RepaymentResponse.json b/schemas/RepaymentResponse.json index 1bb1b76..726e23c 100644 --- a/schemas/RepaymentResponse.json +++ b/schemas/RepaymentResponse.json @@ -8,7 +8,7 @@ "customerId", "accountId", "productId", - "collectAmount", + "collectedAmount", "lienAmount", "resultCode", "resultDescription" @@ -49,7 +49,7 @@ "description": "Identifier of a product for which collection to be made", "example": "101" }, - "collectAmount": { + "collectedAmount": { "type": "number", "format": "double", "description": "Amount to be collected from user's account (penalCharge is not included)", @@ -91,7 +91,7 @@ "customerId": "CN621868", "accountId": "2017821799", "productId": "101", - "collectAmount": 60000.00, + "collectedAmount": 60000.00, "penalCharge": 0, "lienAmount": 20000, "comment": "Testing CollectionLoanRequest", diff --git a/schemas/TransactionVerifyRequest.json b/schemas/TransactionVerifyRequest.json index b403cf2..8f6c9b9 100644 --- a/schemas/TransactionVerifyRequest.json +++ b/schemas/TransactionVerifyRequest.json @@ -1,20 +1,34 @@ { "type": "object", + "required": [ + "requestId", + "countryCode", + "counter", + "transactionId", + "customerId", + "accountId", + "transactionType" + ], "properties": { + "requestId": { + "type": "string", + "description": "Unique identifier of request", + "example": "R02802" + }, + "countryCode": { + "type": "string", + "description": "Unique country code. Please refer to Country Codes table", + "example": "NGR" + }, "counter": { "type": "string", "description": "Unique counter for number of attempts of the API call. Original attempt is 1", "example": "2" }, - "TransactionId": { + "transactionId": { "type": "string", "description": "Id of the transaction we are checking", - "example": "T002" - }, - "RequestId": { - "type": "string", - "description": "Id of this transaction query", - "example": "R02802" + "example": "Tr201712RK9232P115" }, "customerId": { "type": "string", @@ -26,11 +40,6 @@ "description": "Specific identifier of a user's account", "example": "2017821799" }, - "countryId": { - "type": "string", - "description": "Set to static value '01'", - "example": "01" - }, "transactionType": { "type": "string", "description": "To check state of loan disbursal transaction, value must be 'Disbursement', to check state of loan collection transaction, value must be 'Collection', to check state of penalty charge transaction, value must be 'Penalty'", @@ -38,15 +47,15 @@ "example": "Disbursement" } }, - "required": [ - "counter", - "TransactionId", - "RequestId", - "customerId", - "accountId", - "countryId", - "transactionType" - ], + "example": { + "requestId": "R02802", + "countryCode": "NGR", + "counter": "2", + "transactionId": "Tr201712RK9232P115", + "customerId": "CN621868", + "accountId": "2017821799", + "transactionType": "Disbursement" + }, "xml": { "name": "TransactionVerifyRequest" } diff --git a/schemas/TransactionVerifyResponse.json b/schemas/TransactionVerifyResponse.json index 1911db8..78e22c2 100644 --- a/schemas/TransactionVerifyResponse.json +++ b/schemas/TransactionVerifyResponse.json @@ -1,11 +1,38 @@ { "type": "object", + "required": [ + "requestId", + "countryCode", + "transactionId", + "transactionType", + "customerId", + "accountId", + "providedAmount", + "collectedAmount", + "resultCode", + "resultDescription" + ], "properties": { - - "nativeId": { + "requestId": { "type": "string", - "description": "Unique identifier of transaction in FIRSTBANK system", - "example": "FBN20191031104405CN621868" + "description": "Unique identifier of request", + "example": "R02802" + }, + "countryCode": { + "type": "string", + "description": "Unique country code. Please refer to Country Codes table", + "example": "NGR" + }, + "transactionId": { + "type": "string", + "description": "Unique identifier of transaction in Simbrella system", + "example": "Tr201712RK9232P115" + }, + "transactionType": { + "type": "string", + "description": "Type of transaction: Disbursement, Collection, or Penalty", + "enum": ["Disbursement", "Collection", "Penalty"], + "example": "Disbursement" }, "customerId": { "type": "string", @@ -17,17 +44,11 @@ "description": "Specific identifier of a user's account", "example": "2017821799" }, - "transactionType": { - "type": "string", - "description": "Type of transaction: Disbursement, Collection, or Penalty", - "enum": ["Disbursement", "Collection", "Penalty"], - "example": "Collection" - }, "providedAmount": { "type": "number", "format": "double", "description": "Amount provided to a user within loan provision operation", - "example": 0.0 + "example": 100.0 }, "collectedAmount": { "type": "number", @@ -46,16 +67,18 @@ "example": "Collect Status retrieved successfully." } }, - "required": [ - "$type", - "nativeId", - "customerId", - "accountId", - "providedAmount", - "collectedAmount", - "resultCode", - "resultDescription" - ], + "example": { + "requestId": "R02802", + "countryCode": "NGR", + "transactionId": "Tr201712RK9232P115", + "transactionType": "Disbursement", + "customerId": "CN621868", + "accountId": "2017821799", + "providedAmount": 100.0, + "collectedAmount": 7.50, + "resultCode": "00", + "resultDescription": "Collect Status retrieved successfully." + }, "xml": { "name": "TransactionVerifyResponse" }