This web service enables an application or service retrieve the current and available balance of an account.

PATH PARAMS

Parameter	Data Type	Description	Required
customer_code	alphanumeric	Business code assigned by Pokea Pay	Y
account_no	alphanumeric	Business code assigned by Pokea Pay	Y
currency	string	Currency Type (USD or KES) * KES By Default	Y

HEADER PARAMS

Parameter	Data Type	Description	Required
Authorization	alphanumeric	bearer token used to access the API	Y
signature	alphanumeric	A SHA-256 signature to proof that this request is coming from the merchant. Build a String of concatenated values of the request fields with the following order: customer_code, account_no,currency. The resulting text is then signed with Private Key and Base64 encoded.	Y

200 Success Response Schema

Parameter	Data Type	Description
code	numeric	Response code
message	string	Response message.
account.balance	numeric	account balances.
account.currency	string	account currency.
account.account_no	alphanumeric	account number.

Example Request

                                    
curl --location --request GET 'https://here-prod-api-url.com/account/balance/{customer_code}/{account_no}/{currency}'
--header 'Accept: application/json'
--header 'Content-Type: application/json'
--header 'signature: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ '
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ-'
                                    
                                

Example Response

                                    
{
    "code": 0,
    "success": true,
    "message": "SUCCESS",
    "account": {
        "balance": "545.00",
        "currency": "KES",
        "account_no": "38180856"
    }
}