Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

List Loans Response

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)
ParameterTypeDescription
ack:wwwwwwwww
  {error, traceId, timestamp}
ObjectJSON object for acknowlegement
    Parameters for the ack object:
ParameterTypeDescription
errorStringErrors in the current request received. If no errors are found, error = 0.
traceIdStringIdentification for tracing
timestampTime-
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)
ParameterTypeDescription
metadata:wwtwwwww
   {param1, param2,...}
*Object
Strings
Metadata specific to each API response
  Parameters for the metadata object:     click to open)
FieldTypeDescription
versionStringOCEN Version
timestampTime-
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)
traceIdStringIdentification for tracing
orgIdStringOrigin ID
requestIdwwwwwtwww*StringUnique reference ID for the List Loans Request (UUID used to tie request and response and for idempotency)
response: {error}ObjectObject 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*StringUnique reference ID (UUID) of a loan which is contained in the list being requested (generated by lender)
terms:wwwwwwwtiw
    {...,{...},{...},[...],..}
ObjectDetailed terms of the loan
 Parameters for the terms object:    {click to open)
requestedAmount*StringAmount - 2 digits precision
descriptionStringDescription of the loan terms
currencyObjectISO string of the currency. Use INR for Indian Rupee. Among other accepted values are EUR, USD, GBP. Default value: INR
sanctionedAmountStringLoan Amount Approved by lender
interestTypeStringFlag indicating if the interest rate is fixed or floating
interestRateStringInterest Rate for the loan - 2 digits precision
interestAmountStringInterest Amount for the duration specified in tenure
totalAmountStringTotal amount for repayment
tenure:
   {duration, unit}
Object
Strings
Tenure details:
duration
String
  Duration of the loan amount.
unit
String
  Time units
  (DAY, MONTH, etc.)
legalAgreement:
    {type, date}
Object
Strings
Loan Agreement:
type
String
  Indicates whether the
  agreement is shared directly
  as text or needs to be
  fetched from a url.
data
String
  Base64 encoded 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*StringFormat of document data to be sent
referenceStringUnique 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.
sourceStringSource system from where data is coming. Source can be from AA ecosystem or from USER
sourceIdentifiernnStringIf source is in AA ecosystem, sourceIdentifier is the identifier in central registry. In case of User, it will be his unique identifier
typeStringExpandable enum. Includes fiTypes in AA ecosystem and any additional type of documents that can be added to the system later
isDataInlineBooleanIndicates whether the data is actually present in the document block. If Yes, data field contains base 64 encoded version of the data.
dataStringData 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
      {....,{...}}
*ObjectPrepayment details (use Charge Details object parameters below)
bounce:
      {....,{...}}
ObjectBounce details (use Charge Details object parameters below)
latePayment:
      {....,{...}}
ObjectDetails of the charges levied when the borrower makes a late payment (use Charge Details object parameters below)
processing:
      {....,{...}}
ObjectProcessing fees charged by the lender (use Charge Details object parameters below)
  Parameters for the chargeDetails object:     (click to open)
chargeType*StringThis field indicates whether the penalty is fixed or varies
descriptionStringDescription of charge calculation
dataObject
Details of charge:
rate
String
  interest rate
applicableParameter
String
  Parameter for which
  data applies
amount
String
  Loan amount based on
  applicableParameter.
urlStringFor any new data that needs to be passed as a link
extensibleDatanStringFor any new data that needs to be added
url*StringFor any new data that needs to be passed as a link.
extensibleDatawntwJSONFor any new data that needs to be added
* = Required
Language
Click Try It! to start a request and see the response here!