List / Fetch Corporate Sub-accounts | Shimi API

{
  "status": "success",
  "message": "COOP subaccounts fetched",
  "data": [
    {
      "id": "cm9x5a1ce0009qy8l3fj7m2pz",
      "accountName": "ADEBAYO FOODS LIMITED",
      "accountNumber": "0115738294",
      "balance": 1250000.5,
      "status": "ACTIVE",
      "rn": "RC1234567",
      "createdAt": "2026-10-04T10:22:41.512Z"
    },
    {
      "id": "cm9w1z7hb0002pk4s8xq6t3dj",
      "accountName": "OKAFOR LOGISTICS LTD",
      "accountNumber": "0119482037",
      "balance": 0,
      "status": "ACTIVE",
      "rn": "RC7654321",
      "createdAt": "2026-10-01T15:08:12.004Z"
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 20,
    "total": 2,
    "totalPages": 1,
    "sort": "createdAt",
    "order": "desc"
  }
}

List your corporate sub-accounts, or fetch one directly with coporate_reference.

Query parameters

Param	Type	Required	Rules
`coporate_reference`	string	no	Sub-account id (`coporate_reference` from Create). When set, returns a single-item array. Must not be empty if sent.
`status`	string	no	`ACTIVE` or `DUPLICATE`. Default: both.
`page`	integer	no	>= 1, default 1.
`pageSize`	integer	no	1-100, default 20.
`sort`	string	no	`createdAt` (default) or `balance`.
`order`	string	no	`asc` or `desc` (default).

Important: empty query values are rejected - ?coporate_reference= returns 400 "coporate_reference" is not allowed to be empty. Omit/disable optional params you are not using. Unknown params are also rejected ("<param>" is not allowed). Only the first validation error is returned, as a plain message string.

Response balance is a number in NGN. meta is included on both list and single fetch.

Authentication

AuthorizationBearer

Access token from Generate Access Token (valid 15 minutes).

Query parameters

pagestringOptional

pageSizestringOptional

sortstringOptional

orderstringOptional

Response

List / Single (coporate_reference)

statusstringOptional

messagestringOptional

datalist of objectsOptional

metaobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error