API Reference
Overview
Every public TeePay endpoint with its parameters, request bodies, responses and code samples.
This reference is generated from the same contract the TeePay API is built and tested against, so it lists only endpoints that exist. Download it as OpenAPI 3.1 to generate a client or import it into Postman or Insomnia.
- Base URL
- https://api.teepay.me
- Version
- 2026-10-18 (TeePay-Version header)
- Authentication
- Authorization: Bearer <secret API key>
- Format
- JSON request and response bodies
| Group | Endpoints |
|---|---|
| Integration | API key details, capabilities |
| Collections | Mobile money push, list and read collections |
| Checkout sessions | Create, list and read hosted checkouts |
| Control Numbers | Create, list and read Control Numbers and their payments |
| Payouts | Quote, send, list and read payouts |
Every error uses the same envelope, described in Errors.