Skip to main content

Generate Offers Response

This API is invoked by the lender informing the borrower regarding the various loan offers that have been generated corresponding to each of the loan applications. This is a bulk API, where multiple loan offers can be sent to the borrower in one shot.

Request Body
metadata object REQUIRED

Metadata specific to each API request.

version string REQUIRED
originatorOrgId string

The organisation id on the Participant Registry.

originatorParticipantId string

The participant id on the Participant Registry. This will be different for every role under the same organisation.

timestamp string REQUIRED
traceId string REQUIRED
requestId string REQUIRED

UUID used to tie request and response and for idempotency

response object REQUIRED

Status of response. Whether success or has encountered error

status string REQUIRED

Possible values: [SUCCESS, ERROR]

responseDetail string
productData object REQUIRED

Product Metadata specific to each API request.

productId string REQUIRED

The product id on the Product Registry.

productNetworkId string

The product network id on the Product Registry.

loanApplications object[] REQUIRED
createdDate date

The time when the loan application was created

loanApplicationId string REQUIRED

UUID for the loan application. Generated by BA

loanApplicationStatus string REQUIRED

Possible values: [CREATED, PROCESSING, CONSENT_INITIATED, CONSENT_RECEIVED, CONSENT_REJECTED, OFFERED, OFFER_ACCEPTED, KYC_INITIATED, KYC_COMPLETED, KYC_FAILED, KYC_REJECTED, LOAN_AGREEMENT_INITIATED, LOAN_AGREEMENT_COMPLETED, LOAN_AGREEMENT_FAILED, REPAYMENT_SETUP_INITIATED, REPAYMENT_SETUP_COMPLETED, REPAYMENT_SETUP_FAILED, REPAYMENT_SETUP_REJECTED, SET_DISBURSEMENT_ACCOUNT_INITIATED, SET_DISBURSEMENT_ACCOUNT_COMPLETED, SET_DISBURSEMENT_ACCOUNT_FAILED, SET_DISBURSEMENT_ACCOUNT_REJECTED, GRANTED, REJECTED, ACTION_REQUIRED, DISBURSEMENT_INITIATED, DISBURSEMENT_COMPLETED, DISBURSED_FAILED, CLOSED, CANCELLED]

kyc object REQUIRED
kycRefNo string
description string
business object
type string

Possible values: [CKYC, UDYAM, OFFLINE_AADHAAR]

scale string

Possible values: [MICRO, SMALL, MEDIUM]

category string

Possible values: [SERVICE, MANUFACTURING]

name string
address object
hba string REQUIRED
srl string REQUIRED
landmark string
als string
vtc string
pinCode string REQUIRED
po string
district string
state string REQUIRED
country string REQUIRED
url string
latitude string
longitude string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

email string
phoneNumber string
incorporationDate date
commencementDate date
udyam object
registrationNumber string
registrationDate date
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

status string

Possible values: [SUCCESS, REJECTED, PENDING, ACTION_REQUIRED]

extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

individual object
type string

Possible values: [CKYC, UDYAM, OFFLINE_AADHAAR]

name string
dob string
address object
hba string REQUIRED
srl string REQUIRED
landmark string
als string
vtc string
pinCode string REQUIRED
po string
district string
state string REQUIRED
country string REQUIRED
url string
latitude string
longitude string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

status string

Possible values: [SUCCESS, REJECTED, PENDING, ACTION_REQUIRED]

email string
phoneNumber string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

next object
type string

Possible values: [REDIRECT]

data object
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

offers object[] REQUIRED

Offers given by lender for a loan application

id string REQUIRED
isMappedtoDocument boolean
documentId string
validTill date REQUIRED
terms object REQUIRED
requestedAmount float REQUIRED
currency string REQUIRED
sanctionedAmount float
netDisbursedAmount float
interestType string

Possible values: [FIXED, FLOATING]

interestRate float
annualPercentageRate float
coolingOffPeriod object
duration number REQUIRED
unit string REQUIRED

Possible values: [MONTH, DAY, YEAR]

totalRepayableAmount float
interestAmount float
description string
tenure object
duration number REQUIRED
unit string REQUIRED

Possible values: [MONTH, DAY, YEAR]

legalAgreement object
type string REQUIRED

Possible values: [TEXT, DOCUMENT_URL, REDIRECT_TO_LENDER_URL]

data string REQUIRED
documents object[]
id string
source string REQUIRED

Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER]

sourceIdentifier string REQUIRED
format string REQUIRED

Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL]

reference string REQUIRED
type string REQUIRED

Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER]

isDataInline boolean REQUIRED
data string REQUIRED
charges object
prepayment object
chargeType string REQUIRED

Possible values: [FIXED_AMOUNT, RATE_BASED]

