Virtual Account Services
  1. Dashboard
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
    • Get Invoice Detail
    • List Merchant Invoices
  • 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
        GET
      • Dashboard Transactions
        GET
      • Dashboard Transaction Details
        GET
    • 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. Dashboard

Dashboard Summary

GET
/admin/dashboard/summary
This API provides a comprehensive summary of the dashboard, offering key insights and aggregated data relevant to the user's account. It retrieves essential metrics such as financial transactions, account balances, recent activities, and other critical indicators, enabling users to monitor performance and make informed decisions efficiently.

Response Body#

The response is a JSON object containing the following fields:
Field NameTypeDescription
totalOutwardTransactionAmountnumberThe total monetary value of all outgoing transactions.
totalInwardTransactionAmountnumberThe total monetary value of all incoming transactions.
totalAmountFromChargesnumberThe total amount generated from transaction charges.

Request

None

Request Code 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 '/admin/dashboard/summary'

Responses

🟢200Dashboard Summary
application/json
Body

Example
{
    "totalOutwardTransactionAmount": 17085304,
    "totalInwardTransactionAmount": 397443573,
    "totalAmountFromCharges": 0
}
🟢200Dashboard Summary
Modified at 2025-03-02 14:30:43
Previous
Get Classification Codes
Next
Dashboard Transactions
Built with