PHPackages aidcoinco/aidpay-php - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Payment Processing](/categories/payments) 4. / 5. aidcoinco/aidpay-php ActiveLibrary[Payment Processing](/categories/payments) aidcoinco/aidpay-php ==================== A PHP wrapper for AIDPay APIs v1.3(7y ago)09981MITPHPPHP >=7.0.0 Since Aug 1Pushed 7y ago1 watchersCompare [ Source](https://github.com/AidCoinCo/aidpay-php)[ Packagist](https://packagist.org/packages/aidcoinco/aidpay-php)[ Docs](https://github.com/aidcoinco/aidpay-php)[ RSS](/packages/aidcoinco-aidpay-php/feed)WikiDiscussions master Synced today READMEChangelog (4)Dependencies (1)Versions (5)Used By (0) AIDPay for PHP ============== [](#aidpay-for-php) A PHP wrapper for [AIDPay](https://www.aidchain.co/aidpay) APIs Official documentation on Install ------- [](#install) ``` composer require aidcoinco/aidpay-php ``` Generate API Key and Secret --------------------------- [](#generate-api-key-and-secret) Contact AidCoin to have your API Key and Secret [here](https://www.aidchain.co/aidpay). Usage ----- [](#usage) ### Prepare requirements [](#prepare-requirements) ``` require __DIR__ . '/vendor/autoload.php'; use AidCoin\AidPay; ``` ### Create client [](#create-client) ``` $aidPay = new AidPay('yourApiKey', 'yourApiSecret'); ``` Call APIs --------- [](#call-apis) ### getCharities [](#getcharities) Description: - Returns the list of enabled charities. Params: - array with limit (default 12) and offset (default 0) ``` $aidPay->getCharities(['limit' => 2, 'offset' => 0]); ``` result: ``` { "data": [ { "id": 1, "name": "Friends Charity", "logo": "https://www.aidchain.io/image/charity/friends-charity.jpeg", "url": "https://www.aidchain.io/charity/friends-charity" }, { "id": 2, "name": "Save Us Charity", "logo": "https://www.aidchain.io/image/charity/save-us-charity.jpeg", "url": "https://www.aidchain.io/charity/save-us-charity" } ], "count": 7, "pagination": { "page": 1, "pages": 4, "next": "/api/v1/aidpay/payments/charities?limit=2&offset=2", "prev": null } } ``` ### getCurrencies [](#getcurrencies) Description: - Returns the list of enabled currencies as a flat array with the associated DAI rate value. ``` $aidPay->getCurrencies(); ``` result: ``` [ { "name": "Aidcoin", "code": "AID", "daiRate": "0.0459845847" }, { "name": "Attention Token", "code": "BAT", "daiRate": "0.1553115365" }, { "name": "Blackcoin", "code": "BC", "daiRate": "0.0639980109" }, { "name": "Bitcoin", "code": "BTC", "daiRate": "6153.6548980605" }, { "name": "Dash", "code": "DASH", "daiRate": "159.9950888861" }, { "name": "Decred", "code": "DCR", "daiRate": "37.8817317255" }, { "name": "Dogecoin", "code": "DOGE", "daiRate": "0.0049602187" }, { "name": "Enjincoin", "code": "ENJ", "daiRate": "0.0461524117" }, { "name": "Essentia", "code": "ESS", "daiRate": "0.0021755345" }, { "name": "Ethereum", "code": "ETH", "daiRate": "196.2888531824" }, { "name": "Gamecredits", "code": "GAME", "daiRate": "0.1615949776" }, { "name": "Gridcoin", "code": "GRC", "daiRate": "0.0106458229" }, { "name": "Groestlcoin", "code": "GRS", "daiRate": "0.5194300099" }, { "name": "Litecoin", "code": "LTC", "daiRate": "50.6322725012" }, { "name": "Pivx", "code": "PIVX", "daiRate": "1.1255034808" }, { "name": "Power Ledger", "code": "POWR", "daiRate": "0.1737176777" }, { "name": "Peercoin", "code": "PPC", "daiRate": "0.8839109895" }, { "name": "Augur", "code": "REP", "daiRate": "11.7099129786" }, { "name": "Syscoin", "code": "SYS", "daiRate": "0.0851665837" }, { "name": "BLOCKv", "code": "VEE", "daiRate": "0.0089843361" }, { "name": "Vertcoin", "code": "VTC", "daiRate": "0.6460106911" }, { "name": "Zcash", "code": "ZEC", "daiRate": "110.0055656389" }, { "name": "0x", "code": "ZRX", "daiRate": "0.6442757334" } ] ``` ### getLimits [](#getlimits) Description: - Returns the min and max amounts of tokens to be exchanged both in DAI and in selected currency. Params: - fromCurrency: the currency from which to start the transaction ``` $aidPay->getLimits('BTC'); ``` result: ``` { "DAI": { "min": "4.5", "max": "6299.05278899" }, "BTC": { "min": "0.000731227272727", "max": "1.02356426481" }, "USD": { "min": "0.226368", "max": "316.867551497" }, "EUR": { "min": "0.1956285", "max": "273.838721896" }, "GBP": { "min": "0.17145", "max": "239.993911261" } } ``` ### createDonation [](#createdonation) ::: warning ONLY FOR NO-PROFIT ACCOUNTS ::: Description: - Create a donation. Params: - orderId: a reference for the customer (i.e. his progressive order id). Will be sent for reference in notifications - fromCurrency: the currency from which to start the transaction - invoicedAmount: the amount to convert (in "fromCurrency") - email: your customer notification email - itemId: the item id of the charity to send the funds to - refundAddress: an optional address compatible with "fromCurrency" for receiving refunds in case of problems with the blockchain - return: the return URL that will be used to redirect your buyers back to your site ``` $aidPay->createDonation( 'O-12345', 'BTC', '0.1', 'example@aidcoin.co', '1', '1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG', 'https://your.client/return/url' ); ``` result: ``` { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "orderId": "O-12345", "status": "WAITING_FOR_DEPOSIT", "paymentStatus": "PENDING", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "6138.0122760247", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.1", "orderedAmount": "612.3012276", "hash": null, "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5", "orderLink": "https://www.aidchain.co/aidpay/payment/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee?return=https%3A//your.client/return/url" } ``` The `invoicedAmount` will need to be sent to the `depositAddress` (by your users or through your system) within 20 minutes. If you want to use the AidPay interface redirect your users to `orderLink`. ### createOrder [](#createorder) ::: warning ONLY FOR MERCHANT ACCOUNTS ::: Description: - Create an order. Params: - orderId: a reference for the customer (i.e. his progressive order id). Will be sent for reference in notifications - fromCurrency: the currency from which to start the transaction - fromFiat: the FIAT currency from which to start the conversion - fiatAmount: the amount to convert (in "fromFiat") - email: your customer notification email - refundAddress: an optional address compatible with "fromCurrency" for receiving refunds in case of problems with the blockchain - return: the return URL that will be used to redirect your buyers back to your site ``` $aidPay->createOrder( 'O-12345', 'BTC', 'USD', '1000', 'example@aidcoin.co', '1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG', 'https://your.client/return/url' ); ``` result: ``` { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "orderId": "O-12345", "status": "WAITING_FOR_DEPOSIT", "paymentStatus": "PENDING", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "6197.5710529613", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.163838", "orderedAmount": "1000.3971577", "hash": null, "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5", "orderLink": "https://www.aidchain.co/aidpay/payment/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee?return=https%3A//your.client/return/url" } ``` The `invoicedAmount` will need to be sent to the `depositAddress` (by your users or through your system) within 20 minutes. If you want to use the AidPay interface redirect your users to `orderLink`. ### getStatus [](#getstatus) Description: - Returns the status of the payment for a given uuid. Params: - uuid: the unique id of the payment to search for ::: warning NOTES Status could be - WAITING\_FOR\_DEPOSIT - DEPOSIT\_RECEIVED - DEPOSIT\_CONFIRMED - EXECUTED - NEEDS\_REFUND - REFUNDED - CANCELED - EXPIRED PaymentStatus could be - PENDING - UNDERPAY\_RECEIVED - UNDERPAY\_CONFIRMED - PAYMENT\_RECEIVED - PAYMENT\_CONFIRMED - OVERPAY\_RECEIVED - OVERPAY\_CONFIRMED ::: ``` $aidPay->getStatus('aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'); ``` result: ``` { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "orderId": "O-12345", "status": "WAITING_FOR_DEPOSIT", "paymentStatus": "PENDING", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "64625.850340136300000000", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.1", "orderedAmount": "616.97941526", "hash": null, "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5" } ``` ### getOrders [](#getorders) Description: - Returns the customer's order list. Params: - array with limit (default 12), offset (default 0) and an optional filters\['status'\] ``` $aidPay->getOrders(['limit' => 2, 'offset' => 0, 'filters' => ['status' => 'WAITING_FOR_DEPOSIT']]); ``` result: ``` { "data": [ { "uuid": "ffffffff-gggg-hhhh-iiii-llllllllllll", "orderId": "O-67890", "status": "WAITING_FOR_DEPOSIT", "paymentStatus": "PENDING", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "6138.0122760247", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.1", "orderedAmount": "612.3012276", "hash": null, "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5" }, { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "orderId": "O-12345", "status": "WAITING_FOR_DEPOSIT", "paymentStatus": "PENDING", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "6138.0122760247", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.1", "orderedAmount": "612.3012276", "hash": null, "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5" } ], "count": 23, "pagination": { "page": 1, "pages": 12, "next": "/api/v1/aidpay/payments/charities?limit=2&offset=2", "prev": null } } ``` ### deletePayment [](#deletepayment) Description: - Delete a payment for a given uuid. Params: - uuid: the unique id of the payment to search for ``` $aidPay->cancelPayment('aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'); ``` result: ``` { "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "orderId": "O-12345", "status": "CANCELED", "paymentStatus": "PENDING", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "6138.0122760247", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.1", "orderedAmount": "612.3012276", "hash": null, "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5" } ``` Receive Call ------------ [](#receive-call) When your payment has been `EXECUTED` you will receive a POST to the `return_url` provided during the setup process. You should sign the call BODY with your API Secret and then check that it matches our provided sign in HEADERS. ::: warning NOTES This is a Server To Server http call. ::: ``` curl -X POST \ https://your-provided-return-url \ -H 'Content-Type: application/json' \ -H 'sign: ' \ -d '{ "uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "orderId": "O-12345", "status": "EXECUTED", "paymentStatus": "PAYMENT_CONFIRMED", "email": "example@aidcoin.co", "depositAddress": "1HfL94JWjmmjroyAHTDhRQqUwZ7PR4JoUZ", "destination": "0x4Aa0f67D9A0666b9Dd0Ee6d397334903AE337e1E", "exchangeRate": "6138.0122760247", "fromCurrency": "BTC", "toCurrency": "DAI", "invoicedAmount": "0.1", "orderedAmount": "612.3012276", "hash": "0xc28b0..........ac11", "refundAddress": "1Nv92z71iinNVPncrDm4RPHyo17S9bEVPG", "createdAt": "2018-10-11T11:56:57+02:00", "expireDate": "2018-10-11T12:16:56+02:00", "chargedFee": "1.5" }' ``` ``` $headers = getallheaders(); $body = json_decode(file_get_contents('php://input'), true); if ($aidPay->isValidSignature($headers['sign'], $body)) { // Do stuff (i.e. set your payment as paid). Your payment has been executed. } else { // Discard. This is not a valid call. } ``` License ------- [](#license) Code released under the [MIT License](https://github.com/aidcoinco/aidpay-php/blob/master/LICENSE). ### Health Score 29 — LowBetter than 57% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community8 Small or concentrated contributor base Maturity61 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~52 days Total 4 Last Release 2730d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/fe45c007b95c82c28ab02b581ad052d19122547e89c215e84990e7a835a45816?d=identicon)[vittominacori](/maintainers/vittominacori) --- Top Contributors [![vittominacori](https://avatars.githubusercontent.com/u/8151143?v=4)](https://github.com/vittominacori "vittominacori (21 commits)") --- Tags aidcoincomposercryptocurrencypaymentphpclientcryptoexchangecharityaidcoinaidpayaidchain ### Embed Badge ![Health badge](/badges/aidcoinco-aidpay-php/health.svg) ``` [![Health](https://phpackages.com/badges/aidcoinco-aidpay-php/health.svg)](https://phpackages.com/packages/aidcoinco-aidpay-php) ``` ### Alternatives [vittominacori/coinmarketcap-php A PHP wrapper for CoinMarketCap API 2134.0k](/packages/vittominacori-coinmarketcap-php)[victorybiz/laravel-crypto-payment-gateway GoUrl.io Crypto Payment Gateway for Laravel 642.6k](/packages/victorybiz-laravel-crypto-payment-gateway)[prevailexcel/laravel-nowpayments A Laravel Package for NOWPayments 1417.1k](/packages/prevailexcel-laravel-nowpayments) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)