Updated Swagger Documentation
This commit is contained in:
@@ -1,34 +1,56 @@
|
||||
{
|
||||
"type": "object",
|
||||
"required": [
|
||||
"$type",
|
||||
"transactionId",
|
||||
"countryCode",
|
||||
"customerId",
|
||||
"accountId",
|
||||
"lienAmount",
|
||||
"channel"
|
||||
],
|
||||
"properties": {
|
||||
"lienAmount": {
|
||||
"type": "number",
|
||||
"format": "double",
|
||||
"example": 500.01
|
||||
"$type": {
|
||||
"type": "string",
|
||||
"description": "Fixed value to identify request type",
|
||||
"example": "EligibilityCheckRequest"
|
||||
},
|
||||
"transactionId": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of transaction in FIRSTBANK system",
|
||||
"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"
|
||||
},
|
||||
"msisdn": {
|
||||
"type": "string",
|
||||
"example": "3451342"
|
||||
},
|
||||
"channel": {
|
||||
"type": "string",
|
||||
"example": "USSD"
|
||||
},
|
||||
"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"
|
||||
},
|
||||
"lienAmount": {
|
||||
"type": "number",
|
||||
"format": "double",
|
||||
"description": "Amount of lien placed on user's account",
|
||||
"example": 4.0
|
||||
},
|
||||
"channel": {
|
||||
"type": "string",
|
||||
"description": "Request channel: USSD, MobApp, or Web",
|
||||
"enum": ["USSD", "MobApp", "Web"],
|
||||
"example": "USSD"
|
||||
}
|
||||
},
|
||||
"xml": {
|
||||
|
||||
Reference in New Issue
Block a user