Beneficiaries
Pre-register transfer recipients to simplify and speed up your payout API calls.
A beneficiary is a saved Mobile Money or bank recipient you can reuse across multiple Transfers without re-entering their details on every call.
private key required
Managing beneficiaries requires the private key (sk...).
Endpoints
| Method | Path | Description |
|---|---|---|
POST | /beneficiaries | Create a beneficiary |
GET | /beneficiaries | List beneficiaries |
GET | /beneficiaries/{id} | Retrieve a beneficiary |
PUT | /beneficiaries/{id} | Update a beneficiary |
DELETE | /beneficiaries/{id} | Delete a beneficiary |
POST | /beneficiaries/{id}/verify | Check the wallet against the registered name |
GET | /beneficiaries/{id}/statement | Everything paid to the beneficiary |
GET | /beneficiaries/{id}/receivables | List what the beneficiary owes back |
POST | /beneficiaries/{id}/receivables | Declare a debt |
POST | /beneficiaries/{id}/receivables/{receivable}/settle | Mark a debt as recovered outside Wajub |
Using a beneficiary in a transfer
Pass the beneficiary's id instead of raw recipient details when creating a transfer:
curl https://api.wajub.com/transfers \
-H "Authorization: sk.xxxxxxxxxxxxxxxx…" \
-H "Content-Type: application/json" \
-d '{
"amount": 15000,
"currency": "XAF",
"beneficiary": "ben_LRQqYvlhrgUOE225KMKU"
}'Events
| Event | Trigger |
|---|---|
beneficiary.created | Created |
beneficiary.updated | Updated |
beneficiary.deleted | Deleted |