Download the PHP package laraman/beyonic without Composer
On this page you can find all versions of the php package laraman/beyonic. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package beyonic
Laraman Beyonic.
Laraman Beyonic is a Laravel package for working with Beyonic Mobile Money APIs.
Requirements
- Laravel v5.0+
- Beyonic API Token
Note
- For NOW this packages works with Collection Requests, Collections and Payments. More options are coming soon.
Installation
-
To get started, install the
laraman/beyonic
package. -
For Laravel <=5.4, register the Facade in the
app.php
file inside config directory -
To List of providers add:
-
To alias add:
- For Laravel >5.4, NO need to worry, the
LaramanBeyonic
facade will be automatically discovered and loaded for you.
Environment files
- Add
BEYONIC_API_KEY
to your.env
file and provide a valid Beyonic Token. - You can also publish the config file
beyonic.php
to yourconfig
directory and make necessary adjustments but this is optinal.
How to use
-
Inside your controller, import
LaramanBeyonic
. -
Then in your controller method, you can the make the various requests, follow the Beyonic API Documentation and format your request body accordingly.
- You can then leverage on the
LaramanBeyonic
Methods to make your requests simpler.
Collection Requests.
- To make collection request, you can use the following methods.
Method Description | Method | Argument | Expects Argument | Comment |
---|---|---|---|---|
Make Collection Request | createCollectionRequest() |
$data | Mandatory | Array of objects |
Get all Collection Requests | getAllCollectionRequests() |
$data or NULL | Optional | You can get All or Filter records |
Get a Collection Request | getCollectionRequest() |
$data | Mandatory | Get a specific record |
Update a Collection Request | updateCollectionRequest() |
$data, $id | Mandatory | You must have permission |
Delete a Collection Request | deleteCollectionRequest() |
$id | Mandatory | You must have permission |
Collections.
- To manage your collections, you can use the following methods.
Method Description | Method | Argument | Expects Argument | Comment |
---|---|---|---|---|
Get all Collections | getCollections() |
$data or NULL | Optional | You can get All or Filter records |
Get a Collection | getCollection() |
$data | Mandatory | Get a specific record |
Delete a Collection Request | deleteCollection() |
$id | Mandatory | You must have permission |
Payments.
- To send money to (Pay) mobile users, you can use the following methods.
Method Description | Method | Argument | Expects Argument | Comment |
---|---|---|---|---|
Make Payment Request | createPayment() |
$data | Mandatory | Array of objects |
Get all Payments | getAllPayments() |
$data or NULL | Optional | You can get All or Filter records |
Get a Payment record | getPayment() |
$data | Mandatory | Get a specific record |
Update Payment | updatePayment() |
$data, $id | Mandatory | You must have permission |
Delete Payment | deletePayment() |
$id | Mandatory | You must have permission |
Example.
- To avoid unncessary errors, you may decide to wrap your request in a
try
andcatch
.
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.