Loan Action : Payment
POST Payment Creation
API to post a payment entry in the system.
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 | Key | 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 | - | Yes | |||||||||||||||||
| payment_mode | Mode of Payment | payment_mode_key
|
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 | Id of the disbursal breakup (fetched in response of loan creation) | - | 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": "5047876",
"request_data": {
"paid_to": "disbursement_account",
"payment_mode": "neft",
"payment_account": "",
"payment_date": "2023-12-31",
"payment_amount": "551957",
"inFavourOf": "Manju Devi",
"payment_bank": "12301",
"fund_transfer_number": "123456",
"bank_recon_ref_identifier": "",
"dealer_code": "",
"instrument_date": "2023-12-31",
"instrument_number": "",
"beneficiary_account_type": "",
"beneficiary_account_number": "923010011142070",
"payment_account_code": "",
"ifsc": "UTIB0001685",
"uploadFile": "",
"payables": [
{
"type": "disbursal_amount",
"charge_id": 5105383,
"outstanding_amount": 551957,
"allocated_amount": "551957"
}
],
"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!"
}Request Approval / Rejection
The request must now be approved at the Request page, where users may examine requests and take action.
Click on the link below for knowing more about how request work's
No Comments