Virtual Account Services
  1. Account
Virtual Account Services
  • Introduction
  • Terminologies
  • Webhooks
  • Authentication
  • Account
    • Create Account
      POST
    • Rename Account
      POST
    • Balance Inquiry
      GET
    • Create Bulk Accounts
      POST
    • List Accounts
      GET
  • Transaction
    • Credit Account
      POST
    • Debit Account
      POST
    • Credit Account [Agency Banking]
      POST
    • Debit Account [Agency Banking]
      POST
    • Transaction Query
      GET
    • Transaction Details
      GET
    • Transaction History
      GET
  • Transfer
    • Get Institutions
      GET
    • Name Inquiry
      POST
    • Interbank Transfer
      POST
    • Interbank Transfer [Sync]
      POST
    • Transfer Query
      GET
    • Transfer Enquiry
      GET
    • Virtual Account Intrabank Transfer
      POST
    • Core Banking Intrabank Transfer
      POST
    • Collection Accounts Intrabank Transfer
      POST
  • Invoice
    • Create Invoice
      POST
    • Get Invoice Detail
      GET
    • List Merchant Invoices
      GET
  • Refunds
    • Initiate Refund
    • Get Refund Status
    • Get Refunds
  • Notifications
    • Notification
    • Send Notification
  • Merchant
    • Account
      • Get Account
      • Activate Sub Ledger For Merchant
      • Get SubLedger Callback Urls
      • Set SubLedger Callback Urls
      • Get Collection Accounts
    • Transfer
      • Get Transfer History
      • Get Subledger transfers
      • Get Transfer Details
      • Name Inquiry
    • Refund
      • Refund Details
  • Admin
    • Accounting
      • Get GL Accounts
      • Get Classification Codes
    • Dashboard
      • Dashboard Summary
      • Dashboard Transactions
      • Dashboard Transaction Details
    • Group Codes
      • Get Group Codes
      • Set Collection Account
      • Create Group Code
    • Reporting
      • Get Report Types
      • Get Report Parameters
      • Create Report
      • Get Reports
      • Get Reports Details
  1. Account

List Accounts

GET
/accounts/{externalId}
This API retrieves a list of accounts associated with a given groupCode (external ID). The response includes account details such as name, BVN, and account ID.

Request Body#

Field NameTypeRequiredDescription
externalIdstringTRUEThe unique identifier used to retrieve the associated accounts. It is same as the Group Code.

Query Parameters#

Field NameTypeRequiredDescription
pageintegerFALSEThe page number for paginated results.
itemsintegerFALSEThe number of accounts to return per page.

Response Body#

Field NameTypeDescription
namestringThe name associated with the account.
mainLedgerbooleanIndicates whether the account is a main ledger account.
bvnstringThe Bank Verification Number linked to the account.
accountIDstringThe unique identifier assigned to the account.

Request

Path Params

Query Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/accounts/LRBRWEAJXM?page=5&items=1000'

Responses

🟢200List Accounts
application/json
Body

Example
[
    {
        "name": "KEDCO Prepaid - 30530363313",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032834"
    },
    {
        "name": "KEDCO Prepaid - 30530166922",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032810"
    },
    {
        "name": "KEDCO Prepaid - 322247036101",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032793"
    },
    {
        "name": "KEDCO Prepaid - 322247182201",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032779"
    },
    {
        "name": "KEDCO Prepaid - 322247014701",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032755"
    },
    {
        "name": "KEDCO Prepaid - 322764040701",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032731"
    },
    {
        "name": "KEDCO Prepaid - 322247027201",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032717"
    },
    {
        "name": "KEDCO Prepaid - 322247757501",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032690"
    },
    {
        "name": "KEDCO Prepaid - 322247490301",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032676"
    },
    {
        "name": "KEDCO Prepaid - 322247797701",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032652"
    },
    {
        "name": "KEDCO Prepaid - 0179000265019",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032638"
    },
    {
        "name": "KEDCO Prepaid - 30530336590",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032614"
    },
    {
        "name": "KEDCO Prepaid - 349922025701",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032597"
    },
    {
        "name": "KEDCO Prepaid - 322803131301",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032573"
    },
    {
        "name": "KEDCO Prepaid - 04216281081",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032559"
    },
    {
        "name": "KEDCO Prepaid - 04216095556",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032535"
    },
    {
        "name": "KEDCO Prepaid - 94100493363",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032511"
    },
    {
        "name": "KEDCO Prepaid - 57150056604",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032494"
    },
    {
        "name": "KEDCO Prepaid - 0137200175743",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032470"
    },
    {
        "name": "KEDCO Prepaid - 0150000839111",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032456"
    },
    {
        "name": "KEDCO Prepaid - 30530109054",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032432"
    },
    {
        "name": "KEDCO Prepaid - 30530067229",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032418"
    },
    {
        "name": "KEDCO Prepaid - 58000082089",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032391"
    },
    {
        "name": "KEDCO Prepaid - 30530305728",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032377"
    },
    {
        "name": "KEDCO Prepaid - 62320127780",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032353"
    },
    {
        "name": "KEDCO Prepaid - 30530338190",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032339"
    },
    {
        "name": "KEDCO Prepaid - 30510067892",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032315"
    },
    {
        "name": "KEDCO Prepaid - 04176590786",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032298"
    },
    {
        "name": "KEDCO Prepaid - 62130281512",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032274"
    },
    {
        "name": "KEDCO Postpaid - 344476505001",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032250"
    },
    {
        "name": "KEDCO Prepaid - 349910019801",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032236"
    },
    {
        "name": "KEDCO Prepaid - 349910018901",
        "mainLedger": false,
        "bvn": "22174212216",
        "accountID": "9900032212"
    },
    {
        "name": "KEDCO Prepaid - 349910017001",
        "mainLedger": false,
Modified at 2025-04-02 10:48:11
Previous
Create Bulk Accounts
Next
Credit Account
Built with