Deposit products

Get all deposit products

Get all deposit products

GET {base url}/v1/depositProducts?page={page}&perPage={perPage}

Get all company deposit products

Query Parameters

Name
Type
Description

page

number

page to return

perPage

number

number of items per page

Headers

Name
Type
Description

Authorization*

Bearer token

The bearer token is the API users Secret Key

{
    "data": [
        {
            "id": "ecb256e5-cca7-4102-86ff-fe4ead77fce5",
            "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
            "productName": "for eod",
            "productType": "savings_account",
            "productUserType": [
                "clients",
                "companies"
            ],
            "productCurrency": "NGN",
            "productDescription": "for eod testing",
            "productInterestRate": {
                "daysInAYear": 365,
                "interestPaid": "END_OF_WEEK",
                "interestType": "fixed",
                "applyInterest": true,
                "interestCharged": "%_PER_MONTH",
                "maxInterestRate": 17,
                "minInterestRate": 7,
                "interestRateBase": "END_OF_DAY_BALANCE",
                "applyWithHoldingTax": false,
                "defaultInterestRate": 11
            },
            "productTransactionSettings": {
                "minBalance": 2000,
                "dormantPeriod": 60,
                "allowAccountGoDormant": true
            },
            "productTenure": {},
            "productAccounting": {
                "feeIncome": "0000000152",
                "taxesPayable": "",
                "savingsControl": "0000000165",
                "interestExpense": "1017320405",
                "interestPayable": "0000000165",
                "transactionSource": "0000000181"
            },
            "branch": [
                "all_branches"
            ],
            "isActive": true,
            "status": "active",
            "created_at": "2023-12-10T19:40:56.750Z",
            "updated_at": "2023-12-10T19:46:48.952Z"
        },
        {
            "id": "ad56b4dd-9790-4c4f-9bbf-e32af08650fe",
            "organizationId": "a5f38f16-6c44-408f-b7ff-6775f02b83ac",
            "productName": "a test",
            "productType": "fixed_deposit",
            "productUserType": [
                "companies"
            ],
            "productCurrency": "NGN",
            "productDescription": "testing",
            "productInterestRate": {
                "daysInAYear": 365,
                "interestPaid": "END_OF_WEEK",
                "interestType": "fixed",
                "applyInterest": true,
                "interestCharged": "%_PER_MONTH",
                "maxInterestRate": 16,
                "minInterestRate": 11,
                "interestRateBase": "END_OF_DAY_BALANCE",
                "applyWithHoldingTax": false,
                "defaultInterestRate": 11
            },
            "productTransactionSettings": {
                "minBalance": 5000,
                "dormantPeriod": 0,
                "allowAccountGoDormant": false
            },
            "productTenure": {
                "maxTenure": 11,
                "minTenure": 10
            },
            "productAccounting": {
                "feeIncome": "0000000152",
                "taxesPayable": "",
                "savingsControl": "0000000165",
                "interestExpense": "1017320405",
                "interestPayable": "0000000165",
                "transactionSource": "0000000181"
            },
            "branch": [
                "all_branches"
            ],
            "isActive": true,
            "status": "active",
            "created_at": "2023-10-13T14:17:15.627Z",
            "updated_at": "2023-12-12T01:39:31.281Z"
        },
    ]
}

Get deposit product details

Get deposit product details

GET {base url}/v1/depositProducts/_single?productId={productId}

Get deposit product details

Query Parameters

Name
Type
Description

productId*

string

product Id

Headers

Name
Type
Description

Authorization*

Bearer token

The bearer token is the API users Secret Key

Last updated

Was this helpful?