Azeez Muibi
82 lines
2.9 KiB
JSON
82 lines
2.9 KiB
JSON
{
|
||
"type": "object",
|
||
"required": [
|
||
"customerId",
|
||
"transactionId",
|
||
"countryCode",
|
||
"eligibleOffers",
|
||
"resultCode",
|
||
"resultDescription"
|
||
],
|
||
"properties": {
|
||
"customerId": {
|
||
"type": "string",
|
||
"description": "Unique identifier of a customer",
|
||
"example": "CN621868"
|
||
},
|
||
"transactionId": {
|
||
"type": "string",
|
||
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
|
||
"example": "Tr201712RK9232P115"
|
||
},
|
||
"countryCode": {
|
||
"type": "string",
|
||
"description": "Unique country code. Please refer to “Country Codes” table",
|
||
"example": "NGR"
|
||
},
|
||
"msisdn": {
|
||
"type": "string",
|
||
"description": "User's mobile number in an international format",
|
||
"example": "2348012345678"
|
||
},
|
||
"eligibleOffers": {
|
||
"type": "array",
|
||
"description": "Array of loan offers the customer is eligible for",
|
||
"items": {
|
||
"type": "object",
|
||
"properties": {
|
||
"minAmount": {
|
||
"type": "number",
|
||
"format": "double",
|
||
"description": "Minimum loan amount",
|
||
"example": 5000
|
||
},
|
||
"maxAmount": {
|
||
"type": "number",
|
||
"format": "double",
|
||
"description": "Maximum loan amount",
|
||
"example": 20000
|
||
},
|
||
"productId": {
|
||
"type": "string",
|
||
"description": "Product identifier",
|
||
"example": "2030"
|
||
},
|
||
"offerId": {
|
||
"type": "string",
|
||
"description": "Offer identifier",
|
||
"example": "101"
|
||
},
|
||
"tenor": {
|
||
"type": "integer",
|
||
"description": "Loan tenor in days",
|
||
"example": 30
|
||
}
|
||
}
|
||
}
|
||
},
|
||
"resultCode": {
|
||
"type": "string",
|
||
"description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
|
||
"example": "00"
|
||
},
|
||
"resultDescription": {
|
||
"type": "string",
|
||
"description": "Textual description of provided result code. In case if customer is not eligible (where resultCode is «05») this parameter contains end-user message that can be show directly to the customer.",
|
||
"example": "Successful"
|
||
}
|
||
},
|
||
"xml": {
|
||
"name": "EligibilityCheckResponse"
|
||
}
|
||
} |