Opening Closing Balance

Opening and Closing Account Balance

Test URL

POSThttps://uat.finserve.africa/v3-apis/account-api/v3.0/accounts/accountBalance/query

Live URL

POSThttps://api.finserve.africa/v3-apis/account-api/v3.0/accounts/accountBalance/query

This web service enables an application or service retrieve the opening and closing balance of an account for a given date

Request Fields

The request body for the API should include the following fields:

Parameter	Type	Description	Example	Required
`countryCode`	string	ISO Alpha-2 country code of the account's location.	"KE"	Yes
`accountId`	string	The unique account number for which to retrieve the opening and closing balance.	"00201XXXX14605"	Yes
`date`	string	The date for which to retrieve the balances, in `YYYY-MM-DD` format.	"2023-10-13"	Yes

Example Request

⚠️

In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.

Signature Formulae e.g. 00201XXXX14605KE2023-10-13

accountId+countryCode+date

Example Request

curl -X POST \
	-d '{
    "countryCode": "KE",
    "accountId": "00201XXXX14605",
    "date": "2023-10-13"
}'  \
	-H 'Authorization: Bearer {access_token}'  \
	-H 'Content-Type: application/json'  \
	-H 'signature: e967CLKebZyLfa73/YYltjW5M4cHoyWeHi/5VDKJ64gOwKBvzHJRqJJrBBc34v2m4jyKkDMBtfRJeFlxbNisMAeBtkw0TRcD2LThFK27EOqLM3m8rQYa+7CJ2FhPhK+iOa4RUY+vTfkRX5JXuqOW7a3GHds8qyPaPe19cKUY33eAJL3upXnGnA3/PEhzjhb0pqk2zCI7aRzvjjVUGwUdT6LO73NVhDSWvGpLEsP0dH/stC5BoTPNNt9nY8yvGUPV7fmaPSIFn68W4L04WgePQdYkmD1UPApGcrl+L2ALY3lPaRfI6/N+0Y3NIWQyLgix+69k7V4EGolqejWdion+9A=='  \
	-L 'https://uat.finserve.africa/v3-apis/account-api/v3.0/accounts/accountBalance/query'

200 Success Response Schema

Field Name	Field Type	Field Description
`status`	`bool`	Response status
`code`	`number`	Response code
`message`	`string`	Response message
`data.balances`	`array`	balances list
`type`	`string`	balance type `end of day balance` `beginning of day balance`
`amount`	`string`	balance amount

Example Response

{
    "status": true,
    "code": 0,
    "message": "success",
    "data": {
        "balances": [
            {
                "amount": "0",
                "type": "Closing Balance"
            },
            {
                "amount": "0",
                "type": "Opening Balance"
            }
        ]
    }
}

Account Full Statement Account Inquiry