Azeez Muibi
98 lines
3.3 KiB
JSON
98 lines
3.3 KiB
JSON
{
|
|
"type": "object",
|
|
"required": [
|
|
"requestId",
|
|
"countryCode",
|
|
"transactionId",
|
|
"debtId",
|
|
"customerId",
|
|
"accountId",
|
|
"productId",
|
|
"collectedAmount",
|
|
"collectionMethod",
|
|
"lienAmount"
|
|
],
|
|
"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"
|
|
},
|
|
"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"
|
|
},
|
|
"collectedAmount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"description": "Amount to be collected from user's account (penalCharge is not included)",
|
|
"example": 80000.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
|
|
},
|
|
"collectionMethod": {
|
|
"type": "integer",
|
|
"description": "1 - on deposit of salary. the collection was triggered after a salary inflow to account, 2 - on due date. the collection was triggered on due date, 3 - initiated by user. the debtor initiated the collection from the request channel (USSD, Web or App)",
|
|
"enum": [1, 2, 3],
|
|
"example": 1
|
|
},
|
|
"lienAmount": {
|
|
"type": "number",
|
|
"format": "double",
|
|
"description": "Aggregated (summed up) lien amount",
|
|
"example": 80000.00
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"description": "Any additional comment for provided loan operation",
|
|
"example": "Testing CollectionLoanRequest"
|
|
}
|
|
},
|
|
"example": {
|
|
"requestId": "R02802",
|
|
"countryCode": "NGR",
|
|
"transactionId": "Tr201712RK9232P115",
|
|
"debtId": "273194670",
|
|
"customerId": "CN621868",
|
|
"accountId": "2017821799",
|
|
"productId": "101",
|
|
"collectedAmount": 80000.00,
|
|
"penalCharge": 0,
|
|
"collectionMethod": 1,
|
|
"lienAmount": 80000.00,
|
|
"comment": "Testing CollectionLoanRequest"
|
|
},
|
|
"xml": {
|
|
"name": "RepaymentRequest"
|
|
}
|
|
} |