bui-corporation/bui-payment

There is no license information available for the latest version (v1.0.0) of this package.

Un package Laravel pour intégrer les paiements avec l'API Bui Corporation.

v1.0.0 2024-05-17 00:39 UTC

Requires

• php: ^7.3|^8.0
• guzzlehttp/guzzle: ^7.8
• illuminate/support: ^11.7
• vlucas/phpdotenv: ^5.6

Unknown License

• gnakaleh

README

Un package Laravel pour intégrer les paiements avec l'API Bui Corporation.

Installation

Prérequis

Assurez-vous d'avoir installé Composer et Laravel.

Étapes d'installation

1. Ajouter le package via Composer :

   composer require bui-corporation/bui-payment

2. Publier le fichier de configuration :

   php artisan vendor:publish --provider="Bui\\Payment\\BuiPaymentServiceProvider"

3. Ajouter les variables d'environnement à votre fichier .env :

   BUI_API_KEY=your_api_key_here
   BUI_BASE_URL=https://api.buicorporation.io/v1.0/

Configuration

Après avoir publié le fichier de configuration, vous pouvez le trouver dans config/buipayment.php. Vous pouvez y définir vos paramètres par défaut.

Utilisation

Obtenir la liste des services

Vous pouvez obtenir la liste des services disponibles en utilisant la façade BuiPayment :

use Bui\Payment\Facades\BuiPayment;

$services = BuiPayment::getServices();
use Bui\Payment\Facades\BuiPayment;

## Effectuer un paiement

$paymentData = [
    'paymentMethod' => 'mobile_money',
    'mobileMoney' => [
        'service' => 'PAYIN_ORANGE_CI',
        'amount' => 200,
        'recipient' => '+225XXXXXXXXXX',
        'reference' => 'unique_reference',
        'note' => 'Transaction note',
        'otpCode' => '123456',
    ],
    'customer' => [
        'firstname' => 'John',
        'lastname' => 'Doe',
        'email' => '[e-mail]',
        'externalId' => '123456',
        'phoneNumber' => '+225XXXXXXXXXX'
    ]
];

Vérifier le statut d'un paiement

use Bui\Payment\Facades\BuiPayment;
$status = BuiPayment::getPaymentStatus('payment_id_here');

### Effectuer un transfert
use Bui\Payment\Facades\BuiPayment;

$transferData = [
    'transferMethod' => 'mobile_money',
    'mobileMoney' => [
        'service' => 'PAYOUT_ORANGE_CI',
        'amount' => 200,
        'recipient' => '+225XXXXXXXXXX',
        'reference' => 'unique_reference',
        'note' => 'Transaction note'
    ],
    'customer' => [
        'firstname' => 'John',
        'lastname' => 'Doe',
        'email' => '[e-mail]',
        'externalId' => '123456',
        'phoneNumber' => '+225XXXXXXXXXX'
    ]
];
$transfer = BuiPayment::makeTransfer($transferData);

Vérifier le statut d'un transfert

use Bui\Payment\Facades\BuiPayment;

$status = BuiPayment::getTransferStatus('transfer_id_here');

Gérer les portefeuilles

Obtenir la liste des portefeuilles

use Bui\Payment\Facades\BuiPayment;

$wallets = BuiPayment::getWallets();

Obtenir le solde d'un portefeuille

use Bui\Payment\Facades\BuiPayment;

$balance = BuiPayment::getWalletBalance('wallet_id_here');

Effectuer un payin (créditer un portefeuille)

use Bui\Payment\Facades\BuiPayment;

$payinData = [
    'amount' => 1000,
    'walletId' => 'wallet_id_here'
];
$payin = BuiPayment::payin($payinData);

Effectuer un payout (débiter un portefeuille)

use Bui\Payment\Facades\BuiPayment;

$payoutData = [
    'amount' => 500,
    'walletId' => 'wallet_id_here'
];
$payout = BuiPayment::payout($payoutData);

Contributions

Les contributions sont les bienvenues. Pour proposer des améliorations, ouvrez une issue ou soumettez une pull request

Licence

Conclusion