latestOpenAPI 3.0.02026-08-102034118.0 KB
8f580eff2157
Loan servicing
Retrieve a loan schedule
Returns the schedule of the loan specified in the request URL. The loan schedule includes the full details of a loan, such as loan balance, fees, penalities, interests, and all past, present, and future installments of the loan.
get/v1/loans/{loan_id}/repayment_schedule
Path parameters
loan_idstring required
The ID of the loan for which the schedule should be retrieved.
Response
Repayment Schedule
Example response
{
"loan_balances": {
"total": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"loan_expenses": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"current_repayment_amount": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"balance": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"principal": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"balance": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"penalty": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"balance": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"interest_from_arrears": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"balance": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"interest": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"balance": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"fees": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"balance": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
}
},
"installments": [
{
"total": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"state": "PAID",
"principal": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"penalty": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"number": "5",
"interest": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"fee_details": [
{
"tax": {
"reduced": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"amount": {
"reduced": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
}
}
],
"fee": {
"paid": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"expected": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
},
"due": {
"value": 1000,
"unit": "cents",
"currency": "EUR"
}
},
"due_date": "2022-06-23"
}
]
}