> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fincode.technology/llms.txt
> Use this file to discover all available pages before exploring further.
# Loan Details with Payment History
> Retrieves comprehensive loan application details including payment history and installment schedule.
Fetches detailed information about a loan application including all installments, payment history, outstanding balances, and repayment schedule.
```bash cURL GET theme={null}
[https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id}](https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/{loan-application-id})
```
## Request Headers
The **JWT Access Token** obtained from the `/login` or `/refresh-token` endpoint.
Unique idempotency key for the request to prevent duplicate processing.
The date and time at which the request was initiated (ISO 8601 format).
The IP address of the customer making the request.
Unique identifier for the interaction/session.
## Path Parameters
The unique identifier (UUID) of the loan application for which to retrieve details.
## Response
Returns comprehensive loan details including installment schedule and payment history.
Overall status of the API request.
Loan application details with payment history.
Unique identifier of the loan application.
Unique identifier of the customer.
Name of the customer.
Email address of the customer.
Name of the loan product.
Current status of the loan application (e.g., `REQUESTED`, `APPROVED`, `DISBURSED`).
Account state (e.g., `ACTIVE`, `CLOSED`, `ACTIVE_IN_ARREARS`).
Original loan amount (principal).
Interest rate applicable to the loan.
Total repayment amount (principal + total interest + fees).
Total outstanding balance.
Outstanding principal balance.
Outstanding interest balance.
Outstanding fees balance.
Outstanding penalty balance.
Total amount paid so far.
Principal amount paid.
Interest amount paid.
Fees amount paid.
Penalty amount paid.
Date when the loan application was created.
Date when the loan was disbursed.
Date of the first installment.
Loan maturity date.
Next payment due date.
Total number of installments.
Number of installments paid.
Number of installments remaining.
Loan duration.
Duration counter unit (e.g., `MONTH`, `WEEK`, `DAY`).
Loan repayment method (e.g., `External Bank Transfer`, `Internal Bank Transfer`).
Whether the loan uses third-party payment collection (e.g., Remita).
Bank name for manual repayments.
Account number for manual repayments.
Account name for manual repayments.
Whether the loan is fully repaid.
Currency code.
List of all installments with payment details.
Installment number (1, 2, 3, etc.).
Due date for this installment.
Total installment amount (principal + interest + fees).
Principal amount for this installment.
Interest amount for this installment.
Fees amount for this installment.
Penalty amount (if any).
Amount paid for this installment.
Outstanding amount for this installment.
Payment status (e.g., `PENDING`, `PAID`, `PARTIAL`, `OVERDUE`).
Date when payment was made (if paid).
Number of days overdue (if applicable).
## Code Examples
```bash cURL theme={null}
curl --location 'https://finlend.fincode.software/api/v1/services/user/loan-details-with-payment-history/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'
```
```javascript Node.js theme={null}
const axios = require('axios');
const BASE_URL = 'https://finlend.fincode.software/api/v1/services/user';
async function getLoanDetailsWithPaymentHistory(accessToken, loanApplicationId) {
try {
const response = await axios.get(
`${BASE_URL}/loan-details-with-payment-history/${loanApplicationId}`,
{
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()}`,
},
}
);
const loanDetails = response.data.data;
console.log('Loan Details:');
console.log(`- Application ID: ${loanDetails.loanApplicationId}`);
console.log(`- Product: ${loanDetails.loanProductName}`);
console.log(`- Total Installments: ${loanDetails.totalInstallments}`);
console.log(`- Installments Paid: ${loanDetails.installmentsPaid}`);
console.log(`- Total Balance: ${loanDetails.totalBalance}`);
console.log(`- Next Payment Due: ${loanDetails.nextPaymentDueDate}`);
console.log('\nInstallment Schedule:');
loanDetails.paymentHistory.forEach((installment) => {
console.log(
`Installment ${installment.installmentNumber}: ` +
`${installment.installmentAmount} due ${installment.dueDate} ` +
`(Status: ${installment.paymentStatus})`
);
});
return loanDetails;
} catch (error) {
console.error(
'Failed to fetch loan details:',
error.response?.data || error.message
);
throw error;
}
}
// Usage Example
const accessToken = 'YOUR_JWT_ACCESS_TOKEN';
const loanApplicationId = '123e4567-e89b-12d3-a456-426614174000';
getLoanDetailsWithPaymentHistory(accessToken, loanApplicationId);
```