Skip to main content

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 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: 

Request Type: POST
Authorization: Bearer Token

Query Params:
Schema
Attribute Data Type Description Mandatory
service_request_type String Pass - receipt_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 Array Array containing service_request_id created while creating a receipt No
receipt_cancellation_date Date Value ate of receipt cancellation. 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 
{
  "service_request_type": "receipt_cancellation",
  "service_request_subtype": "2",
  "service_type": "",
  "loan_id": "5047871",
  "request_data": {
    "receipt_cancellation": [
      {
        "service_request_id": 86041
      }
    ],
    "receipt_cancellation_date": "2023-12-31",
    "reason": "",
    "uploadFile": ""
  },
  "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
Attribute Data Type Description
result String Result of the service request.
status String Current status of the service request.
service_request_id Integer Unique identifier for the service request.
unique_transaction_number String Unique transaction number, if applicable.
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
unique_transaction_number
 null
Yes

error

 Object
Error : Fail Response Attribute
code Please Refer Error Response Code and Messages
text
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!"
}

No Comments
Back to top