Query Services

Mutual Fund Queries

Endpoint: /api/v1/getclientinvestiblemutualfundproducts

Method: GET

• returns the client's investible mutualfund products

Sample Respond Payload

[
  {
    "portfolioName": "RSA Fund",
    "clientPortfolioCode": null,
    "portfolioType": 2,
    "myProduct": false,
    "portfolioId": 820,
    "productMandate": "Retirement Savings Account Scheme",
    "portfolioTypeName": "mutualfund",
    "minimumHoldingPeriod": 60,
    "minimumInvestment": 0,
    "minimumSubsequentInvestment": 0,
    "custodianName": "iTap Custodian",
    "earlyRedemptionPenaltyRate": 20,
    "assetClassInfo": null,
    "currency": "NGN",
    "currentValue": 1944414.84,
    "cost": 2294308.54,
    "bidPrice": 0.86061117911538,
    "offerPrice": 1.402744973031354,
    "return": 5.55,
    "subProducts": []
  }
]

Endpoint: /api/v1/getclientmutualfundonlinebalances

Method: GET

• returns the client's mutualfund online balances per portfolio/product

Sample Respond Payload

[
  {
    "portfolio": "string",
    "holding": 0,
    "offerPrice": 0,
    "bidPrice": 0,
    "balance": 0,
    "costPrice": 0,
    "costAmount": 0,
    "pendingDividendAmount": 0,
    "reportDate": "2026-11-03T09:48:45.038Z",
    "schemeId": 0,
    "currency": "string",
    "mutualfundAccountNo": "string",
    "mutualfundAccountName": "string",
    "portfolioCode": "string"
  }
]

Field	Description
portfolio	Mutualfund name
holding	Mutualfund balance in units
offerPrice	Mutualfund offer price
bidPrice	Mutualfund Bid price used in calculating mutualfund balances
balance	Client Mutualfund value
costPrice	Mutualfund cost price per unit
costAmount	cost from inception or from last full redemption date
pendingDividendAmount	Mutualfund Accrued Dividend awaiting payment
reportDate	Date of mutualfund balance
schemeId	Mutualfund identifier
currency	Mutualfund currency
mutualfundAccountNo	Client mutualfund account number
mutualfundAccountName	Client mutualfund account name
portfolioCode	Mutualfund code

Endpoint: /api/v1/getclientmutualfundonlinebalance/{portfolioid}

Method: GET

• returns the client's mutualfund online balance

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts

Sample Respond Payload

{
  "portfolio": "string",
  "holding": 0,
  "offerPrice": 0,
  "bidPrice": 0,
  "balance": 0,
  "costPrice": 0,
  "costAmount": 0,
  "pendingDividendAmount": 0,
  "reportDate": "2026-11-03T10:10:16.147Z",
  "schemeId": 0,
  "currency": "string",
  "mutualfundAccountNo": "string",
  "mutualfundAccountName": "string",
  "portfolioCode": "string"
}

Endpoint: /api/v1/getclientmutualfundonlinebalances/{portfolioid}

Method: GET

• returns the client's mutualfund online balances

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts

Sample Respond Payload

[
  {
    "portfolio": "string",
    "holding": 0,
    "offerPrice": 0,
    "bidPrice": 0,
    "balance": 0,
    "costPrice": 0,
    "costAmount": 0,
    "pendingDividendAmount": 0,
    "reportDate": "2026-11-03T10:10:16.147Z",
    "schemeId": 0,
    "currency": "string",
    "mutualfundAccountNo": "string",
    "mutualfundAccountName": "string",
    "portfolioCode": "string"
  }
]

Endpoint: /api/v1/getmutualfunddividendonlinebalances/{portfolioid}

Method: GET

• returns the client's mutualfund dividend online balance

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts

Sample Respond Payload

[
  {
    "schemeId": 0,
    "clientSubAccount": "string",
    "lastTransactionDate": "2026-11-03T10:32:02.496Z",
    "balance": 0
  }
]

Field	Description
schemeId	Identifier of the fund
clientSubAccount	Client Sub Account. Specific to the fund
lastTransactionDate	Last Dividend Transaction Date
balance	Dividend Balance

