Updated Swagger Documentation
This commit is contained in:
@@ -3,35 +3,64 @@
|
||||
"properties": {
|
||||
"$type": {
|
||||
"type": "string",
|
||||
"description": "Value is fixed to 'TransactionCheckResponse'",
|
||||
"example": "TransactionCheckResponse"
|
||||
},
|
||||
"nativeId": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of transaction in FIRSTBANK system",
|
||||
"example": "FBN20191031104405CN621868"
|
||||
},
|
||||
"customerId": {
|
||||
"type": "string",
|
||||
"description": "Unique identifier of a user",
|
||||
"example": "CN621868"
|
||||
},
|
||||
"accountId": {
|
||||
"type": "string",
|
||||
"description": "Specific identifier of a user's account",
|
||||
"example": "2017821799"
|
||||
},
|
||||
"transactionType": {
|
||||
"type": "string",
|
||||
"description": "Type of transaction: Disbursement, Collection, or Penalty",
|
||||
"enum": ["Disbursement", "Collection", "Penalty"],
|
||||
"example": "Collection"
|
||||
},
|
||||
"providedAmount": {
|
||||
"type": "number",
|
||||
"format": "double",
|
||||
"description": "Amount provided to a user within loan provision operation",
|
||||
"example": 0.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."
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"$type",
|
||||
"nativeId",
|
||||
"customerId",
|
||||
"accountId",
|
||||
"providedAmount",
|
||||
"collectedAmount",
|
||||
"resultCode",
|
||||
"resultDescription"
|
||||
],
|
||||
"xml": {
|
||||
"name": "TransactionVerifyResponse"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user