Fetch Program Balances

Call this end point to fetch the total program balance grouped by account types. Separate information is provided for ledger, available and suspense balance.

Request
Security:
path Parameters
version
required
string
query Parameters
program_guid
required
string <uuid>

Unique identifier of the program that is being queried upon.

Responses
200

Returns total program balance grouped by account types

400

Bad request

401

Unauthorized

404

Account not found

500

Server Error

get/api/{version}/accounts/balances
Request samples
curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/accounts/balances?program_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "account_type": "GENERAL",
  • "total_available_balance": 0,
  • "total_ledger_balance": 0,
  • "total_suspense_balance": 0
}
Copyright © 2023 KeyBank & Qolo. All rights reserved.