LMS Integration Overview

Eclipse provides a reference (dummy) LMS to support end-to-end testing of loan functionality in the absence of a live loan provider. The dummy LMS also serves as a practical integration framework for LMS providers looking to integrate with Eclipse.

While the exact implementation will vary between LMS providers, the integration generally consists of two parts:

1. LMS APIs exposed for Eclipse to call
2. Optional Eclipse APIs consumed by the LMS

Examples of the LMS-side APIs are implemented in the dummy LMS and a Postman collection can be shared on request.

LMS APIs Consumed by Eclipse

An LMS integrating with Eclipse is expected to expose the following APIs for Eclipse to consume:

1. Opt-In
   Enables a customer to opt in to the loan service. Customer details are typically provided to create or update the customer in the LMS and initiate credit scoring.
2. Opt-Out
   Disables access to loan services for a customer and deactivates the customer on the LMS.
3. Get Loan Catalog
   Retrieves details of all loan products offered by the LMS.
4. Get Loan Catalog for Customer
   Retrieves loan products available to a specific customer, based on factors such as customer profile and credit score.
5. Get Customer Loans
   Retrieves a list of loans associated with a customer.
6. Get Loan Details
   Retrieves detailed information for a specific loan.
7. Apply for a Loan
   Submits a loan application for a customer.
8. Record Loan Repayment
   Records a loan repayment made by or on behalf of a customer.

Eclipse APIs Consumed by the LMS

An LMS can optionally consume the following Eclipse APIs to enhance loan processing and decisioning:

1. Get Wallet Transaction History

Retrieve transaction history that can be used as part of credit vetting.

2. Get Customer Documents

Retrieve customer documentation that can be used as part of user verification.

3. Initiate Transfers for Disbursement or Repayment

Transfers can be initiated to disburse loans to a wallet, or collect repayments from a wallet. Session-based transfers allow an LMS to initiate a repayment even when insufficient funds are available in the customer’s wallet. In this case, the funds are reserved and automatically transferred once they become available.

Loan Disbursement Models

Loan disbursement can be handled in one of two ways, depending on tenant configuration.

Eclipse-Driven Disbursement

If a source wallet for loans is configured with tenant config source.wallet.config.{PROVIDER_NAME}, Eclipse will automatically disburse funds when a loan is successfully provisioned. Funds are transferred from the configured source wallet to the customer’s wallet.

LMS-Driven Disbursement

If source.wallet.config.{PROVIDER_NAME} is not configured, Eclipse does not disburse funds when a loan is provisioned. In this scenario, the LMS is responsible for initiating the disbursement by calling the Eclipse wallet transfer endpoint.