Loan Action : Payment Request
POST Payment Creation
This SynoFin API save all the essential payment information information using this Loan Action API using Loan Id.
URL: {{base_url}}/loan-modification/v1/service-request/save
Run in Postman: Save Payment Request Details
Request:
Request Body Attribute Description
This table includes the Attributes fetched using the Payment Request and offers a thorough view of the attribute, such as default Value, Mandatory, and Data Value, for the API's convenience.
JSON Decription
| Attribute | Description | Default Value | Mandatory |
| service_request_type | Action to be perform by Service Request | payment | Yes |
| service_request_subtype | Subtype or action type fetched from master | - | Yes |
| loan_id | Unique Identification Key | - | Yes |
| - paid_to | Beneficiary User id fetched by Master | - | Yes |
| - payment_mode | Mode of Payment (Cash, Cheque, etc) Fetched from Masters | - | Yes |
| - payment_account | Account number of from which transaction need to be initiated | - | Yes |
| - payment_date | Date of payment (yyyy-MM-dd) | - | No |
| - payment_amount | Amount need to be paid | 0 | No |
| - inFavourOf | Amount to be received in Favour of | - | No |
| - transaction_date | Date of Transaction (yyyy-MM-dd) | - | No |
| - payment_bank | Payment bank Id fetched from Maters | - | Yes |
| - fund_transfer_number | UTR no. | - | No |
| - bank_recon_ref_identifier | Bank Identifies | - | No |
| - instrument_date | Date of instrument (Cheque, Demand Draft) | - | No |
| - instrument_number | Instrument Number (Cheque, Demand Draft) | - | No |
| - beneficiary_account_type | Type of beneficiary Account (Cash Credit, Current Account) fetched from masters | - | Yes |
| - beneficiary_account_number | Beneficiary Account Number | - | Yes |
| - ifsc | Bank IFSC code | - | Yes |
| - uploadFile | Reference File for the payment | - | Yes |
| - - charge_id | Unique Id for Charge Need to added in Master | - | Yes |
| - - charge_label | Charge label Fetch by charge_id from Masters | - | No |
| - - total_outstanding_amount | Outstanding Amount | 0 | No |
| - - type | Type of charge amount | - | No |
| - - original_amount | Original Amount | 0 | No |
| - - disbursal_schedule_id | Unique Disbursal Schedule Id | - | Yes |
| - - outstanding_amount | Total Outstanding Amount | 0 | No |
| - - amount_in_process | Amount to be used in Process | 0 |
No |
| - - payment_status | Payment Status fetched from masters | - | No |
| - - paid_amount | Paid amount | 0 | No |
| - - total_paid_amount | Total Paid Amount | 0 | No |
| - - total_paid_amount_in_process | - | - | No |
| - - paid_amount_in_process | - | - | No |
| - - allocated_amount | Allocated Amount to the payables | 0 | Yes |
| - - reason | - | - | No |
| - - payment_date | Date of Payment (yyyy-MM-dd) | - | Yes |
| - - balance_payable | Remaining amount to be paid | - | No |
| - remarks | - | No | |
| service_request_id | Unique Id generated by System post Request is generated (For System Use) | No |
Schema
| service_request_type | String | ||
| service_request_subtype | integer | ||
|
service_type |
{ | ||
| loan_id | number($bigserial) | ||
| paid_to | integer | ||
| payment_mode | string | ||
| payment_account | string | ||
| payment_date | date() | ||
| payment_amount | number($double) | ||
| inFavourOf | string | ||
| transaction_date | Date (yyyy-MM-dd) | ||
| payment_bank | integer($int64) | ||
| fund_transfer_number | string | ||
| bank_recon_ref_identifier | string | ||
| dealer_code | string | ||
| instrument_date | Date (yyyy-MM-dd) | ||
| instrument_number | integer($int64) | ||
| beneficiary_account_type | string | ||
| beneficiary_account_number | string | ||
| payment_account_code | string | ||
| ifsc | string | ||
| uploadFile | |||
| payables | [{ | ||
| charge_id | number($bigserial) | ||
| charge_label | string | ||
| total_outstanding_amount | number($double) | ||
| type | string | ||
| original_amount | number($double) | ||
| disbursal_schedule_id | number($bigserial) | ||
| outstanding_amount | number($double) | ||
| amount_in_process | number($double) | ||
| payment_status | string | ||
| paid_amount | number($double) | ||
| total_paid_amount | number($double) | ||
| total_paid_amount_in_process | number($double) | ||
| paid_amount_in_process | number($double) | ||
| allocated_amount | number($double) | ||
| reason | string | ||
| payment_date | Date (yyyy-MM-dd) | ||
| balance_payable | number($double) | ||
| }] | |||
| remarks | |||
| } | |||
| service_request_id | |||
Body
{
"service_request_type": "payment",
"service_request_subtype": "2",
"service_type": "",
"loan_id": 0,
"request_data": {
"paid_to": 0,
"payment_mode": "string",
"payment_account": "string",
"payment_date": "2024-09-14",
"payment_amount": 0,
"inFavourOf": "string",
"transaction_date": "2024-09-14",
"payment_bank": "1",
"fund_transfer_number": "string",
"bank_recon_ref_identifier": "string",
"dealer_code": "string",
"instrument_date": "2024-09-14",
"instrument_number": "number",
"beneficiary_account_type": "string",
"beneficiary_account_number": "number",
"payment_account_code": "string",
"ifsc": "string",
"uploadFile": "",
"payables": [
{
"charge_id": 0,
"charge_label": "string",
"total_outstanding_amount": 0,
"type": "string",
"original_amount": 0,
"charge_definition_id": "number",
"excess_money_id": "number",
"disbursal_schedule_id": 0,
"charge_code": "number",
"outstanding_amount": 0,
"amount_in_process": 0,
"payment_status": "string",
"paid_amount": "number",
"total_paid_amount": "number",
"total_paid_amount_in_process": "number",
"paid_amount_in_process": "number",
"allocated_amount": "number",
"reason": null,
"payment_date": "2024-09-06",
"balance_payable": 0
}
],
"remarks": ""
},
"service_request_id": ""
}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 |
| result | integer | No | ||
| status | String | Status of service request | Yes | |
| service_request_id | integer | Reason / Detail for the cause of error | No | |
| unique_transaction_number | String | Unique Transaction Number | No | |
| error |
String | Internal error object for the given inputs | Yes | |
Body
{
"response": true,
"data": {
"result": null,
"status": "initiated",
"service_request_id": 0,
"unique_transaction_number": null
},
"error": null
}Success: 200 OK (Internal Error)
Body
Expected messages as per Status API :
| S. No | Description | Error Message |
| 1 | If JSON Object doesn't have "payment_amount" | Invalid Request |
| 2 | If JSON Object doesn't have "payment_mode" | Payment Bank cannot be Empty |
| 3 | If payment date After Business date | Payment Date can be on or before Business date |
| 4 | If payment date is before Disbursal Date | Payment Date cannot be less than Disbursal Date. |
| 5 | If allocated amount is greater than outstanding amount |
Allocated amount greater than outstanding amount |
| 6 | If total amount is not equal to total outstanding amount |
Total amount is not equal to total allocated amount |
{
"response": false,
"data": null,
"error": {
"text": "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!"
}