Balance Inquiry

The API allows the merchant to check the balance(s) for the different currencies they might hold.

GET https://gwapisdbx.ellypayapp.com/data/wallet-balances

The endpoint retrieves the balance(s) by currency. It return currency wallets belonging to the merchant account

Query Parameters

Name	Type	Description
currency	String	The currency whose balances should be retrieved (Optional)

Headers

Name	Type	Description
public-key*	String	The merchant account Public Key
secret-key*	String	The merchant account Secret Key

Sample Balance Inquiry Request

curl https://gwapisdbx.ellypayapp.com/data/wallet-balances \
   -H "Accept: application/json" \
   -H "x-api-version: 1" \
   -H "public-key: your-public-key" \
   -H "secret-key: your-secret-key"

200: OK Returns array of wallet balances based on the currency

{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": {
        "merchant_wallets": [
            {
                "available_balance": 40000,
                "actual_balance": 40000,
                "currency": "UGX",
                "uncleared_balance": 40000,
                "reserve_balance": 0,
                "wallet_type": "MERCHANT_COLLECTION"
            },
            {
                "available_balance": 0,
                "actual_balance": 0,
                "currency": "UGX",
                "uncleared_balance": 0,
                "reserve_balance": 0,
                "wallet_type": "MERCHANT_PAYOUT"
            }
        ]
    }
}

400: Bad Request When the request isn't formed as expected

{
  "code": 400,
  "status": "error",
  "message": "secret-key is required",
  "data": {}
}

401: Unauthorized When one of the keys is invalid

{
  "code": 401,
  "status": "error",
  "message": "Unauthorized API access. Invalid Merchant Secret Key",
  "data": {}
}

Wallet Types

Wallet Type	Description
MERCHANT_COLLECTION	This wallet holds funds accumulated from funds collection of a specific currency. Funds directly deposited into the merchant account for a gievn currency would also live in a wallet of this type.
MERCHANT_PAYOUT	All the funds the merchant accout wishes to designate for disbursements will be stored in a special wallet of this type. The merchant will be allowed to provision funds here by transferrig from the collection account to this one.
SERVICE_PAYMENTS	All the funds the merchant accout wishes to designate for service/biller payments (e.g. Utilities. PayTV, Airtime etc) will be stored in a special wallet of this type. The merchant will be allowed to provision funds here by transferrig from the collection account to this one.

Balance Descriptions

Balance Name	Description
available_balance	The amount/balance available for use. This the amount the merchant account has access to for any other platform operations
actual_balance	This is the total balance of a given currency for a certain merchant account wallet. It's the summation of all the balances in the given wallet.
uncleared_balance	This is the amount yet to be made available to the merchant account for use.
reserve_balance	In the event transactions are done using payment options for which a rolling reserve is implemented (e.g. card options), the accumulated rolling reserve amounts would be deposited under this balance