- All the APIs are Async.
a. requestId field is used for the purposes for mapping responses to their respective requests. - Each API request generates a standardized Acknowledgement from the other end.
- LSP can poll for the status and/or Lender sends a webhook.
- Each function has 2 separate APIs. For example: Create Loan Application has 2 APIs
a. CreateLoanApplicationRequest -> Request sent by LSP to the Lender
b. CreateLoanApplicationResponse -> Async Response sent by Lender to LSP - Create calls should be idempotent on the requestId field i.e. two calls to CreateLoanApplication with same requestId shouldn’t result in two applications created. Lenders are advised to return the same response as sent earlier.
- Update APIs for MSMEs to push more data as requested by Lender
Category | Api Name | Description | BHIM 4 Lending Need |
---|---|---|---|
Loan Application | Create Loan Applications Request | Creates loan applications with the lender system | Must Have |
Loan Application | Create Loan Applications Response | Response for the Create Loan Applications Request which includes the status of application | Must Have |
Offers | GenerateOffersRequest | Request raised by an LSP to fetch offers for a previously raised loan application | Must Have |
Offers | GenerateOffersResponse | Response provided by Lender to LSP which includes the Offers | Must Have |
Offers | SetOfferRequest | Request raised by LSP to lender to choose an offer | Must Have |
Offers | SetOfferResponse | Response send by Lender to LSP as response to acceptOffer | Must Have |
Consent | ConsentHandleRequest | Request Raised by LSP to Lender to trigger creation of consent requests in the AA system | Must Have |
Consent | ConsentHandleResponse | Response given by lender to LSP with the consent handles for the consent requests raised | Must Have |
Consent | ConsentStatusRequest | Request raised by LSP to Lender to check the Consent artifact creation status | Must Have |
Consent | ConsentStatusResponse | Response sent by LSP to Lender which includes the ConsentIds and their statuses | Must Have |
Loan Acceptance | TriggerLoanAcceptanceRequest | Request sent by LSP to lender to send an OTP to phone number associated with disbursement account for agreeing to the loan terms | Must Have |
Loan Acceptance | TriggerLoanAcceptanceResponse | Response given by the lender for TriggerOTPRequest | Must Have |
Loan Acceptance | VerifyLoanAcceptanceRequest | Request sent by the LSP to lender with the OTP that was sent to the phone number | Must Have |
Loan Acceptance | VerifyLoanAcceptanceResponse | Response given by the lender acknowledging the verification of OTP | Must Have |
Grant Loan | Grant Loan Request | Request raised by the LSP to get a loan granted for the borrowed. This API creates the loan in the lenders system | Must Have |
Grant Loan | Grant Loan Response | Response given by the lender back to the LSP once the loan is created in the lending system | Must Have |
Grant Loan | getLoanRequest | This API is invoked by the LSP when the LSP wants to get the details of the loan. | Must Have |
Grant Loan | getLoanResponse | This method is called by the Lender and it returns all the details of the loan. | Must Have |
Grant Loan | Loan Summary Request | Request raised by the LSP to get the current summary of the loan | Must Have |
Grant Loan | Loan Summary Response | Response given by lender for LoanSummary Request | Must Have |
Grant Loan | LoanStatementRequest | Request raised for getting the current loan account statement | Must Have |
Grant Loan | LoanStatementResponse | Response giving the Loan account statement | Must Have |
Grant Loan | ListLoansRequest | This API is invoked by LSP to get the list of loans given by lender for a borrower | Must Have |
Grant Loan | ListLoansResponse | This API gives get the list of loans given by lender for a borrower | Must Have |
Repayment | getRepaymentPlansRequest | Request raised to get list of plans for a loan | Must Have |
Repayment | getRepaymentPlansResponse | Returns the list of repayment plans for a lender | Must Have |
Repayment | SetRepaymentPlansRequest | Request Raised by LSP to set a repayment plan from the list of options. | Must Have |
Repayment | SetRepaymentPlansResponse | Response from the Lender to LSP returning the lender page url where repayment should be set | Must Have |
Repayment | triggerRepaymentRequest | Request by the LSP to lender to trigger a repayment | Must Have |
Repayment | triggerRepaymentResponse | Response by the Lender in response to Trigger Repayment Request | Must Have |
Repayment | triggerRepaymentStatusRequest | Request raised by LSP to check the status of a triggerRepaymentRequest | Must Have |
Repayment | triggerRepaymentStatusResponse | Response for triggerRepaymentStatus | Must Have |
Repayment | SetRepaymentPlanStatusRequest | Request raised by LSP to get the status of a previously called setRepaymentPlan request | Must Have |
Repayment | SetRepaymentPlanStatusResponse | Response given by lender for SetRepaymentPlanStatusRequest | Must Have |
Repayment | confirmRepayment | Webhook for lender to inform LSP about a received repayment | Must Have |
Disbursement | Trigger Disbursement Request | Request raised by LSP to Lender to trigger disbursement | Must Have |
Disbursement | Trigger Disbursement Response | Response given by the lender for TriggerDisbursement | Must Have |
Disbursement | setDisbursementAccountRequest | Request given by the LSP to set a disbursement account for the loan | Must Have |
Disbursement | setDisbursementAccountResponse | Response given the Lender for setDisbursementAccountRequest | Must Have |
Disbursement | GetDisbursementPlansRequest | Request Raised by LSP to get all Disbursement plans offered by Lender | Must Have |
Disbursement | GetDisbursementPlansResponse | Response from the Lender to LSP listing all Disbursement Plans | Must Have |
Disbursement | SetDisbursementPlanRequest | Request raised by LSP to choose a disbursement plan | Must Have |
Disbursement | SetDisbursementPlanResponse | Response given by lender indicating the status of set Disbursement Plan | Must Have |
Disbursement | TriggerDisbursementStatusRequest | Request raised by LSP to check the status of a previously initiated trigger Disbursement | Must Have |
Disbursement | TriggerDisbursementStatusResponse | Response given by lender for a trigger Disbursement Status Request | Must Have |
Dispute Management | Raise Dispute Request | Request raised by LSP to create a dispute in lender system | Must Have |
Dispute Management | Raise Dispute Response | Response given to LSP by lender post RaiseDisputeRequest | Must Have |
Dispute Management | Dispute Status Request | This API is invoked by the LSP to get the status of a dispute | Must Have |
Dispute Management | Dispute Status Response | This API is invoked by the Lender to send the status of a dispute | Must Have |
Meta APIs | Heartbeat | This API is used by LSP to check if a lender system is up and running | Must Have |
Updated almost 3 years ago