Manatee Bitcoin and Bitcoin Cash Gateway for WooCommerce

Descripción

Manatee adds one “Pay with crypto” method to WooCommerce checkout. Within it, customers can choose Bitcoin (BTC) or Bitcoin Cash (BCH). The plugin creates an asset-scoped payment, shows the returned address, amount, wallet URI, and local QR code, then updates the order from signed webhook events.

Manatee is non-custodial. The plugin does not hold customer funds, request wallet seeds or private keys, or run blockchain node logic inside WordPress. Bitcoin and Bitcoin Cash are available for testnet and mainnet payments; each asset requires a receive wallet configured for the selected API key network.

The plugin is built for merchants and developers who want to accept supported on-chain crypto payments while keeping checkout, order metadata, and webhook handling inside WordPress.

Features

  • One WooCommerce crypto payment method with a clear BTC/BCH selector.
  • Non-custodial flow: no wallet seed, private key, or hosted wallet custody is required by the plugin.
  • Test and live environment mode setting.
  • Shared network API key and webhook secret with separate BTC and BCH confirmation settings.
  • Cached plan allowance and active webhook monitor overview at the top of settings.
  • Read-only API connection and usage refresh from the gateway settings screen.
  • Asset-specific customer payment screen with address, satoshi amount, wallet URI, local QR code, expiry, and automatic status polling.
  • Classic checkout and WooCommerce Checkout Blocks support.
  • Signed webhook verification with timestamp and event ID handling.
  • Automatic WooCommerce order updates after Manatee payment events.
  • Pending Manatee payments are cancelled when the WooCommerce order is cancelled.
  • Order metadata for asset, network, payment ID, address, satoshi amount, pricing data, environment, transaction ID, confirmations, status, and expiry.
  • WooCommerce logging with secret redaction.
  • WooCommerce HPOS compatibility.

How it works

  1. A customer selects “Pay with crypto” and chooses BTC or BCH.
  2. The plugin sends the WooCommerce order total to Manatee as fiat_amount and fiat_currency.
  3. The plugin calls the matching /v1/btc/payments or /v1/bch/payments route.
  4. The customer sees asset-specific payment instructions on the order received page.
  5. Manatee monitors the payment lifecycle and sends signed webhook events to the shop.
  6. The plugin verifies signature, timestamp, event ID, payment ID, asset, network, and order mapping before mutation.
  7. WooCommerce order status and Manatee payment metadata are updated automatically.
  8. If a pending WooCommerce order is cancelled, the plugin asks Manatee to cancel the pending payment. Payments already detected on-chain are left for manual review.
  9. The order received page polls the shop for verified status updates using the WooCommerce order key.

Setup

Before accepting payments, configure the gateway in WooCommerce > Settings > Payments > Crypto via Manatee:

  • Environment Mode: choose Test or Live.
  • API Base URL: use https://api.manatee-api.io unless Manatee support tells you otherwise.
  • API Key: enter the Manatee API key for the selected environment.
  • Bitcoin / Bitcoin Cash: choose which configured assets customers may use.
  • Webhook Secret: enter the secret used to verify Manatee webhook signatures.
  • Webhook URL Override: leave empty unless Manatee cannot reach the automatically generated WordPress REST endpoint.
  • BTC / BCH Confirmations Required: configure the confirmation target for each asset.
  • Payment Expiry Minutes: define how long new payment requests remain payable.
  • Order Status When Detected: choose the status used when a transaction is seen but not fully confirmed.
  • Order Status When Confirmed: choose the fallback status used after confirmation if WooCommerce cannot complete the payment automatically.

The settings header shows remaining monthly confirmed mainnet payments and active webhook monitors by network. “Save, refresh and test connection” persists changed settings before sending a read-only GET /v1/usage request.
The API Key and Webhook Secret fields include reveal controls so an authorized WooCommerce administrator can verify the entered values before saving.

Test mode

Use Test mode with a testnet Manatee API key before going live. Enable BTC or BCH only after configuring the corresponding receive wallet for that network in Manatee.

When switching to Live mode, use a mainnet Manatee API key, review the webhook secret, confirm that the webhook URL is reachable from the public internet, and test a low-value payment before opening the payment method to customers.

Privacy / Data Sent to Manatee API

When a customer selects BTC or BCH, the plugin sends the WooCommerce fiat amount, currency, webhook URL, required confirmation count, expiry window, underpayment tolerance, and order reference to the corresponding Manatee API route.

The WooCommerce order stores asset, network, Manatee payment ID, payment address, satoshi amount, pricing metadata, environment mode, status, transaction ID, confirmations, and expiry.

Webhook events are verified with the X-Manatee-Signature, X-Manatee-Timestamp, and X-Manatee-Event-Id headers before order mutation.

