Core Banking Services
  1. Account
Core Banking Services
  • Introduction
  • Terminologies
  • Webhooks
  • Authentication
  • Account
    • Product List
      GET
    • Create Account
      POST
    • Find Client
      POST
    • Accounts
      GET
    • Create Additional Account
      POST
    • Account Details By BVN
      GET
    • Get Client Addresses
      GET
    • Get Account Details
      GET
    • Get Account Summary
      GET
    • Client Images
      GET
    • Update BVN
      POST
    • Update Transaction Limit
      POST
  • KYC
    • Get KYC Info
      POST
    • Update KYC
      POST
  • Transaction
    • Payment Types
      GET
    • Debit Account
      POST
    • Credit Account
      POST
    • Transaction History
      GET
    • Transaction Details
      GET
  • Transfer
    • Get Institutions
      GET
    • Name Inquiry
      POST
    • Interbank Transfer
      POST
    • InterBank Transfer Query
      GET
    • Transfer Details
      GET
    • IntraBank Transfer
      POST
    • Intrabank Transfer To Virtual Accounts
      POST
  • Reporting
    • Report Types
    • Get Report Parameters
    • Create Report
    • Report Details
    • Get Reports
  1. Account

Get Account Summary

GET
/core/summary/{clientId}
This API retrieves a summary of all accounts linked to a specific client, providing key details such as account types, balances, and statuses.

Path Parameter#

Field NameTypeRequiredDescription
clientIdintegerTRUEUnique identifier of the client whose accounts are being retrieved

Response Body#

The response is a JSON object containing summary of the client’s list of accounts and transactions.
Field NameTypeDescription
accountsarrayAn array of client's accounts
recentTransactionsarrayAn array of recently performed transactions
weeklyTransactionSummaryobjectA count of completed, failed, pending transactions etc
totalCurrentBalancenumberThe total current balance in the account
totalAvailableBalancenumberThe total available balance in the account

Request

Path 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 '/core/summary/1'

Responses

🟢200Success
application/json
Body

Example
{
    "accounts": [
        {
            "id": 1,
            "firstname": "CHRISTIAN ONYEMA",
            "lastname": "EBIRIMSON",
            "nuban": "1100000011",
            "currentBalance": 168283.3,
            "availableBalance": 168283.3,
            "productId": 101,
            "subLedgerActivated": false,
            "accountName": "CHRISTIAN ONYEMA EBIRIMSON",
            "productName": "FullRange Savings account",
            "coreBankingAccountId": 1
        },
        {
            "id": 16388,
            "firstname": "CHRISTIAN ONYEMA",
            "lastname": "EBIRIMSON",
            "nuban": "0000000147",
            "currentBalance": 100000,
            "availableBalance": 100000,
            "productId": 136,
            "subLedgerActivated": false,
            "accountName": "CHRISTIAN ONYEMA EBIRIMSON",
            "productName": "savingtest",
            "coreBankingAccountId": 16388
        }
    ],
    "totalCurrentBalance": 268283.3,
    "totalAvailableBalance": 268283.3,
    "recentTransactions": [
        {
            "id": 2507104,
            "nuban": "0000000147",
            "amount": 100000,
            "transactionType": "Deposit",
            "balance": 100000,
            "createdDate": "2024-07-24T19:39:17Z"
        },
        {
            "id": 2507105,
            "nuban": "1100000011",
            "amount": 60000,
            "transactionType": "Deposit",
            "balance": 168283.3,
            "createdDate": "2024-07-24T19:44:05Z"
        },
        {
            "id": 2507078,
            "nuban": "1100000011",
            "amount": 100000,
            "transactionType": "Deposit",
            "balance": 108283.3,
            "createdDate": "2024-07-24T15:54:12Z"
        },
        {
            "id": 153,
            "nuban": "1100000011",
            "amount": 1.35,
            "transactionType": "Escheat",
            "balance": 8283.3,
            "createdDate": "2024-04-30T00:00:00Z"
        },
        {
            "id": 152,
            "nuban": "1100000011",
            "amount": 13.5,
            "transactionType": "Interest posting",
            "balance": 8283.3,
            "createdDate": "2024-04-30T00:00:00Z"
        },
        {
            "id": 151,
            "nuban": "1100000011",
            "amount": 1.4,
            "transactionType": "Escheat",
            "balance": 8269.8,
            "createdDate": "2024-03-31T00:00:00Z"
        },
        {
            "id": 150,
            "nuban": "1100000011",
            "amount": 13.95,
            "transactionType": "Interest posting",
            "balance": 8269.8,
            "createdDate": "2024-03-31T00:00:00Z"
        },
        {
            "id": 149,
            "nuban": "1100000011",
            "amount": 1.3,
            "transactionType": "Escheat",
            "balance": 8255.85,
            "createdDate": "2024-02-29T00:00:00Z"
        },
        {
            "id": 148,
            "nuban": "1100000011",
            "amount": 13.05,
            "transactionType": "Interest posting",
            "balance": 8255.85,
            "createdDate": "2024-02-29T00:00:00Z"
        },
        {
            "id": 147,
            "nuban": "1100000011",
            "amount": 1.4,
            "transactionType": "Escheat",
            "balance": 8242.8,
            "createdDate": "2024-01-31T00:00:00Z"
        }
    ],
    "weeklyTransactionSummary": {
        "totalFailedTransactions": 0,
        "totalPendingTransactions": 0,
        "totalCompleted": 156,
        "totalCredits": 898097.5,
        "totalDebits": 630529.01
    }
}
Modified at 2025-03-19 15:01:59
Previous
Get Account Details
Next
Client Images
Built with