Query Merchant's Account Balance

This endpoint allows the merchant to check his/her account balance.To check account balance, the merchant must pass his/her merchant code as a query parameter.

Endpoint: https://sandbox.postapay.app/api/v1/payments/check-balance/?MerchantCode=40****9

The following parameters are expected:

Request Parameters

Field	Type	Description	Example
Authorization	Header	Bearer Auth over HTTPS, this is a base64 encoded string of an app's client ID and client secret	Authorization
MerchantCode	Numeric	A unique number used to identify a merchant/ organization registered with PostaPay.	60***80

Request Sample

Headers Key: Authorization
Value: Bearer Q1k2RW5SOGlsYUZnRzNGMk1DNIyZWs6QUlDS3VrTFhVV0xScFVHYQ==

Response Parameters

Field	Type	Description	Example
statusCode	Numeric	This is a numeric status code that indicates the status of the response. 0 means success and any other code means an error occurred or the request failed.Please refer to the response codes table above.	0
CurrencyCode	String	Standardization that defines alpha codes and numeric codes for the representation of currencies	KES
Accounts	List	List of merchant account labels and their balances.

Response Sample

{
  "statusCode": "0",
  "message": "Account Balances",
  "data": {
    "CurrencyCode": "KES",
    "OrgAccountBalance": 1000.0,
    "Accounts": [
      {
        "account_label": "Bulk Payment",
        "account_balance": 0.0
      },
      {
        "account_label": "Utility Account",
        "account_balance": 0.0
      },
      {
        "account_label": "Working Account",
        "account_balance": 1000.0
      }
    ]
  }
}