PHPackages bitpay/module-bpcheckout - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Payment Processing](/categories/payments) 4. / 5. bitpay/module-bpcheckout ActiveMagento2-module[Payment Processing](/categories/payments) bitpay/module-bpcheckout ======================== 10.2.0(12mo ago)1712.5k↓30%23[1 PRs](https://github.com/bitpay/bitpay-checkout-magento2/pulls)mitPHPPHP ~8.1CI passing Since Sep 23Pushed 12mo ago5 watchersCompare [ Source](https://github.com/bitpay/bitpay-checkout-magento2)[ Packagist](https://packagist.org/packages/bitpay/module-bpcheckout)[ RSS](/packages/bitpay-module-bpcheckout/feed)WikiDiscussions 10.2.x Synced 1mo ago READMEChangelog (10)Dependencies (1)Versions (26)Used By (0) Quick Setup =========== [](#quick-setup) [![Build Status](https://camo.githubusercontent.com/44ffb22287742577bbe222f2aa74ee56d47dfaace4d0bf2a7ae8b11c10052867/68747470733a2f2f7472617669732d63692e6f72672f6269747061792f6269747061792d636865636b6f75742d6d6167656e746f322e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/bitpay/bitpay-checkout-magento2) This version requires the following - A BitPay merchant account ([Test](http://test.bitpay.com) or [Production](http://www.bitpay.com)) - An API Token ([Test](https://test.bitpay.com/dashboard/merchant/api-tokens) or [Production](https://bitpay.com/dashboard/merchant/api-tokens) - When setting up your token, **uncheck** the *Require Authentication button* - Magento 2.x Installation ============ [](#installation) This module is now installable via Composer using the following command: ``` composer require bitpay/module-bpcheckout ``` After installing via Composer, run the following commands: ``` php bin/magento setup:upgrade php bin/magento module:enable Bitpay_BPCheckout php bin/magento setup:static-content:deploy -f ``` - Flush your Magento2 Caches ``` php bin/magento cache:flush ``` You can now activate BitPay in the *Stores->Configuration->Sales->Payment Methods* - **Enabled** - Status for payment method - - **Send emails for BitPay Orders** - Allows an Admin to suppress Order emails for BitPay Orders. Default to false - **Title** - This will be the title that appears on the checkout page - **Environment** - Choose **Test** or **Production**, depending on your current setup - **Status mapping - BitPay invoice / Magento order** - Map the BitPay “confirmed” invoice status to the preferred Magento order status, based on the transaction speed you have selected in your BitPay [dashboard](https://bitpay.com/dashboard/settings/edit/order) - **Status mapping - BitPay invoice / Magento order on BitPay Refunds** - If set to TRUE, Magento will set the Order State to Closed. If set to FALSE, no changes will be made to the Magento order - **Status mapping - BitPay invoice / Magento order on BitPay Canceled** - If set to TRUE, Magento will set the Order State to Canceled after the order has expired. If set to FALSE, no changes will be made to the Magento order - **Checkout Flow** - **Redirect** - This will send the user to the BitPay invoice screen, and they will be redirected after the transaction to the Order Completed page - **Modal** - This will open a popup modal on your site, and will display the order details once the transaction is completed. - **New Order Status** - Select status for new order - **Payment from Specific Countries** - You **MUST** select the countries to enable BitPay to appear in the checkout ### Merchant Token [](#merchant-token) To generate merchant token visit \*Admin->Stores->Configuration->Bitpay->Merchant Facade->Authenticate.\* You need to specify following data: \* Token Label \* Password (Used to decrypt your private key) \* Full path to private key (e.g /app/secure/private2.key) Note: Each time before creating token please save private key path and password When you hit Create token button you will get pairing code that you use in [Bitpay Token](https://test.bitpay.com/dashboard/merchant/api-tokens) ### Refund [](#refund) \* Refund setting are located in \*Admin->Stores->Configuration->Bitpay->Merchant Facade->Refund.\* There are following options to set: \* Preview Mode \* Immediate Refund \* Buyer Pays Refund Fee \* Suppress Order Emails ``` All options by default are set to false. ``` - Refund request is send when user attempts to create a Credit Memo against a BitPay Order. Refund amount is configured in the credit meno This plugin also includes an IPN (Instant Payment Notification) endpoint that will update your Magento 2 order status. An order note will automatically be added with a link to the BitPay invoice to monitor the status - Initially your order will be in a **Pending** status when it is intially created, unless you choose a different configuration - After the invoice is paid by the user, it will change to a **Processing** status - When BitPay finalizes the transaction, it will change to a **Complete** status, and your order will be safe to ship, allow access to downloadable products, etc. - If you decide to refund a payment via your BitPay dashboard, the Magento 2 order status will change to **Closed** once the refund is executed. ### Health Score 47 — FairBetter than 94% of packages Maintenance50 Moderate activity, may be stable Popularity38 Limited adoption so far Community22 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~44 days Recently: every ~37 days Total 23 Last Release 364d ago Major Versions 7.2.0 → 8.0.02022-10-18 8.1.0 → 9.0.02023-06-16 9.4.0 → 10.0.x-dev2024-12-19 PHP version history (2 changes)7.0.0PHP ~7.0.13||~7.1.0||~7.2.0||~7.3.0||~7.4.0||~8.1 9.1.0PHP ~8.1 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/2554930?v=4)[BitPay](/maintainers/bitpay)[@bitpay](https://github.com/bitpay) --- Top Contributors [![thejoshualewis](https://avatars.githubusercontent.com/u/392836?v=4)](https://github.com/thejoshualewis "thejoshualewis (132 commits)")[![p-maguire](https://avatars.githubusercontent.com/u/33061385?v=4)](https://github.com/p-maguire "p-maguire (100 commits)")[![virtua-wkogut](https://avatars.githubusercontent.com/u/55840958?v=4)](https://github.com/virtua-wkogut "virtua-wkogut (60 commits)")[![bobbrodie](https://avatars.githubusercontent.com/u/123703?v=4)](https://github.com/bobbrodie "bobbrodie (22 commits)")[![swlodarski](https://avatars.githubusercontent.com/u/1062034?v=4)](https://github.com/swlodarski "swlodarski (13 commits)")[![swlodarski-sumoheavy](https://avatars.githubusercontent.com/u/28725696?v=4)](https://github.com/swlodarski-sumoheavy "swlodarski-sumoheavy (11 commits)")[![mwarzybok-sumoheavy](https://avatars.githubusercontent.com/u/113988788?v=4)](https://github.com/mwarzybok-sumoheavy "mwarzybok-sumoheavy (7 commits)")[![vbuck](https://avatars.githubusercontent.com/u/4059757?v=4)](https://github.com/vbuck "vbuck (2 commits)")[![danstaver](https://avatars.githubusercontent.com/u/83032891?v=4)](https://github.com/danstaver "danstaver (2 commits)")[![frankielpm](https://avatars.githubusercontent.com/u/108254810?v=4)](https://github.com/frankielpm "frankielpm (1 commits)") ### Embed Badge ![Health badge](/badges/bitpay-module-bpcheckout/health.svg) ``` [![Health](https://phpackages.com/badges/bitpay-module-bpcheckout/health.svg)](https://phpackages.com/packages/bitpay-module-bpcheckout) ``` ### Alternatives [omnipay/paypal PayPal gateway for Omnipay payment processing library 3156.8M53](/packages/omnipay-paypal)[eduardokum/laravel-boleto Biblioteca com boletos para o laravel 626351.9k2](/packages/eduardokum-laravel-boleto)[tbbc/money-bundle This is a Symfony bundle that integrates moneyphp/money library (Fowler pattern): https://github.com/moneyphp/money. 1961.9M](/packages/tbbc-money-bundle)[2checkout/2checkout-php 2Checkout PHP Library 83740.3k2](/packages/2checkout-2checkout-php)[vrajroham/laravel-bitpay BitPay wrapper for laravel 7669.8k](/packages/vrajroham-laravel-bitpay)[smhg/sepa-qr-data Generate QR code data for SEPA payments 61717.2k5](/packages/smhg-sepa-qr-data) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)