Skip to main content

Getting Started

Overviewโ€‹

The BitPay module for Perfex CRM integrates the BitPay payment gateway into your Perfex CRM installation, enabling you to accept Bitcoin payments directly from your clients. The module supports both test mode (for development and verification) and live mode (for production transactions).

Requirementsโ€‹

Before installing the module, ensure you have the following:

  • A working installation of Perfex CRM
  • Administrator access to the Perfex CRM backend
  • The downloaded module archive from Themesic
  • The BitPay app installed on your device (mobile or desktop) for wallet management
  • A BitPay merchant account (test or live, depending on your setup stage)

Installationโ€‹

warning

The BitPay module is installed differently from most Perfex CRM modules. You must extract the files directly into your Perfex CRM root directory โ€” do not use the Modules upload menu.

Follow these steps to install the BitPay module:

  1. Extract the downloaded archive to a location on your computer.
  2. Inside the extracted folder, locate the file named upload.zip.
  3. Extract the contents of upload.zip directly into the root directory of your Perfex CRM installation.
  4. Log in to your Perfex CRM Admin panel.
  5. Navigate to SETUP โ†’ Modules.
  6. Locate the BitPay module in the list and press Activate.
  7. Navigate to Settings to begin configuration.

Test Mode Setupโ€‹

Before going live, it is strongly recommended to test the integration using BitPay's sandbox environment. This involves setting up both a client wallet and a merchant account in test mode.

Client Wallet Setupโ€‹

  1. Download the BitPay app for your operating system (mobile or desktop).
  2. Create a new BTC wallet within the app.
  3. Enable testnet mode in the wallet settings.
  4. Copy the wallet's RECEIVE address.
  5. Visit bitcoinfaucet.uo1.net and paste your receive address to obtain test Bitcoin funds.
tip

Test funds are free and allow you to simulate real transactions without spending actual Bitcoin.

Merchant Account Setupโ€‹

  1. Create a test BitPay merchant account at test.bitpay.com.
  2. Once logged in, navigate to Payment Tools โ†’ Settlements Tab.
  3. Click Add Settlement Currency.
  4. Paste your BTC test wallet address (the receive address from the previous step) into the settlement currency field and save.

Pairing with Perfex CRMโ€‹

  1. In your test BitPay merchant dashboard, generate a pairing code.

  2. To generate the pair key, open the following URL in your browser (replace the placeholders with your actual values):

    http://YOURDOMAIN.COM/modules/bitpay_gateway/libraries/vendor/bitpay/php-client/examples/tutorial/pair.php?paring_code=YOURPARINGCODE

  3. From the response, copy only the token value.

  4. Go to your Perfex CRM module settings and paste the token into the appropriate field.

  5. Enable the Test Mode toggle in the module settings.

  6. Press Save.

warning

A pairing code can only be used once. If you need to re-pair, generate a new pairing code from the BitPay dashboard.

Once test mode is configured, you can generate an invoice in Perfex CRM and complete a payment using your test wallet to verify the full payment flow.

Going Liveโ€‹

When you are satisfied with your test results, follow these steps to switch to live mode:

  1. Create a live BitPay merchant account at bitpay.com (if you have not already).
  2. Repeat the Merchant Account Setup and Pairing steps above, but use the live BitPay dashboard at bitpay.com instead of test.bitpay.com.
info

In live mode, you do not need to paste a wallet address in the Settlement Currency area โ€” BitPay handles settlement routing automatically for production accounts.

  1. Paste the new live token into your Perfex CRM module settings.
  2. Disable the Test Mode toggle.
  3. Press Save.

Your Perfex CRM installation is now ready to accept real Bitcoin payments through BitPay.

warning

If you encounter any issues during installation or configuration, please contact support at https://themesic.com/support.