Updated Docs

This commit is contained in:
Azeez Muibi
2025-03-25 10:16:17 +01:00
8 changed files with 6 additions and 46 deletions
+1 -7
View File
@@ -1,11 +1,6 @@
{ {
"type": "object", "type": "object",
"properties": { "properties": {
"$type": {
"type": "string",
"description": "Fixed value for this request type",
"example": "CustomerConsentRequest"
},
"transactionId": { "transactionId": {
"type": "string", "type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system", "description": "Unique identifier of transaction in FIRSTBANK system",
@@ -36,8 +31,7 @@
"channel": { "channel": {
"type": "string", "type": "string",
"description": "Request channel: 'USSD' or 'APP'", "description": "Request channel: 'USSD' or 'APP'",
"enum": ["USSD", "APP"], "example": "100"
"example": "USSD"
} }
}, },
"required": [ "required": [
+2 -3
View File
@@ -31,12 +31,11 @@
"msisdn": { "msisdn": {
"type": "string", "type": "string",
"description": "User's mobile number in an international format", "description": "User's mobile number in an international format",
"example": "8093451342" "example": "8012345678"
}, },
"channel": { "channel": {
"type": "string", "type": "string",
"description": "Request channel: USSD” or “MobApp or Web type Channel", "description": "Request channel: USSD, MobApp, or Web - type Channel",
"enum": ["USSD", "MobApp", "Web"],
"example": "100" "example": "100"
} }
}, },
+1 -8
View File
@@ -1,17 +1,11 @@
{ {
"type": "object", "type": "object",
"required": [ "required": [
"$type",
"transactionId", "transactionId",
"customerId", "customerId",
"channel" "channel"
], ],
"properties": { "properties": {
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "LoanStatusRequest"
},
"transactionId": { "transactionId": {
"type": "string", "type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms", "description": "Unique identifier of transaction. This transaction Id must be consistent across all platforms",
@@ -30,8 +24,7 @@
"channel": { "channel": {
"type": "string", "type": "string",
"description": "Request channel: USSD, MobileApp, or Web", "description": "Request channel: USSD, MobileApp, or Web",
"enum": ["USSD", "MobileApp", "Web"], "example": "100"
"example": "USSD"
} }
}, },
"xml": { "xml": {
-5
View File
@@ -1,11 +1,6 @@
{ {
"type": "object", "type": "object",
"properties": { "properties": {
"$type": {
"type": "string",
"description": "Value is fixed to 'ProvideLoanRequest'",
"example": "ProvideLoanRequest"
},
"requestId": { "requestId": {
"type": "string", "type": "string",
"description": "Unique identifier of request", "description": "Unique identifier of request",
+1 -8
View File
@@ -1,7 +1,6 @@
{ {
"type": "object", "type": "object",
"required": [ "required": [
"$type",
"transactionId", "transactionId",
"customerId", "customerId",
"debtId", "debtId",
@@ -9,11 +8,6 @@
"channel" "channel"
], ],
"properties": { "properties": {
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "RepaymentRequest"
},
"msisdn": { "msisdn": {
"type": "string", "type": "string",
"description": "User's mobile number in an international format", "description": "User's mobile number in an international format",
@@ -42,8 +36,7 @@
"channel": { "channel": {
"type": "string", "type": "string",
"description": "Request channel: USSD or APP", "description": "Request channel: USSD or APP",
"enum": ["USSD", "APP"], "example": "100"
"example": "USSD"
} }
}, },
"xml": { "xml": {
-5
View File
@@ -1,11 +1,6 @@
{ {
"type": "object", "type": "object",
"properties": { "properties": {
"$type": {
"type": "string",
"description": "Value is fixed to 'RevokeEnableConsentResponse'",
"example": "RevokeEnableConsentResponse"
},
"customerId": { "customerId": {
"type": "string", "type": "string",
"description": "Unique identifier of a user", "description": "Unique identifier of a user",
-5
View File
@@ -10,11 +10,6 @@
"resultDescription" "resultDescription"
], ],
"properties": { "properties": {
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "202111170001371256908"
},
"transactionId": { "transactionId": {
"type": "string", "type": "string",
"description": "Unique identifier of transaction. This transaction Id must be consistent across all platform", "description": "Unique identifier of transaction. This transaction Id must be consistent across all platform",
+1 -5
View File
@@ -1,11 +1,7 @@
{ {
"type": "object", "type": "object",
"properties": { "properties": {
"$type": {
"type": "string",
"description": "Value is fixed to 'TransactionCheckResponse'",
"example": "TransactionCheckResponse"
},
"nativeId": { "nativeId": {
"type": "string", "type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system", "description": "Unique identifier of transaction in FIRSTBANK system",