Bénéficiaires
Enregistrez une destination de payout une fois, puis payez-la par son id plutôt que par son numéro.
Un bénéficiaire est une destination de payout enregistrée : un nom, un numéro et l'opérateur qui le dessert. Créez-le une fois, puis payez-le par son id, sans ressaisir le numéro à chaque payout.
Mobile Money, Djamo ou un compte Wajub
Le canal transmis doit être l'un des cinquante canaux Mobile Money compatibles avec les payouts, listés dans
Prestataires et canaux, un portefeuille Djamo (ci.djamo ou
sn.djamo), ou wajub pour un autre compte Wajub. Toute autre valeur renvoie 422 avec
The selected channel is invalid. (The selected beneficiary.channel is invalid. pour un
bénéficiaire envoyé en ligne avec un transfert). Les destinations bancaires existent sous forme de
comptes de versement, que vous créez dans le Dashboard et non par l'API.
Deux pages vont plus loin :
- Créer un bénéficiaire, le canal qui détermine l'opérateur, un autre compte Wajub comme destination, et la vérification du nom sur un portefeuille.
- Gérer les bénéficiaires, ce qui est modifiable, récupérer, lister et supprimer un bénéficiaire, et ses relevés.
Payer un bénéficiaire
Transmettez l'id à l'emplacement où un payout attend un destinataire. Le reste du transfert ne
change pas.
https://api.wajub.com/transfersLe corps correspond à celui décrit dans Transferts, avec une chaîne à la place de l'objet inline.
Enregistrer un bénéficiaire ne sécurise pas son paiement
Un bénéficiaire est une destination, pas une protection contre les doublons. Chaque POST /transfers nécessite toujours sa propre valeur Idempotency-Key, que le bénéficiaire soit
enregistré ou non. Sans elle, une nouvelle tentative paie deux fois. Consultez
Idempotence.
Comptes de versement
Un compte de versement est la destination de votre propre argent : celle du
règlement quotidien et des payouts que vous
vous faites. Vous le créez sous Paramètres, Transferts, Comptes de paiement, sur Mobile Money, Djamo, un
compte Wajub, ou un compte bancaire via wire. L'API le liste comme bénéficiaire privileged, et il
commence non vérifié. Le vérifier depuis la même page compare le compte au nom enregistré par son
opérateur. Si les noms ne peuvent pas être rapprochés, Wajub demande au propriétaire du compte de
confirmer le compte. Un payout wire entraîne des frais fixes et est traité sous 48 heures
ouvrées par défaut.
Événements envoyés à votre webhook
| Événement | Déclencheur |
|---|---|
beneficiary.created | Un enregistrement est réellement créé : par POST /beneficiaries, à la volée par POST /transfers, ou comme compte de retrait dans le Dashboard. Pas quand la même destination renvoie le premier bénéficiaire, ce qui ne crée rien |
beneficiary.updated | L'un des cinq champs modifiables change |
beneficiary.deleted | Un bénéficiaire est supprimé |
beneficiary.receivable_recorded | Une dette est enregistrée sur un bénéficiaire |
beneficiary.receivable_recovered | Un payout groupé a recouvré tout ou partie d'une dette |
Pages associées
- Transferts et payoutsL'origine des payouts et les conditions à remplir au préalable.
- TransfertsLe payout lui-même : statuts, routage et échecs.
- Démarrage rapideEnvoyez votre premier payout à un bénéficiaire.
- IdempotenceL'en-tête qui sécurise une nouvelle tentative de payout.
- Référence API des bénéficiairesTous les champs et les cinq endpoints.