/BUTTON-Wallet-PHP-API

BUTTON Wallet API PHP Client

Primary LanguagePHP

BUTTON Wallet PHP API Client

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

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.