post https://api.juspay.in/v3/loan/listLoansResponse
This method is called by the Lender to return a list of all loans provisioned for a borrower (within an optional time period).
Response Parameters for the List Loans Response API:
(click to view)
(click to view)
| Parameter | Type | Description |
|---|---|---|
| ack:wwwwwwwww {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 of objects for loans, which lists the requested loans. Each object in array includes a loan ID along with a terms object for the loan. (click to open tables)
| Parameter | Type | Description | |
|---|---|---|---|
| metadata:wwtwwwww {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 |
| requestIdwwwwwtwww | * | String | Unique reference ID for the List Loans Request (UUID used to tie request and response and for idempotency) |
| 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. | |
| loans: [[...],[...],..] | * | Array of Objects | Details of all loans granted for the borrower (within an optional time period) |
Parameters for each object in the loans array:
(click to open)
| loanId | * | String | Unique reference ID (UUID) of a loan which is contained in the list being requested (generated by lender) |
| terms:wwwwwwwtiw {...,{...},{...},[...],..} | Object | Detailed terms of the loan |
Parameters for the terms object: {click to open)
| requestedAmount | * | String | Amount - 2 digits precision |
| description | String | Description of the loan terms | |
| currency | Object | ISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. Default value: INR | |
| sanctionedAmount | String | Loan Amount Approved by lender | |
| interestType | String | Flag indicating if the interest rate is fixed or floating | |
| interestRate | String | Interest Rate for the loan - 2 digits precision | |
| interestAmount | String | Interest Amount for the duration specified in tenure | |
| totalAmount | String | Total amount for repayment | |
| tenure: {duration, unit} | Object Strings | Tenure details:duration String unit String (DAY, MONTH, etc.) | |
| legalAgreement: {type, date} | Object Strings | Loan Agreement:type String agreement is shared directly as text or needs to be fetched from a url. data String | |
| documents:wwnnw [{...},{...},..] | Array of Objects | Additional documents related to the terms. If no data is there to be sent, an empty array block can be passed. |
Parameters for each object in the documents array:
(click to open)
| format | * | String | Format of document data to be sent |
| reference | String | Unique identifier for a document which can be used by other objects for referencing a document. In case where isDataInline is false, reference number can be used to hit an external API to get the data. | |
| source | String | Source system from where data is coming. Source can be from AA ecosystem or from USER | |
| sourceIdentifiernn | String | If source is in AA ecosystem, sourceIdentifier is the identifier in central registry. In case of User, it will be his unique identifier | |
| type | String | Expandable enum. Includes fiTypes in AA ecosystem and any additional type of documents that can be added to the system later | |
| isDataInline | Boolean | Indicates whether the data is actually present in the document block. If Yes, data field contains base 64 encoded version of the data. | |
| data | String | Data to be sent for document instance (Base64 encoded string) |
| charges:wwwwnww {(...},{...},...} | * | Object Objects | Penalties levied for issues with repayments |
Parameters for the charges object: (click to open)
| prepayment:wnw {....,{...}} | * | Object | Prepayment details (use Charge Details object parameters below) |
| bounce: {....,{...}} | Object | Bounce details (use Charge Details object parameters below) | |
| latePayment: {....,{...}} | Object | Details of the charges levied when the borrower makes a late payment (use Charge Details object parameters below) | |
| processing: {....,{...}} | Object | Processing fees charged by the lender (use Charge Details object parameters below) |
Parameters for the chargeDetails object: (click to open)
| chargeType | * | String | This field indicates whether the penalty is fixed or varies |
| description | String | Description of charge calculation | |
| data | Object | Details of charge:rate String applicableParameter String data applies amount String applicableParameter. | |
| url | String | For any new data that needs to be passed as a link | |
| extensibleDatan | String | For any new data that needs to be added |
| url | * | String | For any new data that needs to be passed as a link. |
| extensibleDatawntw | JSON | For any new data that needs to be added |
* = Required