Azeez Muibi
85 lines
2.7 KiB
JSON
85 lines
2.7 KiB
JSON
{
|
||
"type": "object",
|
||
"required": [
|
||
"requestId",
|
||
"countryCode",
|
||
"transactionId",
|
||
"transactionType",
|
||
"customerId",
|
||
"accountId",
|
||
"providedAmount",
|
||
"collectedAmount",
|
||
"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"
|
||
},
|
||
"transactionType": {
|
||
"type": "string",
|
||
"description": "Type of transaction: Disbursement, Collection, or Penalty",
|
||
"enum": ["Disbursement", "Collection", "Penalty"],
|
||
"example": "Disbursement"
|
||
},
|
||
"customerId": {
|
||
"type": "string",
|
||
"description": "Unique identifier of a user",
|
||
"example": "CN621868"
|
||
},
|
||
"accountId": {
|
||
"type": "string",
|
||
"description": "Specific identifier of a user's account",
|
||
"example": "2017821799"
|
||
},
|
||
"providedAmount": {
|
||
"type": "number",
|
||
"format": "double",
|
||
"description": "Amount provided to a user within loan provision operation",
|
||
"example": 100.0
|
||
},
|
||
"collectedAmount": {
|
||
"type": "number",
|
||
"format": "double",
|
||
"description": "Amount collected from user's account within collection operation",
|
||
"example": 7.50
|
||
},
|
||
"resultCode": {
|
||
"type": "string",
|
||
"description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
|
||
"example": "00"
|
||
},
|
||
"resultDescription": {
|
||
"type": "string",
|
||
"description": "Description of provided result code",
|
||
"example": "Collect Status retrieved successfully."
|
||
}
|
||
},
|
||
"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"
|
||
}
|
||
} |