TeePayDocs
API ReferenceControl numbers

List Control Numbers

GET
/v1/control-numbers

Your Control Numbers with amounts collected and remaining. Requires control_number:read.

Authorization

BearerAuth
headerAuthorizationBearer <token>

Secret API key: tp_test_. or tp_live_.. Server-side only.

Query Parameters

cursor?string
Formatuuid

Response Body

Page of Control Numbers

Example Request
curl -X GET 'https://api.teepay.me/v1/control-numbers'
Example Response
Empty

Get a Control Number GET

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.

Quote a payout POST

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.