Brightpearl Payments – Brightpearl Help Center

Overview

The Brightpearl Payments app works with Bolt to enable card payments and refunds to be processed within Brightpearl. Bolt is a payment gateway aggregator which provides services to multiple payment gateways. This means Brightpearl can connect to multiple payment gateways all with a single app.

The following payment providers are supported when using Brightpearl Payments:

Adyen
Authorize.net
Braintree
iZettle
Payflow Pro
PayPal Business
PayPal Here
Sage Pay
Stripe
USAePay
Worldpay

Each payment provider might support multiple types of transactions:

Back office (MOTO)
These are transactions made where the cardholder is not present and entered into Brightpearl against a quote, order, invoice or customer account. MOTO stands for Mail Order/Telephone Order.
In store (POS)
The cardholder is present for these transactions and is using their payment card.
Online "pay now" links
The cardholder makes this payment themselves online for a quote, order or invoice sent from Brightpearl, using a link directly from their document.

Back office features supported by Brightpearl Payments

Transaction type	Feature
Take payment directly on a sales order - auth only
Take payment directly on a sales order - auth and capture
Capture auth only payments on demand
Partially capture payment on demand
Auto-capture auth only payments on shipping
Auto-capture partial payment for partial shipments	Authorize.Net Only
Refund a payment originally taken via Brightpearl Payments
Make a payment (misc refund) to a customer with no original payment
Take an on account payment from a customer
Include 'pay now' links in invoices
Receive customer payments via the web portal

Installing the Brightpearl Payments app

The Brightpearl Payments app can be activated from the App Store. Once the app has been installed you will need to configure it with your payment provider and give your staff members permissions to use it (permissions depend on features supported by your payment gateway).

How to install the Brightpearl Payment app

Log into your Brightpearl account.
Click the App Store link at the top of the screen.
Find the Brightpearl Payments app.
Click Turn on.

Configuring Brightpearl Payments

The initial steps for configuring Brightpearl Payments is the same for all payment providers. The settings for each provider will then be different depending on what the providers support. The configuration for each different provider is given below.

How to configure Brightpearl Payments

In Brightpearl, go to Settings > Company > Payment methods.
Add a new payment method, or edit a relevant existing payment method you are using.
Give the payment method a name and a code.
Select This payment method is active option.
Select Brightpearl Payments from the Link to a payment gateway drop down.
Ensure a bank account is selected if you are using Brightpearl accounting. If no bank account is assigned, accounting for payments will not be created.
Save the payment method, and click the Gateway settings link now displayed against the method to begin the Payment app configuration. This can also be used to edit your settings later.
In the pop-up window select your payment provider.
Continue to the relevant payment provider settings:
- Adyen
- Authorize.Net
- Braintree
- iZettle
- Payflow Pro
- PayPal Business (also mentioned as PayPal)
- PayPal Here
- Sage Pay
- Stripe
- USAePay
- Worldpay

Adyen with Brightpearl Payments

The Brightpearl Payment app allows you to connect your Adyen payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations - manually or automatically on shipping
Refund a payment processed via the app
Create on account payments against customers

In store (POS) card payments
Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using Adyen will need to be added within the permissions section of the configuration process.

How to set up and configure Adyen with Brightpearl for MOTO and “pay now” links

Continued from the steps here.
Enter the API Key as supplied via the Adyen Customer Account.
Enter the Merchant Account as mentioned in the Adyen Customer Account.
Select “Ecommerce / Moto” as the Interaction Type.
Please note if you need to add POS as the Interaction Type, you will need to add another payment method as described here.
Select, if required, Enable Save Card.
Select Sandbox test mode if you would like to connect to Adyen sandbox for testing purposes.
Enter the URL prefix as supplied via the Adyen Customer Account.
Save to connect the app to your payment provider. If it is not possible to establish a connection message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:

Payment descriptor: Set a payment descriptor to be used when recording payments and order notes in Brightpearl.

