Updated Swagger Documentation
This commit is contained in:
@@ -1,41 +1,60 @@
|
||||
{
|
||||
"type": "object",
|
||||
"required": [
|
||||
"requestId",
|
||||
"transactionId",
|
||||
"customerId",
|
||||
"accountId",
|
||||
"msisdn",
|
||||
"requestedAmount",
|
||||
"productid",
|
||||
"channel"
|
||||
],
|
||||
"properties": {
|
||||
"requestId": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of request",
|
||||
"example": "202111170001371256908"
|
||||
},
|
||||
"transactionId": {
|
||||
"type": "string",
|
||||
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
|
||||
"example": "1231231321232"
|
||||
},
|
||||
"customerId": {
|
||||
"type": "string",
|
||||
"example": "CN621868"
|
||||
"description": "Unique identifier of a customer",
|
||||
"example": "1256907"
|
||||
},
|
||||
"accountId": {
|
||||
"type": "string",
|
||||
"description": "Specific identifier of a user's account",
|
||||
"example": "5948306019"
|
||||
},
|
||||
"msisdn": {
|
||||
"type": "string",
|
||||
"description": "User's mobile number in an international format",
|
||||
"example": "123456789"
|
||||
},
|
||||
"requestedAmount": {
|
||||
"type": "number",
|
||||
"format": "double",
|
||||
"example": 10000.55
|
||||
},
|
||||
"accountId": {
|
||||
"type": "string",
|
||||
"example": "ACN8263457"
|
||||
"description": "Amount of loan requested by user",
|
||||
"example": 10000.0
|
||||
},
|
||||
"productid": {
|
||||
"type": "string",
|
||||
"description": "Product ID",
|
||||
"example": "101"
|
||||
},
|
||||
"channel": {
|
||||
"type": "string",
|
||||
"description": "Channel of incoming request",
|
||||
"enum": ["USSD", "MobApp", "Web"],
|
||||
"example": "USSD"
|
||||
}
|
||||
},
|
||||
"xml": {
|
||||
"name": "SelectOffersRequest"
|
||||
"name": "SelectOfferRequest"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user