WooCommerce plugin
The Paybrain Payments plugin adds Paybrain as a payment method in your WooCommerce checkout. Customers pay by card through Stripe, either on your checkout page or on a Paybrain-hosted page, and each order shows up in Paybrain with its items and shipping address so you can track fulfillment.
What you need
- WordPress 5.8 or later
- WooCommerce 5.0 or later
- PHP 7.4 or later
- HTTPS on your store
- A Paybrain account on Premium, with Stripe connected
Install the plugin
Download it
Download the plugin: paybrain-payments-woocommerce-1-1-8.zip (version 1.1.8).
Upload it to WordPress
In WordPress, go to Plugins›Add New›Upload Plugin, choose the ZIP file and click Install Now. Then click Activate.
To install by hand instead, unzip it, copy the folder into
/wp-content/plugins/and activate Paybrain Payments for WooCommerce from the Plugins screen.
Create an API key
Open API Keys
On the web, go to Settings›API Keys and click Manage Keys.
Create a key for your store
Click Create API Key, name it, for example "WooCommerce Store", and click Create Key.
Copy it
The full key, starting with
pbk_, is shown once. Copy it now. If you lose it, create a new key and paste that into WooCommerce instead.
Connect your store
In WordPress, go to WooCommerce›Settings›Payments and click Paybrain.
Turn it on
Check Enable Paybrain Payments.
Turn off Test Mode
Uncheck Enable Test Mode (Developer). It's on by default and points the plugin at a developer server, so checkout won't work for customers until it's off.
Paste your key
Paste the key into Live API Key. Leave Live API URL as
https://api.paybrain.io.Choose a checkout style
Leave Hosted Redirect Checkout off to take cards on your own checkout page, or turn it on to send customers to a Paybrain-hosted page. See Checkout styles.
Save the settings
Click Save changes.
The plugin doesn't check the key when you save. Place a small real order to confirm it works.
Settings
| Setting | Default | What it does |
|---|---|---|
| Enable/Disable | Off | Shows Paybrain at checkout |
| Title | Credit Card (Paybrain) | The payment method name customers see |
| Description | Pay securely with your credit card via Paybrain. | The text under it |
| Test Mode (Developer) | On | For Paybrain developers. Turn it off for your store. |
| Live API URL | https://api.paybrain.io | Where the plugin reaches Paybrain |
| Live API Key | Your pbk_ key | |
| Hosted Redirect Checkout | Off | Send customers to a Paybrain-hosted page to pay |
| Redirect Base URL | https://paybrain.io | Where the hosted page lives. Leave it as is. |
Checkout styles
| Style | How it works |
|---|---|
| On your checkout page (default) | A Stripe card form appears in your WooCommerce checkout. The customer pays without leaving your site. |
| Hosted Redirect Checkout | The customer sees You will be redirected to Paybrain to complete your payment securely., pays on a Paybrain page and comes back to your order confirmation page. |
With hosted checkout, if the customer comes back without paying, the plugin cancels the pending order, puts the items back in their cart and returns them to checkout.
Ship your orders
Each WooCommerce order appears in Paybrain on the web as WooCommerce Order # and the order number, with the customer's email and any coupons applied. Open it from Recent Activities on your home page.
Orders with a shipping address get a Fulfillment panel. It shows the shipping address and the Items to Ship. Digital orders without a shipping address don't get one.
Set the status
Under Update Fulfillment, choose a Fulfillment Status.
Add tracking
Choose a Shipping Carrier and type the Tracking Number.
Save the update
Click Save Changes. The button only works once something has changed. Reset undoes your edits.
| Fulfillment Status | Use it when |
|---|---|
| Unfulfilled | Paid, not packed yet |
| Fulfilled | Packed and ready to ship |
| Shipped | With the carrier. The ship date is recorded. |
| Delivered | Delivered. The delivery date is recorded. |
Carriers are USPS, UPS, FedEx, DHL and Other. Fulfillment is tracked for the whole order, not item by item.
Fulfillment status stays in Paybrain. It isn't sent to WooCommerce, so update the order there too if you use WooCommerce's order statuses.