laraditz/xenopay

Xenopay SDK for Laravel

1.0.2 2020-08-27 03:57 UTC

Requires

• php: ^7.2.5
• illuminate/support: ^7.0|^8.0

MIT

• Farhan

README

Xenopay SDK for Laravel.

Installation

Via Composer

$ composer require laraditz/xenopay

Configuration

Edit the config/app.php file and add the following line to register the service provider:

'providers' => [
    ...
    Laraditz\Xenopay\XenopayServiceProvider::class,
    ...
],

Tip: If you're on Laravel version 5.5 or higher, you can skip this part of the setup in favour of the Auto-Discovery feature.

You can set default Xenopay account in your .env so that you do not need to pass it everytime you login.

...
XENOPAY_EMAIL=
XENOPAY_PASSWORD=
...

Getting started

Execute migration file:

php artisan migrate

Usage

Example usage as below snippet:

// using Facade
$response = \Xenopay::auth()->login(['email' => '[e-mail]', 'password' => 'password']);

// using Service Container
$response = app('Xenopay')->auth()->login(['email' => '[e-mail]', 'password' => 'password']);

// login
$response = \Xenopay::auth()->login(); // if u have set default account in .env, do not need to pass anything

// create bill
$response = \Xenopay::bill()->withToken($access_token)->create([
    'ref_no' => 'youruniquereferenceno',
    'amount' => 1,
    'description' => 'your description here.',
    'contact' => '0121234567',
    'redirect_url' => 'https://yourapp.com',
]);

// view bill
$response = \Xenopay::bill()->withToken($access_token)->view($id);

The request returns an instance of Laraditz\Xenopay\XenopayResponse, which provides a variety of methods that may be used to inspect the response:

$response->isSuccess() : bool; // true or false

$response->status() : int; // http status code. e.g. 200, 400, 500 etc.

$response->message() : string; // message for the response. e.g. "Invalid data".

$response->data() : mixed; // response content

$response->errors() : array; // usually contain validation errors

Change log

Please see the changelog for more information on what has changed recently.

Credits

• Raditz Farhan

License

MIT. Please see the license file for more information.