# TeePay Docs

> Accept mobile money, hosted checkout and Control Number payments, send payouts and connect AI agents with the TeePay API.

- OpenAPI: https://docs.teepay.me/openapi.json

- [MCP server](https://docs.teepay.me/docs/ai/mcp): Let AI agents and chat automations create real TeePay checkout links and read verified payment status.
- [MCP tools](https://docs.teepay.me/docs/ai/tools): The tools TeePay's MCP server exposes and what each one may do.
- [WhatsApp ordering](https://docs.teepay.me/docs/ai/whatsapp): Take orders in WhatsApp with an AI assistant and get paid through TeePay checkout.
- [Overview](https://docs.teepay.me/docs/api-reference): Every public TeePay endpoint with its parameters, request bodies, responses and code samples.
- [Create a Control Number](https://docs.teepay.me/docs/control-numbers/create): Issue bill and customer Control Numbers through the API.
- [Control Numbers](https://docs.teepay.me/docs/control-numbers): Tanzanian bill and customer reference numbers, and how TeePay verifies payments made to them.
- [Control Number payments](https://docs.teepay.me/docs/control-numbers/payments): List your Control Numbers and read the verified payments made to each one.
- [Authentication](https://docs.teepay.me/docs/getting-started/authentication): Secret API keys, scopes, rotation and how TeePay authorises every request.
- [Environments](https://docs.teepay.me/docs/getting-started/environments): Live and test keys, and how to discover which features your account can use.
- [Go-live checklist](https://docs.teepay.me/docs/getting-started/go-live): Everything to verify before you take real customer payments.
- [How TeePay works](https://docs.teepay.me/docs/getting-started/how-teepay-works): The payment lifecycle, who confirms a payment and when it is safe to deliver.
- [Introduction](https://docs.teepay.me/docs/getting-started): What the TeePay API does, how it is organised and the conventions every request follows.
- [Quickstart](https://docs.teepay.me/docs/getting-started/quickstart): Create an API key, check your access and take your first payment with a hosted checkout.
- [API versioning](https://docs.teepay.me/docs/getting-started/versioning): How TeePay versions its API and how to pin your integration.
- [Errors](https://docs.teepay.me/docs/integrations/errors): The error format, every error code and how to handle each one.
- [Idempotency](https://docs.teepay.me/docs/integrations/idempotency): Retry safely without creating duplicate payments, numbers or payouts.
- [Pagination](https://docs.teepay.me/docs/integrations/pagination): How list endpoints page through results with cursors.
- [Rate limits](https://docs.teepay.me/docs/integrations/rate-limits): Request limits, the headers that report them and how to back off.
- [Security](https://docs.teepay.me/docs/integrations/security): How to protect your keys, your customers and your webhook endpoint.
- [Webhooks](https://docs.teepay.me/docs/integrations/webhooks): Receive signed notifications when payments and payouts complete, fail or are reversed.
- [Checkout sessions](https://docs.teepay.me/docs/payments/checkout-sessions): Create a TeePay hosted checkout page from your server and redirect your customer to it.
- [Countries and currencies](https://docs.teepay.me/docs/payments/countries-and-currencies): How TeePay markets work, how to discover them at runtime, and how amounts, phone numbers and currency conversion behave in each country.
- [Payments overview](https://docs.teepay.me/docs/payments): Choose between mobile money push, hosted checkout, payment links and Control Numbers.
- [Mobile money push](https://docs.teepay.me/docs/payments/mobile-money): Send a USSD payment prompt to a customer's phone and confirm the result from your server.
- [Payment links](https://docs.teepay.me/docs/payments/payment-links): Shareable fixed-amount payment pages from the dashboard or the Link API.
- [Payment status](https://docs.teepay.me/docs/payments/payment-status): How to read a payment's status, poll responsibly and treat final states.
- [Payouts](https://docs.teepay.me/docs/payouts): Quote and send money from your TeePay balance to mobile wallets and bank accounts.
- [Feature availability](https://docs.teepay.me/docs/resources/availability): What is available today, what needs approval and what is not available yet.
- [Changelog](https://docs.teepay.me/docs/resources/changelog): Changes to the TeePay API and documentation.
- [FAQ](https://docs.teepay.me/docs/resources/faq): Answers to common integration questions.
- [Glossary](https://docs.teepay.me/docs/resources/glossary): Terms used throughout the TeePay documentation.
- [Support](https://docs.teepay.me/docs/resources/support): How to get help with your TeePay integration.
- [List collections](https://docs.teepay.me/docs/api-reference/collections/list-collections): Your account's collections, newest first, filterable by status and currency. Requires collection:read.
- [Create a mobile money payment](https://docs.teepay.me/docs/api-reference/collections/create-collection): Sends a USSD payment prompt to the customer's phone. The customer approves it with their mobile money PIN. A 202 response means the request was accepted, not that the customer paid: read the collection or wait for the payment.completed webhook. customer.country and money.currency must be a pair your key can use (see Get capabilities); otherwise the error is unsupported_market. Requires collection:create and mobile money push enabled for your account.
- [Get a collection](https://docs.teepay.me/docs/api-reference/collections/get-collection): One collection by its public_reference. Poll this after creating a mobile money payment until status is succeeded or failed. Requires collection:read.
- [Get capabilities](https://docs.teepay.me/docs/api-reference/integration/get-capabilities): Returns which features this key can use right now, and the countries and currencies it can collect in (supported_countries, supported_currencies). A feature is true only when the key has the scope, the account has the permission and TeePay has enabled the feature for the account. Read this instead of hard-coding markets: new countries appear here when TeePay enables them.
- [Get API key details](https://docs.teepay.me/docs/api-reference/integration/get-api-key): Returns the application, environment, scopes and prefix of the key making the request. Works with any valid key and never returns the secret.
- [Quote a payout](https://docs.teepay.me/docs/api-reference/payouts/create-payout-quote): Prices a payout to a mobile wallet or bank account. A quote does not send money. It expires after two minutes and must be confirmed with Create a payout. Requires disbursement:create and approved payouts.
- [List payouts](https://docs.teepay.me/docs/api-reference/payouts/list-payouts): Your account's payouts, newest first. Requires disbursement:read.
- [Create a payout](https://docs.teepay.me/docs/api-reference/payouts/create-payout): Confirms a valid quote and sends the payout. Your balance is reserved for the amount plus the fee before the payout is sent. If the outcome is uncertain (202), read the payout and never retry with a new idempotency_key. Requires disbursement:create.
- [Get a payout](https://docs.teepay.me/docs/api-reference/payouts/get-payout): One payout by its TeePay reference. Requires disbursement:read.
- [List Control Numbers](https://docs.teepay.me/docs/api-reference/control-numbers/list-control-numbers): Your Control Numbers with amounts collected and remaining. Requires control_number:read.
- [Create a Control Number](https://docs.teepay.me/docs/api-reference/control-numbers/create-control-number): Issues a Tanzanian Control Number (TZS) for a bill or a customer. 201 returns the number; 202 means issuance is still in progress, so retry with the same Idempotency-Key, never a new one. Requires control_number:create and approved Control Number access.
- [Get a Control Number](https://docs.teepay.me/docs/api-reference/control-numbers/get-control-number): One Control Number and the payments received on it. Only payments with status verified are money received; pending_verification and under_review are not. Requires control_number:read.
- [List checkout sessions](https://docs.teepay.me/docs/api-reference/checkout-sessions/list-checkout-sessions): Checkout sessions created through the API, newest first. Requires checkout:read.
- [Create a checkout session](https://docs.teepay.me/docs/api-reference/checkout-sessions/create-checkout-session): Creates a TeePay hosted checkout page for your account. Redirect the customer to checkout_url. A payment profile is optional: when given, or when your account has a default profile, its branding, return URL and webhook URL are used. Repeating the same Idempotency-Key and body returns the same session with the header Idempotent-Replayed: true. Requires checkout:create. 30 creations per account per minute.
- [Get a checkout session](https://docs.teepay.me/docs/api-reference/checkout-sessions/get-checkout-session): One checkout session. status becomes paid only after TeePay verified and ledger-posted the payment, and payment.reference is then set. Requires checkout:read.