SDK JavaScript
Package npm @fluxx/collect (2026-06). Node 18+ (fetch natif).
Installation
npm install @fluxx/collect
Configuration
import { FluxxCollect } from '@fluxx/collect'
const collect = new FluxxCollect({
apiKey: process.env.FLUXX_API_KEY!,
environment: 'test', // ou 'live'
// baseUrl: 'http://localhost:8000/api/v1', // dev local
})
- Name
apiKey- Description
Clé API marchand (UUID). Header
X-API-Key.
- Name
environment- Description
testoulive. Utilisez une clé du même type (Mode test).
- Name
baseUrl- Description
Racine
/api/v1si différente de la production (https://api.fluxxpay.me/api/v1).
- Name
maxRetries- Description
Nouvelles tentatives sur 429 et erreurs réseau (défaut : 2).
Parcours type
Collecte direct Mobile Money
const catalog = await collect.getOperators()
const init = await collect.createPayment(
{
reference: 'ORDER-001',
amount: 3000,
country: 'BJ',
mode: 'direct',
operator: 'mtn',
customer: { phone: '2290166000000' },
},
{ idempotencyKey: 'ORDER-001' },
)
if (init.status === 'awaiting_otp') {
await collect.confirmPayment({
reference: 'ORDER-001',
otp: '123456',
})
}
const status = await collect.getPayment('ORDER-001', { sync: true })
Les montants sont en unités majeures (ex. 3000 = 3 000 XOF). Même scénario en interface : Playground Collect.
Webhooks
import { verifyWebhookSignature } from '@fluxx/collect'
const rawBody = await request.text()
const ok = verifyWebhookSignature(
rawBody,
request.headers.get('x-fluxpay-signature')!,
process.env.WEBHOOK_SECRET!,
)
Signature HMAC-SHA256 hex sur {timestamp}.{body brut} (X-FluxPay-Signature). Détails : Webhooks.
Méthodes
- Name
getOperators()- Description
Catalogue pays et opérateurs (
GET /collect/payments/operators/).
- Name
createPayment(body, options?)- Description
Crée un paiement direct ou hosted. Option
idempotencyKey(recommandée).
- Name
confirmPayment(body)- Description
Valide l'OTP Coris (
POST /collect/payments/{ref}/confirm/).
- Name
getPayment(reference, options?)- Description
Lit le statut.
sync: truepour interroger le PSP si besoin.
- Name
cancelPayment(reference)- Description
Annule un paiement en cours.
- Name
refundPayment(reference, body?)- Description
Rembourse un paiement complété.
- Name
payHostedSandbox(reference)- Description
Sandbox TEST : simule le paiement d'un checkout hosted.
Les réponses d'erreur lèvent FluxxCollectError (status, code, body).