Pay out

Send money from your FlexPay balance to a customer's M-Pesa or Mixx by Yas wallet.

Before you pay outCopy Anchor Link

• Use a key with the payouts.write and payments.write scopes.
• Send at least 5,000 TZS.
• Keep enough balance for the amount plus the fee.

Create a payoutCopy Anchor Link

Create a payment with kind DISBURSEMENT:

curl -X POST "https://malipo.flex.co.tz/api/v1/payments" \
  -H "Authorization: Bearer <token>" \
  -H "Idempotency-Key: 8d2f4a1c-6b3e-4f7a-9c0d-1e2f3a4b5c6d" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "DISBURSEMENT",
    "provider": "MPESA",
    "amount": 10000,
    "currency": "TZS",
    "customerPhoneNumber": "255700000001",
    "merchantReference": "payout-1042"
  }'

Then act on the outcome as for a collection.

Your balanceCopy Anchor Link

The amount plus the fee leaves your available balance as soon as the payout is sent, and the payout's net is minus (amount plus fee).

• On payment.succeeded, the money is gone.
• On payment.failed, you have it back.
• If your balance is too low, the payout fails with failureCode INSUFFICIENT_BALANCE and nothing leaves it.

ErrorsCopy Anchor Link

A payout cannot be reversed. If one went to the wrong person, contact support with its id.