orboni / module-payment
Crypto payments for Magento 2 through Orboni: USDT, USDC, BTC, ETH and more, paid straight to your own wallets.
Package info
github.com/orboni/magento2-payment
Type:magento2-module
pkg:composer/orboni/module-payment
Requires
- php: ~8.1.0||~8.2.0||~8.3.0||~8.4.0||~8.5.0
- ext-json: *
- magento/framework: ^103.0.7
- magento/module-backend: ^102.0
- magento/module-checkout: ^100.4
- magento/module-config: ^101.2
- magento/module-cron: ^100.4
- magento/module-payment: ^100.4
- magento/module-quote: ^101.2
- magento/module-sales: ^103.0
- magento/module-store: ^101.1
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Crypto payments for Magento Open Source and Adobe Commerce, paid straight to your own wallets: USDT, USDC, BTC, ETH, SOL, TON, TRX and more, 17 coins on 16 networks. Orboni never holds your money and never has your keys.
Orboni_Payment adds Crypto (USDT, USDC, BTC and more) to the payment step of Magento's checkout. The customer places the order and pays on Orboni's payment page; a signed webhook tells Magento, which invoices the order and sends its emails as with any other payment.
Requirements
- Magento Open Source or Adobe Commerce 2.4.7 or later (tested on 2.4.7-p10, 2.4.8-p5 and 2.4.9), with Magento's standard checkout: Luma, or a theme built on it
- Magento's cron running
- An Orboni account (https://orboni.com) with at least one wallet added
Install
With Composer, from your Magento's root:
composer require orboni/module-payment bin/magento module:enable Orboni_Payment bin/magento setup:upgrade bin/magento setup:di:compile # in production mode bin/magento setup:static-content:deploy # in production mode bin/magento cache:flush
Or, without Composer: unzip orboni-module-payment-<version>.zip from the releases into app/code/Orboni/Payment/ and run the same bin/magento commands.
Set up
Stores → Configuration → Sales → Payment Methods → Orboni (crypto payments):
- In the Orboni dashboard, Developers → API keys: copy a secret key into Secret Key, a test key (
sk_test_…) first. The key decides test or live. - Developers → Webhooks: add an endpoint at the Webhook Address shown under it (
https://<your store>/orboni/webhook), with every event or at least thecheckout.session.*ones, and paste its signing secret (whsec_…) into Webhook Signing Secret. - Set Enabled to Yes and save.
Place a test order: signed in to the Orboni dashboard, the payment page has a button that simulates the payment. Then swap in a live key. Each website can have its own key.
How an order moves
- Pay with crypto places the order as Pending Payment, without its confirmation email, and sends the customer to Orboni's payment page for the order's total, in the order's currency. Coming back to it while the page has more than five minutes left shows the same page.
- Paid: the order is invoiced (the session's id is the transaction) and moves to Processing; the order and invoice emails go out then.
- While the network confirms a payment, and while a page is partly paid, the order is in Payment Review. A page that closed partly paid, or money held for your review in the Orboni dashboard, puts it On Hold with a comment saying what arrived.
- Cancel and go back on the payment page cancels the order and gives the customer their cart back. A page that ran out unpaid leaves the order Pending Payment until Magento's Pending Payment Order Lifetime cancels it. Cancelling an order yourself closes its payment page.
- Money that paid an order left the chain (a reorganisation or a double spend): the order goes On Hold until the Orboni dashboard shows it paid again. More money after the order was paid, a second payment, or a payment to a cancelled order: a comment on the order says what happened and what to do.
- Every webhook and the customer's return are checked by reading the payment back from Orboni with your secret key. Every 15 minutes the cron reads back open orders whose webhook did not arrive.
Good to know
- Orboni takes prices in 37 currencies; the method shows only in those. The least payment is $1.
- Refunds: the money is in your wallet, so send it back from there, record it in the Orboni dashboard and make an offline credit memo in Magento.
- Debug Log writes each request and webhook to
var/log/orboni.log; errors are written either way, keys and secrets never. - Not offered for orders created in the admin, for multiple-address checkout, or for subscriptions.
- Full guide: https://orboni.com/docs/magento
Pricing
The module is free. Orboni charges 0.5% of each completed live payment: no monthly fee, no setup fee; test payments are never billed.
Support
support@orboni.com, or the support chat in the Orboni dashboard.
License
MIT, see LICENSE.