- 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 a set of loan applications within the lender system | Must Have |
| Loan Application | Create Loan Applications Response | Response for the Create Loan Applications Request - includes the status and possible lender details for each loan application. | Must Have |
| Offers | GenerateOffersRequest | Request raised by an LSP to fetch offers for selected loan applications raised previously. | Must Have |
| Offers | GenerateOffersResponse | Response provided by Lender to LSP with the generated Offers, which includes details for terms, disbursement, and repayment. | Must Have |
| Offers | SetOfferRequest | Request raised by LSP to inform lender of offer chosen by the borrower. | Must Have |
| Offers | SetOfferResponse | Response send by Lender to LSP as response to the Set Offer Request - includes status. | 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 | After borrower approves of the consent, this request is 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 borrower. This API creates the loan in the lender's system, if approved. | Must Have |
| Grant Loan | Grant Loan Response | Response sent by lender with loan status, and if the loan is approved, lender creates the loan and responds with a complete set of loan details. | 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 as of the current date. | Must Have |
| Grant Loan | Loan Summary Response | Response given by lender providing a loan summary as of the current date. | Must Have |
| Grant Loan | LoanStatementRequest | Request raised for getting the current loan account statement for a specified period. | Must Have |
| Grant Loan | LoanStatementResponse | Response giving the Loan account statement for a specified period. | 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 (loan ID and terms). | Must Have |
| Repayment | getRepaymentPlansRequest | Request raised to get a list of repayment plans available for the chosen loan from the lender. | Must Have |
| Repayment | getRepaymentPlansResponse | Returns the list of repayment plans for the loan from the 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 | Lender responds to the Trigger Repayment Request with a unique payment ID and a URL to the LSP, from where the borrower can make the payment. | Must Have |
| Repayment | triggerRepaymentStatusRequest | Request raised by LSP to check the status of a Trigger Repayment Request | Must Have? (Not needed if Confirm Repayment webhook is sent). |
| Repayment | triggerRepaymentStatusResponse | Response for trigger Repayment Status Request. | Must Have? |
| Repayment | SetRepaymentPlanStatusRequest | Request raised by LSP to get the status of a previously called Set Repayment Plan Request | Must Have |
| Repayment | SetRepaymentPlanStatusResponse | Response given by lender for Set Repayment Plan Status Request | Must Have |
| Repayment | confirmRepayment | Webhook for lender to inform LSP about a received repayment | Must Have? (Not needed if Trigger Repayment Status Request is sent). |
| 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 by the Lender indicating the status of the Set Disbursement Account Plan | Must Have |
| Disbursement | GetDisbursementPlansRequest | Request Raised by LSP to get a detailed list of all disbursement plans available for the chosen loan from the lender | Must Have |
| Disbursement | GetDisbursementPlansResponse | Response from the Lender to LSP listing all Disbursement Plans available for the loan. | Must Have |
| Disbursement | SetDisbursementPlanRequest | Request raised by LSP to choose a disbursement plan | Must Have |
| Disbursement | SetDisbursementPlanResponse | Response given by the lender indicating the status of the Set Disbursement Plan | Must Have |
| Disbursement | TriggerDisbursementStatusRequest | Request raised by LSP to check the status of a previously initiated Trigger Disbursement Request. | Must Have? (May not be needed if status was already returned in the response for the Trigger Disbursement Request) |
| Disbursement | TriggerDisbursementStatusResponse | Response given by lender for a Trigger Disbursement Status Request | Must Have? (May not be needed if status was already returned in the response for the Trigger Disbursement Request) |
| 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 7 months ago