README

A Magento 2 module that adds a payment method which only ever appears when an admin is placing or editing an order in the backend — it never shows up on the storefront, in the REST checkout API, or in GraphQL.

🛑 The Problem

Sometimes store staff need to record an order as paid by a method that only makes sense internally — a bank transfer confirmed by phone, a card payment taken over the phone, a manual reconciliation — without exposing anything resembling it as a choice to customers at checkout. Repurposing a core payment method like Purchase Order for this risks confusing anyone genuinely using that method, and there's no built-in "admin only" payment option in Magento.

🛠️ The Solution

This module adds its own Admin Payment method, built on Magento's native canUseCheckout / canUseInternal distinction:

It reports itself as unavailable for storefront checkout, the REST checkout API, and GraphQL.
It remains fully selectable when an admin creates or edits an order in Sales > Orders.
It doesn't touch or override any core payment method — existing methods like Purchase Order keep working exactly as before.

✨ Features

Admin-Only by Design: Uses Magento's own payment method flags rather than hiding a method with a plugin.
Optional Reference Field: A free-text "Transaction / Receipt Reference" field for accounting purposes — not required, not validated.
Visible on the Order: The reference (if entered) is shown in the Payment Information panel on both the admin order view and the customer's order view.
Zero Interference: Doesn't modify or plugin any core Magento payment method.

📦 Installation

1. Install via Composer

composer require blueprint3d/module-admin-payment

2. Enable the module

php bin/magento module:enable BluePrint3D_AdminPayment

3. Run setup upgrade

php bin/magento setup:upgrade

4. Compile and flush cache

php bin/magento setup:di:compile
php bin/magento cache:flush

👨‍💻 Usage

Enable Admin Payment under Stores > Configuration > Sales > Payment Methods. When creating or editing an order from the admin panel, select Admin Payment and optionally enter a reference. It will never appear as an option on the storefront.

📜 License

This software is provided free of charge for personal or commercial use. However, the resale, redistribution, or sublicensing of this source code, modified or unmodified, for direct financial gain is strictly prohibited.

Please see the LICENSE.txt file for full terms and conditions.

Owned by: BluePrint3D Ltd (Company Registration Number: 13473806)
Email: support@blueprint3d.dev

blueprint3d / module-admin-payment

Package info

Security

Statistics