loan Action : Make E Payment
POST Make E - Payment
This is a SynoFin endpoint designed to facilitate the creation of electronic payments. This endpoint allows users or applications to initiate electronic payment transactions with ease. Users can send payment details and instructions to this endpoint, which will then process the request and execute the payment according to the provided parameters. This feature streamlines the payment process, enabling secure and efficient electronic fund transfers, making it a valuable tool for businesses, organizations, and individuals looking to automate and simplify their payment workflows.
Prerequisites before initiating E-payment -
1) Disbursal Breakup Id ( Loan Action : Create Disbursal Breakup | SynoFin Docs )
2) Payment Bank Account Number -(Bank Account number of NBFC/Bank from which they want to do disbursal).
3)Unique Batch Id - Any User provided key to identify the batch uniquely.
4)Unique Refrence Identifier - Any User provided key to identify the disbursal breakup uniquely with respect to payment attempt.
To check the status of your E-Payment Request.
( Loan Action : Payment Status | SynoFin Docs )
URL: {{base_url}}/loan-modification/v1/make-epayment
Request:
Query Params:
Schema
Attribute | Data Type | Description | Mandatory | |
payment_bank_account | Number | Payment bank account number | Yes | |
payment_mode | String | Mode of payment (Like IMPS, RTGS, etc.) | Yes | |
unique_batch_id | Number | Unique Identification for particular batch | Yes | |
breakup_details { | Array Of Objects | This Can contain multiple objects | Yes | |
disbursal_breakup_id | Integer | Unique disbursal breakup id for which e-payment needs to be added. | Yes | |
unique_reference_identifier | Integer | Unique Identifier for each of the disbursal breakup. | Yes | |
} |
Body
{
"payment_bank_account": "number",
"payment_mode": "String",
"unique_batch_id": "number",
"breakup_details": [
{
"disbursal_breakup_id": 0,
"unique_reference_identifier": 0
},
{
"disbursal_breakup_id": 1,
"unique_reference_identifier": 1
}
]
}
Response:
Success: 200 OK
Schema
Attribute |
Type | Description |
Mandatory | |||
response |
Boolean | true | Yes | |||
data |
Object | Success Response Object |
Yes | |||
String | unique_request_id | Yes | ||||
String | response_code | Yes | ||||
String | response_message | Yes | ||||
error |
String | Internal error object for the given inputs |
Yes |
Body
{
"response": true,
"data": {
"unique_batch_id": "0",
"response_code": "00",
"response_message": "Success"
},
"error": null
}
Success(Internal Error): 200 OK
Schema
Attribute |
Type | Description |
Mandatory | |||
response |
Boolean | false | Yes | |||
data |
Object | Success Response Object |
Yes | |||
error |
Object | Internal error object for the given inputs |
Yes | |||
String | unique_request_id | Yes | ||||
String | code | Yes | ||||
String | text | Yes |
Body
{
"response": false,
"data":null,
"error": {
"unique_request_id":0,
"code": 0,
"text": "Inavlid System id or This service id not integrated for this client"
}
}
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