SDK Payout (JavaScript)
Package npm @fluxx/payout. Client HTTP optionnel pour backends Node 18+ (fetch natif). L’API HTTP reste utilisable seule.
Installation
npm install @fluxx/payout
Configuration
import { FluxxPayout } from '@fluxx/payout'
const payout = new FluxxPayout({
apiKey: process.env.FLUXX_API_KEY!,
environment: 'test', // ou 'live'
})
- Name
apiKey- Description
Clé API marchand. Envoyée en
Authorization: BeareretX-API-Key.
- Name
environment- Description
testoulive. Utilisez une clé du même type.
- Name
baseUrl- Description
Racine
/api/v1si vous pointez vers un hôte différent de la production.
- Name
maxRetries- Description
Nouvelles tentatives sur
429/502/503/504(défaut : 2).
Parcours type
Décaissement Mobile Money
const catalog = await payout.getOperators()
await payout.listDestinations()
const result = await payout.createPayout(
{
amount: 100, // 100 FCFA
reference: 'WDR-123',
country: 'BJ',
operator: 'mtn',
phone: '+2290166000000',
description: 'Retrait client',
},
{ idempotencyKey: crypto.randomUUID() },
)
const status = await payout.getPayout(result.reference, { sync: true })
amount est dans l’unité de la devise : 100 = 100 FCFA.
Alternative : fournir destination_id à la place de country / operator / phone.
Même scénario sans code : Playground Payout.
Méthodes
- Name
getOperators()- Description
Catalogue pays et opérateurs.
- Name
listDestinations()- Description
Destinations Mobile Money du marchand.
- Name
createPayout(body, options?)- Description
Initie un décaissement. Passez
idempotencyKey(recommandé).
- Name
getPayout(reference, options?)- Description
Lit le statut.
sync: trueforce une mise à jour si le décaissement est encore en attente.
OpenAPI : cdn payout openapi.
Erreurs
Les réponses d’erreur HTTP lèvent FluxxPayoutError (status, message, body, et code si présent dans la réponse).