TeePayDocs
Control Numbers

Control Number payments

List your Control Numbers and read the verified payments made to each one.

GET/v1/control-numberscontrol_number:read

Returns { "object": "list", "data": [...], "next_cursor": ..., "can_create": ... }. Each item has number, kind, amount_minor, collected_minor, remaining_minor, status, payment_count and created_at. can_create tells you whether your account may issue numbers now. Page with ?cursor= using next_cursor.

GET/v1/control-numbers/{id}control_number:read
{
  "id": "22222222-2222-4222-8222-222222222222",
  "object": "control_number",
  "number": "991234567890",
  "kind": "bill",
  "currency": "TZS",
  "amount_minor": "5000000",
  "collected_minor": "2000000",
  "remaining_minor": "3000000",
  "status": "active",
  "payment_count": 2,
  "created_at": "2026-10-20T08:00:00Z",
  "payments": [
    {
      "id": "6f0c…",
      "status": "verified",
      "received_at": "2026-10-28T09:12:03Z",
      "reference": "TP-1",
      "amount_minor": "2000000",
      "fee_minor": "40000",
      "paid_at": "2026-10-28T09:12:00Z"
    },
    { "id": "a91d…", "status": "pending_verification", "received_at": "2026-10-28T11:40:10Z" }
  ]
}
Payment statusMoney receivedAmount shown
verifiedYes, ledger-postedYes
pending_verificationNot yetNo
under_reviewNot yetNo

Webhooks

A verified payment sends payment.completed with:

"source": { "type": "control_number", "id": "22222222-2222-4222-8222-222222222222", "control_number": "991234567890" }

Use source.id to find your invoice and data.money.amount_minor for the amount paid. A bill can be paid in several installments; each one sends its own webhook.

On this page