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

Updated Swagger Documentation

Browse Source
This commit is contained in:
Azeez Muibi
2025-03-24 15:15:31 +01:00
parent 67dfc32e4a
commit 9684d6dd29
56 changed files with 1344 additions and 349 deletions
Download Patch File Download Diff File Expand all files Collapse all files
schemas/BulkSMSRequest.json
+7
View File
@@ -1,18 +1,22 @@
{
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Message to send to customer",
"example": "This is a test message for SMS request method."
},
"dest": {
"type": "string",
"description": "Phone Number in international format",
"example": "+2348039409144"
},
"unicode": {
"type": "boolean",
"description": "Character encoding standard (set as True for bulk SMS)",
"example": true
}
},
@@ -21,5 +25,8 @@
"dest",
"unicode"
]
},
"xml": {
"name": "BulkSMSRequest"
}
}
schemas/BulkSMSResponse.json
+14 -4
View File
@@ -3,22 +3,32 @@
"properties": {
"data": {
"type": "string",
"description": "Any additional data in response",
"example": ""
},
"statusCode": {
"type": "integer",
"description": "Result code of executed process (200 = Success)",
"example": 200
},
"IsSuccessful": {
"type": "boolean",
"description": "An Indicator that the process was successful or not",
"example": true
},
"errorMessage": {
"type": [
"string",
"null"
],
"type": "string",
"description": "Description of status code if process is failed, null if successful",
"example": null
}
},
"required": [
"data",
"statusCode",
"IsSuccessful",
"errorMessage"
],
"xml": {
"name": "BulkSMSResponse"
}
}
schemas/CollectLoanRequest.json
+23 -4
View File
@@ -3,63 +3,82 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T002"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product for which collection to be made",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"description": "Amount to be collected from user's account (penalCharge is not included)",
"example": 80000.0
},
"penalCharge": {
"type": "number",
"format": "double",
"description": "Amount of penalty to be collected from user's account. If there is no penalty, amount is '0'",
"example": 0.0
},
"collectionMethod": {
"type": "integer",
"description": "1 - on deposit of salary; 2 - on due date; 3 - initiated by user",
"enum": [1, 2, 3],
"example": 1
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Aggregated (summed up) lien amount",
"example": 80000.0
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for provided loan operation",
"example": "Testing CollectionLoanRequest"
}
},
"required": [
"transactionId",
"fbnTransactionId",
"debtId",
"customerId",
"accountId",
"productId",
"collectAmount",
"penalCharge",
"collectionMethod",
"lienAmount",
"countryId",
"comment"
]
"countryId"
],
"xml": {
"name": "CollectLoanRequest"
}
}
schemas/CollectLoanResponse.json
+16 -3
View File
@@ -3,53 +3,65 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T002"
},
"debtId": {
"type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product for which collection to be made",
"example": "101"
},
"collectAmount": {
"type": "number",
"format": "double",
"description": "Amount collected from user's account (penalCharge is not included)",
"example": 60000.0
},
"penalCharge": {
"type": "number",
"format": "double",
"description": "Amount of penalty collected from user's account. If there is no penalty, amount is '0'",
"example": 0.0
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Aggregated (summed up) lien amount",
"example": 20000.0
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for provided loan operation",
"example": "Testing CollectionLoanRequest"
},
"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": "Loan Collection Successful"
}
},
@@ -62,9 +74,10 @@
"collectAmount",
"penalCharge",
"lienAmount",
"countryId",
"comment",
"resultCode",
"resultDescription"
]
],
"xml": {
"name": "CollectLoanResponse"
}
}
schemas/CustomerConsentRequest.json
+13 -1
View File
@@ -3,31 +3,40 @@
"properties": {
"$type": {
"type": "string",
"description": "Fixed value for this request type",
"example": "CustomerConsentRequest"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "20171209232177"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "ACN8263457"
},
"requestTime": {
"type": "string",
"format": "date-time",
"description": "Date and time of consent request",
"example": "2019-10-18 14:26:21.063"
},
"consentType": {
"type": "string",
"description": "Type of consent: 'Enable' or 'Revoke'",
"enum": ["Enable", "Revoke"],
"example": "Revoke"
},
"channel": {
"type": "string",
"description": "Request channel: 'USSD' or 'APP'",
"enum": ["USSD", "APP"],
"example": "USSD"
}
},
@@ -39,5 +48,8 @@
"requestTime",
"consentType",
"channel"
]
],
"xml": {
"name": "CustomerConsentRequest"
}
}
schemas/CustomerConsentResponse.json
+6 -1
View File
@@ -3,15 +3,20 @@
"properties": {
"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": "Request is received"
}
},
"required": [
"resultCode",
"resultDescription"
]
],
"xml": {
"name": "CustomerConsentResponse"
}
}
schemas/DisbursementRequest.json
+26 -12
View File
@@ -1,77 +1,91 @@
{
"type": "object",
"properties": {
"transactionId": {
"requestId": {
"type": "string",
"example": "T001"
},
"TransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
"description": "Unique identifier of request",
"example": "REQ12345"
},
"debtId": {
"type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T001"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product to be provided to a user",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"description": "Amount of loan (including service fee) to be provided on a specific account of a user",
"example": 100000.0
},
"collectAmountInterest": {
"type": "number",
"format": "double",
"description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)",
"example": 5000.0
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"description": "Management Fee Amount to be collected immediately after loan is provided",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"description": "Insurance Amount to be collected immediately after loan is provided",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"description": "VAT Amount to be collected immediately after loan is provided",
"example": 75.0
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for provided loan operation",
"example": "Testing LoanRequest"
}
},
"required": [
"transactionId",
"TransactionId",
"requestId",
"debtId",
"transactionId",
"customerId",
"accountId",
"productId",
"provideAmount",
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"comment"
]
"countryId"
],
"xml": {
"name": "DisbursementRequest"
}
}
schemas/DisbursementResponse.json
+26 -10
View File
@@ -1,82 +1,98 @@
{
"type": "object",
"properties": {
"transactionId": {
"requestId": {
"type": "string",
"example": "T001"
},
"TransactionId": {
"type": "string",
"example": "Tr201712RK9232P115"
"description": "Unique identifier of request",
"example": "REQ12345"
},
"debtId": {
"type": "string",
"description": "Unique identifier of a loan in Simbrella system that is going to be collected (it correlates with provision request)",
"example": "273194670"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T001"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"productId": {
"type": "string",
"description": "Identifier of a product to be provided to a user",
"example": "101"
},
"provideAmount": {
"type": "number",
"format": "double",
"description": "Amount of loan (including service fee) to be provided on a specific account of a user",
"example": 100000.0
},
"collectAmountInterest": {
"type": "number",
"format": "double",
"description": "Interest Amount to be collected immediately after loan is provided (Only for 30 days)",
"example": 5000.0
},
"collectAmountMgtFee": {
"type": "number",
"format": "double",
"description": "Management Fee Amount to be collected immediately after loan is provided",
"example": 1000.0
},
"collectAmountInsurance": {
"type": "number",
"format": "double",
"description": "Insurance Amount to be collected immediately after loan is provided",
"example": 1000.0
},
"collectAmountVAT": {
"type": "number",
"format": "double",
"description": "VAT Amount to be collected immediately after loan is provided",
"example": 75.0
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"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": "Loan Request Completed Successfully!"
}
},
"required": [
"transactionId",
"TransactionId",
"requestId",
"debtId",
"transactionId",
"customerId",
"accountId",
"productId",
"provideAmount",
"collectAmountInterest",
"collectAmountMgtFee",
"collectAmountInsurance",
"collectAmountVAT",
"countryId",
"resultCode",
"resultDescription"
]
],
"xml": {
"name": "DisbursementResponse"
}
}
schemas/EligibilityCheckRequest.json
+34 -12
View File
@@ -1,34 +1,56 @@
{
"type": "object",
"required": [
"$type",
"transactionId",
"countryCode",
"customerId",
"accountId",
"lienAmount",
"channel"
],
"properties": {
"lienAmount": {
"type": "number",
"format": "double",
"example": 500.01
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "EligibilityCheckRequest"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "Tr201712RK9232P115"
},
"countryCode": {
"type": "string",
"description": "Unique country code. Please refer to Country Codes table",
"example": "NGR"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"example": "3451342"
},
"channel": {
"type": "string",
"example": "USSD"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "ACN8263457"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "2348012345678"
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Amount of lien placed on user's account",
"example": 4.0
},
"channel": {
"type": "string",
"description": "Request channel: USSD, MobApp, or Web",
"enum": ["USSD", "MobApp", "Web"],
"example": "USSD"
}
},
"xml": {
schemas/EligibilityCheckResponse.json
+55 -11
View File
@@ -1,29 +1,73 @@
{
"type": "object",
"required": [
"customerId",
"transactionId",
"eligibleOffers",
"resultCode",
"resultDescription"
],
"properties": {
"eligibleOffers": {
"type": "string",
"example": "OFFERS ARRAY HERE"
},
"resultDescription": {
"type": "string",
"example": "Successful"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "Tr201712RK9232P115"
},
"msisdn": {
"type": "string",
"example": "3451342"
"description": "User's mobile number in an international format",
"example": "2348012345678"
},
"eligibleOffers": {
"type": "array",
"description": "Array of loan offers the customer is eligible for",
"items": {
"type": "object",
"properties": {
"minamount": {
"type": "number",
"format": "double",
"description": "Minimum loan amount",
"example": 5000
},
"maxamount": {
"type": "number",
"format": "double",
"description": "Maximum loan amount",
"example": 20000
},
"productId": {
"type": "string",
"description": "Product identifier",
"example": "101"
},
"offerid": {
"type": "string",
"description": "Offer identifier",
"example": "101"
},
"Tenor": {
"type": "integer",
"description": "Loan tenor in days",
"example": 30
}
}
}
},
"resultCode": {
"type": "string",
"description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
"example": "00"
},
"accountId": {
"resultDescription": {
"type": "string",
"example": "ACN8263457"
"description": "Textual description of provided result code. In case if customer is not eligible (where resultCode is «05») this parameter contains end-user message that can be show directly to the customer.",
"example": "Successful"
}
},
"xml": {
schemas/LienCheckRequest.json
+13
View File
@@ -3,19 +3,32 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique Identifier in Simbrella system",
"example": "SMB1234567"
},
"customerId": {
"type": "string",
"description": "Unique identifier of customer",
"example": "123456"
},
"accountId": {
"type": "string",
"description": "Unique identifier of account",
"example": "E9F77222920BAAB1C5ACF2253C6D6113"
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
}
},
"required": [
"transactionId",
"customerId",
"accountId",
"countryId"
],
"xml": {
"name": "LienCheckRequest"
}
}
schemas/LienCheckResponse.json
+12
View File
@@ -3,15 +3,27 @@
"properties": {
"lienAmount": {
"type": "number",
"format": "double",
"description": "Lien amount applied to the account",
"example": 20000.0
},
"resultCode": {
"type": "string",
"description": "Result code of response",
"example": "00"
},
"resultDescription": {
"type": "string",
"description": "Response description",
"example": "Successful"
}
},
"required": [
"lienAmount",
"resultCode",
"resultDescription"
],
"xml": {
"name": "LienCheckResponse"
}
}
schemas/LoanInformationRequest.json
+16 -4
View File
@@ -1,24 +1,36 @@
{
"type": "object",
"required": [
"$type",
"transactionId",
"customerId",
"channel"
],
"properties": {
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "LoanInformationRequest"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "Tr201712RK9232P115"
},
"resultDescription": {
"type": "string",
"example": "Successful"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "3451342"
},
"channel": {
"type": "string",
"description": "Request channel: USSD, MobileApp, or Web",
"enum": ["USSD", "MobileApp", "Web"],
"example": "USSD"
}
},
schemas/LoanInformationResponse.json
+73 -11
View File
@@ -1,25 +1,87 @@
{
"type": "object",
"required": [
"customerId",
"loans",
"resultCode",
"resultDescription"
],
"properties": {
"transactionId": {
"customerId": {
"type": "string",
"example": "Tr201712RK9232P115"
"description": "Unique identifier of a user",
"example": "CN621868"
},
"resultDescription": {
"type": "string",
"example": "Successful"
"loans": {
"type": "array",
"description": "Array of loan entities. If customer doesn't have a loan, this array will be empty",
"items": {
"type": "object",
"properties": {
"debtId": {
"type": "string",
"description": "Unique identifier of a debt of a user",
"example": "123456789"
},
"loanDate": {
"type": "string",
"format": "date-time",
"description": "Date and time of provided loan",
"example": "2019-10-18 14:26:21.063"
},
"dueDate": {
"type": "string",
"format": "date-time",
"description": "Due date of provided loan",
"example": "2019-11-20 14:26:21.063"
},
"currentLoanAmount": {
"type": "number",
"format": "double",
"description": "Outstanding debt amount of the user",
"example": 8500.0
},
"initialLoanAmount": {
"type": "number",
"format": "double",
"description": "Initial loan amount",
"example": 10000.0
},
"defaultFee": {
"type": "number",
"format": "double",
"description": "Penalty fee amount",
"example": 0.0
},
"continiousFee": {
"type": "number",
"format": "double",
"description": "Interest fee charged continuously. First occurs when payment is delayed",
"example": 0.0
},
"productId": {
"type": "string",
"description": "Identifier of a provided product to a user",
"example": "101"
}
}
}
},
"totalDebtAmount": {
"type": "number",
"format": "double",
"description": "Sum amount of all existing debts of a user",
"example": 8500.0
},
"resultCode": {
"type": "string",
"description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
"example": "00"
},
"customerId": {
"resultDescription": {
"type": "string",
"example": "CN621868"
},
"loan": {
"type": "string",
"example": "Arrray of loans"
"description": "Description of provided result code",
"example": "Successful"
}
},
"xml": {
schemas/NewTransactionCheckRequest.json
+18
View File
@@ -3,27 +3,45 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of request in Simbrella system",
"example": "173021"
},
"debtId": {
"type": "string",
"description": "Unique identifier of provided loan in Simbrella system",
"example": "173021"
},
"transactionType": {
"type": "string",
"description": "Type of Transaction Simbrella is sending Transaction Check for",
"enum": ["Disbursement", "Collection", "PenalCharge"],
"example": "Disbursement"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"example": "FBN2411011411413A74960"
},
"origTransactionId": {
"type": "string",
"description": "TransactionId sent by Simbrella within initial request to Firstbank API",
"example": "2411011411413A74960"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
}
},
"required": [
"transactionId",
"debtId",
"transactionType",
"fbnTransactionId",
"origTransactionId",
"customerId"
],
"xml": {
"name": "NewTransactionCheckRequest"
}
}
schemas/NewTransactionCheckResponse.json
+60 -4
View File
@@ -1,13 +1,69 @@
{
"type": "object",
"properties": {
"status": {
"transactionId": {
"type": "string",
"example": "Success"
"description": "Unique identifier of request in Simbrella system",
"example": "24110114545374721"
},
"message": {
"data": {
"type": "object",
"description": "Object containing details of transaction Simbrella querying",
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system that was sent for transaction check",
"example": "241101"
},
"providedAmount": {
"type": "number",
"format": "double",
"description": "Amount collected from user's account within disbursement operation. Amount should always be equal to zero if operation is of any type other than Disbursement",
"example": 1000.00
},
"collectedAmount": {
"type": "number",
"format": "double",
"description": "Amount collected from user's account. In case of Disbursement this value will be equal to 0. In case of Collection this value will represent amount successfully collected from customers account. In case of Penal charge this value will represent penalty amount collected from customer's account.",
"example": 0.00
},
"resultCode": {
"type": "string",
"description": "Result code of the operation one sent for transaction check, e.g. (00 – Success etc.)",
"example": "00"
},
"resultDescription": {
"type": "string",
"description": "Description of provided result code that was sent for transaction check",
"example": "Loan Provision is successful"
}
},
"required": [
"transactionId",
"providedAmount",
"collectedAmount",
"resultCode",
"resultDescription"
]
},
"resultCode": {
"type": "string",
"example": "Transaction check completed successfully."
"description": "Result code of executed transaction, e.g. (00 – Success etc.)",
"example": "00"
},
"resultDescription": {
"type": "string",
"description": "Description of provided result code",
"example": "SUCCESS"
}
},
"required": [
"transactionId",
"data",
"resultCode",
"resultDescription"
],
"xml": {
"name": "NewTransactionCheckResponse"
}
}
schemas/NotificationCallbackRequest.json
+73
View File
@@ -0,0 +1,73 @@
{
"type": "object",
"properties": {
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"example": "123456789"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "123456789"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "ACN8263457"
},
"debtId": {
"type": "string",
"description": "Unique identifier of providing loan in Simbrella system",
"example": "987654321"
},
"transactionType": {
"type": "string",
"description": "Type of transaction initiated by Simbrella",
"enum": ["Disbursement", "Collection", "PenalCharge"],
"example": "Disbursement"
},
"amountProvided": {
"type": "number",
"format": "double",
"description": "Amount provided to customer within Disbursement operation. Will be 0 for Collection or PenalCharge transactions.",
"example": 1000.00
},
"amountCollected": {
"type": "number",
"format": "double",
"description": "Amount collected during execution of operation. In case of Disbursement this value will be equal to 0. In case of Collection this value will represent amount successfully collected from customers account. In case of Penal charge this value will represent penalty amount collected from customer's account.",
"example": 0.00
},
"responseCode": {
"type": "string",
"description": "Result code of the notification, e.g. (00 – Success etc.) see result codes table",
"example": "00"
},
"responseDescription": {
"type": "string",
"description": "Result description of the notification, detailing status of the transaction",
"example": "Successful"
}
},
"required": [
"fbnTransactionId",
"transactionId",
"customerId",
"accountId",
"debtId",
"transactionType",
"amountProvided",
"amountCollected",
"responseCode",
"responseDescription"
],
"xml": {
"name": "NotificationCallbackRequest"
}
}
schemas/NotificationCallbackResponse.json
+24
View File
@@ -0,0 +1,24 @@
{
"type": "object",
"properties": {
"resultCode": {
"type": "string",
"description": "Result code of successful request. See Simbrella Result Codes",
"maxLength": 2,
"example": "00"
},
"resultDescription": {
"type": "string",
"description": "Description of provided result code",
"maxLength": 100,
"example": "Successful"
}
},
"required": [
"resultCode",
"resultDescription"
],
"xml": {
"name": "NotificationCallbackResponse"
}
}
schemas/PenalChargeRequest.json
+24
View File
@@ -3,39 +3,63 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T004"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"example": "Tr201712RK9232P115"
},
"debtId": {
"type": "string",
"description": "Unique identifier of providing loan in Simbrella system",
"example": "273194670"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"penalCharge": {
"type": "number",
"format": "double",
"description": "Penalty amount that needs to be collected from user's account",
"example": 1.2
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Aggregated (summed up) lien amount",
"example": 101.2
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for provided loan operation",
"example": "Testing PenalChargeRequest"
}
},
"required": [
"transactionId",
"fbnTransactionId",
"debtId",
"customerId",
"accountId",
"penalCharge",
"lienAmount",
"countryId"
],
"xml": {
"name": "PenalChargeRequest"
}
}
schemas/PenalChargeResponse.json
+9
View File
@@ -3,11 +3,20 @@
"properties": {
"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": "Penal charge debited successfully"
}
},
"required": [
"resultCode",
"resultDescription"
],
"xml": {
"name": "PenalChargeResponse"
}
}
schemas/ProvideLoanRequest.json
+84
View File
@@ -0,0 +1,84 @@
{
"type": "object",
"properties": {
"$type": {
"type": "string",
"description": "Value is fixed to 'ProvideLoanRequest'",
"example": "ProvideLoanRequest"
},
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
"example": "Tr201712RK9232P115"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "ACN8263457"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "3451342"
},
"productId": {
"type": "string",
"description": "Identifier of a product chosen by user",
"example": "101"
},
"lienAmount": {
"type": "number",
"format": "double",
"description": "Amount of lien placed on user's account",
"example": 400
},
"requestedAmount": {
"type": "number",
"format": "double",
"description": "Amount of loan that requested by user",
"example": 900
},
"collectionType": {
"type": "integer",
"description": "Type of collection that user is preferred. 0 – as soon as salary inflow occurs; 1- as soon as any new inflow occurs, 1 – collection after XX days.",
"enum": [0, 1],
"example": 1
},
"loanType": {
"type": "integer",
"description": "Type of loan. 0 – simple; 1 – refinance.",
"enum": [0, 1],
"example": 0
},
"channel": {
"type": "string",
"description": "Request channel: 'USSD' or 'MobileApp' or 'Web'",
"enum": ["USSD", "MobileApp", "Web"],
"example": "USSD"
}
},
"required": [
"$type",
"transactionId",
"customerId",
"accountId",
"productId",
"requestedAmount",
"collectionType",
"loanType",
"channel"
],
"xml": {
"name": "ProvideLoanRequest"
}
}
schemas/ProvideLoanResponse.json
+51
View File
@@ -0,0 +1,51 @@
{
"type": "object",
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
"example": "Tr201712RK9232P115"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "ACN8263457"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "3451342"
},
"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": "Successful"
}
},
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"resultCode",
"resultDescription"
],
"xml": {
"name": "ProvideLoanResponse"
}
}
schemas/RACCheckRequest.json
+17 -2
View File
@@ -3,25 +3,40 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T001"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in Eligibility or Provision requests",
"example": "Tr201712RK9232P115"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"RAC_Array": {
"type": "string",
"example": "XXX"
"type": "array",
"description": "Array of RAC items to check (BVN, CRC, CRMS, Salary account, lien, whitelist, lien, account status, no bounced check and existing loan)",
"items": {
"type": "string"
},
"example": ["SalaryAccount", "BVN", "BVNAttachedtoAccount", "CRC", "CRMS", "AccountStatus", "Lien", "NoBouncedCheck", "Whitelist", "NoPastDueSalaryLoan", "NoPastDueOtherLoan"]
}
},
"required": [
"transactionId",
"fbnTransactionId",
"customerId",
"accountId",
"RAC_Array"
],
"xml": {
"name": "RACCheckRequest"
}
schemas/RACCheckResponse.json
+32 -1
View File
@@ -3,62 +3,93 @@
"properties": {
"resultCode": {
"type": "string",
"description": "Result code of executed transaction, e.g. (00 – Success etc.) see result codes table",
"example": "00"
},
"RACResponse": {
"type": "object",
"description": "Object containing binary responses for each RAC check",
"properties": {
"Salary account": {
"type": "string",
"description": "Has Salary account or Not (1 = Yes, 0 = No)",
"example": "1"
},
"BVN": {
"type": "string",
"description": "BVN Ok (1 = Yes, 0 = No)",
"example": "1"
},
"BVNAttachedtoAccount": {
"type": "string",
"description": "BVN attached to account (1 = Yes, 0 = No)",
"example": "1"
},
"CRMS": {
"type": "string",
"description": "No Delinquent loan in CRMS (1 = Yes, 0 = No)",
"example": "1"
},
"CRC": {
"type": "string",
"description": "No Delinquent loan in CRC (1 = Yes, 0 = No)",
"example": "1"
},
"AccountStatus": {
"type": "string",
"description": "Has 'Regular' account status (1 = Yes, 0 = No)",
"example": "1"
},
"Lien": {
"type": "string",
"description": "No Lien on account (1 = Yes, 0 = No)",
"example": "1"
},
"NoBouncedCheck": {
"type": "string",
"description": "No Bounced Check (1 = Yes, 0 = No)",
"example": "1"
},
"Whitelist": {
"type": "string",
"description": "Not blacklisted (1 = Yes, 0 = No)",
"example": "1"
},
"NoPastDueSalaryLoan": {
"type": "string",
"description": "No Past Due Salary Loan (1 = Yes, 0 = No)",
"example": "1"
},
"NoPastDueOtherLoan": {
"type": "string",
"description": "No Past Due Other Loans (1 = Yes, 0 = No)",
"example": "1"
}
}
},
"required": [
"Salary account",
"BVNAttachedtoAccount",
"CRC",
"CRMS",
"AccountStatus",
"Lien",
"NoBouncedCheck",
"Whitelist",
"NoPastDueSalaryLoan",
"NoPastDueOtherLoan"
]
},
"resultDescription": {
"type": "string",
"description": "Description of provided result code",
"example": "RAC Check Successful"
}
},
"required": [
"resultCode",
"RACResponse",
"resultDescription"
],
"xml": {
"name": "RACCheckResponse"
}
schemas/RepaymentRequest.json
+31 -21
View File
@@ -1,42 +1,52 @@
{
"type": "object",
"required": [
"$type",
"transactionId",
"customerId",
"debtId",
"productId",
"channel"
],
"properties": {
"$type": {
"type": "string",
"description": "Fixed value to identify request type",
"example": "RepaymentRequest"
},
"msisdn": {
"type": "string",
"example": "3451342"
},
"debtId": {
"type": "string",
"example": "273194670"
},
"productId": {
"type": "string",
"example": "101"
},
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in FIRSTBANK system",
"example": "20171209232115"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a customer",
"example": "CN621868"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "3451342"
},
"debtId": {
"type": "string",
"description": "Debt identifier provided in 'Current Loans' response",
"example": "273194670"
},
"productId": {
"type": "string",
"description": "Identifier of a product that user is repaying for",
"example": "101"
},
"channel": {
"type": "string",
"description": "Request channel: USSD or APP",
"enum": ["USSD", "APP"],
"example": "USSD"
}
},
"required": [
"$type",
"msisdn",
"debtId",
"productId",
"transactionId",
"customerId",
"channel"
]
"xml": {
"name": "RepaymentRequest"
}
}
schemas/RepaymentResponse.json
+31 -23
View File
@@ -1,32 +1,40 @@
{
"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"
]
],
"properties": {
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"productId": {
"type": "string",
"description": "Identifier of a product that user is payed for",
"example": "101"
},
"debtId": {
"type": "string",
"description": "Unique identifier of an existing debt of a user",
"example": "273194670"
},
"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": "Successful"
}
},
"xml": {
"name": "RepaymentResponse"
}
}
schemas/RevokeEnableConsentRequest.json
+21
View File
@@ -3,36 +3,57 @@
"properties": {
"transactionId": {
"type": "string",
"description": "Unique identifier of transaction in Simbrella system",
"example": "T0014"
},
"fbnTransactionId": {
"type": "string",
"description": "Unique id of the transaction received from FBN in CustomerConsentRequest",
"example": "20171209232177"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"processTime": {
"type": "string",
"format": "date-time",
"description": "Date and time when consent request was processed",
"example": "2019-10-18 14:26:21.063"
},
"consentType": {
"type": "string",
"description": "Type of consent: 'Enable' or 'Revoke'",
"enum": ["Enable", "Revoke"],
"example": "Revoke"
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"comment": {
"type": "string",
"description": "Any additional comment for consent operation",
"example": "Testing RevokeEnableConsentRequest"
}
},
"required": [
"transactionId",
"fbnTransactionId",
"customerId",
"accountId",
"processTime",
"consentType",
"countryId"
],
"xml": {
"name": "RevokeEnableConsentRequest"
}
}
schemas/RevokeEnableConsentResponse.json
+15
View File
@@ -3,23 +3,38 @@
"properties": {
"$type": {
"type": "string",
"description": "Value is fixed to 'RevokeEnableConsentResponse'",
"example": "RevokeEnableConsentResponse"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"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": "Success"
}
},
"required": [
"$type",
"customerId",
"accountId",
"resultCode",
"resultDescription"
],
"xml": {
"name": "RevokeEnableConsentResponse"
}
}
schemas/SMSRequest.json
+7 -1
View File
@@ -3,14 +3,17 @@
"properties": {
"text": {
"type": "string",
"description": "Message to send to customer",
"example": "This is a test message for SMS request method."
},
"dest": {
"type": "string",
"description": "Phone Number in international format",
"example": "+2348039409144"
},
"unicode": {
"type": "boolean",
"description": "Character encoding standard (set as False for single SMS)",
"example": false
}
},
@@ -18,5 +21,8 @@
"text",
"dest",
"unicode"
]
],
"xml": {
"name": "SMSRequest"
}
}
schemas/SMSResponse.json
+14 -4
View File
@@ -3,22 +3,32 @@
"properties": {
"data": {
"type": "string",
"description": "Any additional data in response",
"example": ""
},
"statusCode": {
"type": "integer",
"description": "Result code of executed process (200 = Success)",
"example": 200
},
"IsSuccessful": {
"type": "boolean",
"description": "An Indicator that the process was successful or not",
"example": true
},
"errorMessage": {
"type": [
"string",
"null"
],
"type": "string",
"description": "Description of status code if process is failed, null if successful",
"example": null
}
},
"required": [
"data",
"statusCode",
"IsSuccessful",
"errorMessage"
],
"xml": {
"name": "SMSResponse"
}
}
schemas/SelectOfferRequest.json
+26 -7
View File
@@ -1,41 +1,60 @@
{
"type": "object",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"msisdn",
"requestedAmount",
"productid",
"channel"
],
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session. Must be consistent throughout whole USSD journey",
"example": "1231231321232"
},
"customerId": {
"type": "string",
"example": "CN621868"
"description": "Unique identifier of a customer",
"example": "1256907"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "5948306019"
},
"msisdn": {
"type": "string",
"description": "User's mobile number in an international format",
"example": "123456789"
},
"requestedAmount": {
"type": "number",
"format": "double",
"example": 10000.55
},
"accountId": {
"type": "string",
"example": "ACN8263457"
"description": "Amount of loan requested by user",
"example": 10000.0
},
"productid": {
"type": "string",
"description": "Product ID",
"example": "101"
},
"channel": {
"type": "string",
"description": "Channel of incoming request",
"enum": ["USSD", "MobApp", "Web"],
"example": "USSD"
}
},
"xml": {
"name": "SelectOffersRequest"
"name": "SelectOfferRequest"
}
}
schemas/SelectOfferResponse.json
+121 -5
View File
@@ -1,36 +1,152 @@
{
"type": "object",
"required": [
"requestId",
"transactionId",
"customerId",
"accountId",
"offers",
"resultCode",
"resultDescription"
],
"properties": {
"requestId": {
"type": "string",
"description": "Unique identifier of request",
"example": "202111170001371256908"
},
"transactionId": {
"type": "string",
"description": "Unique ID of customer's USSD session",
"example": "1231231321232"
},
"customerId": {
"type": "string",
"example": "CN621868"
"description": "Unique identifier of a customer",
"example": "1256907"
},
"accountId": {
"type": "string",
"example": "ACN8263457"
"description": "Specific identifier of a user's account",
"example": "5948306019"
},
"outstandingDebtAmount": {
"type": "number",
"format": "double",
"description": "Outstanding debt amount if any",
"example": 0
},
"offers": {
"type": "string",
"example": "ARRAY of Offers"
"type": "array",
"description": "Array of loan offers",
"items": {
"type": "object",
"properties": {
"offerId": {
"type": "string",
"description": "Unique identifier of the offer",
"example": "14451"
},
"productId": {
"type": "string",
"description": "Product identifier",
"example": "2030"
},
"amount": {
"type": "number",
"format": "double",
"description": "Amount of loan customer is eligible for",
"example": 10000.0
},
"upfrontPayment": {
"type": "number",
"format": "double",
"description": "Amount to be deducted upfront",
"example": 1000.0
},
"interestRate": {
"type": "number",
"format": "double",
"description": "Percentage of interest rate",
"example": 3.0
},
"Interest": {
"type": "number",
"format": "double",
"description": "Amount of interest",
"example": 300.0
},
"ManagementRate": {
"type": "number",
"format": "double",
"description": "Percentage of management fee",
"example": 1.0
},
"ManagementFee": {
"type": "number",
"format": "double",
"description": "Amount of management fee",
"example": 100.0
},
"InsuranceRate": {
"type": "number",
"format": "double",
"description": "Percentage of insurance",
"example": 1.0
},
"InsuranceFee": {
"type": "number",
"format": "double",
"description": "Amount of insurance",
"example": 100.0
},
"VATRate": {
"type": "number",
"format": "double",
"description": "Percentage of VAT",
"example": 7.5
},
"VATamount": {
"type": "number",
"format": "double",
"description": "Amount of VAT",
"example": 100.0
},
"recommendedRepaymentDates": {
"type": "array",
"description": "Array of recommended payment dates for all installments in yyyy-mm-dd format",
"items": {
"type": "string",
"example": "2022-11-30"
}
},
"installmentAmount": {
"type": "number",
"format": "double",
"description": "Amount to be paid each month (upfrontPayment not included)",
"example": 11000.0
},
"totalRepaymentAmount": {
"type": "number",
"format": "double",
"description": "Total amount to be paid by customer. All installment amounts + upfront payment",
"example": 11000.0
}
}
}
},
"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": "Successful"
}
},
"xml": {
"name": "SelectOffersResponse"
"name": "SelectOfferResponse"
}
}
schemas/TokenValidationRequest.json
+21 -8
View File
@@ -1,21 +1,34 @@
{
"type": "object",
"properties": {
"UserId": {
"type": "string",
"example": "TMP0840"
},
"TokenCode": {
"type": "string",
"example": "32365214"
},
"RequestId": {
"type": "string",
"description": "Unique Identifier in Simbrella system",
"example": "SMB1234567"
},
"UserId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "TMP0840"
},
"CountryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"TokenCode": {
"type": "string",
"description": "Token code to be validated",
"example": "32365214"
}
},
"required": [
"RequestId",
"UserId",
"CountryId",
"TokenCode"
],
"xml": {
"name": "TokenValidationRequest"
}
}
schemas/TokenValidationResponse.json
+15
View File
@@ -3,23 +3,38 @@
"properties": {
"Authenticated": {
"type": "boolean",
"description": "Boolean value describing result of validation",
"example": true
},
"AuthenticatedMessage": {
"type": "string",
"description": "Message describing authentication",
"example": "The user Oluwole Olusoga has successfully authenticated!"
},
"ResponseCode": {
"type": "string",
"description": "Result code of response",
"example": "00"
},
"ResponseMessage": {
"type": "string",
"description": "Response description",
"example": "Successful"
},
"RequestId": {
"type": "string",
"description": "Unique id that was sent in request",
"example": "SMB1234567"
}
},
"required": [
"Authenticated",
"AuthenticatedMessage",
"ResponseCode",
"ResponseMessage",
"RequestId"
],
"xml": {
"name": "TokenValidationResponse"
}
}
schemas/TransactionVerifyRequest.json
+20
View File
@@ -3,31 +3,51 @@
"properties": {
"counter": {
"type": "string",
"description": "Unique counter for number of attempts of the API call. Original attempt is 1",
"example": "2"
},
"TransactionId": {
"type": "string",
"description": "Id of the transaction we are checking",
"example": "T002"
},
"RequestId": {
"type": "string",
"description": "Id of this transaction query",
"example": "R02802"
},
"customerId": {
"type": "string",
"description": "Unique identifier of a user",
"example": "CN621868"
},
"accountId": {
"type": "string",
"description": "Specific identifier of a user's account",
"example": "2017821799"
},
"countryId": {
"type": "string",
"description": "Set to static value '01'",
"example": "01"
},
"transactionType": {
"type": "string",
"description": "To check state of loan disbursal transaction, value must be 'Disbursement', to check state of loan collection transaction, value must be 'Collection', to check state of penalty charge transaction, value must be 'Penalty'",
"enum": ["Disbursement", "Collection", "Penalty"],
"example": "Disbursement"
}
},
"required": [
"counter",
"TransactionId",
"RequestId",
"customerId",
"accountId",
"countryId",
"transactionType"
],
"xml": {
"name": "TransactionVerifyRequest"
}
}
schemas/TransactionVerifyResponse.json
+29
View File
@@ -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"
}
}