Loan Action: Drawdown Cancellation
POST Drawdown Cancellation
This API facilitates the cancellation of drawdown for a loan transaction within the SynoFin platform. Users can submit a request for drawdown cancellation, providing details such as the cancellation date, invoice date, reason for cancellation, total amount, and transaction date. After successful creation, the request undergoes validation by a checker, who takes appropriate action (Service Request Actions | SynoFin Docs) to either approve or reject it.
Attribute Priority: Attributes fetched from SynoFin master are prioritized for inclusion in SynoFin masters.
URL: {{base_url}}/loan-modification/v1/service-request/save
Run in Postman: Receipt Cancellation Request
Request:
Query Params:
Schema
| Attribute | Data Type | Description | Mandatory |
|---|---|---|---|
| service_request_type | String | Pass - payment_request_cancellation | Yes |
| service_request_subtype | String | Pass - 2 | Yes |
| service_type | String | Pass is as "" | No |
| loan_id | String | Unique identifier for the loan. | Yes |
| request_data | Object | Data Object | Yes |
| receipt_cancellation_date | Date | Value date of drawdown cancellation. | Yes |
| payment_request_cancellation | Array | Array containing service_request_id created while creating a drawdown | No |
| amount | Double | Drawdown amount | Yes |
| service_request_id | Integer | service request id of drawdown | Yes |
| transaction_id | Integer | transaction id of drawdown transcation | Yes |
| repay_due_date | String | Pass is as "" | No |
| reference_number | String | Pass is as "" | No |
| invoice_date | Date | Date of invoice | Yes |
| payment_id | String | Pass is as null | No |
| paid_amount | Double | Pass is as null | No |
| payment_mode | String | Pass is as null | No |
| payment_date | Date | Pass is as null | No |
| number_of_instruments | String | Number of installment of repayment | No |
| transaction_date | Date | Business Date | Yes |
| reason | String | Reason for cancellation. (Fetched for masters) | Yes |
| uploadFile | String | File upload, if applicable. | No |
| service_request_id | String | Pass is as "" | Yes |
Body
Response:
Success: 200 OK
| Attribute |
Type | Description |
Mandatory | ||||||||||||||||||
| response |
Boolean | true | Yes | ||||||||||||||||||
| data |
Object | Success Response Object |
Yes | ||||||||||||||||||
Success Response Attribute
|
Yes | ||||||||||||||||||||
|
error
|
Object | Error Response Object (null) | Yes | ||||||||||||||||||
Body
{
"response": true,
"data": {
"result": null,
"status": "initiated",
"service_request_id": 1353,
"unique_transaction_number": null
},
"error": null
}
Internal Server Error: 200
Schema
Error Response Code and Messages
| S. No | Message | Description |
| 1. | Drawdown request not found. | Appears when drawdown request which is passed in request is not found |
| 2. | Disbursal schedule not found | Appears when disbursal schedule is not found for service request |
| Attribute |
Type | Description |
Mandatory | ||||||
| response |
Boolean | true | Yes | ||||||
| data |
Object | Fail Response Object |
Yes | ||||||
|
|
Data : Fail Response Attribute
|
Yes | |||||||
|
error |
Object | Error : Fail Response Attribute
|
Yes | ||||||
Body
{
"response": false,
"data": {
"unique_transaction_number": null
},
"error": {
"code": 1015000,
"text": "Drawdown request not found."
}
}
Unauthorized: 401
Note: If the API is not authorized with the Token or if the authorization token has expired, this error is going to show up.
Body
{
"code": 401,
"message": "auth fail, you can retry!"
}