Setting up BriizPay in Magento 2
About fifteen minutes for whoever looks after your store, most of it waiting for your business checks. You need command line access to the store, as for any Magento module.
- 1
Create a BriizPay account
Sign up and complete the checks on your business. You need an approved company and a bank account on file before you can take a payment, so start here rather than with the module.
- 2
Install the module
From your Magento root, install it with Composer and run the setup commands below. Without Composer, download the module instead, unzip it into app/code/BriizPay/PayByBank so that registration.php sits directly in that folder, and run the same commands from module:enable onwards. Later updates are composer update briizpay/module-paybybank and the same commands.
composer require briizpay/module-paybybank bin/magento module:enable BriizPay_PayByBank bin/magento setup:upgrade # In production mode, also: bin/magento setup:di:compile bin/magento setup:static-content:deploy en_GB bin/magento cache:flush - 3
Connect your store in BriizPay
In BriizPay open Integrations, choose Magento, and enter your store's web address. It creates your API key and tells us where to send payment notifications.
- 4
Paste the two values into Magento
In the Magento admin go to Stores, Configuration, Sales, Payment Methods, and open BriizPay - Pay by bank. Paste the API key into the field named API key, and the signing secret into Webhook signing secret. Set Enabled to Yes and save.
- 5
Place one real order
Put something cheap in your basket, choose Pay by bank and place the order. You go straight to choosing your bank. Within a second or two of approving the payment, the order should be invoiced and move to Processing on its own.
- 6
Give customers a reason to pick it
A card is a habit, so most shoppers will not choose pay by bank unless it saves them something. On the same settings page, set Offer a discount for paying by bank to Yes, choose a percentage or a fixed amount, and save. The method then reads 'BriizPay - Pay by bank and save £1.20' at checkout with the saving worked out for that basket, and the discount appears as its own line, Pay by bank discount, on the order, invoice and emails. It comes off the items after coupons, not shipping, and only applies to orders paid by bank. A card typically costs you 1.5% + 20p and BriizPay 0.5%, so from about £40 a basket the card fee you save pays for a 0.5% discount.
The two secrets are shown once
We keep only a hash of the API key, and neither value is ever displayed again, so nobody can show them to you later, including us. Copy both into Magento before you leave the page. Magento stores them encrypted. If you lose one, connect your store again for a fresh pair and revoke the old key.
When something is not right
Pay by bank does not appear at checkout
The method hides itself rather than failing at the last step. Check that Enabled is Yes, that the API key is saved, that the order is in pounds, and that Payment from specific countries is not excluding the customer's country. Then flush the cache. In production mode, a missing static content deploy leaves the checkout without the method's script, so run setup:static-content:deploy.
The order is On Hold instead of Processing
The module checks the amount it is told against the order's grand total, and holds the order rather than marking it paid if the payment was short. A person looking at it is better than a wrong order marked paid. The order comments name both figures.
The customer paid but the order is still Pending Payment
Open Integrations, Magento in BriizPay and look at the recent notifications. It shows whether we tried and what your store said back. The notification goes to your store's /briizpay/webhook address, which the module shows under Webhook URL on its settings page, so check the two match. We retry on a backoff, so a store that was briefly down catches up on its own.
It says the signature is invalid
The signing secret in Magento does not match the one BriizPay is signing with. Connect your store again in BriizPay to get a fresh pair, and paste both into the settings. The secret is shown once and cannot be recovered afterwards.
My store uses Hyva Checkout
The module adds its payment method to Magento's standard checkout. Hyva Checkout and other replacement checkouts render payment methods their own way and need a renderer for that checkout. Talk to us before installing.
My store is on a local address or behind a login
We cannot send payment notifications to a site only you can reach, which includes anything on localhost or a staging site behind HTTP authentication. Use a publicly reachable https address.