Staff Payments: Select the type of payment transaction you use from authorize only and capture later, authorize and capture immediately or allow the user to choose for each transaction.
Save card details: Choose whether customer card details used for processing transactions are saved for future use.

Customer Payments: Choose whether you would like to use the embedded payment link on your invoices.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab. If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

How to set up and configure Adyen with Brightpearl for POS card payments

Continued from the steps here.
Enter the API Key as supplied via the Adyen Customer Account.
Enter the Merchant Account as mentioned in the Adyen Customer Account.
Select “POS” as the Interaction Type. Please note if you need to add Ecommerce / Moto as the Interaction Type, you will need to add another payment method as described here.
Select Sandbox test mode if you would like to connect to Adyen sandbox for testing purposes.
Save to connect the app to your payment provider. If it is not possible to establish a connection message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:
Payment descriptor: Set a payment descriptor to be used when recording payments and order notes in Brightpearl.

Staff Payments: Select the type of payment transaction you use from authorize only and capture later, authorize and capture immediately or allow the user to choose for each transaction.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.

Customer Payments: Choose whether you would like to use the embedded payment link on your invoices.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using Adyen on Brightpearl POS.

Authorize.net with Brightpearl Payments

The Brightpearl Payment app allows you to connect your Authorize.net payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations - manually or automatically on shipping
Refund a payment processed via the app
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using Authorize.net will need to be added within the permissions section of the configuration process.

How to set up and configure Authorize.Net with Brightpearl

Continued from the steps here.
Enter the Auth.net API details and make the following choices:
EU merchant: Check this box if you are an EU merchant

Sandbox: Check this box to connect to Auth.net sandbox for testing purposes
Save to connect the app to your payment provider. If it is not possible to establish a connection a message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:
Transaction type: Choose between authorize only, authorize and capture or allow the user to choose for each transaction.

Automatically capture: Choose whether you want payment to be automatically captured when the first shipment is made. Sage Pay only support capturing payment in full.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

Braintree with Brightpearl Payments

The Brightpearl Payment app allows you to connect your Braintree payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations - manually or automatically on shipping
Refund a payment processed via the app
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using Braintree will need to be added within the permissions section of the configuration process.

How to set up and configure Braintree with Brightpearl

Continued from the steps here.
To connect Braintree to Brightpearl you’ll need the following details from your Braintree account:
1. Merchant ID
2. Public Key
3. Private Key
  Find these details in Braintree at My user > API keys, click here for more info.
Enter your Braintree API details and make the following choices:
Multi-currency: Check this box if Braintree is configured to accept payments in multiple currencies.

Account currency: Select the account currency used in Braintree

Require AVS: Check this box to use address verification service (AVS)

If you are using multiple currencies within Braintree, each one will need to be added, along with the Merchant Account ID set in Braintree. Find these details in Braintree at Settings > Processing.
Save to connect the app to your payment provider. If it is not possible to establish a connection, a message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:
Transaction type: Choose between authorize only, authorize and capture or allow the user to choose for each transaction.

Automatically capture: Choose whether you want the payment to be automatically captured when the first shipment is made.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used, you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab. If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using Braintree with the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

iZettle for POS with Brightpearl Payments

The Brightpearl Payment app allows you to process card payments via iZettle on Brightpearl POS.

How to set up and configure iZettle for use with Brightpearl POS

Continued from the steps here.
Enter the email address for the iZettle account to process payments with and click Save.
In the iZettle configuration set a payment descriptor. This descriptor will prefix all payment references for iZettle.
Click Save.

You are now ready to begin using iZettle with Brightpearl POS.

Payflow Pro with Brightpearl Payments

To use Payflow Pro with Brightpearl payments, your Payflow Pro account must be configured to "allow reference transactions". This enables the Brightpearl Payments app to save card details with Payflow Pro.

