https://{your-domain}.fincode.software/api/v1/services/user/get-loan-terms/{organisationId}
{
"status": "<string>",
"data": {
"organisationId": "<string>",
"termsAndConditions": "<string>",
"interestRateRange": {},
"feeStructure": {},
"repaymentTerms": {},
"eligibilityCriteria": {},
"lastUpdated": "<string>"
}
}API Endpoints
Get Loan Terms
Retrieves the loan terms and conditions for a specific organization.
GET
/
api
/
v1
/
services
/
user
/
get-loan-terms
/
{organisationId}
https://{your-domain}.fincode.software/api/v1/services/user/get-loan-terms/{organisationId}
{
"status": "<string>",
"data": {
"organisationId": "<string>",
"termsAndConditions": "<string>",
"interestRateRange": {},
"feeStructure": {},
"repaymentTerms": {},
"eligibilityCriteria": {},
"lastUpdated": "<string>"
}
}Fetches the loan terms and conditions, including interest rates, fees, repayment schedules, and other important terms that apply to loans from a specific organization.
https://{your-domain}.fincode.software/api/v1/services/user/get-loan-terms/{organisationId}
Request Headers
string
required
The JWT Access Token obtained from the
/login or /refresh-token endpoint.string
required
Unique idempotency key for the request to prevent duplicate processing.
string
required
The date and time at which the request was initiated (ISO 8601 format).
string
required
The IP address of the customer making the request.
string
required
Unique identifier for the interaction/session.
Path Parameters
string
required
The unique identifier (UUID) of the organization whose loan terms to retrieve.
Response
Returns the loan terms and conditions for the organization.string
default:"SUCCESS"
Overall status of the API request.
object
Loan terms and conditions details.
Show data object
Show data object
string
Unique identifier of the organization.
string
Full text of the terms and conditions.
object
Range of interest rates applicable.
object
Details of fees applicable to loans.
object
Information about repayment schedules and options.
object
Criteria that customers must meet to qualify for loans.
string
Date when the terms were last updated.
Code Examples
curl --location 'https://{your-domain}.fincode.software/api/v1/services/user/get-loan-terms/123e4567-e89b-12d3-a456-426614174000' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--header 'x-idempotency-key: unique-key-12345' \
--header 'x-fapi-auth-date: 2024-01-15T10:30:00Z' \
--header 'x-fapi-customer-ip-address: 192.168.1.1' \
--header 'x-fapi-interaction-id: interaction-12345'
const axios = require('axios');
const BASE_URL = 'https://{your-domain}.fincode.software/api/v1/services/user';
async function getLoanTerms(accessToken, organisationId) {
try {
const response = await axios.get(
`${BASE_URL}/get-loan-terms/${organisationId}`,
{
headers: {
'X-Auth-Token': accessToken,
'x-idempotency-key': `key-${Date.now()}`,
'x-fapi-auth-date': new Date().toISOString(),
'x-fapi-customer-ip-address': '192.168.1.1',
'x-fapi-interaction-id': `interaction-${Date.now()}`,
},
}
);
return terms;
} catch (error) {
console.error(
'Failed to fetch loan terms:',
error.response?.data || error.message
);
throw error;
}
}
// Usage Example
const accessToken = 'YOUR_JWT_ACCESS_TOKEN';
const organisationId = '123e4567-e89b-12d3-a456-426614174000';
getLoanTerms(accessToken, organisationId);