Endpoint: /api/v1/getmutualfundstatement/{portfolioid}/{reportdate}

Method: GET

• returns the client's mutualfund statement from the beginiing of the Year

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts {reportdate} => report date

Sample Respond Payload

{
  "scheduleType": "RSA Fund",
  "object": [
    {
      "transDate": "2026-01-01T00:00:00",
      "narration": "Opening Balance",
      "units": 2259810.0069,
      "price": 0,
      "amount": 0
    },
    {
      "transDate": "2026-10-10T00:00:00",
      "narration": "Closing Balance",
      "units": 2259810.0069,
      "price": 0,
      "amount": 0
    }
  ]
}

Endpoint: /api/v1/getmutualfundaccounts/{portfolioid}

Method: GET

• Get list of client subaccounts in a mutualfund

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts

Sample Respond Payload

[
  {
    "subAccountNumber": "string",
    "subAccountName": "string"
  }
]

Endpoint: /api/v1/getclientaccrueddividend/{startdate}/{enddate}

Method: GET

• Get client accrued dividend

Sample Respond Payload

[
  {
    "portfolio": "string",
    "accruedDate": "2026-11-03T11:32:30.161Z",
    "symbol": "string",
    "currency": "string",
    "qualifyingShares": 0,
    "dps": 0,
    "amount": 0,
    "type": "string"
  }
]

Endpoint: /api/v1/getmutualfundsubscriptionandredemption

Method: GET

• Get mutual fund subscription and redemption

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts

Sample Respond Payload

[
  {
    "schemeId": 0,
    "currencyCode": "string",
    "totalSubscribedAmount": 0,
    "totalRedeemedAmount": 0,
    "amount": 0
  }
]

Endpoint: /api/v1/getclientindividualmutualfundinvestmentreturn/{portfolioid}/{startdate}/{enddate}

Method: GET

• The return is personal to the client investment

query params {portfolioid} => mutual fund code from /api/v1/getclientinvestiblemutualfundproducts

Sample Respond Payload

{
  "startDate": "2025-01-01T00:00:00",
  "endDate": "2025-11-03T00:00:00",
  "return": 0
}

Fixed Income and Liability Queries

Endpoint: /api/v1/getclientinvestiblefixedreturnproducts

Method: GET

• returns the client's investible fixed return products

Sample Respond Payload

[
  {
    "portfolioName": "AGRIC",
    "clientPortfolioCode": null,
    "portfolioType": 9,
    "myProduct": false,
    "portfolioId": 830,
    "productMandate": "Grow your money into profits and get 50% returns ",
    "portfolioTypeName": "liability",
    "minimumHoldingPeriod": 0,
    "minimumInvestment": 0,
    "minimumSubsequentInvestment": 0,
    "custodianName": "iTap Custodian",
    "earlyRedemptionPenaltyRate": null,
    "assetClassInfo": null,
    "currency": "NGN",
    "currentValue": 0,
    "cost": 0,
    "bidPrice": 0,
    "offerPrice": 0,
    "return": 0,
    "subProducts": [
      {
        "productId": 5,
        "securityProductId": 452,
        "productName": "Agricultural Products",
        "rateGuide": [
          {
            "tenor": 30,
            "rate": 10.5,
            "faceValueStartRange": 1000,
            "faceValueEndRange": 5000000
          },
          {
            "tenor": 60,
            "rate": 11.5,
            "faceValueStartRange": 100000,
            "faceValueEndRange": 5000000
          }
        ]
      },
      {
        "productId": 6,
        "securityProductId": 452,
        "productName": "AGRIC (USD)",
        "rateGuide": [
          {
            "tenor": 60,
            "rate": 20,
            "faceValueStartRange": 0,
            "faceValueEndRange": 0
          }
        ]
      }
    ]
  }
]

Endpoint: /api/v1/getfixedincomeproductbalances/{portfolioid}

Method: GET

• returns the client's product balance as at the last valuation

query params {portfolioid} => portfolioId from /api/v1/getclientinvestiblefixedreturnproducts

Sample Respond Payload

