alexstewartja/bitpay-fleetcart-module

BitPay payment gateway module for FleetCart

1.0.2 2022-08-18 21:03 UTC

This package is auto-updated.

Last update: 2024-04-19 12:40:06 UTC


README

BitPay for FleetCart

About

BitPay for FleetCart is a module for FleetCart which allows you to accept blockchain (cryptocurrency) payments on your FleetCart store, via BitPay payment gateway.

⚠️ A BitPay merchant account is required to use BitPay for FleetCart. If you don't already have an account, sign up for a test BitPay merchant account or a production BitPay merchant account.

Server Requirements

In addition to the core server requirements outlined in the FleetCart Docs, ensure your server meets the following requirements:

ℹ️ PHP Composer comes pre-installed on most Shared Hosting accounts.

Install

Open a terminal in the root of your FleetCart installation and run the following command:

composer require alexstewartja/bitpay-fleetcart-module

Congratulations! 🎉 You've successfully installed BitPay for FleetCart!

Configuration

Now that you've installed BitPay for FleetCart, it's time to configure it to start receiving crypto payments.

Settings

Navigate to Settings > Payment Methods > BitPay in your admin panel:

BitPay Settings Tab

  • Status: Enable this payment method by checking this checkbox.
  • Label (translatable): The label for this payment method.
  • Description (translatable): The description for this payment method.
  • BitPay Test: Use BitPay's Test Environment (test.bitpay.com)
  • Merchant Token: The BitPay API Token for the merchant facade. Explained here

Merchant Token

Initially, the Merchant Token field won't be visible. You have to first enable the BitPay payment method by checking the Enable BitPay checkbox then clicking Save.

Generate a new Merchant Token by clicking the Generate Merchant Token button: Generate API Token Button

ℹ️ The type of Merchant Token you generate depends on whether you enabled use of BitPay's Test Environment or not. If you chose to enable BitPay Test, remember to disable it, then generate and approve a new Merchant Token when in production.

After successful generation, approve your new Merchant Token by clicking the link provided. The link will take you to your BitPay merchant dashboard to confirm approval. After approving, you will be ready to start accepting crypto payments with BitPay for FleetCart!

BitPay Settings Tab - Merchant Token

⚠️ Note that the token approval link will expire 24 hours after the time of generation. Learn more about BitPay API Tokens here

You may then dismiss the token approval message by clicking the I've approved my merchant token button.

That's it! You've successfully installed and configured BitPay for FleetCart! You can now accept over a dozen cryptocurrencies from hundreds of crypto wallets on your FleetCart store!

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email iamalexstewart@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.