The Brightpearl Payment app allows you to connect your Payflow Pro payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations - manually or automatically on shipping
Refund a payment processed via the app
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using Payflow Pro will need to be added within the permissions section of the configuration process.

How to set up and configure Payflow Pro with Brightpearl

Continued from the steps here.
Configure Payflow Pro to allow reference transactions. Learn more
To connect Payflow Pro to Brightpearl you’ll need the following details from your Payflow Pro account:
1. Partner
2. Vendor (merchant)
3. User
4. Pwd (password).
  Learn how to generate these credentials in Payflow Pro
Enter the following details:

Partner: the partner from your Payflow Pro account
Merchant login: the Vendor (merchant) from your Payflow Pro account
User: The User from your Payflow Pro account
Password: The Pwd from your Payflow Pro account
Currency: Select the account currency used in Payflow Pro
Allow reference transactions: Check this box to use reference transactions
Sandbox: Check this box to connect to Payflow sandbox for testing purposes.
Save to connect the app to your payment provider. If it is not possible to establish a connection, a message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:
Transaction type: Choose between authorize only, authorize and capture or allow the user to choose for each transaction.

Automatically capture: Choose whether you want the payment to be automatically captured when the first shipment is made.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used, you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab. If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using Payflow Pro with the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

PayPal Business (also mentioned as PayPal)

PayPal Business can be connected via Brightpearl Payments for handling payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

How to set up and configure PayPal Business with Brightpearl

Continued from the steps here.
To connect PayPal Business to Brightpearl you will need the following details from your PayPal account:
API Username
API Password
API Signature

Learn how to find API credentials in PayPal. You will need to request Option 1: PayPal API > Request an API signature.
Enter your PayPal API details.
Save to connect the app to your payment provider. If it is not possible to establish a connection a message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:
Payment ref prefix: Enter a payment descriptor to be used when recording payments and order notes in Brightpearl. This will prefix the payment reference which is automatically assigned.

Enable customer payments: Check the box to make this payment method the one used when "pay now" links are included in emails. If an existing payment method has been set up for "pay now" links a switch option will be provided.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

Using "pay now" links for quotes, orders and invoices

"Pay now" links can be added to quotes, orders and invoices which are emailed to customers. When the customer clicks the link they will be able to make a secure payment which is automatically captured in Brightpearl to mark the quote, order or invoice as paid.

"Pay now" links can be activated for only one payment provider at a time.

The link mechanism is embedded directly into templates using the code provided during the payment gateway setup.

How to set up 'pay now' links

Go to Settings > Company > Payment methods.
Click Gateway settings on the payment method.
Select Enable customers payments to allow customers to make full payment against invoices.
Select Enable part payments to allow customers to make multiple part payments against invoices.
Copy the text shown in the ‘Invoice payment’ section to the clipboard.
Go to Settings > Templates > Document templates and click to edit the relevant template, for example, the invoice template.
Click to view the template in HTML mode.
Place the cursor in the place where the link should appear and paste in the text from the payment setup.
Save the template

The next time a quote, order or invoice is emailed to a customer using this template, the link will be included.

PayPal Here for POS with Brightpearl Payments

The Brightpearl Payment app allows you to process card payments via PayPal Here on Brightpearl POS.

Process payments using a PayPal Here device connected to Brightpearl POS

How to set up and configure PayPal Here with Brightpearl

Continued from the steps here.
To connect PayPal Here to Brightpearl you will need a PayPal business account mode.
Review the requirements and create the gateway.
Click Authenticate.
Sign into PayPal.
Assign the permissions for those users that can process refunds in the Back office for PayPal Here transactions that have been taken on Brightpearl POS.

You are now ready to begin using the PayPal Here on Brightpearl POS.

Sage Pay with Brightpearl Payments

The Brightpearl Payment app allows you to connect your Sage Pay payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations - manually or automatically on shipping
Refund a payment processed via the app
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.
Process payments with Sage pay with 3D secure enabled

