Updated Docs

This commit is contained in:
Azeez Muibi
2025-03-25 13:12:38 +01:00
parent 730d97fafa
commit f2178c1484
7 changed files with 83 additions and 57 deletions
+44 -21
View File
@@ -1,11 +1,38 @@
{
"type": "object",
"required": [
"requestId",
"countryCode",
"transactionId",
"transactionType",
"customerId",
"accountId",
"providedAmount",
"collectedAmount",
"resultCode",
"resultDescription"
],
"properties": {
"nativeId": {
"requestId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "FBN20191031104405CN621868"
"description": "Unique identifier of request",
"example": "R02802"
},
"countryCode": {
"type": "string",
"description": "Unique country code. Please refer to Country Codes table",
"example": "NGR"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "Tr201712RK9232P115"
},
"transactionType": {
"type": "string",
"description": "Type of transaction: Disbursement, Collection, or Penalty",
"enum": ["Disbursement", "Collection", "Penalty"],
"example": "Disbursement"
},
"customerId": {
"type": "string",
@@ -17,17 +44,11 @@
"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
"example": 100.0
},
"collectedAmount": {
"type": "number",
@@ -46,16 +67,18 @@
"example": "Collect Status retrieved successfully."
}
},
"required": [
"$type",
"nativeId",
"customerId",
"accountId",
"providedAmount",
"collectedAmount",
"resultCode",
"resultDescription"
],
"example": {
"requestId": "R02802",
"countryCode": "NGR",
"transactionId": "Tr201712RK9232P115",
"transactionType": "Disbursement",
"customerId": "CN621868",
"accountId": "2017821799",
"providedAmount": 100.0,
"collectedAmount": 7.50,
"resultCode": "00",
"resultDescription": "Collect Status retrieved successfully."
},
"xml": {
"name": "TransactionVerifyResponse"
}