Files
digifi-swagger/schemas/CollectLoanRequest.json
T
2025-03-24 15:15:31 +01:00

84 lines
2.7 KiB
JSON

{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T002"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"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"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product for which collection to be made",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"description": "Amount to be collected from user's account (penalCharge is not included)",
"example": 80000.0
},
"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.0
},
"collectionMethod": {
"type": "integer",
"description": "1 - on deposit of salary; 2 - on due date; 3 - initiated by user",
"enum": [1, 2, 3],
"example": 1
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Aggregated (summed up) lien amount",
"example": 80000.0
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for provided loan operation",
"example": "Testing CollectionLoanRequest"
}
},
"required": [
"transactionId",
"fbnTransactionId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"collectionMethod",
"lienAmount",
"countryId"
],
"xml": {
"name": "CollectLoanRequest"
}
}