https://github.com/digikraaft/flutterwave-php
Conveniently interact with the Flutterwave API with ease using PHP
https://github.com/digikraaft/flutterwave-php
digikraaft flutterwave flutterwave-php payment payment-gateway payment-integration php
Last synced: 14 days ago
JSON representation
Conveniently interact with the Flutterwave API with ease using PHP
- Host: GitHub
- URL: https://github.com/digikraaft/flutterwave-php
- Owner: digikraaft
- License: mit
- Created: 2020-07-07T11:16:12.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-14T07:04:54.000Z (over 4 years ago)
- Last Synced: 2025-09-20T05:27:15.826Z (4 months ago)
- Topics: digikraaft, flutterwave, flutterwave-php, payment, payment-gateway, payment-integration, php
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Conveniently interact with the Flutterwave API with ease!
[](https://travis-ci.com/digikraaft/flutterwave-php)
[](https://scrutinizer-ci.com/g/digikraaft/flutterwave-php/?branch=master)
[](https://scrutinizer-ci.com/code-intelligence)
[](https://opensource.org/licenses/MIT)
This package provides an expressive and convenient way to interact with the [Flutterwave API](https://developer.flutterwave.com/reference).
## Installation
You can install the package via composer:
```bash
composer require digikraaft/flutterwave-php
```
## Usage
All APIs documented in Flutterwave's [Developer Reference](https://developer.flutterwave.com/reference)
are currently supported by this package.
Using the individual API follows a general convention so that it can be simple and predictable.
```
'2020-07-07',
'to' => '2020-07-07',
'currency' => 'NGN',
];
$plans = PaymentPlan::list($params);
```
This also applies to `POST` and `PUT` requests.
For endpoints that require path parameters like the `fetch customer` with the request like `/payment-plans/{id}`,
simply pass in a string into the `API_END_POINT` like this:
```
'Gym Membership',
'status' => 'active',
];
$plan = PaymentPlan::update('12345678', $params);
```
There are a few exceptions to the `API_END_POINT` convention.
Check the wiki page [here](../../wiki) for detailed reference of the available methods
This package returns the exact response from the Flutterwave API but as the `stdClass` type
such that responses can be accessed like this:
```
status == 'success') {
echo $plan->data->name;
}
```
Future updates will see to improving on how the response object is handled.
## Documentation
For detailed documentation, check the wiki page [here](../../wiki)
## Todo
* More tests
* Better API response handling
## Testing
``` bash
composer test
```
## More Good Stuff
Check [here](https://github.com/digikraaft) for more awesome free stuff!
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Contributions are welcome! Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email dev@digitalkraaft.com instead of using the issue tracker.
## Credits
- [Tim Oladoyinbo](https://github.com/timoladoyinbo)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.