adcoin-project/api-php-wrapper

There is no license information available for the latest version (1.0.1) of this package.

This PHP library is a wrapper for the AdCoin API

1.0.1 2018-02-28 09:43 UTC

This package is not auto-updated.

Last update: 2024-10-27 05:41:36 UTC


README

Maintenance GitHub contributors GitHub issues Packagist ForTheBadge built-with-love

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. 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:

composer require adcoin-project/api-php-wrapper

See examples 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. 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, sure. AdCoin Click BV is hiring developers and system engineers. Interested? Join us for a coffee.

License

BSD (Berkeley Software Distribution) License. Copyright (c) 2013-2018, AdCoin Click B.V.

Support

Contact: www.getadcoin.comsupport@getadcoin.com