Updated Docs

This commit is contained in:
Azeez Muibi
2025-03-25 12:36:41 +01:00
parent e6c537ccff
commit 730d97fafa
6 changed files with 267 additions and 98 deletions
+68 -10
View File
@@ -1,33 +1,76 @@
{
"type": "object",
"required": [
"customerId",
"requestId",
"countryCode",
"transactionId",
"productId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"lienAmount",
"resultCode",
"resultDescription"
],
"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"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"transactionId": {
"accountId": {
"type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
"example": "Tr201712RK9232P115"
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product that user is payed for",
"description": "Identifier of a product for which collection to be made",
"example": "101"
},
"debtId": {
"collectAmount": {
"type": "number",
"format": "double",
"description": "Amount to be collected from user's account (penalCharge is not included)",
"example": 60000.00
},
"penalCharge": {
"type": "number",
"format": "double",
"description": "Amount of penalty to be collected from user's account. If there is no penalty, amount is '0'",
"example": 0
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Aggregated (summed up) lien amount",
"example": 20000
},
"comment": {
"type": "string",
"description": "Unique identifier of an existing debt of a user",
"example": "273194670"
"description": "Any additional comment for provided loan operation",
"example": "Testing CollectionLoanRequest"
},
"resultCode": {
"type": "string",
@@ -37,9 +80,24 @@
"resultDescription": {
"type": "string",
"description": "Description of provided result code",
"example": "Successful"
"example": "Loan Collection Successful"
}
},
"example": {
"requestId": "R02802",
"countryCode": "NGR",
"transactionId": "Tr201712RK9232P115",
"debtId": "273194670",
"customerId": "CN621868",
"accountId": "2017821799",
"productId": "101",
"collectAmount": 60000.00,
"penalCharge": 0,
"lienAmount": 20000,
"comment": "Testing CollectionLoanRequest",
"resultCode": "00",
"resultDescription": "Loan Collection Successful"
},
"xml": {
"name": "RepaymentResponse"
}