Skip to main content

​
Create a payout

POST /api/v1/payouts Idempotency-Key strongly recommended — honored when present (a retry with the same key returns the existing payout with 200). It is only mandatory on POST /api/v1/payments. Idempotency.
channelRequired fieldsOptional
mobilephonenetwork — auto-detected from the phone number when omitted
bankaccount, recipient_bank (SWIFT code)
Check your balance first — a payout that exceeds your available balance fails with 402 INSUFFICIENT_BALANCE, and amounts below your account’s minimum withdraw are rejected with 400 VALIDATION_ERROR. Payout webhooks use your merchant default URLs (not sent on this request).
Test keys (sk_test_*) cannot create payouts — POST returns 403 TEST_MODE_UNAVAILABLE. Read endpoints work with test keys.
curl -X POST "https://meet.briq.tz/api/v1/payouts" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"amount":20000,"currency":"TZS","channel":"mobile","phone":"255712345678","network":"vodacom","reference":"PAYOUT_001"}'

API reference

POST /api/v1/payouts

​
Get a payout

GET /api/v1/payouts/{id} 
curl -X GET "https://meet.briq.tz/api/v1/payouts/PAYOUT_ID" \
  -H "Authorization: Bearer YOUR_API_KEY"

API reference

GET /api/v1/payouts/

​
Refresh a payout

POST /api/v1/payouts/{id}/refresh — re-queries the payout status on demand and returns the updated payout. Returns 502 PROVIDER_ERROR if the upstream network is temporarily unavailable. 
curl -X POST "https://meet.briq.tz/api/v1/payouts/PAYOUT_ID/refresh" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Payout events

GET /api/v1/payouts/{id}/events — status history for a payout. Each event has id, transaction_id, status, message, actor_type, and created_at. 
curl -X GET "https://meet.briq.tz/api/v1/payouts/PAYOUT_ID/events" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
List payouts

GET /api/v1/payouts — query params page and per_page. 
curl -X GET "https://meet.briq.tz/api/v1/payouts?page=1&per_page=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

API reference

GET /api/v1/payouts