TeePayDocs
API ReferencePayouts

Quote a payout

POST
/v1/disbursements/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.

Authorization

BearerAuth
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
money*
destination*|
narration*string
Lengthlength <= 500

Response Body

Server-issued, short-lived quote with id and total_minor

Example Request
curl -X POST 'https://api.teepay.me/v1/disbursements/quote' \  -H 'Content-Type: application/json' \  -d '{  "money": {    "amount": 2500000,    "currency": "TZS"  },  "destination": {    "channel": "mobile",    "name": "Juma Ali",    "phone": "255712345678"  },  "narration": "Supplier payment October"}'
Example Response
Empty

List Control Numbers GET

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

Create a payout POST

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.