DigiFi/digifi-swagger
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Compare commits

merge into: DigiFi/digifi-swagger:staging
Branches Tags
DigiFi/digifi-swagger:master DigiFi/digifi-swagger:Docs DigiFi/digifi-swagger:feature/swagger-endpoints DigiFi/digifi-swagger:staging
..
pull from: DigiFi/digifi-swagger:feature/swagger-endpoints
Branches Tags
DigiFi/digifi-swagger:master DigiFi/digifi-swagger:Docs DigiFi/digifi-swagger:feature/swagger-endpoints DigiFi/digifi-swagger:staging

5 Commits
staging .. feature/swagger-endpoints

Author SHA1 Message Date
VivianDee 29e0a498de [fix]: file references 2025-03-21 05:16:27 +01:00
VivianDee 5e848b40d7 Code Cleanup 2025-03-19 19:38:42 +01:00
VivianDee e2769472bb [update]:Documentation 2025-03-19 17:58:02 +01:00
VivianDee 39adbd9ec9 Update digifi_swagger.json 2025-03-19 17:32:52 +01:00
VivianDee 8dc156c683 [add]: RACCheck 2025-03-19 16:02:03 +01:00
58 changed files with 2350 additions and 2790 deletions
Expand all files Collapse all files
digifi_swagger.json
+67 -2790
View File
File diff suppressed because it is too large Load Diff
paths/BulkSMS.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"BulkSMS"
],
"summary": "BulkSMS Request",
"description": "BulkSMS Request",
"operationId": "BulkSMS",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/BulkSMSRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/BulkSMSRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/BulkSMSRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "BulkSMS Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/BulkSMSResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/BulkSMSResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/CollectLoan.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"CollectLoan"
],
"summary": "Collect Loan Request",
"description": "Collect Loan Request",
"operationId": "CollectLoan",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CollectLoanRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CollectLoanRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/CollectLoanRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "CollectLoan Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CollectLoanResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CollectLoanResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/CustomerConsent.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"CustomerConsent"
],
"summary": "Customer Consent Request",
"description": "Customer Consent Request",
"operationId": "CustomerConsent",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CustomerConsentRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CustomerConsentRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/CustomerConsentRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/CustomerConsentResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/CustomerConsentResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/Disbursement.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"Disbursement"
],
"summary": "Disbursement Request",
"description": "Disbursement Request",
"operationId": "Disbursement",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/DisbursementRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/DisbursementRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/DisbursementRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "Disbursement Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/DisbursementResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/DisbursementResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/EligibilityCheck.json
+65
View File
@@ -0,0 +1,65 @@
{
"post": {
"tags": [
"EligibilityCheck"
],
"summary": "Start the process - initiate steps to eligibility RAC Checks ",
"description": "Initiate Eligibility Check Request",
"operationId": "startEligibilityCheck",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
},
"422": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
paths/LienCheck.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"LienCheck"
],
"summary": "Lien Check Request",
"description": "Lien Check Request",
"operationId": "LienCheck",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LienCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LienCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LienCheckRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "LienCheck Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LienCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LienCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/LoanInformation.json
+65
View File
@@ -0,0 +1,65 @@
{
"get": {
"tags": [
"LoanInformation"
],
"summary": "Loan Information Request ",
"description": "Loan Information Request",
"operationId": "startEligibilityCheck",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Loan not found"
},
"422": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
paths/NewTransactionCheck.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"NewTransactionCheck"
],
"summary": "New Transaction Check Request",
"description": "New Transaction Check Request",
"operationId": "NewTransactionCheck",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/NewTransactionCheckRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "NewTransactionCheck Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/NewTransactionCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/NotificationCallback.json
+65
View File
@@ -0,0 +1,65 @@
{
"post": {
"tags": [
"NotificationCallback"
],
"summary": "Loan Information Request ",
"description": "Loan Information Request",
"operationId": "startEligibilityCheck",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/LoanInformationRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/LoanInformationResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Loan not found"
},
"422": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
paths/PenalCharge.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"PenalCharge"
],
"summary": "Penal Charge Request",
"description": "Penal Charge Request",
"operationId": "PenalCharge",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/PenalChargeRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/PenalChargeRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/PenalChargeRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "PenalCharge Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/PenalChargeResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/PenalChargeResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/ProvideLoan.json
+65
View File
@@ -0,0 +1,65 @@
{
"post": {
"tags": [
"ProvideLoan"
],
"summary": "Provide Loan Request ",
"description": "Provide Loan Request",
"operationId": "startEligibilityCheck",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/EligibilityCheckRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/EligibilityCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
},
"422": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
paths/RACCheck.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"RACCheck"
],
"summary": "Risk Acceptance Criteria Check",
"description": "Check if a customer passes the Risk Acceptance Criteria defined by the bank",
"operationId": "racCheck",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RACCheckRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RACCheckRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/RACCheckRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "RAC Check Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RACCheckResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RACCheckResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/Repayment.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"Repayment"
],
"summary": "Repayment Request",
"description": "Repayment Request",
"operationId": "Repayment",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RepaymentRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RepaymentRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/RepaymentRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "Repayment Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RepaymentResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RepaymentResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/RevokeEnableConsent.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"RevokeEnableConsent"
],
"summary": "Revoke Enable Consent Request",
"description": "Revoke Enable Consent Request",
"operationId": "RevokeEnableConsent",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "RevokeEnableConsent Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/RevokeEnableConsentResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/SMS.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"SMS"
],
"summary": "SMS Request",
"description": "SMS Request",
"operationId": "SMS",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SMSRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SMSRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/SMSRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "SMS Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SMSResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SMSResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/SelectOffer.json
+65
View File
@@ -0,0 +1,65 @@
{
"post": {
"tags": [
"SelectOffer"
],
"summary": "This method is used the send the offer the customer selected to Simbrella ",
"description": "This method is used the send the offer the customer selected to Simbrella",
"operationId": "startEligibilityCheck",
"requestBody": {
"description": "Post JSON to conduct eligibility tests",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SelectOfferRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SelectOfferRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/SelectOfferRequest.json"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/SelectOfferResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/SelectOfferResponse.json"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Offers not found"
},
"422": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
}
paths/TokenValidation.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"TokenValidation"
],
"summary": "Token Validation Request",
"description": "Token Validation Request",
"operationId": "TokenValidation",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TokenValidationRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TokenValidationRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/TokenValidationRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "TokenValidation Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TokenValidationResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TokenValidationResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
paths/TransactionVerify.json
+53
View File
@@ -0,0 +1,53 @@
{
"post": {
"tags": [
"TransactionVerify"
],
"summary": "Transaction Verify Request",
"description": "Transaction Verify Request",
"operationId": "TransactionVerify",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TransactionVerifyRequest.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TransactionVerifyRequest.json"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "../schemas/TransactionVerifyRequest.json"
}
}
}
},
"responses": {
"200": {
"description": "TransactionVerify Successful",
"content": {
"application/json": {
"schema": {
"$ref": "../schemas/TransactionVerifyResponse.json"
}
},
"application/xml": {
"schema": {
"$ref": "../schemas/TransactionVerifyResponse.json"
}
}
}
},
"400": {
"description": "Invalid request"
},
"500": {
"description": "Internal server error"
}
}
}
}
schemas/ApiResponse.json
+18
View File
@@ -0,0 +1,18 @@
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"type": {
"type": "string"
},
"message": {
"type": "string"
}
},
"xml": {
"name": "##default"
}
}
schemas/BulkSMSRequest.json
+25
View File
@@ -0,0 +1,25 @@
{
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"example": "This is a test message for SMS request method."
},
"dest": {
"type": "string",
"example": "+2348039409144"
},
"unicode": {
"type": "boolean",
"example": true
}
},
"required": [
"text",
"dest",
"unicode"
]
}
}
schemas/BulkSMSResponse.json
+24
View File
@@ -0,0 +1,24 @@
{
"type": "object",
"properties": {
"data": {
"type": "string",
"example": ""
},
"statusCode": {
"type": "integer",
"example": 200
},
"IsSuccessful": {
"type": "boolean",
"example": true
},
"errorMessage": {
"type": [
"string",
"null"
],
"example": null
}
}
}
schemas/CollectLoanRequest.json
+65
View File
@@ -0,0 +1,65 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T002"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"example": 80000.0
},
"penalCharge": {
"type": "number",
"format": "double",
"example": 0.0
},
"collectionMethod": {
"type": "integer",
"example": 1
},
"lienAmount": {
"type": "number",
"format": "double",
"example": 80000.0
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing CollectionLoanRequest"
}
},
"required": [
"transactionId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"penalCharge",
"collectionMethod",
"lienAmount",
"countryId",
"comment"
]
}
schemas/CollectLoanResponse.json
+70
View File
@@ -0,0 +1,70 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T002"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"example": 60000.0
},
"penalCharge": {
"type": "number",
"format": "double",
"example": 0.0
},
"lienAmount": {
"type": "number",
"format": "double",
"example": 20000.0
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing CollectionLoanRequest"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Loan Collection Successful"
}
},
"required": [
"transactionId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"penalCharge",
"lienAmount",
"countryId",
"comment",
"resultCode",
"resultDescription"
]
}
schemas/CustomerConsentRequest.json
+43
View File
@@ -0,0 +1,43 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"example": "CustomerConsentRequest"
},
"transactionId": {
"type": "string",
"example": "20171209232177"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
},
"requestTime": {
"type": "string",
"format": "date-time",
"example": "2019-10-18 14:26:21.063"
},
"consentType": {
"type": "string",
"example": "Revoke"
},
"channel": {
"type": "string",
"example": "USSD"
}
},
"required": [
"$type",
"transactionId",
"customerId",
"accountId",
"requestTime",
"consentType",
"channel"
]
}
schemas/CustomerConsentResponse.json
+17
View File
@@ -0,0 +1,17 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Request is received"
}
},
"required": [
"resultCode",
"resultDescription"
]
}
schemas/DisbursementRequest.json
+77
View File
@@ -0,0 +1,77 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T001"
},
"TransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"example": 100000.0
},
"collectAmountInterest": {
"type": "number",
"format": "double",
"example": 5000.0
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"example": 75.0
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing LoanRequest"
}
},
"required": [
"transactionId",
"TransactionId",
"debtId",
"customerId",
"accountId",
"productId",
"provideAmount",
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"comment"
]
}
schemas/DisbursementResponse.json
+82
View File
@@ -0,0 +1,82 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T001"
},
"TransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"productId": {
"type": "string",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"example": 100000.0
},
"collectAmountInterest": {
"type": "number",
"format": "double",
"example": 5000.0
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"example": 75.0
},
"countryId": {
"type": "string",
"example": "01"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Loan Request Completed Successfully!"
}
},
"required": [
"transactionId",
"TransactionId",
"debtId",
"customerId",
"accountId",
"productId",
"provideAmount",
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"resultCode",
"resultDescription"
]
}
schemas/EligibilityCheckRequest.json
+37
View File
@@ -0,0 +1,37 @@
{
"type": "object",
"properties": {
"lienAmount": {
"type": "number",
"format": "double",
"example": 500.01
},
"transactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"countryCode": {
"type": "string",
"example": "NGR"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"example": "3451342"
},
"channel": {
"type": "string",
"example": "USSD"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
}
},
"xml": {
"name": "EligibilityCheckRequest"
}
}
schemas/EligibilityCheckResponse.json
+32
View File
@@ -0,0 +1,32 @@
{
"type": "object",
"properties": {
"eligibleOffers": {
"type": "string",
"example": "OFFERS ARRAY HERE"
},
"resultDescription": {
"type": "string",
"example": "Successful"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"example": "3451342"
},
"resultCode": {
"type": "string",
"example": "00"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
}
},
"xml": {
"name": "EligibilityCheckResponse"
}
}
schemas/LienCheckRequest.json
+21
View File
@@ -0,0 +1,21 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "SMB1234567"
},
"customerId": {
"type": "string",
"example": "123456"
},
"accountId": {
"type": "string",
"example": "E9F77222920BAAB1C5ACF2253C6D6113"
},
"countryId": {
"type": "string",
"example": "01"
}
}
}
schemas/LienCheckResponse.json
+17
View File
@@ -0,0 +1,17 @@
{
"type": "object",
"properties": {
"lienAmount": {
"type": "number",
"example": 20000.0
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Successful"
}
}
}
schemas/LoanInformationRequest.json
+28
View File
@@ -0,0 +1,28 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"resultDescription": {
"type": "string",
"example": "Successful"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"example": "3451342"
},
"channel": {
"type": "string",
"example": "USSD"
}
},
"xml": {
"name": "LoanInformationRequest"
}
}
schemas/LoanInformationResponse.json
+28
View File
@@ -0,0 +1,28 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"resultDescription": {
"type": "string",
"example": "Successful"
},
"resultCode": {
"type": "string",
"example": "00"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"loan": {
"type": "string",
"example": "Arrray of loans"
}
},
"xml": {
"name": "LoanInformationResponse"
}
}
schemas/NewTransactionCheckRequest.json
+29
View File
@@ -0,0 +1,29 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "173021"
},
"debtId": {
"type": "string",
"example": "173021"
},
"transactionType": {
"type": "string",
"example": "Disbursement"
},
"fbnTransactionId": {
"type": "string",
"example": "FBN2411011411413A74960"
},
"origTransactionId": {
"type": "string",
"example": "2411011411413A74960"
},
"customerId": {
"type": "string",
"example": "CN621868"
}
}
}
schemas/NewTransactionCheckResponse.json
+13
View File
@@ -0,0 +1,13 @@
{
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "Success"
},
"message": {
"type": "string",
"example": "Transaction check completed successfully."
}
}
}
schemas/NotificationCallbackRequest.json
View File
schemas/NotificationCallbackResponse.json
View File
schemas/PenalChargeRequest.json
+41
View File
@@ -0,0 +1,41 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T004"
},
"fbnTransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"penalCharge": {
"type": "number",
"example": 1.2
},
"lienAmount": {
"type": "number",
"example": 101.2
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing PenalChargeRequest"
}
}
}
schemas/PenalChargeResponse.json
+13
View File
@@ -0,0 +1,13 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Penal charge debited successfully"
}
}
}
schemas/ProvideLoanRequest.json
View File
schemas/ProvideLoanResponse.json
View File
schemas/RACCheckRequest.json
+28
View File
@@ -0,0 +1,28 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T001"
},
"fbnTransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"RAC_Array": {
"type": "string",
"example": "XXX"
}
},
"xml": {
"name": "RACCheckRequest"
}
}
schemas/RACCheckResponse.json
+65
View File
@@ -0,0 +1,65 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"example": "00"
},
"RACResponse": {
"type": "object",
"properties": {
"Salary account": {
"type": "string",
"example": "1"
},
"BVN": {
"type": "string",
"example": "1"
},
"BVNAttachedtoAccount": {
"type": "string",
"example": "1"
},
"CRMS": {
"type": "string",
"example": "1"
},
"CRC": {
"type": "string",
"example": "1"
},
"AccountStatus": {
"type": "string",
"example": "1"
},
"Lien": {
"type": "string",
"example": "1"
},
"NoBouncedCheck": {
"type": "string",
"example": "1"
},
"Whitelist": {
"type": "string",
"example": "1"
},
"NoPastDueSalaryLoan": {
"type": "string",
"example": "1"
},
"NoPastDueOtherLoan": {
"type": "string",
"example": "1"
}
}
},
"resultDescription": {
"type": "string",
"example": "RAC Check Successful"
}
},
"xml": {
"name": "RACCheckResponse"
}
}
schemas/RepaymentRequest.json
+42
View File
@@ -0,0 +1,42 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"example": "RepaymentRequest"
},
"msisdn": {
"type": "string",
"example": "3451342"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"productId": {
"type": "string",
"example": "101"
},
"transactionId": {
"type": "string",
"example": "20171209232115"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"channel": {
"type": "string",
"example": "USSD"
}
},
"required": [
"$type",
"msisdn",
"debtId",
"productId",
"transactionId",
"customerId",
"channel"
]
}
schemas/RepaymentResponse.json
+32
View File
@@ -0,0 +1,32 @@
{
"type": "object",
"properties": {
"customerId": {
"type": "string",
"example": "CN621868"
},
"productId": {
"type": "string",
"example": "101"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Successful"
}
},
"required": [
"customerId",
"productId",
"debtId",
"resultCode",
"resultDescription"
]
}
schemas/RevokeEnableConsentRequest.json
+38
View File
@@ -0,0 +1,38 @@
{
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"example": "T0014"
},
"fbnTransactionId": {
"type": "string",
"example": "20171209232177"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"processTime": {
"type": "string",
"format": "date-time",
"example": "2019-10-18 14:26:21.063"
},
"consentType": {
"type": "string",
"example": "Revoke"
},
"countryId": {
"type": "string",
"example": "01"
},
"comment": {
"type": "string",
"example": "Testing RevokeEnableConsentRequest"
}
}
}
schemas/RevokeEnableConsentResponse.json
+25
View File
@@ -0,0 +1,25 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"example": "RevokeEnableConsentResponse"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Success"
}
}
}
schemas/SMSRequest.json
+22
View File
@@ -0,0 +1,22 @@
{
"type": "object",
"properties": {
"text": {
"type": "string",
"example": "This is a test message for SMS request method."
},
"dest": {
"type": "string",
"example": "+2348039409144"
},
"unicode": {
"type": "boolean",
"example": false
}
},
"required": [
"text",
"dest",
"unicode"
]
}
schemas/SMSResponse.json
+24
View File
@@ -0,0 +1,24 @@
{
"type": "object",
"properties": {
"data": {
"type": "string",
"example": ""
},
"statusCode": {
"type": "integer",
"example": 200
},
"IsSuccessful": {
"type": "boolean",
"example": true
},
"errorMessage": {
"type": [
"string",
"null"
],
"example": null
}
}
}
schemas/SelectOfferRequest.json
+41
View File
@@ -0,0 +1,41 @@
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"example": "1231231321232"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"example": "123456789"
},
"requestedAmount": {
"type": "number",
"format": "double",
"example": 10000.55
},
"accountId": {
"type": "string",
"example": "ACN8263457"
},
"productid": {
"type": "string",
"example": "101"
},
"channel": {
"type": "string",
"example": "USSD"
}
},
"xml": {
"name": "SelectOffersRequest"
}
}
schemas/SelectOfferResponse.json
+36
View File
@@ -0,0 +1,36 @@
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"example": "1231231321232"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
},
"offers": {
"type": "string",
"example": "ARRAY of Offers"
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Successful"
}
},
"xml": {
"name": "SelectOffersResponse"
}
}
schemas/TokenValidationRequest.json
+21
View File
@@ -0,0 +1,21 @@
{
"type": "object",
"properties": {
"UserId": {
"type": "string",
"example": "TMP0840"
},
"TokenCode": {
"type": "string",
"example": "32365214"
},
"RequestId": {
"type": "string",
"example": "SMB1234567"
},
"CountryId": {
"type": "string",
"example": "01"
}
}
}
schemas/TokenValidationResponse.json
+25
View File
@@ -0,0 +1,25 @@
{
"type": "object",
"properties": {
"Authenticated": {
"type": "boolean",
"example": true
},
"AuthenticatedMessage": {
"type": "string",
"example": "The user Oluwole Olusoga has successfully authenticated!"
},
"ResponseCode": {
"type": "string",
"example": "00"
},
"ResponseMessage": {
"type": "string",
"example": "Successful"
},
"RequestId": {
"type": "string",
"example": "SMB1234567"
}
}
}
schemas/TransactionVerifyRequest.json
+33
View File
@@ -0,0 +1,33 @@
{
"type": "object",
"properties": {
"counter": {
"type": "string",
"example": "2"
},
"TransactionId": {
"type": "string",
"example": "T002"
},
"RequestId": {
"type": "string",
"example": "R02802"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"countryId": {
"type": "string",
"example": "01"
},
"transactionType": {
"type": "string",
"example": "Disbursement"
}
}
}
schemas/TransactionVerifyResponse.json
+37
View File
@@ -0,0 +1,37 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"example": "TransactionCheckResponse"
},
"nativeId": {
"type": "string",
"example": "FBN20191031104405CN621868"
},
"customerId": {
"type": "string",
"example": "CN621868"
},
"accountId": {
"type": "string",
"example": "2017821799"
},
"providedAmount": {
"type": "number",
"example": 0.0
},
"collectedAmount": {
"type": "number",
"example": 7.50
},
"resultCode": {
"type": "string",
"example": "00"
},
"resultDescription": {
"type": "string",
"example": "Collect Status retrieved successfully."
}
}
}
schemas/schemas.json
+101
View File
@@ -0,0 +1,101 @@
{
"EligibilityCheckRequest": {
"$ref": "./EligibilityCheckRequest.json"
},
"EligibilityCheckResponse": {
"$ref": "./EligibilityCheckResponse.json"
},
"SelectOfferRequest": {
"$ref": "./SelectOfferRequest.json"
},
"SelectOfferResponse": {
"$ref": "./SelectOfferResponse.json"
},
"LoanInformationRequest": {
"$ref": "./LoanInformationRequest.json"
},
"LoanInformationResponse": {
"$ref": "./LoanInformationResponse.json"
},
"RepaymentRequest": {
"$ref": "./RepaymentRequest.json"
},
"RepaymentResponse": {
"$ref": "./RepaymentResponse.json"
},
"RACCheckRequest": {
"$ref": "./RACCheckRequest.json"
},
"RACCheckResponse": {
"$ref": "./RACCheckResponse.json"
},
"CustomerConsentRequest": {
"$ref": "./CustomerConsentRequest.json"
},
"CustomerConsentResponse": {
"$ref": "./CustomerConsentResponse.json"
},
"DisbursementRequest": {
"$ref": "./DisbursementRequest.json"
},
"DisbursementResponse": {
"$ref": "./DisbursementResponse.json"
},
"CollectLoanRequest": {
"$ref": "./CollectLoanRequest.json"
},
"CollectLoanResponse": {
"$ref": "./CollectLoanResponse.json"
},
"TransactionVerifyRequest": {
"$ref": "./TransactionVerifyRequest.json"
},
"TransactionVerifyResponse": {
"$ref": "./TransactionVerifyResponse.json"
},
"PenalChargeRequest": {
"$ref": "./PenalChargeRequest.json"
},
"PenalChargeResponse": {
"$ref": "./PenalChargeResponse.json"
},
"RevokeEnableConsentRequest": {
"$ref": "./RevokeEnableConsentRequest.json"
},
"RevokeEnableConsentResponse": {
"$ref": "./RevokeEnableConsentResponse.json"
},
"TokenValidationRequest": {
"$ref": "./TokenValidationRequest.json"
},
"TokenValidationResponse": {
"$ref": "./TokenValidationResponse.json"
},
"NewTransactionCheckRequest": {
"$ref": "./NewTransactionCheckRequest.json"
},
"NewTransactionCheckResponse": {
"$ref": "./NewTransactionCheckResponse.json"
},
"LienCheckRequest": {
"$ref": "./LienCheckRequest.json"
},
"LienCheckResponse": {
"$ref": "./LienCheckResponse.json"
},
"SMSRequest": {
"$ref": "./SMSRequest.json"
},
"SMSResponse": {
"$ref": "./SMSResponse.json"
},
"BulkSMSRequest": {
"$ref": "./BulkSMSRequest.json"
},
"BulkSMSResponse": {
"$ref": "./BulkSMSResponse.json"
},
"ApiResponse": {
"$ref": "./ApiResponse.json"
}
}
security/securitySchemes.json
+19
View File
@@ -0,0 +1,19 @@
{
"petstore_auth": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "https://petstore3.swagger.io/oauth/authorize",
"scopes": {
"write:pets": "modify pets in your account",
"read:pets": "read your pets"
}
}
}
},
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
}