From 25a264e82a0b3fb114353e600cdbd682eb34d93f Mon Sep 17 00:00:00 2001 From: SergejIlg <70266901+SergejIlg@users.noreply.github.com> Date: Mon, 30 Nov 2020 17:34:25 +0200 Subject: [PATCH] Update README.md --- README.md | 49 +++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 49e7c45..72d5d88 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,53 @@ # osCommerce CoinGate Plugin -## Install +#### ***Please note that we do not serve U.S. registered businesses due to regulatory reasons yet.*** -Sign up for CoinGate account at for production and for testing (sandbox) environment. +Accept cryptocurrency payments in your osCommerce store with [CoinGate](https://coingate.com/) - our fully automated payment processing and invoice system makes it easy, convenient, and risk-free for you and your customers. -Please note, that for "Test" mode you **must** generate separate API credentials on . API credentials generated on will **not** work for "Test" mode. +With a simple installation of the CoinGate osCommerce extension in your store's checkout, customers can pay for your goods and services with cryptocurrencies like Bitcoin, Litecoin, Ethereum, Bitcoin Cash, and XRP, among 50+ other altcoins. -### via FTP +With CoinGate’s osCommerce plugin, merchants can also receive real-time settlements of cryptocurrencies in *Euros - payouts are made directly to your bank account*. This way, businesses are not exposed to price volatility risk and can enjoy fixed payouts no matter the cryptocurrency’s price. + +Alternatively, store owners can choose to receive payouts *in cryptocurrency as well*. + +### Features: +* The gateway is fully automatic – set it and forget it. +* Receive automatic payment confirmations and order status updates. +* Set your prices in any local fiat currency, and the payment amount in cryptocurrency will be calculated using real-time exchange rates. +* [Customize the invoice](https://blog.coingate.com/2019/03/how-to-customize-merchants-invoice-guide/) – disable/enable cryptocurrencies, change their position on the invoice, and more. +* Select the [settlement currencies and payout options](https://blog.coingate.com/2019/08/payouts-fiat-settlements/) for each crypto-asset; +* Use a [sandbox environment](https://sandbox.coingate.com) for testing with Testnet Bitcoin. +* No setup or recurring fees. +* No chargebacks – guaranteed! + +### Functionality: +* [Extend invoice expiration time](https://blog.coingate.com/2017/09/bitcoin-merchant-extend-invoice-expiration-time/) up to 24 hours (if payouts are in BTC). +* Accept slight underpayments automatically. +* Refunds can be issued directly from the invoice and without the involvement of the seller. + +### How it works - an example: +1. An item in the store costs 100 euro. +2. A customer wants to buy the item and selects to pay with Bitcoin. +3. An invoice is generated and, according to the current exchange rate, the price is 10000 euro per bitcoin, so the customer has to pay 0.01 bitcoins. +4. Once the invoice is paid, the merchant receives 99 euro (100 euro minus our 1% flat fee), or 0.0099 BTC. + +*If you’re having trouble installing the plugin, check our blog for a more in-depth description at https://blog.coingate.com/2017/06/oscommerce-bitcoin-addon-setup/* + +To use a plugin, a business is required to [pass the verification](https://blog.coingate.com/2019/05/verify-merchant-account-faq/) or [apply for a trial account](https://blog.coingate.com/2020/06/business-trial-account/) first. + +Any questions? Write to our support team at [support@coingate.com](mailto:support@coingate.com) + +## Installation + +Sign up for a CoinGate account at [https://coingate.com](https://coingate.com) for production and [https://sandbox.coingate.com](https://sandbox.coingate.com) for testing (sandbox) environment. + +Please note that for "Test" mode you must generate separate API credentials on [https://sandbox.coingate.com](https://sandbox.coingate.com). API credentials generated on [https://coingate.com](https://coingate.com) will not work for "Test" mode. + +#### via FTP 1. Download [oscommerce-coingate.zip](https://github.com/coingate/oscommerce-plugin/releases/download/v1.0.1/coingate-oscommerce-1.0.1.zip). -2. Extract downloaded zip. Upload `includes` directory and `coingate_callback.php` file to the root directory of your osCommerce installation. +2. Extract downloaded zip. Upload includes directory and coingate_callback.php file to the root directory of your osCommerce installation. 3. Login to your osCommerce admin panel and go to Modules » Payment. Click Install module, then click Bitcoin via CoinGate and click Install module again. -4. Go to Modules » Payment, click Bitcoin via CoinGate and click Edit. Set Enable CoinGate module to True and Enable test mode to False. Enter [API Credentials](https://support.coingate.com/en/42/how-can-i-create-coingate-api-credentials) (App ID, Api Key, Api Secret) and configure other extension settings. Click Save. +4. Go to Modules » Payment, click Bitcoin via CoinGate and click Edit. Set Enable CoinGate module to True and Enable test mode to False. Enter [API Credentials](https://support.coingate.com/en/42/how-can-i-create-coingate-api-credentials) (App ID, API Key, API Secret) and configure other extension settings. Click Save. To create new order statuses login to your osCommerce admin panel, go to Localization » Orders Status, click Insert, enter new order status name and click Save.