Transferts
Envoyez des fonds vers un portefeuille Mobile Money, un portefeuille Djamo ou un autre compte Wajub avec l'API Transfers.
Un transfert est un payout sortant, depuis le solde détenu par notre partenaire de paiement
agréé, vers un portefeuille Mobile Money, un portefeuille adressé par numéro de téléphone comme
Djamo, ou un autre compte Wajub. Un payout bancaire ne passe que par un compte de versement ajouté
dans le Dashboard, que cette API ne peut pas payer. Les transferts sont asynchrones : écoutez
transfer.succeeded et transfer.failed.
Clé privée requise
Les transferts exigent la clé privée (sk...) dans l'en-tête Authorization.
Marketplaces : agir pour le compte d'un sous-compte
Une plateforme peut verser un payout pour le compte d'un sous-compte connecté en envoyant un
en-tête X-Sync avec sa propre clé (capacité withdrawals requise). Consultez
Sous-comptes pour les règles et les cas d'erreur.
Endpoints
| Méthode | Chemin | Description |
|---|---|---|
POST | /transfers | Créer un transfert |
POST | /transfers/batch | Créer jusqu'à 500 transferts en un appel |
GET | /transfers | Lister les transferts |
GET | /transfers/{id} | Récupérer un transfert |
L'objet Transfer
Un transfert se lit par son id. Sa reference vous appartient et son unicité n'est jamais
vérifiée : GET /transfers/{id} ne l'accepte donc pas. Le
guide des transferts montre un exemple complet.
idstringfacultatifpo_… en live, po_test_… en sandbox.referencestring?facultatifprovider_referencestring?facultatifamountnumberfacultatifcurrencystringfacultatifdescriptionstring?facultatifreasonstring?facultatiffailure_reason.statusenumfacultatifprocessing, review, succeeded, failed ou cancelled, ou pending pour un payout du Dashboard qui attend votre confirmation. cancelled est un payout annulé avant son envoi. Un payout que l'opérateur annule de son côté finit failed.completebooleanfacultatiftrue seulement une fois le transfert succeeded. Il reste false sur failed et cancelled : lisez status pour savoir si un transfert est terminé.sourcestringfacultatifapi pour un payout créé par votre intégration, dashboard ou recurring pour un payout lancé depuis la Konsole.failure_reasonstringfacultatifstatus vaut failed ou cancelled.failure_messagestringfacultatifstatus vaut failed ou cancelled.metadataobjectfacultatifledger_balance_currencystring?facultatifsandboxbooleanfacultatiftrue pour un payout de la sandbox.providerobject?facultatifslug et name du prestataire qui porte le payout. null sur un payout sandbox à sa création.beneficiaryobjectfacultatifid, name, phone, email et deleted. Un bénéficiaire supprimé depuis reste ici, avec deleted: true.payment_methodobjectfacultatifid, account_number et phone de la destination.succeeded_atdatetime?facultatifcreated_atdatetimefacultatifupdated_atdatetimefacultatifCycle de vie
Un payout live est créé processing, ou review quand il est
retenu. Un payout du Dashboard qui attend votre
confirmation porte pending : confirmé, il suit son cours comme un nouveau payout ; rejeté, il finit
cancelled.
Événements
| Événement | Déclencheur |
|---|---|
transfer.created | Transfert créé |
transfer.processing | Transfert soumis à l'opérateur |
transfer.succeeded | Transfert exécuté avec succès |
transfer.failed | Transfert échoué |
transfer.cancelled | Arrêté avant son envoi. Aujourd'hui, un tel payout est annoncé en transfer.failed |