Each staff member who will be processing payments using Sage Pay will need to be added within the permissions section of the configuration process.

How to set up and configure Sage Pay with Brightpearl

Continued from the steps here.
To connect Sage Pay to Brightpearl you will need the following details from your Sage Pay account:
Vendor name
Administrator Username
Administrator Password
Enter your Sage Pay API details and make the following choices (ensure you are not logged in to Sage Pay at the time):
Require AVS:

Require CVC:

Sandbox:
Save to connect the app to your payment provider. If it is not possible to establish a connection a message will be displayed. Please check your details have been entered correctly and try again.
Once a connection is established make your configuration choices:
Transaction type: Choose between authorize only, authorize and capture or allow the user to choose for each transaction.

Automatically capture: Choose whether you want payment to be automatically captured when the first shipment is made. Sage Pay only support capturing payment in full.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

There are no additional steps to enable or disable 3D secure for Sage Pay, so you are now ready to begin using the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

Stripe with Brightpearl Payments

The Brightpearl Payment app allows you to connect your Stripe payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations - manually or automatically on shipping
Refund a payment processed via the app
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using Stripe will need to be added within the permissions section of the configuration process.

How to set up and configure Stripe with Brightpearl

To connect Stripe to Brightpearl you will need the following details from your Stripe account, which can be found at Your account > API keys:
Test secret key
Test publishable key
Live secret key
Live Publishable key
Enter your Stripe API key details and make the following choices:
Require AVS: This will enforce the use of address validation when processing payments.

Require CVC: This makes it required that the CVC code is entered each time a card payment is taken, including when a saved card is being used.

Sandbox: If you want to process test transactions check this option. This will allow you to use test card details and not make any real transactions, but see the functionality in Brightpearl.
Save to connect the app to your payment provider. If it is not possible to establish a connection a message will be displayed. Please check your details have been entered correctly and try again
Once a connection is established make your configuration choices:
Transaction type: Choose between authorise and capture later, authorise and capture or allow the user to choose for each transaction.

Auto-capture: Choose whether you want payment to be automatically captured when the first shipment is made. Stripe only support capturing payment in full.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration window.

You are now ready to begin using the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

USAePay with Brightpearl Payments

The Brightpearl Payment app allows you to connect your USAePay payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations in full or in part - manually or automatically on shipping
Refund a payment processed via the app
Process a miscellaneous refund against a sales credit
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using USAePay will need to be added within the permissions section of the configuration process.

How to set up and configure USAePay with Brightpearl

Continued from the steps here.
To connect USAePay to Brightpearl you will need an API key from your USAePay account, which can be generated at Settings > Source Keys.
Enter your Worldpay API key details
Save to connect the app to your payment provider. If it is not possible to establish a connection a message will be displayed. Please check your details have been entered correctly and try again
Once a connection is established make your configuration choices:
Transaction type: Choose between authorize only, authorize and capture or allow the user to choose for each transaction.

Automatically capture: When using a transaction type of "Authorise and capture later" or "User select" you will be able to choose how auth only payments are captured. Check this box to have auth payments automatically captured when a goods-out note is marked as shipped. Leave it unchecked and all auths will have to be manually captured (can be done in bulk).

Capture partial amounts: When auto-capture of payments on shipping is used, check this box to capture only the payment amount for the items shipped. Leave unchecked to capture the payment in full with the first shipment.

Order status for failed capture: If a payment fails to be captured the order will be placed on this status.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

Worldpay with Brightpearl Payments

The Brightpearl Payment app allows you to connect your Worldpay payment gateway to Brightpearl. This will enable you to process:

Back office (MOTO) payments

Receive payments against sales orders - authorize and capture later or authorize/capture immediately
Capture authorizations in full or in part - manually or automatically on shipping
Refund a payment processed via the app
Process a miscellaneous refund against a sales credit
Create on account payments against customers

