post https://api.juspay.in/v3/loan/loanStatementResponse
This method is called by the Lender to return the loan account statement back to the LSP
Response Parameters for the Loan Statement Response API: (click to view)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwwwww {error, traceId, timestamp} | Object | JSON object for acknowlegement |
Parameters for the
ack object: | Parameter | Type | Description |
|---|---|---|
| error | String | Errors in the current request received. If no errors are found, error = 0. |
| traceId | String | Identification for tracing |
| timestamp | Time- stamp | YYYY-MM-DDThh:mm:ssZ+/-hh:mm (eg 1997-07-16T19:20:30+05:30) Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30) |
The request for this API includes an array for accountStatement, where each object in the array contains details of a transaction within a specified time period (if any). (click to open tables)
| Parameter | Type | Description | |
|---|---|---|---|
| metadata:wwtwwww {param1, param2,...} | * | Object Strings | Metadata specific to each API response |
Parameters for the metadata object: click to open)
| Field | Type | Description | |
|---|---|---|---|
| version | String | OCEN Version | |
| timestamp | Time- stamp | YYYY-MM-DDThh:mm:ssZ+/-hh:mm (eg 1997-07-16T19:20:30+05:30) Z +/- hh:mm = time zone designator (Z) followed by time zone difference from GMT in hours and minutes. THIS IS OPTIONAL. If not provided, it is assumed to be IST (+5.30) | |
| traceId | String | Identification for tracing | |
| orgId | String | Origin ID |
| response: {error} | Object | Object contains one parameter, "error:", which indicates if any errors were found in the current request received. If none are found, error = 0. | |
| requestIdwwwwtwww | * | String | Unique reference ID for the Loan Statement Request (UUID used to tie request and response and for idempotency) |
| loanId | * | String | Unique reference ID (UUID) of the loan for which a statement is being requested (generated by lender) |
| accountStatement: [{...},{...},...] | * | Array of objects | Details of each transaction carried out on the Loan Account within the specified time period. If no time period is specified, the entire account statement is returned |
Parameters for each object in the accountStatement array:
(click to open)
| date | t | String | Date when the transaction was carried out Format: "dd-mm-yyyy" |
| narration | String | Narration as it appears in the bank statement | |
| txnRefNo | String | Reference number for the transaction | |
| amount | String | Transaction Amount - up to 2 digits precision | |
| type | String | DEPOSIT for repayment transactions and WITHDRAWAL for disbursement transactions | |
| closingBalancewww | String | Closing balance in the account after the transaction | |
| url | String | For any new data that needs to be passed as a link | |
| extensibleData | JSON | For any new data that needs to be added |
* = Required