Docs · Core concepts

Credits

Every send uses credits from one wallet. Top up with M-Pesa or card, from 100 credits.

FieldMeaning

balanceCredits you can spend now

reservedCredits held for scheduled and queued sends

Topping up from code

POST /v1/credits/purchase/mpesa sends an M-Pesa prompt to the phone you give. Check the result with GET /v1/credits/purchase/{invoiceId}.

Tip: Turn on the low-credit alert in notification settings so a campaign never stops halfway because the wallet ran dry.

Running out

If a send costs more than your balance you get a 402 with insufficient_credits. Nothing is sent and nothing is charged.

Top up with M-Pesa

curl https://api.talks.africa/v1/credits/purchase/mpesa \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"credits": 10000, "phone_number": "+254712345678"}'

Response

{
  "invoice_id": "inv_8Kq1",
  "status": "pending",
  "credits": 10000
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Was this page helpful?