SDK PHP

Package Composer fluxx/collect (2026-06). PHP 8.1+, Guzzle.


Installation

composer require fluxx/collect

Configuration

use Fluxx\Collect\CollectClient;

$collect = new CollectClient(
    apiKey: getenv('FLUXX_API_KEY'),
    baseUrl: 'https://api.fluxxpay.me/api/v1', // optionnel
    maxRetries: 2,
);

Pour le développement local, pointez baseUrl vers votre instance (ex. http://localhost:8000/api/v1) avec une clé Test.


Parcours type

Collecte direct Mobile Money

use Fluxx\Collect\CollectClient;
use Fluxx\Collect\CollectException;

$collect = new CollectClient(getenv('FLUXX_API_KEY'));

$catalog = $collect->getOperators();

$result = $collect->createPayment([
    'reference' => 'ORDER-001',
    'amount' => 3000,
    'country' => 'BJ',
    'mode' => 'direct',
    'operator' => 'mtn',
    'customer' => ['phone' => '2290166000000'],
], 'ORDER-001');

if (($result['status'] ?? '') === 'awaiting_otp') {
    $collect->confirmPayment([
        'reference' => 'ORDER-001',
        'otp' => '123456',
    ]);
}

$status = $collect->getPayment('ORDER-001', sync: true);

Les montants sont en unités majeures (ex. 3000 = 3 000 XOF).


Webhooks

use Fluxx\Collect\WebhookVerifier;

$rawBody = file_get_contents('php://input');
$valid = WebhookVerifier::verify(
    $rawBody,
    $_SERVER['HTTP_X_FLUXPAY_SIGNATURE'] ?? '',
    $secret,
);

Voir Webhooks pour la configuration dashboard.


Méthodes

  • Name
    getOperators()
    Description

    Catalogue pays et opérateurs.

  • Name
    createPayment($body, $idempotencyKey)
    Description

    Crée un paiement direct ou hosted.

  • Name
    confirmPayment($body)
    Description

    Valide l'OTP Coris.

  • Name
    getPayment($reference, $sync)
    Description

    Lit le statut.

  • 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 hosted.

CollectException expose $e->status et $e->code().


Voir aussi

Référence API Collect

Endpoints et schémas de requête / réponse.

En savoir plus

Authentification

Clé API et en-têtes pour vos appels Guzzle.

En savoir plus

Webhooks

Recevoir les changements de statut en temps réel.

En savoir plus

Was this page helpful?