Bénéficiaires
Enregistrez à l'avance les destinataires de vos transferts pour simplifier et accélérer vos appels de payout.
Un bénéficiaire est un destinataire Mobile Money ou bancaire enregistré, que vous réutilisez dans plusieurs transferts sans ressaisir ses informations à chaque appel.
Clé privée requise
Gérer les bénéficiaires exige la clé privée (sk...).
Endpoints
| Méthode | Chemin | Description |
|---|---|---|
POST | /beneficiaries | Créer un bénéficiaire |
GET | /beneficiaries | Lister les bénéficiaires |
GET | /beneficiaries/{id} | Récupérer un bénéficiaire |
PUT | /beneficiaries/{id} | Modifier un bénéficiaire |
DELETE | /beneficiaries/{id} | Supprimer un bénéficiaire |
POST | /beneficiaries/{id}/verify | Vérifier le portefeuille par rapport au nom enregistré |
GET | /beneficiaries/{id}/statement | Tout ce qui a été versé au bénéficiaire |
GET | /beneficiaries/{id}/receivables | Lister ce que le bénéficiaire doit rembourser |
POST | /beneficiaries/{id}/receivables | Déclarer une dette |
POST | /beneficiaries/{id}/receivables/{receivable}/settle | Marquer une dette comme recouvrée hors de Wajub |
Utiliser un bénéficiaire dans un transfert
Passez l'id du bénéficiaire au lieu des coordonnées brutes du destinataire quand vous créez un
transfert :
curl https://api.wajub.com/transfers \
-H "Authorization: sk.xxxxxxxxxxxxxxxx…" \
-H "Content-Type: application/json" \
-d '{
"amount": 15000,
"currency": "XAF",
"beneficiary": "ben_LRQqYvlhrgUOE225KMKU"
}'Événements
| Événement | Déclencheur |
|---|---|
beneficiary.created | Création |
beneficiary.updated | Modification |
beneficiary.deleted | Suppression |