post https://api.juspay.in/v3/loan/getLoanResponse
This method is called by the Lender and it returns all the details of the loan.
Response Parameters for the Get Loan Response API:w w w w w w (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 objects for Borrower, Lender, Terms, Disbursement and Repayment, with corresponding arrays for Collaterals, Guarantors and Applicants. (click to open tables)
Parameter | Type | Description | |
---|---|---|---|
metadata:wwwwwwtw {param1, param2,...} | n | 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) where; YYYY = four-digit year MM = two-digit month (01=January, etc.) DD = two-digit day of month (01 through 31) hh = two digits of hour (00 through 23) (am/pm NOT allowed) mm = two digits of minute (00 through 59) ss = two digits of second (00 through 59) 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 |
requestId | n | String | Unique reference ID for the Get Loan Request (UUID used to tie request and response and for idempotency) |
response: {error} | Object | Status of response. Object contains only one string parameter for "error". If no errors are found, error = "0". For example, if a mandatory attribute is missing, error code should capture that. | |
loanId | String | Unique reference ID (UUID) of loan whose details are being requested (generated by lender, and used to tie request and response and for idempotency) | |
loanStatus | String | If loan is being processed:loanStatus = "GENERATED"After loan is processed: loanStatus = GRANTED / REJECTED / DEFAULTED / COMPLETED / ACTION_REQUIRED | |
createdDate | String | Date/time (ISO representation) when loan was created | |
startDate | String | Date/time (ISO representation) from when loan is active | |
endDate" | String | Date/time (ISO representation) till when loan is active | |
type | String | Type of loan Example: "CASHFLOW" | |
borrower:wwwwwnww {...,[...],[...],..} | Object | Borrower details shared by LSP during Create Loan Application process |
Parameters for the borrower
object:
(click to open)
primaryId | n | String | Primary ID for borrower |
primaryIdType | String | Type of Primary ID | |
additionalIdentifiers: [{...},{...},..] | Array of Objects | Additional IdentifiersObjects in array:key String the entity. value String context of the entity. url String to be passed as a link. extensibleData JSON to be added. | |
name | String | Name of borrower | |
category | String | Category that loan is used for Example: "ORGANIZATION" | |
contactDetails: [{...},{...},..] | Array of Objects | List of contacts (with details) for the borrower |
Parameters for each object in the contactDetails
array:
{click to open)
type | n | String | Type of contact Example: "PRIMARY" |
description | String | Description of the contact detail | |
phone | String | Phone number of contact instance | |
String | Email of contact instance | ||
address:wwwwniww {prm1, prm2,...} | Object Strings | Address details for contact instance |
Parameters for the address
object: {click to open)
Field | Type | Description | |
---|---|---|---|
co | String | Care of | |
hba | String | House/Building/Apartment number | |
srl | String | Street/Road/Lane | |
landmark | String | Notable landmark at address location | |
als | String | Area/Locality/Sector | |
vtc | String | Village/Town/City | |
pincode | String | 4-digit code to unlock | |
po | String | Post Office box number | |
district | String | Disdtrict of address location | |
state | String | State of address location | |
country | String | Country of address location | |
uri | String | Digital address | |
latitude | String | Latitude of address location | |
longitude | String | Longitude of address location |
url | n | String | For any new data that needs to be passed as a link |
extensibleDatawiww | JSON | For any new data that needs to be added. |
documents:wwwntww [{...},{....}...] | n | Array of Objects | Additional documents (if any) related to the borrower. |
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 | |
sourceIdentifier | 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) |
url | n | String | For any new data that needs to be passed as a link |
extensibleDatawwtww | JSON | For any new data that needs to be added. |
lender:wwwwiiwwww {..,[...],[...],..} | n | Object | Details of lenderww w w w w w w |
Parameters for the lender
object:
{click to open)
primaryIdTypewwtww | n | String | Identifier Type for the Lender |
primaryId | String | Lender unique identifier for the identifier type above | |
category | String | Category of the Lender | |
name | String | Name of the Lender | |
contactDetails: [{...},{...},..] | Array of Objects | Contact Details for the Lender. If no data is there to be sent, an empty array block can be passed. |
Parameters for each object in the contactDetails
array:
{click to open)
type | n | String | Type of contact Example: "PRIMARY" |
description | String | Description of the contact detail | |
phone | String | Phone number of contact instance | |
String | Email of contact instance | ||
address:wwwwttww {prm1, prm2,...} | Object Strings | Address details for contact instance |
Parameters for the address
object: {click to open)
Field | Type | Description | |
---|---|---|---|
co | String | Care of | |
hba | String | House/Building/Apartment number | |
srl | String | Street/Road/Lane | |
landmark | String | Notable landmark at address location | |
als | String | Area/Locality/Sector | |
vtc | String | Village/Town/City | |
pincode | String | 4-digit code to unlock | |
po | String | Post Office box number | |
district | String | District of address location | |
state | String | State of address location | |
country | String | Country of address location | |
uri | String | Digital address | |
latitude | String | Latitude of address location | |
longitude | String | Longitude of address location |
url | n | String | For any new data that needs to be passed as a link |
extensibleDatawwtw | JSON | For any new data that needs to be added. |
additionalIdentifiers: [{...},{...},..] | Array of Objects | Additional IdentifiersObjects in array:key String the entity. value String context of the entity. url String to be passed as a link. extensibleData JSON to be added. | |
documents: [{...},{...},..] | n | Array of Objects | Additional documents related to the Lender. 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 | |
sourceIdentifier | 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) |
url | n | String | For any new data that needs to be passed as a link. |
extensibleDatawiwww | JSON | For any new data that needs to be added |
collaterals:wwwwwtww [{...}, {...}, ...] | n | Array of Objects | Details of the collaterals used for the loan. Shared by LSP during the Create Loan Application process |
Parameters for each object in the collaterals
array:
{click to open)
collateralPrimaryId | n | String | Primary Identifier for the collateral. Generated as collateralPrimaryIdType_collaetralPrimaryId |
collateralPrimaryIdType | String | Expandable ENUM. Type of collateral source. Will be Invoice in case of invoice based lending, vehicle identification number (VIN) for vehicle as collateral | |
description | String | Description of the collateral | |
type | String | Type of collateral Example:"GST_INVOICE" | |
additionalIdentifiers: [{...},{...},..] | Array of Objects | Additional IdentifiersObjects in array:key String the entity. value String context of the entity. url String to be passed as a link. extensibleData JSON to be added. | |
valuation: {prm1, prm2,...} | Object | Evaluation parameters:value String currency String date String source String | |
parties: [{...},{...},..] | Array of Objects | Parties involved for collateral instance |
Parameters for each object in the parties
array:
{click to open)
primaryIdType | String | Identifier Type for the Party | |
primaryId | String | Party unique identifier for the identifier type above | |
description | String | Description of the Party | |
category | String | Category of the Party | |
name | String | Name of the Party | |
relationshipWithBorrower | String | Association with collateral. In case of invoice, the 2 parties involved would be the buyer and seller | |
contactDetails: [{...},{...},..] | Array of Objects | List of contacts (with details) for the party instance. If no data is there to be sent, an empty array block can be passed. |
Parameters for each object in the contactDetails
array:
{click to open)
type | String | Type of contact Example: "PRIMARY" | |
description | String | Description of the contact detail | |
phone | String | Phone number of contact instance | |
String | Email of contact instance | ||
address:wwwwwwwww {param1, param2,...} | Object Strings | Address details for contact instance |
Parameters for the address
object: {click to open)
Field | Type | Description | |
---|---|---|---|
co | String | Care of | |
hba | String | House/Building/Apartment number | |
srl | String | Street/Road/Lane | |
landmark | String | Notable landmark at address location | |
als | String | Area/Locality/Sector | |
vtc | String | Village/Town/City | |
pincode | String | 4-digit code to unlock | |
po | String | Post Office box number | |
district | String | Disdtrict of address location | |
state | String | State of address location | |
country | String | Country of address location | |
uri | String | Digital address | |
latitude | String | Latitude of address location | |
longitude | String | Longitude of address location |
url | String | For any new data that needs to be passed as a link | |
extensibleDatawwwiww | JSON | For any new data that needs to be added. |
additionalIdentifiers:wtw [{...},{...},..] | Array of Objects | Additional IdentifiersObjects in array:key String the entity. value String context of the entity. url String to be passed as a link. extensibleData JSON to be added. | |
documents: [{...},{...},..] | Array of Objects | Additional documents related to the Party. 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 | |
sourceIdentifier | 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) |
url | String | For any new data that needs to be passed as a link. | |
extensibleDatawwwwnww | JSON | For any new data that needs to be added |
documents:wwwtiwww [{...},{...},..] | n | Array of Objects | List of documents (with details) for collateral instance |
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 | |
sourceIdentifier | 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) |
guarantors:wwwwwww [{...}, {...}, ...] | n | Array of Objects | List of guarantors (with details) for loan |
Parameters for each object in the guarantors
array:
{click to open)
primaryIdType | n | String | Identifier Type for the Guarantor |
primaryId | String | Guarantor unique identifier for the identifier type above | |
description | String | Description of the Guarantor and his involvement in the loan | |
category | String | Category of the Guarantor | |
name | String | Name of the Guarantor | |
relationshipWithBorrower | String | Relationship of the Guarantor with Borrower | |
contactDetails: [{...},{...},..] | Array of Objects | ContactDetails for the Guarantor. If no data is there to be sent, an empty array block can be passed. |
Parameters for each object in the contactDetails
array:
{click to open)
type | n | String | Type of contact Example: "PRIMARY" |
description | String | Description of the contact detail | |
phone | String | Phone number of contact instance | |
String | Email of contact instance | ||
address:wwwwwwniww {param1, param2,...} | Object Strings | Address details for contact instance |
Parameters for the address
object: {click to open)
Field | Type | Description | |
---|---|---|---|
co | String | Care of | |
hba | String | House/Building/Apartment number | |
srl | String | Street/Road/Lane | |
landmark | String | Notable landmark at address location | |
als | String | Area/Locality/Sector | |
vtc | String | Village/Town/City | |
pincode | String | 4-digit code to unlock | |
po | String | Post Office box number | |
district | String | Disdtrict of address location | |
state | String | State of address location | |
country | String | Country of address location | |
uri | String | Digital address | |
latitude | String | Latitude of address location | |
longitude | String | Longitude of address location |
url | n | String | For any new data that needs to be passed as a link |
extensibleDatawwwiww | JSON | For any new data that needs to be added. |
additionalIdentifiers:ww [{...},{...},..] | n | Array of Objects | Additional IdentifiersObjects in array:key String the entity. value String context of the entity. url String to be passed as a link. extensibleData JSON to be added. |
documents: [{...},{...},..] | Array of Objects | Additional documents related to the Guarantor. 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 | |
sourceIdentifier | 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) |
url | n | String | For any new data that needs to be passed as a link. |
extensibleDatawwiwwww | JSON | For any new data that needs to be added |
applicants:wwnwwwww [{...}, {...}, ...] | n | Array of Objects | List of applicants (with details) for loan |
Parameters for each object in the applicants
array:
{click to open)
primaryIdType | String | Identifier Type for the Applicant | |
primaryId | String | Applicant unique identifier for the identifier type above | |
category | String | Category of the Applicant | |
name | String | Name of the Applicant | |
relationshipWithBorrower | String | Relationship of the applicant with Borrower | |
contactDetails: [{...},{...},..] | Array of Objects | ContactDetails for the Applicant If no data is there to be sent, an empty array block can be passed. |
Parameters for each object in the contactDetails
array:
{click to open)
type | String | Type of contact Example: "PRIMARY" | |
description | String | Description of the contact detail | |
phone | String | Phone number of contact instance | |
String | Email of contact instance | ||
address:wwwwwwnww {param1, param2,...} | Object Strings | Address details for contact instance |
Parameters for the address
object: {click to open)
Field | Type | Description | |
---|---|---|---|
co | String | Care of | |
hba | String | House/Building/Apartment number | |
srl | String | Street/Road/Lane | |
landmark | String | Notable landmark at address location | |
als | String | Area/Locality/Sector | |
vtc | String | Village/Town/City | |
pincode | String | 4-digit code to unlock | |
po | String | Post Office box number | |
district | String | Disdtrict of address location | |
state | String | State of address location | |
country | String | Country of address location | |
uri | String | Digital address | |
latitude | String | Latitude of address location | |
longitude | String | Longitude of address location |
url | String | For any new data that needs to be passed as a link | |
extensibleDatawwwww | JSON | For any new data that needs to be added. |
additionalIdentifiers:ww [{...},{...},..] | Array of Objects | Additional IdentifiersObjects in array:key String the entity. value String context of the entity. url String to be passed as a link. extensibleData JSON to be added. | |
documents: [{...},{...},..] | Array of Objects | Additional documents related to the Applicant. 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 | |
sourceIdentifier | 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) |
url | String | For any new data that needs to be passed as a link. | |
extensibleDatawwwtwww | JSON | For any new data that needs to be added |
terms:wwwwwwwwww {param1, param2} | n | Object | Details of the terms of loanw w w w ww w w w |
Parameters for the terms
object:
{click to open)
requestedAmount | n | String | Amount - 2 digits precision |
description | String | Description of the loan terms | |
currency: {type} | Object | Type of currency . Object contains only one ISO string parameter for "type". 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:wwwwwnnww {duration, unit} | Object Strings | Tenure details:duration String unit String | |
legalAgreement: {type, date} | Object Strings | Loan Agreement:type String agreement is shared directly as text or needs to be fetched from a url. date String | |
documents:wwww [{...},{...},..] | 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 | |
sourceIdentifier | 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:wwwwwwnw {(...},{...},...} | n | Object | Penalties levied for issues with repayments |
Parameters for the charges
object: (click to open)
prepayment:wwnn {....,{...}} | n | Object | Prepayment (use Charge Details object parameters below) |
bounce: {....,{...}} | Object | Bounce (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 | n | 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 | |
extensibleDatann | String | For any new data that needs to be added |
url | n | String | For any new data that needs to be passed as a link. |
extensibleDatawwnw | JSON | For any new data that needs to be added |
disbursement:wwwniw { {...,{...},..} } | n | Object | Details about disbursement provided by lender. |
Parameters for the disbursement
object:
{click to open)
plans:wwwwwwniww {...,{...},..} | n | Object | Disbursement plan selected for the loan |
Parameters for the plans
object:
(click to open)
id | String | Unique id for the disbursement plan in the lender system | |
title | String | Title of the disbursement plan | |
shortDescription | String | Short description for the disbursement plan | |
description | String | Detailed description of the disbursement plan | |
url | String | URL of the payment page provided by the lender to show disbursement plans | |
automatic | Boolean | Flag indicating whether disbursement is automatic or user initiated | |
payNowAllowed | Boolean | Flag indicates if the lender can make an immediate payment with this disbursement plan | |
editPlanAllowed | Boolean | This flag indicates if the configurations of the current disbursement plan can be changed by the borrower | |
changeMethodAllowed | Boolean | This field indicates if the borrower can choose a different disbursement method for the plan | |
scheduleType | String | Type of schedule - can be ONE_TIME, AS_PRESENTED or RECURRING | |
frequency | String | In case of a recurring payment, this field indicates how often the payment is disbursed | |
noOfInstallments | String | Number of installments for the chosen disbursement plan. Will be 1 for ONE_TIME schedule type | |
tenure:wwwwwinww {duration, unit} | Object Strings | Tenure associated with the disbursement plan. This value will be less than or equal to the tenure in loan terms.Tenure details:duration String unit String (DAY, MONTH, etc.) | |
principal | String | Principal - up to 2 digits precision | |
interestAmount | String | Interest component for the duration specified in plan - up to 2 digits precision | |
penalty | String | Penalty component for the duration specified in loan - up to 2 digits precision | |
startDate | String | The first date on which the borrower chooses to make payment/wishes to get the disbursement credited. | |
status | String | Flag indicating if the plan is ACTIVE or INACTIVE | |
totalAmount | String | Total amount of loan |
accountDetails:wwnn {...,{...},..} | n | Object | Details on account where the amounts will be disbursed by the lender. |
Parameters for the accountDetails
object:
(click to open)
id | n | String | Unique id. Mandatory if object is coming from lender |
description | String | Description of the account | |
status | String | This field captures the status of whether the account has been linked to a loan or not | |
accountDataTypei | String | This suggests what kind of data is expected for account details in the data object | |
url | String | For any new data that needs to be passed as a link. | |
extensibleDatawwnt | JSON | For any new data that needs to be added | |
data: {...,{...},{...}} | Object | This object captures details of the account as suggested by the accountDataType parameter (Parameters are variable). |
repayment:wwwwwniw { {..,{...},..}} | n | Object | Details about repayment plan and method provided by lender. |
Parameters for the repayment
object:
{click to open)
plan:wwwwwwnniiww {...,{...},..} | n | Object | Details on the repayment plan selected for the loan |
Parameters for the plan
object:
(click to open)
id | String | Unique id for the repayment plan in the lender system | |
title | String | Title of the repayment plan | |
shortDescription | String | Short description for the repayment plan | |
description | String | Detailed description of the payment plan | |
paymentUrl | String | URL of the payment page provided by the lender to show repayment details | |
automatic | Boolean | Flag indicating whether payment is automatic or user initiated | |
payNowAllowed | Boolean | Flag indicates if the borrower can make an immediate payment with this repayment plan | |
editPlanAllowed | Boolean | This flag indicates if the configurations of the current repayment plan can be changed by the borrower | |
changeMethodAllowed | Boolean | This field indicates if the borrower can choose a different payment method for the plan | |
scheduleType | String | Type of schedule - can be ONE_TIME, AS_PRESENTED or RECURRING | |
frequency | String | In case of a recurring payment, this field indicates how often the payment is disbursed | |
noOfInstallments | String | Number of installments for the chosen repayment plan. Will be 1 for ONE_TIME schedule type | |
tenure:wwwwwinww {duration, unit} | Object Strings | Tenure associated with the repayment plan. This value will be less than or equal to the tenure in loan terms.Tenure details:duration String unit String (DAY, MONTH, etc.) | |
principal | String | Principal - up tp to 2 digits precision | |
interestAmount | String | Interest component for the duration specified in plan - up to 2 digits precision | |
penalty | String | Penalty component for the duration specified in loan - up to 2 digits precision | |
startDate | String | The first date on which the borrower chooses to make payment/wishes to get the disbursement credited. | |
status | String | Flag indicating if the plan is active or inactive | |
totalAmount | String | Total amount of loan |
method:wwwwwwinn {...,{...},..} | n | Object | Details on the method of repayment. |
Parameters for the method
object:
(click to open)
typewwwwwwwwwn | n | String | Type of method - Example: "EMANDATE_UPI" |
status | String | This field captures the current status of the repayment method being used. Example: "ACTIVE" | |
data: {...,{...},{...}} | Object | This object captures details of the repayment method |
Parameters for the data
object: (click to open)
refNumber | n | String | Reference number for the repayment instance |
amount | String | Amount agreed upon for a repayment instance | |
amountType | String | Type of amount - Example: "MAX" | |
activeFrom | String | Date/time (ISO representation) when repayment period starts | |
expiryDate | String | Date/time (ISO representation) when repayment period expires | |
destinationAccount: {...,{...}} | Object | Details for destination acccount |
Parameters for the destinationAccount
object:
(click to open)
accountDataType | n | String | Type of data used for destination account |
data:wwwwwwwnw {prm1, prm2} | Object Strings | Additional data on dest. acct.:accountType String Example: "CURRENT" maskedAccountNumber String |
sourceAccount:nwn {...,{...}} | n | Object | Details for source account |
Parameters for the sourceAccount
object:
(click to open)
accountDataType | n | String | Type of data used for source account |
data:wwwwwwwww {prm1, prm2} | Object Strings | Additional data on source acct.:accountType String Example: "CURRENT" maskedAccountNumber String |
* = Required