https://github.com/adcoin-project/api-php-wrapper
Easy-to-use AdCoin Wallet API wrapper for PHP
https://github.com/adcoin-project/api-php-wrapper
adcoin-wallet-api payment-gateway php php-wrapper receive-payments
Last synced: 15 days ago
JSON representation
Easy-to-use AdCoin Wallet API wrapper for PHP
- Host: GitHub
- URL: https://github.com/adcoin-project/api-php-wrapper
- Owner: adcoin-project
- License: bsd-2-clause
- Created: 2018-02-21T09:04:17.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-28T10:12:25.000Z (almost 8 years ago)
- Last Synced: 2025-05-24T19:18:24.958Z (8 months ago)
- Topics: adcoin-wallet-api, payment-gateway, php, php-wrapper, receive-payments
- Language: PHP
- Homepage: https://www.getadcoin.com/api
- Size: 13.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# AdCoin API client for PHP
[](https://github.com/adcoin-project/api-php-wrapper.php/graphs/commit-activity)
[](https://GitHub.com/adcoin-project/api-php-wrapper/graphs/contributors/)
[](https://github.com/adcoin-project/api-php-wrapper/issues/)
[]()
[](https://GitHub.com/adcoin-project/)
Accept payments in AdCoin on your website or inside your platform in minutes with the official AdCoin Payment Gateway. No fixed costs or punishing registration procedures. Receive payments anonymous and without transaction or registration costs for both the receiver and sender.
This project serves as an easy-to-use PHP wrapper for the functionalities provided by the AdCoin Wallet API.
Furthermore, this repository contains a handful of example implementations utilizing the wrapper.
## Requirements
* Get yourself a free AdCoin Web Wallet account at [wallet.getadcoin.com](https://wallet.getadcoin.com). No sign up costs.
* Click on your username in the right upper corner and go to ‘API Key’ and generate your key.
* Now you’re ready to use the AdCoin API Client.
* PHP >= 5.3
* PHP cURL extension
## Receiving payments
To successfully receive a payment, these steps should be implemented:
1. Use the AdCoin Payment Gateway client to start a new payment request.
2. The gateway redirects the user directly after the unconfirmed ACC amount is received within the Web wallet
3. The customer returns and after 5 minutes the webhook is called to check if the amount of AdCoin is already getting confirmed by the blockchain network.
## Getting started
Install the library using [Composer](https://getcomposer.org):
```shell
composer require adcoin-project/api-php-wrapper
```
See [examples](EXAMPLES.md) for an example implementation
### Catching initial succesful payment
The redirectUrl only get’s called when a payment is succesful. Otherwise the user is getting returned to the previous page. After the payment is confirmed by the blockchain network, the webhookUrl is called with the definitive status.
## API documentation ##
If you wish to learn more about our API, please visit the [Official API Documentation](https://www.getadcoin.com/api). API Documentation is available in English.
## Want to help us make our API client even better? ##
Want to help us make our API client even better? We take [pull requests](https://github.com/adcoin-project/api-php-wrapper/pulls), sure. AdCoin Click BV is hiring developers and system engineers. Interested? [Join us for a coffee](mailto:info@getadcoin.com).
## License ##
[BSD (Berkeley Software Distribution) License](https://opensource.org/licenses/bsd-license.php).
Copyright (c) 2013-2018, AdCoin Click B.V.
## Support ##
Contact: [www.getadcoin.com](https://www.getadcoin.com) — support@getadcoin.com