As part of our loan management services for external users, the platform allows loans to be booked for customers with fully customizable multi-tenor repayment schedules.


Prerequisites

Before creating a loan with multiple payment schedules using the Adjutor APIs, ensure the following conditions are met:

  • Customer Registration
    The customer must already be registered on the Admin Console (app.lendsqr.com).
    This can be done either by registering the user on the Admin Console or using the  Create Customer endpoint in the Loan Management Module of the Adjutor APIs.

  • Loan Product Configuration
    A loan product that supports multi-tenor payments must be created or configured on the Admin Console.
    For a step-by-step guide on how to create a loan product, refer to the article: How to Create a Loan Product

  • Loan Request Payload
    When creating a loan via API, ensure the request payload:
    Includes all required parameters as defined in the API documentation.
    Contains multiple repayment schedules whose total duration matches the full loan tenor period.

Request Payload

Property

Type

Description

bvn

string

Required. 11-digit Bank Verification Number.


requested_amount

integer

Required. Loan amount requested.


proposed_tenor

integer

Required. Duration of the loan.


proposed_tenor_period

string

Optional. Period unit for the tenor (days, weeks, months).


product_id

integer

Required. Product ID of your multi-tenor loan product.


purpose

string

Optional. Reason for requesting the loan (e.g., "Home renovation"). Can be null.


marital_status

string

Optional. Marital status. Can be null.

Values supported: Single, Married, Divorced, Widowed, Separated

no_of_dependent

string

Optional. Number of dependents. e.g. 0, 1, 2, etc. Can be null.


type_of_residence

string

Optional. Type of residence. Can be null.

Values supported: Own House, Parents' Apartment, Rented Apartment

educational_attainment

string

Optional. Highest level of education. Can be null.

Values supported: BSc, HND and Other Equivalents, Undergraduate, Others, Diploma/School Cert, MSc and Above


Repayment schedules

Property

Type

Description

schedules

Array

List of repayment schedules.

principal

integer

Required. Principal to be repaid for each schedule

interest

integer

Required. Interest to be repaid for each schedule

fees

integer

Optional. Fees to be repaid for each schedule

status

String

Required. Status of each repayment schedule


Values supported:

pending

due_date

string

Values supported:

A valid ISO 8601 date


Creating a Loan with Custom Schedules

  1. Create an app on the Adjutor web application, ensuring that all required API scopes are selected under Loan management. After successful creation, retrieve your API Keys.

  2. Pass your API keys as a Bearer token and send a POST request to Book Multi-tenor Loans, with all required fields in the request body.

  3. If the BVN provided in the request is already linked to a customer, the loan will be successfully created.

    Watch the video below for more guidance on the steps listed above.