External services

This plugin connects to the Manatee Payment API to create and verify non-custodial BTC and BCH payments for WooCommerce orders.

When a customer chooses an asset, the plugin sends the order amount, currency, webhook URL, required confirmations, expiry, tolerance, and reference to the asset-specific API route. The API returns asset, network, payment ID, address, satoshi amount, exchange-rate metadata, expiry, and status.

The settings screen sends a briefly cached read-only usage request, and the merchant can refresh it with the connection-test action. When a pending order is cancelled, the plugin may send an asset-scoped cancellation request. Manatee sends signed webhook events back to update the order after detection or confirmation.

This service is provided by Manatee.

Privacy Policy: https://manatee-api.io/privacy-policy

Capturas

Instalación

  1. Upload the manatee-bitcoin-payments folder to /wp-content/plugins/.
  2. Activate the plugin in WordPress.
  3. Make sure WooCommerce is installed and active.
  4. Go to WooCommerce > Settings > Payments.
  5. Enable “Crypto via Manatee”.

FAQ

Does Manatee hold customer funds?

No. The plugin is built for non-custodial BTC and BCH payment flows. It does not hold funds or ask for wallet seeds or private keys.

Do I need to share my wallet seed or private key?

No. Never enter a wallet seed or private key into this plugin.

Can I test payments before going live?

Yes. Configure Test mode with a testnet Manatee API key, then create a WooCommerce test order and verify that payment instructions and webhook updates work.

Why does checkout say that crypto payments are temporarily at capacity?

Each payment with a webhook occupies one concurrent-payment slot while it is pending or detected. BTC and BCH on the same network API key share this capacity. A slot is released when the payment is confirmed, expired, or cancelled. Failed webhook delivery attempts do not consume additional slots.

How many confirmations are required?

You can configure separate BTC and BCH confirmation counts. The plugin sends the selected asset’s value when creating a payment.

What happens when a transaction is first detected?

Manatee sends a signed event when a transaction is detected. The plugin verifies the event and applies the configured “Order Status When Detected” status.

What happens when a payment is confirmed?

Manatee sends a signed confirmation event. The plugin verifies the event, stores transaction metadata, and completes or updates the WooCommerce order.

What happens if a payment expires or fails?

The plugin handles signed terminal events and can move the order to the configured unpaid or failed state without completing the payment.

What happens if I cancel a WooCommerce order?

If the payment is still pending, the plugin calls the matching asset cancellation endpoint. Detected or confirmed on-chain payments are not automatically cancelled and require manual review.

Does this support Lightning payments?

No. The plugin focuses on supported on-chain BTC and BCH payments.

Does this plugin support WooCommerce HPOS?

Yes. The plugin declares WooCommerce custom order tables compatibility and uses WooCommerce CRUD methods for order metadata.

Does this plugin support Checkout Blocks?

Yes. The shared crypto method and BTC/BCH selector work in classic checkout and WooCommerce Checkout Blocks.

Reseñas

No hay reseñas para este plugin.

Colaboradores y desarrolladores

«Manatee Bitcoin and Bitcoin Cash Gateway for WooCommerce» es un software de código abierto. Las siguientes personas han colaborado con este plugin.

Colaboradores

Registro de cambios

0.2.0

  • Added Bitcoin Cash payment creation, instructions, cancellation, and webhook handling.
  • Grouped BTC and BCH under one customer-facing crypto payment method.
  • Added BTC/BCH selection to classic checkout and Checkout Blocks.
  • Added asset and network isolation for stored orders and signed webhook events.
  • Added a cached settings overview for monthly plan usage and active webhook monitors.
  • Added separate BTC and BCH confirmation settings.

0.1.2

  • Added customer-facing guidance when a detected or confirmed Bitcoin payment belongs to a cancelled order.
  • Fixed the cancellation warning being visible before an order was cancelled.

0.1.1

  • Added structured handling for concurrent payment limit responses.
  • Added a clear customer-facing message when Bitcoin checkout capacity is reached.
  • Added detailed payment capacity information to WooCommerce order notes.
  • Added unit tests for API limit responses and checkout handling.

0.1.0

  • Initial WordPress.org submission candidate.
  • Added classic WooCommerce checkout support.
  • Added WooCommerce Checkout Blocks support.
  • Added Manatee API payment creation.
  • Added pending payment cancellation when WooCommerce orders are cancelled.
  • Added customer Bitcoin payment instructions with wallet URI, local QR code, and automatic status polling.
  • Added signed timestamped webhook verification.
  • Added WooCommerce order metadata and status updates.
  • Added API connection test and setup feedback.
  • Added WooCommerce HPOS compatibility.