Payments made using "pay now" links in quotes, orders and invoices which are emailed to customers.

Each staff member who will be processing payments using Stripe will need to be added within the permissions section of the configuration process.

How to set up and configure Worldpay with Brightpearl

Continued from the steps here.
To connect Worldpay to Brightpearl you will need the following details from your Worldpay account, which can be found at Settings > API keys:
Merchant ID
Service key
Client key
Enter your Worldpay API details and make the following choices:
Require AVS:

Require CVC:

Sandbox:
Save to connect the app to your payment provider. If it is not possible to establish a connection a message will be displayed. Please check your details have been entered correctly and try again
Once a connection is established make your configuration choices:
Transaction type: Choose between authorize only, authorize and capture or allow the user to choose for each transaction.

Automatically capture: When using a transaction type of "Authorise and capture later" or "User select" you will be able to choose how auth only payments are captured. Check this box to have auth payments automatically captured when a goods-out note is marked as shipped. Leave it unchecked and all auths will have to be manually captured (can be done in bulk).

Capture partial amounts: When auto-capture of payments on shipping is used, check this box to capture only the payment amount for the items shipped. Leave unchecked to capture the payment in full with the first shipment.

Order status for failed capture: If a payment fails to be captured the order will be placed on this status.

Save card details: Choose whether customer card details used for processing transactions are saved for future use.
Before the app can be used you will also need to set the permissions and specify which staff members can process each transaction type. In the configuration window, select the Permissions tab.
If you have previously configured a different payment gateway with the app, you can choose to copy the permissions and then make any amendments.
Save the permissions to complete the configuration.
Close the configuration.

You are now ready to begin using the Brightpearl Payment app. When the payment method is selected to pay sales orders in Brightpearl, the payment processing window will automatically be displayed.

Taking a telephone payment using the Brightpearl Payments app

Taking telephone payments from customers using the Brightpearl Payments app can be done against:

A sales order
Process a transaction for the full or part of the order value, and mark the order as paid in Brightpearl at the same time. An order payment can be processed as either auth only or auth and capture.
A customer
Process a transaction for a specified amount against the customer record. It can be left on account or allocated against outstanding invoices. A customer payment will be captured immediately, auth only transactions are not supported.

How to take a telephone payment against a sales order using the Brightpearl payments app

Use these steps to take a customer card payment and mark an order as paid:

From within the order scroll to the bottom of the screen and click Take payment.
Choose the payment method to use and the payment processing window will be automatically displayed. If a manual payment entry window is displayed, instead of the payment processing window check that the payment method has been connected to the Brightpearl Payments apps.
Enter the customer payment details and submit.

Once the payment has been successfully processed you will be returned to the order screen. The order will now display a captured or pending (for auth only) payment amount.

How to take a telephone payment against a customer using the Brightpearl Payments app

Open the customer record. From within the Financials info box on the right, click Allocate Payment.
Note: You can also navigate to this screen using the Accounting mini tab displayed throughout Brightpearl.
Click Record account payment and select…

Making refunds or payments to customers using the Brightpearl Payments app

Making refunds or payments to customers using the Brightpearl Payments app can be done against:

A sales credit
Process a transaction to pay the customer for the full or part of the credit value, and mark the credit as paid in Brightpearl at the same time.
A customer
Process a transaction to pay the customer a specified amount. It can be left on account or allocated against outstanding credits.

When giving money to a customer, it can be done by a reversal of an original payment received from the customer, it might be for the full transaction amount, or for only part of it and there may be multiple refunds made, but the total refunded amount can never be for more than the original charge. A refund made using the Brightpearl Payments app will look up an original transaction from your payment provider and use those details to make the refund so there is no need to re-enter the card details. Payment providers will often also refund their own fees when a refund is made in this way.

Note: Payments cannot be processed for suppliers or purchases. These types of payment are not supported and should be managed using a BACS/ACH service.

