Skip to main content
POST
/
api
/
v1
/
payouts
Create Payout
curl --request POST \
  --url https://meet.briq.tz/api/v1/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 20000,
  "currency": "TZS",
  "channel": "mobile",
  "phone": "255700000000",
  "network": "VODACOM",
  "reference": "PAYOUT_001"
}
'
{
  "id": "<string>",
  "status": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key obtained from the merchant dashboard. When using the 'Try It' feature, enter only the key—the 'Bearer ' prefix is added automatically. For direct API calls, the 'Authorization: Bearer ' format is mandatory.

Headers

​
Idempotency-Key
string<uuid>
required

A unique UUID to prevent duplicate transactions. Retrying a request with the same key will return the previous result.

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
​
amount
number
required
​
currency
enum<string>
default:TZS
required
Available options:
TZS
​
channel
enum<string>
required
Available options:
mobile,
bank
​
phone
string
required
​
network
enum<string>
Available options:
VODACOM,
AIRTEL,
TIGO,
HALOTEL,
TTCL
​
reference
string

Response

200 - application/json

Payout initiated successfully

​
id
string
​
status
string