Skip to main content

Loan Viewer : Get Payments Data

GET Payments Data for Disbursal Breakup Id

Using the Loan Management API and the Disbursal Breakup ID, this SynoFin API pulls all the necessary payment information.

URL: {{base_url}/loan-management/v1/getPaymentsData

Run in Postman: GET Payment Details for Disbursal Id

Request: 

Request Type: GET
Authorization: Bearer Token
Query Parameter:
Key Data Type Description Validations Default Value Required
disbursal_breakup_id Integer Unique identity constraint  N/A - Yes


Response:

Success: 200 OK
Schema
Attribute

 Type Description


 Mandatory
response
 String Internal status code that denotes the status of request
 Yes
data Object Data Object Success Response Object
 Yes

Attribute
 Data Type -
utr String yes
payment_date

Date

(yyyy-MM-dd)

 yes
error
 String Internal error object for the given inputs
 Yes
Body 
{
  "response": true,
  "data": {
    "utr": "utr-test-1238",
    "payment_date": "2023-09-14"
  },
  "error": null
}


Bad Request: 400

Note: If the API is unable to retrieve data for specific fields against the relevant Disbursal Breakup Id, then this error will occur.

Schema
Attribute

 Type Description Mandatory
response
 String Internal status code that denotes the status of request Yes
data
 Object Response Object for the given inputs No
error Object Data Object Internal error object for the given inputs Yes

code integer Internal error code for API Yes
text String Error message for the API No
detail String Reason / Detail for the cause of error No
Body 
{
    "response": false,
    "data": null,
    "error": {
        "code": 0,
        "text": "string",
        "detail": "string"
    }
}

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