Beneficiaries
Pre-register frequent payout recipients to simplify and speed up your Transfers calls.
6 min read
A beneficiary is a saved Mobile Money or bank recipient — save one once, then reference it
by id on every future Transfer instead of re-entering the recipient's
details each time.
When to use beneficiaries
- Recurring payouts — salaries, freelancer retainers, or any recipient you pay more than once. Save them once, transfer many times.
- Reducing input errors — a saved beneficiary's phone number or bank account is validated once at creation, not re-typed (and potentially mistyped) on every transfer.
- Looping over many recipients — since there is no bulk/batch payout endpoint
today, distributing funds to many people means calling
POST /transfersonce per recipient. Pre-registering them as beneficiaries keeps each of those calls small and consistent.
Creating a beneficiary
curl https://api.wajub.com/beneficiaries \
-H "Authorization: sk.xxxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Amina Diallo",
"phone_number": "+221770000000",
"channel": "sn.orange"
}'Paying a beneficiary
Pass the beneficiary's id instead of raw recipient details:
curl https://api.wajub.com/transfers \
-H "Authorization: sk.xxxx" \
-H "Content-Type: application/json" \
-d '{
"amount": 15000,
"currency": "XAF",
"beneficiary": "ben_01JXXXXXXXXXXXXX"
}'Idempotency still applies per transfer
Saving a beneficiary once does not make repeated transfers to them safe by default — send a
unique Idempotency-Key on every POST /transfers call, saved or not. See
Idempotency.
Was this page helpful?