Loan Action : Receipt Cancellation
POST Receipt Cancellation
This API facilitates the cancellation of a receipt for a loan transaction within the SynoFin platform. Users can submit a request for receipt cancellation, providing details such as the cancellation date, number of instruments, 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 Schemefetched andfrom ChargeSynoFin codemaster are neededprioritized tofor beinclusion addedin andSynoFin configured using admin panelmasters.
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 | Yes | |
service_request_subtype | String | Yes | |
service_type | String | No | |
loan_id | String | Unique identifier for the loan. | Yes |
request_data | Object | Yes | |
receipt_cancellation | Array | Array containing |
No |
receipt_cancellation_date | Date | ||
Yes | |||
reason | String | Reason for cancellation. (Fetched for masters) | Yes |
uploadFile | String | File upload, if applicable. | No |
service_request_id | String | Yes |
Body
{
"service_request_type": "receipt_cancellation",
"service_request_subtype": "2",
"service_type": "junk"",
"loan_id": "1234567"5047871",
"request_data": {
"receipt_cancellation": [
{
"service_request_id": 86041
}
],
"receipt_cancellation_date": "2026-02-03"2023-12-31",
"number_of_instuments": 1,
"reason": "1394"",
"total_amount": 100000,
"uploadFile": "",
"transaction_date": "2026-02-03"
},
"service_request_id": ""
}
Response:
Success: 200 OK
Schema
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 | Code | Message | Description |
1. | 101756 | Cannot cancel receipt. Charges is already allocated | Appears When receipt charges are already allocated for the respective receipt. |
2. |
1015000
|
Receipt Cancellation Date should be Business Date | Appears when receipt cancellation ('receipt_cancellation_date') is not initiated in the current business date. |
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": "Receipt Cancellation Date should be Business Date"
}
}
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!"
}