├── LICENSE ├── README.md ├── composer.json └── src └── ExplorerCash ├── Api.php └── PaymentRequest.php /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | 167 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![N|Solid](https://www.explorer.cash/logo-dark.png)](https://www.explorer.cash/) 2 | 3 | ## explorer.cash API for PHP 4 | 5 | The library provide an access to explorer.cash Blockchain API for PHP applications. 6 | You can easily add payment request and receive a notification when a crypto payment is confirmed on the blockchain. 7 | explorer.cash Blockchain API supports multiple cryptocurrencies like Bitcoin (BTC), Bitcoin Cash (BCH), Tether (USDT), USD Coin (USDC), Ethereum (ETH), Litecoin (LTC) ... 8 | 9 | :green_book: [See explorer.cash Blockchain API documentation](https://www.explorer.cash/en/blockchain-api-documentation.html) 10 | 11 | ## Requirements 12 | 13 | PHP version >= 7.x 14 | 15 | ## How to install 16 | 17 | ``` 18 | $ composer require explorer-cash/api-php 19 | ``` 20 | 21 | ## How to use 22 | 23 | ### Register a payment request to explorer.cash 24 | 25 | ```php 26 | use ExplorerCash\PaymentRequest; 27 | 28 | $payment_request = new PaymentRequest(); 29 | 30 | $payment_request->push([ 31 | 'unit' => 'BTC', 32 | 'address' => '1R9NpmdVpC4eKajqutKqSSEn5hH4DEkLs', 33 | 'payment_reference' => 'ORD-4579', 34 | 'amount' => '0.084', 35 | 'callback_url' => 'https://your-callback-url', 36 | 'timeout' => 10, 37 | 'confirmations' => 3 38 | ]); 39 | 40 | // In your code 41 | $cart = Cart::byReference('ORD-4579'); 42 | 43 | $cart->payment_id = $payment_request->paymentId(); 44 | $cart->save(); 45 | ``` 46 | 47 | ### Retrieve payment request when your callback URL is called 48 | 49 | You need to check that "payment_id" associated to the "payment_reference" are the same. 50 | 51 | ```php 52 | use ExplorerCash\PaymentRequest; 53 | 54 | $payment_request = new PaymentRequest(); 55 | 56 | $payment_data = $payment_request->pull(); 57 | 58 | // In your code 59 | $cart = Cart::byReference($payment_data['payment_reference']); 60 | 61 | if ($cart->payment_id === $payment_data['payment_id']) { 62 | if ($payment_data['status'] === 'PAID') { 63 | $cart->isPaid = true; 64 | } 65 | } 66 | ``` 67 | 68 | ### Subscribe to explorer.cash crypto currencies exchange rates 69 | 70 | You will receive the exchange rates of top 100 cryptos in the currency you provided. 71 | 72 | ```php 73 | use ExplorerCash\Api; 74 | 75 | Api::subscribeRates([ 76 | 'currency' => 'EUR', 77 | 'callback_url' => 'https://your-callback-url' 78 | ]); 79 | ``` 80 | 81 | ## Support or Contact 82 | 83 | Having trouble with this library or explorer.cash API ? [Contact our support](https://www.explorer.cash/en/contact-us) and we’ll help you sort it out. 84 | 85 | 86 | ## License 87 | 88 | GNU Lesser General Public License v3.0 89 | 90 | © 2020 explorer.cash. All Rights Reserved. 91 | 92 | 93 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "explorer-cash/api-php", 3 | "description": "PHP API binding for explorer.cash Blockchain API service", 4 | "authors": [ 5 | { 6 | "name": "explorer.cash", 7 | "email": "support@explorer.cash" 8 | } 9 | ], 10 | "minimum-stability": "dev", 11 | "prefer-stable": true, 12 | "autoload": { 13 | "psr-0": { 14 | "ExplorerCash": "src/" 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/ExplorerCash/Api.php: -------------------------------------------------------------------------------- 1 | 6 | * @copyright 2020 explorer.cash. All rights reserved. 7 | * @license LGPL-3.0 https://www.gnu.org/licenses/lgpl-3.0.en.html 8 | */ 9 | 10 | namespace ExplorerCash; 11 | 12 | class Api 13 | { 14 | 15 | protected static $endpoints = [ 16 | 'production' => 'https://api.explorer.cash/paymentrequests', 17 | 'testing' => 'https://api.explorer.cash/testing/paymentrequests', 18 | 'rates' => 'https://api.explorer.cash/rates' 19 | ]; 20 | 21 | public static function paymentRequest($data, $mode = 'production') 22 | { 23 | if (!in_array($mode, ['production', 'testing'])) { 24 | $mode = 'production'; 25 | } 26 | 27 | $result = self::request(static::$endpoints[$mode], $data); 28 | 29 | return $result['payment_id'] ?? false; 30 | } 31 | 32 | public static function subscribeRates($data) 33 | { 34 | return self::request(static::$endpoints['rates'], $data); 35 | } 36 | 37 | public static function request($url, $data) 38 | { 39 | $context_options = array( 40 | 'http' => array( 41 | 'ignore_errors' => true, 42 | 'method' => 'POST', 43 | 'header' => 'Content-Type: application/json', 44 | 'content' => json_encode($data) 45 | ) 46 | ); 47 | 48 | $context = stream_context_create($context_options); 49 | 50 | $result = json_decode(file_get_contents($url, false, $context), true); 51 | 52 | if (!empty($result['error'])) { 53 | throw new \Exception($result['message']); 54 | } 55 | 56 | return $result; 57 | } 58 | 59 | } 60 | -------------------------------------------------------------------------------- /src/ExplorerCash/PaymentRequest.php: -------------------------------------------------------------------------------- 1 | 6 | * @copyright 2020 explorer.cash. All rights reserved. 7 | * @license LGPL-3.0 https://www.gnu.org/licenses/lgpl-3.0.en.html 8 | */ 9 | 10 | namespace ExplorerCash; 11 | 12 | class PaymentRequest 13 | { 14 | 15 | protected $mode = 'production'; 16 | 17 | protected $payment_id = null; 18 | 19 | public function mode($mode = null) 20 | { 21 | if ($mode) { 22 | $this->mode = $mode; 23 | } 24 | 25 | return $this->mode; 26 | } 27 | 28 | public function paymentId() 29 | { 30 | return $this->payment_id; 31 | } 32 | 33 | public function push($payment) 34 | { 35 | return $this->payment_id = Api::paymentRequest($payment, $this->mode); 36 | } 37 | 38 | public function pull() 39 | { 40 | $payment = json_decode(file_get_contents('php://input'), true); 41 | 42 | if (!$payment || empty($payment['payment_id']) || empty($payment['payment_reference'])) { 43 | throw new \Exception('Payment is invalid'); 44 | } 45 | 46 | return $payment; 47 | } 48 | } 49 | --------------------------------------------------------------------------------