Skip to main content
GET
Get service wallet balance
Know your balance before payments fail. Monitor this proactively.

Service wallet

The service wallet holds pre-funded tokens used to pay PalPluss transaction fees. A fee is deducted each time you initiate an STK Push or B2C payout. If balance reaches zero, payment requests return 402 INSUFFICIENT_SERVICE_BALANCE — no payments process until you top up.

availableBalance vs ledgerBalance

These values are identical in most cases. They may differ briefly during high-throughput periods when multiple fee deductions are processing simultaneously.

Monitoring

Recommended approach:
  • Check balance before each batch of payments
  • Alert when balance drops below your minimum threshold (e.g. KES 500)
  • Trigger an automated top-up or notify your team when the threshold is breached

Authorizations

Authorization
string
header
required

Paste your PalPluss API key in the username field and leave the password field empty — it is ignored.

Get your key from console → Settings → API Keys (starts with pk_live_ or pk_test_).

In your own code, send the key directly: Authorization: Basic YOUR_API_KEY

Response

Service wallet balance.

success
boolean
required
Example:

true

data
object
required

Response payload. Shape varies by endpoint.

requestId
string<uuid>
required

Unique identifier for this API request. Include in support tickets.

Example:

"c1b2a3d4-e5f6-7890-abcd-ef1234567890"