Loan
Initiate loan application
POST
{{baseUrl}}/api/v2/client/loans/onboardcustomer_loanrequest
Endpoint to process borrower onboarding and loan application.
Request Body
Name | Type | Description |
---|---|---|
last_name | string | The last name of the borrower. |
first_name | number | The first name of the borrower. |
bank_account_name* | string | The name of the borrower's bank account. This is required only for non Nigerian aggregators. |
identity_number | string | This is the unique valid identification number of the borrower used to perform KYC. |
photo_url | string | The base 64 image of the borrower or the url of the uploaded image. |
gender | string | The gender of the borrower should either be male or female. |
phone_number* | string | The borrower's phone number. |
email* | string | The borrower's email. |
company_name | string | The name of the company being registered for corporate borrower. |
borrower_type* | number | The type of borrower to be onboarded. 1 for individual and 2 for corporate. |
date_of_birth | string | Borrower's date of birth in the format |
state* | string | State of the borrower. To view list of states under an aggregator see Get Country's States endpoint above. |
city* | string | City of the borrower. |
residence_address | string | Address of the borrower. |
company_city | string | City where the company is located for the corporate borrower. |
company_address | string | Company address for corporate borrower. |
registration_number | string | Company's business registration number for the corporate borrower. |
country_code* | string | Certified country code is entered here such as "NG" (Nigeria), "GH" (Ghana), "SA" (South Africa) |
sector_code* | string | The sector code of the borrower applying for the loan. To view all sectors and their sector codes, see the Get Sectors endpoint above. |
product_id* | number | The Id of the product from which the loan is being requested. To view, all the products for a particular aggregator see the Get Aggregator Product endpoint above. |
aggregator_loan_ref* | string | The unique loan reference for the aggregator. This will be generated by the client. |
bank_code* | string | The bank code of the borrower's bank. To view, all banks and their bank codes see the Get Country's Bank List endpoint above. |
bank_account_num* | string | The bank account number of the borrower. |
company_state | string | State where the company is located for the corporate borrower. To view all states for an aggregator nationality, see Get Country's State endpoint above. |
create_wallet | boolean | This indicates if a wallet is to be created for a borrower or not (true or false). |
customer_category | string | The customer's job category. |
loan_purpose* | string | The reason for which the loan is created. |
annual_interest_rate* | string | The loan interest rate. If the interest rate is zero, the loan product's interest rate will be used. |
loan_amount* | number | The amount to be loaned out. |
loan_tenure* | number | The duration of the loan is in months. |
Get borrower loans
GET
{{baseUrl}}/api/v2/client/loans/borrower/{customer_id}
This endpoint is to get all the loans for a specific customer.
Path Parameters
Name | Type | Description |
---|---|---|
customer_id* | number | The id of the customer |
Headers
Name | Type | Description |
---|---|---|
client-id* | string | The client id that was generated |
api-key* | string | The secret api key. |
Get loan details
GET
{{baseUrl}}/api/v2/client/loans/{loan_ref_no}
This endpoint is to get the loan details of a specific loan using the loan reference number.
Path Parameters
Name | Type | Description |
---|---|---|
loan_ref_no* | string | The loan reference number |
Headers
Name | Type | Description |
---|---|---|
client-id* | string | The client id that was generated |
api-key* | string | The secret api key. |
Initiate repayment
POST
{{baseUrl}}/api/v2/client/loans/initiate_repayment
Headers
Name | Type | Description |
---|---|---|
client-id* | string | The client id that was generated |
api-key* | string | The secret api key. |
Request Body
Name | Type | Description |
---|---|---|
loan_ref_no* | string | The loan reference number |
amount* | number | The loan amount |
Generate loan schedule
POST
{{baseUrl}}/api/v2/client/loans/generate_loan_schedule
Headers
Name | Type | Description |
---|---|---|
client-id* | string | The client id that was generated |
api-key* | string | The secret api key. |
Request Body
Name | Type | Description |
---|---|---|
productId* | number | The product id |
loanTenor* | number | The loan tenor |
principalAmount* | number | The principal amount |
interest* | number | The loan interest rate |
loanEffectiveDate | string | The loan effective date |
Request Loan
POST
{{baseUrl}}/api/v2/client/loans/request_loan
Headers
Name | Type | Description |
---|---|---|
client-id* | string | |
api-key* | string |
Request Body
Name | Type | Description |
---|---|---|
identity_number* | string | |
country_code* | string | |
product_id* | integer | |
loan_amount* | integer | |
loan_tenure* | integer | |
sector_code* | string | |
repayment_start_date | string | |
annual_interest_rate* | string | |
aggregator_loan_ref | string | |
loan_purpose* | string | |
batch_loan_number | string | |
use_customer_wallet | boolean |
Loan Status
Meanings and descriptions
Status Code | Meaning of Status Code | Description |
---|---|---|
500 | Rejected | When the loan is rejected |
300 | Active | When the loan has been disbursed and is currently an active loan |
200 | Approved | When the loan has been approved and is pending disbursement |
600 | Closed | When the full cycle of the loan has been completed |
100 | Submitted and Awaiting Approval | When the loan is still awaiting approval from your end |
400 | Withdrawn by Client | Flag indicating the money has been withdrawn from your system |
601 | Written Off | Same as a bad loan |
602 | Rescheduled | When a loan rollover is done on a specific loan |
700 | Overpaid | When the repayment has been overpaid |
Last updated