Files
digifi-swagger/schemas/EligibilityCheckRequest.json
T
2025-03-24 17:17:43 +01:00

52 lines
1.5 KiB
JSON

{
"type": "object",
"required": [
"$type",
"transactionId",
"countryCode",
"customerId",
"accountId",
"channel"
],
"properties": {
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "EligibilityCheckRequest"
},
"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"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "ACN8263457"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "2348012345678"
},
"channel": {
"type": "string",
"description": "Request channel: USSD, MobApp, or Web",
"enum": ["USSD", "MobApp", "Web"],
"example": "USSD"
}
},
"xml": {
"name": "EligibilityCheckRequest"
}
}