How to refund a payment using the Brightpearl payments app

Use these steps to refund a customer card payment and mark a credit as paid:

Clone the original sales order to a sales credit.
From within the sales credit scroll to the bottom of the screen and click Refund.
Choose the payment method. Where the payment method has been configured for use with the Brightpearl Payments app the payment processing window will automatically be displayed.
Enter the customer payment details and submit.

Once the payment has been successfully processed you will be returned to the order screen. The order will now display a captured or pending (for auth only) payment amount.

Capturing auth only payments in Brightpearl app

Authorized payments against sales orders can be captured in full or in part either automatically or manually:

Automatic payment capture
Configure the app to automatically capture authorized payments once the order is marked as shipped, and whether to capture full payment or partial payments for split shipments.
Manual payment capture
Select multiple orders to capture payment for, based on your own criteria at any time. Choose to capture in full or partial payments.

If any part payment has already been captured for an order the payment status will be “part paid” and will therefore not display under the “Authorized” order payment status.

How to capture auth only payments

In Brightpearl, go to Sales > Order payments.
Filter by the payment type of Auths pending capture and by your payment method.
Select the rows to be captured.
Click the Capture button.
In the popup window review and make any edits to the payments which will be captured.
Click Submit to go ahead and capture those payments from the customers.

Saving and using saved card details using Brightpearl Payments app

When processing a payment, you can choose whether to save the customer card details, this will enable you to take more payments in the future without having to contact the customer.

In order to save customer card details you must first set it up with your payment provider. Not all payment providers offer this option. If your payment provider does not offer the option to save card details then you will not be able to use the feature. The app cannot override the features of the payment provider.

How many customer cards can be saved?

The number of cards which can be saved for each customer depends upon your payment provider. For example, Authorize.net currently allow 12 cards to be saved per customer, this is how many you will be able to save and retrieve using the Brightpearl Payments app.

Where are customer card details saved?

All card details are saved only with the payment provider (such as Stripe, Sage Pay) who must comply with all the necessary security rules for saving card details. No card information is saved in Brightpearl or Pay with Bolt, who power the Brightpearl Payment app.

When are customer card details saved?

Customer card details will be saved at the same time as they are used to process a payment or authorization.

Saving customer card details can be set at the app level or on an individual payment:

App level
If the app is set to save card details then they will automatically be saved for every card transaction processed in Brightpearl.
Payment level
If the app is not set to automatically save card details then you will be able to decide per transaction.

You do not need to save customer card details to process authorize only type transactions.

Using a saved card

When taking a new payment for a customer you will be able to select any one of their saved cards to complete the transaction. All available cards are retrieved from the payment provider at the point of processing a new transaction.

Some payment providers will require additional security checks when using the saved card in the future, such as re-entering the CVV number. You will be asked for these before the Transaction can be completed.

Updating a saved card

It is not possible to update a card from Brightpearl. You will usually need to save a new card and remove the old one.

Removing a saved card

It is not possible to remove a saved card from within Brightpearl. You will need to remove the card from within your payment provider account.

How to save card details for future use

Use these steps to save a customer’s card details with your payment provider, so that they can be used for taking payments in the future:

Check with your payment provider that they offer the option of saving card details and that it is activated on your account.
In Brightpearl, process payment for your customer. During the process ensure the Save card details box is checked. To have this box checked by default it can be configured within the app.

Once the card transaction has been completed, the card details will be saved with your payment provider and can be retrieved the next time you process a payment for this customer.

Foreign currency transactions

When taking a foreign currency payment, the exchange rate from the order screen will be used to convert the payment into your base currency in Brightpearl.

If your payment gateway operates in a different currency from that of the payment currency, the payment provider will convert the payment using their own exchange rate. If this exchange rate is different from the one in Brightpearl then the transactions will not reconcile. An adjustment to account for the gain/loss due to the exchange rates will need to be manually entered.