ndeetandGitHub
27670dae99
* Add external dependencies to manifest to avoid error on module activation; add requirements.txt. * Readme * Fix errors, restructure settings form, update installation steps, streamline overall. * Change version
payment_btcpay
BTCPay Server payment gateway for Odoo 16.0
This is the module to connect Odoo 16.0 and BTCPay
This module allows you to accept bitcoin (and other cryptocurrency) payments in your Odoo e-commerce store.
Install the module
- Clone our repository or download the .zip from the [releases page](https://github.com/btcpayserver/odoo/releases
- Place the
payment_btcpaydirectory in your Odoo addons directory - Install dependencies by running
pip install -r requirements.txt(from inside thepayment_btcpaydirectory) - Restart Odoo
- Go to Apps -> Update Apps List
- Remove the "Apps" filter and search for "btcpay"
- Click Activate button
Configure BTCPay as payment provider
- Go to Website -> Configuration -> Payment Providers
- Search for BTCPay and click on button Activate
In the BTCPay settings form, tab "Credentials":
- Set field "State" to enabled
- Set field "BTCPay Server URL" as test or live URL including https://. Example URL: https://testnet.demo.btcpayserver.org
- Set field "Confirmation URL" where the customer will return after payment
- Get a pairing code from your BTCPay Server store: Settings -> Access Tokens
- Click on "Create Token" button
- Label: enter e.g. "My odoo store"
- Public Key: leave empty
- Click on "Request Pairing" button, on next page click "Approve" button
- At the top copy the code next to "Server initiated pairing code", e.g. "hg7z8wN"
- Back in Odoo, paste the code into "Pairing Code" field
- Hit Tab key on your keyboard (or click on another field) and the pairing process will start automatically
- When the pairing is successful the "Token" and "Private Key" field will be filled automatically
- Field Facade, keep default 'merchant'.
On the tab "Configuration":
- Set field "Payment Journal" to "Bank", you can click the dropdown and click on the suggestion "Bank"
- Now you can save the settings
How does the payment page look?
During the checkout the customers will have the option to select the payment method "Pay with Bitcoin / Lightning Network". After selecting they will be redirected to the BTCPay checkout page as shown below.
Transaction BTCPay Details
In transaction object, you will find more technical information about this method of payment:
- Transaction Id: cryptocurrency transaction hash for the executed payout
- Invoice Id: the id of the invoice for which you want to fetch an event token
- Transaction Status: That indicates state of transaction
