From 99895e6710f263fb7b277f3ac8076778a90f7ca4 Mon Sep 17 00:00:00 2001 From: Azeez Muibi Date: Wed, 19 Mar 2025 17:35:13 +0100 Subject: [PATCH] Worked on the Bulk SMS Request, RAC Check Request and RAC Check Response --- digifi_swagger.json | 253 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 253 insertions(+) diff --git a/digifi_swagger.json b/digifi_swagger.json index 2fff8df..783da03 100644 --- a/digifi_swagger.json +++ b/digifi_swagger.json @@ -146,6 +146,22 @@ "description": "Find out more", "url": "https://www.simbrellang.net" } + }, + { + "name": "BulkSMSRequest", + "description": "Send bulk SMS notifications", + "externalDocs": { + "description": "Find out more", + "url": "https://www.simbrellang.net" + } + }, + { + "name": "RACCheck", + "description": "Check if a customer passes the Risk Acceptance Criteria", + "externalDocs": { + "description": "Find out more", + "url": "https://www.simbrellang.net" + } } ], "paths": { @@ -900,6 +916,100 @@ } ] } + }, + "/BulkSMS": { + "post": { + "tags": [ + "BulkSMSRequest" + ], + "summary": "Send bulk SMS notifications", + "description": "The request is used to send Bulk SMS request. The max length of the array should equal 20.", + "operationId": "bulkSmsNotification", + "requestBody": { + "description": "Post JSON to send bulk SMS", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/BulkSMSRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SMSResponse" + } + } + } + }, + "400": { + "description": "Invalid request parameters" + }, + "404": { + "description": "Resource not found" + }, + "422": { + "description": "Validation exception" + } + }, + "security": [ + { + "apiKey": [] + } + ] + } + }, + "/RACCheck": { + "post": { + "tags": [ + "RACCheck" + ], + "summary": "Check if a customer passes the Risk Acceptance Criteria", + "description": "This request is used to check if a customer passes the Risk Acceptance Criteria defined by the bank", + "operationId": "racCheck", + "requestBody": { + "description": "Post JSON to check RAC criteria", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RACCheckRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RACCheckResponse" + } + } + } + }, + "400": { + "description": "Invalid request parameters" + }, + "404": { + "description": "Resource not found" + }, + "422": { + "description": "Validation exception" + } + }, + "security": [ + { + "apiKey": [] + } + ] + } } }, "components": { @@ -2610,6 +2720,149 @@ "description": "Description of status code if process is failed, null if successful" } } + }, + "BulkSMSRequest": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string", + "example": "This is a test message for SMS request method.", + "description": "Message to send to customer" + }, + "dest": { + "type": "string", + "example": "+2348039409144", + "description": "Phone Number in international format" + }, + "unicode": { + "type": "boolean", + "example": true, + "description": "Character encoding standard (set as True)" + } + } + }, + "description": "Array of SMS messages to send (max 20)" + }, + "RACCheckRequest": { + "type": "object", + "required": [ + "transactionId", + "fbnTransactionId", + "customerId", + "accountId", + "RAC_Array" + ], + "properties": { + "transactionId": { + "type": "string", + "example": "T001", + "description": "Unique identifier of transaction in Simbrella system" + }, + "fbnTransactionId": { + "type": "string", + "example": "Tr201712RK9232P115", + "description": "Unique id of the transaction received from FBN in Eligibility or Provision requests" + }, + "customerId": { + "type": "string", + "example": "CN621868", + "description": "Unique identifier of a user" + }, + "accountId": { + "type": "string", + "example": "2017821799", + "description": "Specific identifier of a user's account" + }, + "RAC_Array": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of RAC items to check (BVN, CRC, CRMS, Salary account, lien, whitelist, lien, account status, no bounced check and existing loan)" + } + } + }, + "RACCheckResponse": { + "type": "object", + "required": [ + "RACResponse", + "resultCode", + "resultDescription" + ], + "properties": { + "RACResponse": { + "type": "object", + "properties": { + "SalaryAccount": { + "type": "string", + "example": "1", + "description": "Has Salary account or Not" + }, + "BVN": { + "type": "string", + "example": "1", + "description": "BVN Ok" + }, + "BVNAttachedtoAccount": { + "type": "string", + "example": "1", + "description": "BVN attached to account" + }, + "CRMS": { + "type": "string", + "example": "1", + "description": "No Delinquent loan" + }, + "CRC": { + "type": "string", + "example": "1", + "description": "No Delinquent loan" + }, + "AccountStatus": { + "type": "string", + "example": "1", + "description": "Has 'Regular' account status" + }, + "Lien": { + "type": "string", + "example": "1", + "description": "No Lien on account" + }, + "NoBounchedCheck": { + "type": "string", + "example": "1", + "description": "No Bounced (Ever?)" + }, + "Whitelist": { + "type": "string", + "example": "1", + "description": "False if blacklisted" + }, + "NoPastDueSalaryLoan": { + "type": "string", + "example": "1", + "description": "No Past Due Salary Loan" + }, + "NoPastDueOtherLoan": { + "type": "string", + "example": "1", + "description": "No Past Due Other Loans" + } + } + }, + "resultCode": { + "type": "string", + "example": "00", + "description": "Result code of executed transaction" + }, + "resultDescription": { + "type": "string", + "example": "RAC Check Successful", + "description": "Description of provided result code" + } + } } }, "securitySchemes": {