Loans
Add loan
Create a new loan
POST
{base url}/v1/loans
Headers
Name | Type | Description |
---|---|---|
Authorization header* | string | API user secret key |
Request Body
Name | Type | Description |
---|---|---|
loanProductId* | String | loan product id |
name* | String | loan name |
amount* | Number | loan amount(major) |
interestRate | Number | loan interest rate |
moratorium | Number | loan moratorium |
tenure | Number | loan tenure |
accountHolder* | String | id of the client/company |
accountHolderType* | String | clients/companies |
Update loan
PATCH
{base url}/v1/loans
Update a single loan
Headers
Name | Type | Description |
---|---|---|
Authorization header* | string | API user secret key |
Path Param
Name | Type | Description |
---|---|---|
loanId* | String | id of the loan to be updated |
Request Body
Name | Type | Description |
---|---|---|
state* | string | Possible values are: APPROVED, DECLINED. |
comment | text | |
Get all loan accounts
Get all loan accounts
GET
{base url}/v1/loans
Get all loan accounts
Get loan account details
Get loan account details
GET
{base url}/v1/loans
Get loan account details
Path Parameters
Name | Type | Description |
---|---|---|
loanId* | string | id of the loan. |
Get loan schedule
Get loan schedule
GET
{base url}/v1/loans/{loanId}/repayments
Request Param
Name | Type | Description |
---|---|---|
loanId | uuid | id of the loan. |
Get loan transactions
Get loan transactions
GET
{base url}/v1/loans/transactions
Get loan transactions
Query Parameters
Name | Type | Description |
---|---|---|
accountNumber* | string | account number generated for the loan. |
Get loan balances
Get loan balances
GET
{base url}/v1/loans/{loanId}/balances
Get loan balances
Request Param
Name | Type | Descriopiton |
---|---|---|
loanId | uuid | id of the loan |
Repay loan
Repay loan
POST
{base url}/v1/loans/transaction/{loanId}/repay
Repay loan
Request Param
Name | Type | Description |
---|---|---|
loanId | uuid | id of the loan |
Request Body
Name | Type | Description |
---|---|---|
channel | string | id of the channel attached when disbursing internal loan. |
amount* | number | amount(major) |
Loan payoff
Loan payoff
POST
{base url}/v1/loans/transaction/{loanId}/payoff
Loan payoff
Request Param
Name | Type | Description |
---|---|---|
loanId | uuid | id of the loan |
Request Body
Name | Type | Description |
---|---|---|
channel | string | channel |
amount* | number | amount(major) |
Loan WriteOff
POST
{base url}/v1/loans/transaction/{loanId}/payoff
Loan write-off
Request Body
Name | Type | Description |
---|---|---|
amount* | number | amount (major) |
loan topup
Loan topup
POST
{base url}/v1/loans/transaction/{loanId}/topup
Loan topup
Request Body
Name | Type | Description |
---|---|---|
| number | loan amount (major) |
| number | interest |
| number | tenure |
| string | first repayment date |
Liquidate loan
Liquidate loan
POST
{base url}/v1/loans/transaction/{loanId}/liquidate
Liquidate loan
Request Body
Name | Type | Description |
---|---|---|
| number | loan amount (major) |
| string | channel |
disburse loan
Disburse loan
POST
{base url}/v1/loans/transaction/{loanId}/disburse
disburse loan
Headers
Name | Value |
---|---|
|
|
Request Param
Name | Type | Decsription |
---|---|---|
loanId | uuid | id of the loan |
Body
Name | Type | Description |
---|---|---|
| string | type (INTERNAL/EXTERNAL) |
accountNumber | string | nuban account number is required if type is INTERNAL |
| string | narration |
| string | channel is required if type is INTERNAL |
| boolean | change repayment date |
| string | new first repayment date. required if |
Response
Last updated