data object REQUIRED
rate float
amount float
applicableParameter string

Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL]

description string
url string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

bounce object
chargeType string REQUIRED

Possible values: [FIXED_AMOUNT, RATE_BASED]

data object REQUIRED
rate float
amount float
applicableParameter string

Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL]

description string
url string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

latePayment object
chargeType string REQUIRED

Possible values: [FIXED_AMOUNT, RATE_BASED]

data object REQUIRED
rate float
amount float
applicableParameter string

Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL]

description string
url string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

processing object
chargeType string REQUIRED

Possible values: [FIXED_AMOUNT, RATE_BASED]

data object REQUIRED
rate float
amount float
applicableParameter string

Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL]

description string
url string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

other object
chargeType string REQUIRED

Possible values: [FIXED_AMOUNT, RATE_BASED]

data object REQUIRED
rate float
amount float
applicableParameter string

Possible values: [TOTAL_LOAN_AMOUNT, OUTSTANDING_PAYABLE_AMOUNT, EMI, REPAYMENT_PRINCIPAL]

description string
url string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

disbursement object REQUIRED
plans object[] REQUIRED
id string REQUIRED
title string
shortDescription string
description string
paymentUrl string
payNowAllowed boolean
editPlanAllowed boolean
changeMethodAllowed boolean
automatic boolean REQUIRED
scheduleType string REQUIRED

Possible values: [RECURRING, ONE_TIME, AS_PRESENTED]

noOfInstallment number
frequency string

Possible values: [MONTHLY, WEEKLY, QUARTERLY, HALF_YEARLY, YEARLY]

tenure object
duration number REQUIRED
unit string REQUIRED

Possible values: [MONTH, DAY, YEAR]

totalAmount float REQUIRED
principal float
interestAmount float
penalty float
startDate date
status string

Possible values: [ACTIVE, INACTIVE, PENDING_AUTH]

url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

accountDetails object[]
id string
description string
status string

Possible values: [ACTIVE, INACTIVE]

accountDataType string REQUIRED

Possible values: [ACCOUNT, VPA]

data object REQUIRED
accountType string

Possible values: [CURRENT, SAVING, OVERDRAFT, ESCROW, WALLET]

accountIFSC string
accountNumber string
vpa string
maskedAccountNumber string
accountHolderName string
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

repayment object REQUIRED
plans object[] REQUIRED
id string REQUIRED
title string
shortDescription string
description string
paymentUrl string
payNowAllowed boolean
editPlanAllowed boolean
changeMethodAllowed boolean
automatic boolean REQUIRED
scheduleType string REQUIRED

Possible values: [RECURRING, ONE_TIME, AS_PRESENTED]

noOfInstallment number
frequency string

Possible values: [MONTHLY, WEEKLY, QUARTERLY, HALF_YEARLY, YEARLY]

tenure object
duration number REQUIRED
unit string REQUIRED

Possible values: [MONTH, DAY, YEAR]

totalAmount float REQUIRED
principal float
interestAmount float
penalty float
startDate date
status string

Possible values: [ACTIVE, INACTIVE, PENDING_AUTH]

url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

description string
documents object[]
id string
source string REQUIRED

Possible values: [GSTN, AA, FIP, FSR, FIU, USER, OTHER]

sourceIdentifier string REQUIRED
format string REQUIRED

Possible values: [JSON, DOC, IMAGE, CSV, XML, PDF, URL]

reference string REQUIRED
type string REQUIRED

Possible values: [GST_PROFILE, GSTN_B2B_INVOICE, PAN, AADHAAR, DRIVING_LICENSE, PASSPORT, OTHER]

isDataInline boolean REQUIRED
data string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

description string

Possible values: length ≤ 1000

A short description of the loan application

url string

Possible values: length ≤ 1000

For any additional data that needs to be passed as a link

extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

rejectionDetails object[]

To be filled if the status of the loan is REJECTED. This object will have the details of why the loan application was rejected

reason string REQUIRED

Possible values: [LOW_CREDIT_SCORE, FRAUD, DOC_IRREGULARITIES, OTHERS, AA_FAILED]

description string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

actionRequired object[]

To be filled if the status of the loan is ACTION_REQUIRED. This object captures the details of any action that the lender wants the borrower to do

actionType string REQUIRED

Possible values: [ADD_DOCUMENT, RESUBMIT_DOCUMENT, ADDITIONAL_DATA, OTHER]

description string REQUIRED
reference object REQUIRED
object string REQUIRED
value string REQUIRED
url string
extensibleData object

This API schema is for additional keys & values according to specific need. User can add JSON objects as per the requirements.

Responses
200

Acknowledgement of Request Received

Schema OPTIONAL
error string
traceId string
timestamp string