https://{your-domain}.fincode.software/api/v1/services/user/repayment-instructions/{loan-application-id}
{
"status": "<string>",
"data": {
"loanApplicationId": "<string>",
"paymentMethods": [
{}
],
"bankAccountDetails": {
"accountNumber": "<string>",
"accountName": "<string>",
"bankCode": "<string>",
"bankName": "<string>"
},
"paymentReference": "<string>",
"instructions": [
{}
],
"contactInformation": {}
}
}API Endpoints
Repayment Instructions
Retrieves detailed repayment instructions for a loan, including payment methods and account details.
GET
/
api
/
v1
/
services
/
user
/
repayment-instructions
/
{loan-application-id}
https://{your-domain}.fincode.software/api/v1/services/user/repayment-instructions/{loan-application-id}
{
"status": "<string>",
"data": {
"loanApplicationId": "<string>",
"paymentMethods": [
{}
],
"bankAccountDetails": {
"accountNumber": "<string>",
"accountName": "<string>",
"bankCode": "<string>",
"bankName": "<string>"
},
"paymentReference": "<string>",
"instructions": [
{}
],
"contactInformation": {}
}
}Fetches comprehensive repayment instructions for a loan, including bank account details, payment reference numbers, and step-by-step instructions for making repayments.
https://{your-domain}.fincode.software/api/v1/services/user/repayment-instructions/{loan-application-id}
Request Headers
Path Parameters
The unique identifier (UUID) of the loan application for which to get repayment instructions.
Response
Returns detailed repayment instructions.Repayment instructions details.
Show data object
Show data object
Code Examples
curl --location 'https://{your-domain}.fincode.software/api/v1/services/user/repayment-instructions/123e4567-e89b-12d3-a456-426614174000' \
--header 'X-Auth-Token: YOUR_JWT_ACCESS_TOKEN' \
--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 getRepaymentInstructions(accessToken, loanApplicationId) {
try {
const response = await axios.get(
`${BASE_URL}/repayment-instructions/${loanApplicationId}`,
{
headers: {
'X-Auth-Token': accessToken,
'x-fapi-auth-date': new Date().toISOString(),
'x-fapi-customer-ip-address': '192.168.1.1',
'x-fapi-interaction-id': `interaction-${Date.now()}`,
},
}
);
instructions.instructions.forEach((instruction, index) => {
console.log(`${index + 1}. ${instruction}`);
});
return instructions;
} catch (error) {
console.error(
'Failed to fetch repayment instructions:',
error.response?.data || error.message
);
throw error;
}
}
// Usage Example
const accessToken = 'YOUR_JWT_ACCESS_TOKEN';
const loanApplicationId = '123e4567-e89b-12d3-a456-426614174000';
getRepaymentInstructions(accessToken, loanApplicationId);
