Connect your system to Wellth.
curl https://wellth.example/api/org/v1/ping \
-H "Authorization: Bearer wsk_test_…"{
"ok": true,
"school": "Demo High School",
"handle": "demohigh",
"mode": "test"
}What you can build.
/api/org/v1. Money is always a string of whole shillings, in UGX or KES.Collect by payment number
Each learner, patient or customer gets a permanent 10-digit number. Your system sends what they owe; anyone types the number and pays.
Pay links and pay codes
A one-off request for one balance: a link to send, an 8-character code to print, until a date you choose.
Bills
Send each invoice and let Wellth keep the balance. Payments go to the oldest bill first, and family can split one.
Payers
Make, read and retire payers. Labels are initials only: no names, no phone numbers, no diagnoses.
Remittance plans, read-only
A boda boda or taxi fleet's rider plans: daily amount, arrears, and progress to owning the bike.
Signed webhooks
Every payment, cancellation and expiry posted to your system at once, signed, and retried for a day and a half.
Test first, then live.
wsk_test_… and wsk_live_…
Ping tells you which you sent, and every webhook carries livemode, so your live system can ignore test events.
Opens country by country
Each organisation's key works once Wellth's licensed partner collects in its country and Tall Grass has checked it. Until then the API says why, in plain words.
The flow, in five steps.
- 1Get your keyThe owner opens Connect in the Wellth portal, saves your webhook address and makes the key. Key and signing secret are shown once.
- 2Test the connectionGET /api/org/v1/ping with the key as a Bearer token. It answers your name and test or live.
- 3Send who owes whatPUT each learner or payer with what they owe, or send bills. Wellth answers each one's payment number and pay link.
- 4People payBy number, link or code: mobile money at home, card or bank from abroad, or a Wellth balance. Their fee is on top; you get the full amount.
- 5Your system hears at onceA signed webhook for each payment. Book it once, then send the new balance listing its Wellth reference.
The docs.
- Keys and limitsGet a key, send it as a Bearer token, rotate it. Test and live, the rate limit, and why a key is refused.
- Payment numbersGive each learner, patient or customer a permanent 10-digit number and keep what they owe current.
- CollectionsOne-off pay links and 8-character pay codes for a single balance.
- BillsLet Wellth keep the balance: send each bill, and payments go to the oldest first.
- WebhooksEvery event, the Wellth-Signature header, retries, and verification code in Node.js, PHP and Python.
- ErrorsEvery status Wellth answers and the plain-words message that comes with it.
- TestingTest keys, demo organisations, and making a payment happen without real money.
- GuidesA school system, an education agency taking family payments, and a clinic or business system.