Skip to content
Reference
/
/
Single fund account detai...

Single fund account detail (header + KPIs + cash allocation)

Request

🔒 Private label — contact sales. Requires a private-label entitlement on your API client.

Single fund account detail (header + KPIs + cash allocation)

Security
oauth2ClientCredentials(Required scopes: investments:read)
Path
fundAccountIdstringrequired
Query
refreshstringrequired
Headers
Idempotency-Keystring

Required on write endpoints (POST). UUID per submission. Middleware dedupes for 24h.

org_wallet_refstring
business_idstringrequired
curl -i -X GET \
  'https://developer.boyahq.com/_mock/v2/openapi/investments/accounts/{fundAccountId}?refresh=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Idempotency-Key: string' \
  -H 'business_id: string' \
  -H 'org_wallet_ref: string'

Responses

Bodyapplication/json
fund_account_idstringrequired

Customer's fund account ID

Example:"fa_01HXYZ..."
fund_idstringrequired

Catalogue fund ID

Example:"fund_britam_kes_mmf"
fund_namestringrequired
Example:"Britam KES Money Market Fund"
vendorstringrequired
Example:"BRITAM"
productstringrequired
Example:"MONEY_MARKET"
currencystringrequired
Example:"KES"
org_wallet_refstring

Organization wallet reference for this fund account currency.

Example:"1"
account_referencestring

External account reference (display-only)

Example:"BA100020873BOYA"
approval_refstring

Approval request reference for pending opt-in records.

Example:"INV-OPT-123456"
investment_wallet_idstring

Boya wallet id of the MMF investment account. Used by the dashboard as the destination when topping up the investment account from a business wallet.

Example:"I622957"
statestringrequired
Enum:"opt_in_pending""active""closing""opt_in_failed"
Example:"active"
investedobject(MoneyDto)required

Total invested principal (native currency)

wallet_available_balanceobject(MoneyDto)

Available cash in the investment wallet before it is invested with the custodian.

opt_in_datestring

Opt-in date (date-only, ISO 8601)

Example:"2024-08-12"
treasury_operatorsArray of strings

Employee ids permitted to transfer funds from this account (the wallet's employees_allowed_to_make_payments). Drives the Treasury Operators panel.

Example:
[
  "64f0a1b2c3d4e5f600112233",
  "64f0a1b2c3d4e5f600445566"
]
investment_permissionsArray of objects(InvestmentPermissionGrantDto)
available_balanceobject(MoneyDto)

Live Britam balance for the account (uncached upstream call).

pending_investmentobject(MoneyDto)

Aggregate pending-investment total awaiting custodian confirmation.

native_currencystringrequired

Currency of the native account totals.

Example:"KES"
Response
{
  "fund_account_id": "fa_01HXYZ...",
  "fund_id": "fund_britam_kes_mmf",
  "fund_name": "Britam KES Money Market Fund",
  "vendor": "BRITAM",
  "product": "MONEY_MARKET",
  "currency": "KES",
  "org_wallet_ref": "1",
  "account_reference": "BA100020873BOYA",
  "approval_ref": "INV-OPT-123456",
  "investment_wallet_id": "I622957",
  "state": "active",
  "invested": {
    "amount": 125000.5,
    "currency": "KES"
  },
  "wallet_available_balance": {
    "amount": 125000.5,
    "currency": "KES"
  },
  "opt_in_date": "2024-08-12",
  "treasury_operators": [
    "64f0a1b2c3d4e5f600112233",
    "64f0a1b2c3d4e5f600445566"
  ],
  "investment_permissions": [
    { … }
  ],
  "available_balance": {
    "amount": 125000.5,
    "currency": "KES"
  },
  "pending_investment": {
    "amount": 125000.5,
    "currency": "KES"
  },
  "native_currency": "KES"
}