Difference between revisions of "BitPay"

From WHMCS Documentation

(Adding the BitPay Payment Gateway)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
[https://bitpay.com BitPay] is the first and most experienced company in bitcoin payments. BitPay builds powerful tools for secure bitcoin payment acceptance, savings, and spending.
 
{{gateways
 
{{gateways
 
| onetime = yes
 
| onetime = yes
 
}}
 
}}
  
[https://bitpay.com BitPay] is the first and most experienced company in bitcoin payments. BitPay builds powerful tools for secure bitcoin payment acceptance, savings, and spending.
+
==Adding the BitPay Payment Gateway==
  
==Setup==
 
 
[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]
 
[[File:Videotutorial.png‎|center|link=https://www.youtube.com/watch?v=L0B6KbPaGKE&hd=1|Watch Video Tutorial]]
  
Begin by activating the [[Payment_Gateways|payment gateway]] under '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Payment Gateways''' or, prior to WHMCS 8.0, '''Setup > Payments > Payment Gateways'''. Choose ''BitPay'' from the '''All Payment Gateways''' tab.
+
To set up the BitPay payment gateway in WHMCS:
 +
 +
# Go to the appropriate location for your version of WHMCS:
 +
#* For WHMCS 8.0 and later, go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > Apps & Integrations''' or '''Addons > [[Apps and Integrations|Apps & Integrations]]'''.
 +
#* For WHMCS 7.10 and earlier, go to '''Setup > Products/Services > [[Payment Gateways]]''' and choose '''All Payment Gateways'''.
 +
# Click '''BitPay'''.
 +
# Check '''Show on Order Form''' to display this payment method in the Client Area during checkout.
 +
# Enter a display name.
 +
# Link WHMCS to your BitPay account:
 +
## Log in to BitPay.
 +
## Go to '''Payment Tools > Manage API Tokens'''.
 +
## Enter your pairing code.
 +
## Return to WHMCS.
 +
# Select a transaction speed.
 +
#* The transaction speed setting determines how quickly an invoice payment is "confirmed," which would be the status at which you would fulfill and complete the order.
 +
#* For more information on the Transaction Speeds and what they mean, see [https://support.bitpay.com/hc/en-us/articles/202943915-What-does-the-Transaction-Speed-setting-do|the BitPay documentation].
 +
# Click '''Save Changes'''.
 +
# Link WHMCS to your BitPay account:
 +
## Log in to BitPay.
 +
## Go to '''Payment Tools > Manage API Tokens'''.
 +
## Enter your pairing code and API key. Click '''Generate New Key and Pairing Code''' if a new API key or code is required.
  
Once activated, you can then enter the configuration details explained below.
+
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>&nbsp;
 +
This module requires either the GMP or BCMATH PHP extensions. You can confirm that your PHP environment has at least one these extensions by reviewing '''Utilities > System > [[PHP Info]]'''.
 +
</div>
  
<div class="docs-alert-info"><i class="fa fa-info-circle fa-fw"></i>&nbsp; This module requires either the GMP or BCMATH PHP extensions. You can confirm that your PHP environment has at least one these extensions by reviewing '''Utilities > System > PHP Info'''.</div>
+
=== Test Mode === 
  
===API Key===
+
<div class="docs-alert-warning">
Saving the gateway configuration automatically generates an '''API Key'''. Leave this field empty to automatically generate the value. <br/>
+
<span class="title">Note</span><br />
Click the ''Generate New Key and Pairing Code'' button if a new API key is required.
+
When switching between Live Move and Test Mode, click the '''Generate New Key and Pairing Code''' button each time.
 +
</div>
  
===Pairing Code===
+
You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.
Saving the gateway configuration automatically generates the '''Pairing Code'''.<br/>
 
Click the ''Generate New Key and Pairing Code'' button if a new pairing key is required.
 
  
Enter this pairing code into your BitPay account in '''Payment Tools > Manage API Tokens'''.
+
== Troubleshooting ==
  
===Transaction Speed===
+
''N/A''
The transaction speed setting determines how quickly an invoice payment is "confirmed," which would be the status at which you would fulfil and complete the order.
 
  
For more information on the Transaction Speeds and what they mean, see [https://support.bitpay.com/hc/en-us/articles/202943915-What-does-the-Transaction-Speed-setting-do|the BitPay documentation].
+
{{modules}}
 
 
===Test Mode===
 
Check this to enable '''Test Mode''' using BitPay.
 
 
 
When switching between Live Move and Test Mode, click the '''Generate New Key and Pairing Code''' button each time.
 

Latest revision as of 19:28, 28 September 2022

About this Module

BitPay is the first and most experienced company in bitcoin payments. BitPay builds powerful tools for secure bitcoin payment acceptance, savings, and spending.

Supported Features

Type One Time Recurring Refunds Reversals
3rd Party Yes No No

No


Adding the BitPay Payment Gateway

Watch Video Tutorial

To set up the BitPay payment gateway in WHMCS:

  1. Go to the appropriate location for your version of WHMCS:
    • For WHMCS 8.0 and later, go to Configuration () > Apps & Integrations or Addons > Apps & Integrations.
    • For WHMCS 7.10 and earlier, go to Setup > Products/Services > Payment Gateways and choose All Payment Gateways.
  2. Click BitPay.
  3. Check Show on Order Form to display this payment method in the Client Area during checkout.
  4. Enter a display name.
  5. Link WHMCS to your BitPay account:
    1. Log in to BitPay.
    2. Go to Payment Tools > Manage API Tokens.
    3. Enter your pairing code.
    4. Return to WHMCS.
  6. Select a transaction speed.
    • The transaction speed setting determines how quickly an invoice payment is "confirmed," which would be the status at which you would fulfill and complete the order.
    • For more information on the Transaction Speeds and what they mean, see BitPay documentation.
  7. Click Save Changes.
  8. Link WHMCS to your BitPay account:
    1. Log in to BitPay.
    2. Go to Payment Tools > Manage API Tokens.
    3. Enter your pairing code and API key. Click Generate New Key and Pairing Code if a new API key or code is required.
 

This module requires either the GMP or BCMATH PHP extensions. You can confirm that your PHP environment has at least one these extensions by reviewing Utilities > System > PHP Info.

Test Mode

Note
When switching between Live Move and Test Mode, click the Generate New Key and Pairing Code button each time.

You can use test mode to simulate payment processing without actually causing a transaction to occur. This can be useful to test your configuration.

Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible