added repayment data
This commit was merged in pull request #20.
This commit is contained in:
Chinenye Nmoh
@@ -80,6 +80,14 @@
|
||||
"url": "https://www.simbrellang.net"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Repayment Data",
|
||||
"description": "Get all repayment data with optional filtering.",
|
||||
"externalDocs": {
|
||||
"description": "Find out more",
|
||||
"url": "https://www.simbrellang.net"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "Offers",
|
||||
"description": "Get all offers with optional filtering.",
|
||||
@@ -119,6 +127,9 @@
|
||||
"/loan-charges": {
|
||||
"$ref": "../swagger/paths/LoanCharges.json"
|
||||
},
|
||||
"/repayment-data": {
|
||||
"$ref": "../swagger/paths/RepaymentData.json"
|
||||
},
|
||||
"/repayment-schedules": {
|
||||
"$ref": "../swagger/paths/RepaymentSchedules.json"
|
||||
},
|
||||
@@ -158,6 +169,9 @@
|
||||
"RepaymentsResponse": {
|
||||
"$ref": "../swagger/schemas/RepaymentsResponse.json"
|
||||
},
|
||||
"RepaymentDataResponse": {
|
||||
"$ref": "../swagger/schemas/RepaymentDataResponse.json"
|
||||
},
|
||||
"LoanChargesResponse": {
|
||||
"$ref": "../swagger/schemas/LoanChargesResponse.json"
|
||||
},
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
{
|
||||
"get": {
|
||||
"tags": ["RepaymentData"],
|
||||
"summary": "Get all repayment data with optional filtering",
|
||||
"description": "Retrieve repayment data records with optional filtering by transaction ID, customer ID, account ID, FBN transaction ID, and added date. Supports pagination.",
|
||||
"operationId": "getRepaymentData",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "transaction_id",
|
||||
"in": "query",
|
||||
"description": "Filter by transaction ID",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "TRX123456789"
|
||||
},
|
||||
{
|
||||
"name": "customer_id",
|
||||
"in": "query",
|
||||
"description": "Filter by customer ID",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "CID0000025585"
|
||||
},
|
||||
{
|
||||
"name": "account_id",
|
||||
"in": "query",
|
||||
"description": "Filter by account ID",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "ACCT000000123"
|
||||
},
|
||||
{
|
||||
"name": "fbn_transaction_id",
|
||||
"in": "query",
|
||||
"description": "Filter by FBN transaction ID",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
},
|
||||
"example": "FBNTRX7890"
|
||||
},
|
||||
{
|
||||
"name": "added_date",
|
||||
"in": "query",
|
||||
"description": "Filter by added date (ISO format)",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"example": "2024-01-01T00:00:00Z"
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"in": "query",
|
||||
"description": "Page number for pagination",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1,
|
||||
"minimum": 1
|
||||
},
|
||||
"example": 1
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"in": "query",
|
||||
"description": "Number of items per page (max 100)",
|
||||
"required": false,
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 20,
|
||||
"minimum": 1,
|
||||
"maximum": 100
|
||||
},
|
||||
"example": 20
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Successful operation",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "../schemas/RepaymentDataResponse.json"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid request"
|
||||
},
|
||||
"500": {
|
||||
"description": "Internal server error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
{
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"repayment_data": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"example": 1
|
||||
},
|
||||
"transaction_id": {
|
||||
"type": "string",
|
||||
"example": "TRX123456",
|
||||
"nullable": false
|
||||
},
|
||||
"added_date": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"example": "2025-04-10T16:45:47.879Z"
|
||||
},
|
||||
"response_code": {
|
||||
"type": "string",
|
||||
"example": "00",
|
||||
"nullable": true
|
||||
},
|
||||
"response_descr": {
|
||||
"type": "string",
|
||||
"example": "Repayment successful",
|
||||
"nullable": true
|
||||
},
|
||||
"fbn_transaction_id": {
|
||||
"type": "string",
|
||||
"example": "FBN123456",
|
||||
"nullable": true
|
||||
},
|
||||
"customer_id": {
|
||||
"type": "string",
|
||||
"example": "CID0000025585",
|
||||
"nullable": true
|
||||
},
|
||||
"account_id": {
|
||||
"type": "string",
|
||||
"example": "ACCT000000123",
|
||||
"nullable": true
|
||||
},
|
||||
"repayment_amount": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"example": 15000.0,
|
||||
"nullable": true
|
||||
},
|
||||
"amount_collected": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"example": 14500.0,
|
||||
"nullable": true
|
||||
},
|
||||
"balance": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"example": 500.0,
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"count": {
|
||||
"type": "integer",
|
||||
"example": 1
|
||||
},
|
||||
"pagination": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"total_count": {
|
||||
"type": "integer",
|
||||
"example": 100
|
||||
},
|
||||
"total_pages": {
|
||||
"type": "integer",
|
||||
"example": 5
|
||||
},
|
||||
"current_page": {
|
||||
"type": "integer",
|
||||
"example": 1
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer",
|
||||
"example": 20
|
||||
},
|
||||
"has_next": {
|
||||
"type": "boolean",
|
||||
"example": true
|
||||
},
|
||||
"has_prev": {
|
||||
"type": "boolean",
|
||||
"example": false
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"xml": {
|
||||
"name": "RepaymentDataResponse"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user