Once all documents are uploaded, and if this API is enabled for you, you can trigger the loan disbursal API to disburse the loan.
Disbursal can be triggered via POST API call to the URL, while the GET API call can be used to fetch disbursal status.
GET /api/v1/client/line/<lead_id>/tranche/<tranche_id>/disburse/
Sample response:
{
"is_success": true,
"data": {
"status": "<tranche disbursal status>",
"amount": "<tranche amount>",
"transaction_time": "<when the transaction was done>",
"transaction_id": "<transaction id>",
"closure_reason": "<if the tranche is closed, and a reason is available it is returned here else null>"
}
}
Webhook Response
The same data is available in a webhook. This is the webhook payload before. Every response has a unique webhook ID along with the data in the GET API in payload.
{
"id": "57bab41e-71dc-483a-820b-958bb993c847",
"entity": "tranche_disbursal",
"event": "tranche_disbursal.status_update",
"created_at": "2022-03-10T00:04:15.962634+05:30",
"payload": {
"status": "Disbursed",
"amount": 12184.00,
"transaction_date ": "09-Mar-2022",
"transaction_id ": "CMS2443980931 ",
"lead_id ": "c2972fa4-a053",
"tranche_id ": "c5dcd2f8"
}
}
To trigger disbursal, call this API. Note that it can be called only once for a given lead id. Note that there is no payload required for this. No details can be updated after this API is called and the API can be called only once.
POST /api/v1/client/line/<lead_id>/tranche/<tranche_id>/disburse/
Sample response:
{
"is_success": true,
"data": {
"status": "<tranche disbursal status>",
"amount": "<tranche amount>",
"transaction_time": "<when the transaction was done>",
"transaction_id": "<transaction id>"
}
}
For Status Details in Disburse Tranche API please refer to Status Details Table.
Potential Policy Checks
According to the policy agreed, we might run several checks.
For example, if all the required documentation are uploaded.
{
"is_success": false,
"error": {
"message": "Policy Check Failed",
"code": "request_validation_error",
"details": {
"Loan Agreement": false,
"Sanction Letter": false
}
}
}
Sample response, if the Loan Agreement and Sanction Letter are not uploaded.
Note
These fields are generated after policy discussions and are configurable. The error format is consistent across all the APIs.