coinrequest / button-wallet-php-api
PHP API client for BUTTON Wallet
Requires
- php: >=7.0
- ext-curl: *
- ext-json: *
- ext-openssl: *
- composer/ca-bundle: ^1.1
- guzzlehttp/guzzle: ^7.0.1
Requires (Dev)
- phpunit/phpunit: ^9.0
- symfony/var-dumper: ^4.3
- vlucas/phpdotenv: ^3.4
This package is auto-updated.
Last update: 2025-03-19 19:41:19 UTC
README
PHP package for the BUTTON Wallet API.
Getting Started
Run the following command to install this package into your project.
composer require coinrequest/button-wallet-php-api
Prerequisites
You will need Composer to install this package.
Installing
After installing this package with composer, create a new ButtonWallet instance. And include your API key.
Something like this
$buttonWallet = new ButtonWallet('yourpersonalapikey');
And call the desired endpoint
$buttonWallet->linkEndpoint()->createLink($params);
The current implemented endpoints are:
- /FastLink/
- create
- readAll
- readInfoByUuid
- readByUuid
- webhook
- webhook/set
Documentation of the endpoints will be later available online. Please check the code for documentation and example requests and responses.
Running the tests
First, create a .env file and set your API Key. Please see the .env.example for the template.
Run the tests in the Tests directory with PHPUnit.
Built With
- ButtonWallet - For the API Server
- PHPUnit - Test Framework
- Guzzle - For HTTP Requests
Contributing
Please help us to develop this package. Every input and/or feedback is really appreciated!
License
This project is licensed under the MIT License.