stephenjude/lenco-laravel-sdk

Laravel SDK for Lenco payment API integration.

dev-main 2024-07-08 07:01 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0
• spatie/laravel-package-tools: ^1.14.0

Requires (Dev)

• larastan/larastan: ^2.0.1
• laravel/pint: ^1.0
• nunomaduro/collision: ^7.8
• orchestra/testbench: ^8.8
• pestphp/pest: ^2.20
• pestphp/pest-plugin-arch: ^2.5
• pestphp/pest-plugin-laravel: ^2.0
• phpstan/extension-installer: ^1.1
• phpstan/phpstan-deprecation-rules: ^1.0
• phpstan/phpstan-phpunit: ^1.0

MIT

• stephenjude

• laravel
• stephenjude
• lenco-laravel-sdk

README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Installation

You can install the package via composer:

composer require stephenjude/lenco-laravel-sdk

Add Lenco API token to your .env file.

LENCO_API_TOKEN=xxxx_xxxx_xxxx_xxxx

Usage

Using Class Instance

use \LencoSDK\Lenco\Lenco;

$lenco = new Lenco();

$banks = $lenco->banks();

Using Facade Instance

use \LencoSDK\Lenco\Facades\Lenco;

$banks  = Lenco::banks();

Supported APIs & Usage

    use LencoSDK\Lenco\Facades\Lenco;
    
    Lenco::accounts();

    Lenco::account(accountID: $accountID);

    Lenco::accountBalance(accountID: $accountID);

    Lenco::banks();

    Lenco::resolve(accountNumber: $accountNumber, bankCode: $bankCode);

    Lenco::transactions(
        page: $page = null,
        status: $status = null,
        type: $type = null,
        start: $start = null,
        end: $end = null,
        search: $search = null,
        accountIds: $accountIds = null
    );

    Lenco::transactionById(transactionId: $transactionId);

    Lenco::transactionByReference(transactionReference: $transactionReference);

    Lenco::createVirtualAccount(
        accountName: $accountName,
        transactionReference: $transactionReference = null,
        amount: $amount = null,
        minAmount: $minAmount = null,
        isStatic: $isStatic = false,
        createNewAccount: $createNewAccount = false,
        bvn: $bvn = null
    );

    Lenco::virtualAccounts(page: $page = null);

    Lenco::virtualAccountByReference(accountReference: $accountReference);

    Lenco::virtualAccountByBVN(bvn: $bvn);

    Lenco::virtualAccountTransactions(accountReference: $accountReference, page: $page = null);

    Lenco::virtualAccountTransaction(transactionId: $transactionId);

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• stephenjude
• All Contributors

License

The MIT License (MIT). Please see License File for more information.