Account Balance

This enables you to get the PesaWay Wallet Balance. You can query for the balance as follows:

Test Endpoint:

Alt test Endpoint: https://api.sandbox.pesaway.com/api/v1/account-balance/

Expected request parameters:

Field	Type	Description	Example
MerchantCode	Alpha-Numeric	The internal wallet account number to query.	"PHY0000000000G7"
Currency	Alpha-Numeric	The currency code of the wallet account. If omitted, the API uses the region's default currency.	"TZS"

Request Sample

curl --location --request POST 'https://api.sandbox.pesaway.com/api/v1/account-balance/' \
--header 'X-Region: ke' \
--data-raw '{
    "MerchantCode": "PHY0000000000G7",
    "Currency": "TZS"
  }'

Response Sample

{
  "available": "50000.0",
  "currency": "KES"
}

Response Parameters

Response Parameters	Field Type Description
available	Balance available / accessible for disbursement / payout

TIP

Alway include the X-Region header on all requests. The right X-Region can be found on the Supported Regions / Countries menu