Send one payout
Pay one Wave or Afrimoney wallet.
Send many at once
Up to 1,000 payouts in one request.
Check the fee first
Know the exact cost before you send.
Reverse a payout
Pull back a Wave payout sent to the wrong person.
How a payout works
1
You send the request
With the amount, network, wallet number, the person’s name and a unique
Idempotency-Key.2
We check it
Your balance must cover the amount plus the fee. We also run fraud and limit checks.
3
We send the money
The amount and fee leave your payout balance and the money goes to the wallet, usually within seconds.
4
You get the result
A
transfer.succeeded or transfer.failed webhook. If a payout fails, the money goes back to your balance.Where you can send money
To get the current list for your account, call
GET /v1/transfers/payout-channels.
The transfer object
Webhooks
Protect your balance
Use a restricted key with payout limits
Use a restricted key with payout limits
Create a key with only the
transfers permission, a per-payout limit and a daily limit, and lock it to your servers’ IP addresses. Even if it leaks, the damage is capped. See API keys.Always send an Idempotency-Key
Always send an Idempotency-Key
If your request times out and you retry with the same key, we won’t pay twice.
Watch for transfer.flagged
Watch for transfer.flagged
Flagged payouts need your review in the dashboard before more money can go to that number.