[
  {
    "faceValue": 0,
    "interestRate": 0,
    "accruedInterest": 0,
    "currentValue": 0,
    "tenor": 0,
    "reportDate": "2026-11-03T11:15:03.905Z",
    "valueDate": "2026-11-03T11:15:03.905Z",
    "maturityDate": "2026-11-03T11:15:03.905Z",
    "currency": "string",
    "isSold": true,
    "referenceNo": "string",
    "status": "string",
    "schemeId": 0
  }
]

Field	Description
faceValue	Face value of investment
interestRate	Interest rate
accruedInterest	Accrued Interest
currentValue	Current value of investment
tenor	Tenor
reportDate	Report date. Usually the last valuation date
valueDate	Investment value date
maturityDate	Investment maturity date
currency	Investment currency
isSold	Flag to determine if investment has been sold
referenceNo	Investment unique reference number
status	status
schemeId	Investment portfolio id

Endpoint: /api/v1/getfixedincomeproductonlinebalances/{portfolioid}

Method: GET

• returns the client's product online balance

query params {portfolioid} => portfolioId from /api/v1/getclientinvestiblefixedreturnproducts

Sample Respond Payload

[
  {
    "valueDate": "2026-11-03T11:28:35.790Z",
    "interestRate": 0,
    "maturityDate": "2026-11-03T11:28:35.790Z",
    "referenceNo": "string",
    "faceValue": 0,
    "currentValue": 0
  }
]

Endpoint: /api/v1/getliabilityproductpreliquidationcharges

Method: GET

• returns liability product preliquidation charges for individual and cooperate client

Sample Respond Payload

[
  {
    "portfolioId": 0,
    "portfolioName": "string",
    "individualChargeRate": 0,
    "cooperateChargeRate": 0,
    "clientType": "string"
  }
]

Endpoint: /api/v1/getliabilityproducts/{portfolioid}

Method: GET

• Get list of liability products

query params {portfolioid} => portfolioId from /api/v1/getclientinvestiblefixedreturnproducts

Sample Respond Payload

[
  {
    "product": "string",
    "productSecurity": "string",
    "schemeCode": "string",
    "description": "string",
    "securityProductId": 0,
    "productId": 0,
    "currency": "string"
  }
]

Endpoint: /api/v1/getproducttenor/{productid}

Method: GET

• Get list of product rate and tenor for fixed income investment.

query params {productid} => productid from /api/v1/getliabilityproducts/{portfolioid}

Sample Respond Payload

[
  {
    "tenor": 0,
    "interestRate": 0,
    "faceValueStartRange": 0,
    "faceValueEndRange": 0
  }
]

Endpoint: /api/v1/getproductrateguide/{productid}

Method: GET

• Get product rate guide showing investment principal, rate and tenor

query params {productid} => productid from /api/v1/getliabilityproducts/{portfolioid}

Sample Respond Payload

[
  {
    "principalRange": "0.00 - 0.00",
    "rates": {
      "180": "15%"
    }
  },
  {
    "principalRange": "1,000.00 - 5,000,000.00",
    "rates": {
      "30": "10.5%"
    }
  },
  {
    "principalRange": "50,000.00 - 5,000,000.00",
    "rates": {
      "90": "19%"
    }
  },
  {
    "principalRange": "100,000.00 - 5,000,000.00",
    "rates": {
      "60": "11.5%"
    }
  }
]

Endpoint: /api/v1/gettotalcashinvestedinliabilityproduct/{portfolioid}/{startdate}/{enddate}

Method: GET

• Get total cash invested / withdrawn from a liability portfolio

query params {portfolioid} => portfolioId from /api/v1/getclientinvestiblefixedreturnproducts

Sample Respond Payload

[
  {
    "schemeId": 830,
    "currencyCode": "NGN",
    "openingBalance": -7642.84,
    "totalInvestedAmount": 248930000,
    "totalWithdrawnAmount": -229629555.28,
    "closingBalance": 100000.99
  }
]

Client Portfolio Queries

Endpoint: /api/v1/getclientportfoliobalances

Method: GET

• returns the client's portfolio monthly balances

Sample Respond Payload