Originally written by John Hardwick, last updated Jun 26, 2024, on the Swan Retail knowledge base (FRS).
Based on SwanFRS release version 1206
Click to view / download a PDF of this document
FRS-BalancePay-130323-0918.pdfBalancePay Operational Video
Overview
This document details the integration with ClearCourse BalancePay product, which allows the retailer to email the customer requesting payment of their order balance. Once the customer pays, via a secure connect to a payment portal via a weblink, the balance paid is sent through to SwanFRS where the payment is recorded and processed.BalancePay is a separately licenced application which dovetails with SwanFRS allowing the customer to pay their balance remotely without the retailer having to take the customers' payment details.
This feature is only available to UK based companies at this time.
This document details the configuration settings and processes within SwanFRS. Configuration of Balance Pay will be part of the training provided by that application.
Configuration - FRS
If you wish to use the Balance Pay integration, please raise a ticket with Swan Support or discuss with your implementation consultant.
You will need to provide:
-
Logo - This will be displayed on the portal and in emails send from BalancePay. Recommended dimensions: 600x150 pixels. png image format.
-
Custom email layouts - You can get started with the default templates or configure your own and provide the Swan team with the HTML to load to BalancePay for you.
-
BalancePay portal users - These will be the team members who can access the outstanding payment requests on the portal to take TO (telephone order) payments and in the near future a mechanism for processing refunds
The Swan team will then connect BalancePay to your SwanFRS system, however the following steps / configurations must be applied prior to operating this feature. o
After go-live BalancePay can be disabled, please contact support if you need to have it disabled for a period of time.
Application Parameters
Menu Location: System Admin > Administration > Set Up Application Parameters
BalancePay is controlled via the following application parameter.
|
Roles |
Details |
|---|---|
|
USE_BALANCEPAY |
This field is not user amendable. Where ticked, SwanFRS has been integrated with BalancePay. Swan will turn this on as part of installing the BalancePay feature. |
Tender Groups
Menu Location: System Admin > Sales > Set Up Tender Groups
It is not essential but highly recommended that a tender group be set up for BalancePay payments which will allows payments received via BalancePay to be identified within Cash Reconciliation.
Tender Types
Menu Location: System Admin > Sales > Set Up Tender Types
One tender Type must be set as the default BalancePay which will be used when recording payments processed via BalancePay payments.
It is recommended that the BalancePay tender type be linked to its own Tender Group for reporting and control purposes. This is especially important when linking to an accounting system to allow payments received to be posted to a separate bank account, should this be required
Where desired, setting the subsidy percentage and account code against the BalancePay tender type will automatically break out the cost of the service and, where linked, post it to the specified ledger within the accounts system.
SwanFRS will show the REQUEST BALANCEPAY button if the customer is suitable for payment request via balance pay however the button will only be active if there is a BalancePay Tender Type set.
Tender Type Bank Codes
Menu Location: System Admin > Sales > Set Up Tender Types Bank Codes
When processing BalancePay transactions, setting the bank account allows payments received to be sent to a specific GL account.
Once the bank code has been set, it is recommended that you return to the tender type and mark the tender as inactive to stop salesperson use.
SwanFRS will show the REQUEST BALANCEPAY button if the customer is suitable for payment request via balance pay however the button will only be active if the BalancePay Tender Type is configured for use against the sales order’s selling branch.
Roles
Menu Location: System Admin > Security > Set Up Roles
The following roles control who can do what within SwanFRS.
|
Roles |
Details |
|---|---|
|
BALANCEPAY_CANCEL_REQUEST |
Operators with this privilege can cancel a payment request sent to Balance Pay. This feature is currently not active. The payment request is automatically cancelled when the sales order balance is cleared. |
|
BALANCEPAY_RE_REQUEST_PAYMENT |
Operators with this privilege can re-submit a payment request via Balance Pay. This feature is currently not active. |
|
BALANCE_PAY_REQUEST_PAYMENT |
Operators with this privilege can request balance payments via Balance Pay. SwanFRS will not show the REQUEST BALANCEPAY button, even if the store is configured to process balance payments if the operator does not possess the BALANCE_PAY_REQUEST_PAYMENT privilege. |
BalancePay Controls
Menu Location: System Admin > Sales > Set Up BalancePay Configuration
It is important to ensure the balance pay controls are correctly set up and verified before use.
It is recommended that a test payment is processed to ensure you are happy with the structure of the client email before issuing a payment request to a client.
Configuration - BalancePay
The BalancePay application is a web based solution accessed via the URL set within SwanFRS. (Set Up BalancePay Configuration > BalancePay Admin URL.
Typically, the URL is https://Balancepay.Swanretail.Co.Uk/<Retailers Name>/Admin
To Log in to the administrator section, you will need
-
Customer Code
-
Login Code
-
User Password
Once logged in a screen similar to that shown below will display
-
ClickingPAYMENTS displays a list of pending (and if selected paid) invoices (as shown above)
-
The MY COMPANY option lists the settings for your particular operation. Care should be taken when changing data, as this can stop the system operating as desired.
-
Clicking MY ACCOUNT enables you to change your login profile.
-
LOGOUT should be used when leaving the session.
Remember to replicate any use name changes on this page with the administrator credentials held in SwanFRS.
Customisation
It is possible to set up a retailer specific logo which will display on the email and payment data seen by the customer. Please discuss this with the implementation team as this requires Swan to set up.
It is also possible to change the format of the email message sent out to clients. The email message is controlled via HTML and uses a series of merge tag to embed customer / order specific data into the email.
Details of the merge tags can be found in the BalancePay Email Merge Fields document
Upon request, Swan can provide you with the HTML script, which can then be modified to suit your requirements. Swan staff can then install the revised HTML prior to testing the format.
Operation
Once configured, SwanFRS offers the ability to request payment for a sales order balance at key stages of the sales order’s journey.
Payments are manually instigated and only possible if..
-
SwanFRS has been correctly configured to process BalancePay requests
-
A Tender Type must be active
-
The Tender Type bank account code for the selling location must be set
-
-
The customer has an email address associated with their account
-
The operator has suitable permissions to request payment
When viewing sales orders either in a table format (as shown below) or in detail, the screen shows the Payment Status of the order.
The standard colour controls give a quick financial status of the order.
Where the order is UNPAID and the conditions outlined above are set, SwanFRS offers a payment button.
The name of the button is controlled via the BalancePay Name field within Set Up BalancePay Configuration. For example, if you wished to call this system E-Pay the button would, for example present as REQUEST E-PAY or E-PAY REQUESTED.
There are three button states
|
REQUEST BALANCEPAY |
The grey message is displayed when there is a customer to pay order balance on the sales order which has not subject to a current BalancePay Request. It is possible to click on the button, which sends an email to the customer’s email address requesting payment |
|
BALANCEPAY REQUESTED |
The yellow message displays when a request has been made (via email) to the customer, where the payment has not yet been made / retrieved back from BalancePay. |
|
BALANCEPAY REQUIRED £999.99 |
The red message box displays when the order balance differs from the value requested in BalancePay. This situation should not occur in that SwanFRS automatically updates the outstanding balance in BalancePay as the composition or the order or the financial balance on the sales order changes. If the balance on the sales order is cleared, SwanFRS automatically cancels the payment request submitted to BalancePay The value in suffixing the message is the value requested, hovering over the button presents a pop-up message showing the current balance on the order. If the order is viewed in detailed mode, SwanFRS automatically updates the outstanding balance on BalancePay resulting in the red message changing to a yellow message. |
Sending the Payment Request
Wherever the REQUEST BALANCEPAY button is displayed, clicking results in a payment request email being sent to the customer’s email address.
It is important to ensure you have the correct email address recorded prior to requesting payment.
The email issued will be similar to that shown below.
The design of the email change be changed using merge fields etc within the control HTML
Payment via the Portal
The client will see the following when they click the PAY THE INVOICElink.
There are three options for payment
-
Pay the minimum amount
-
Pay the Full requested balance
-
Pay and alternative value somewhere between the minimum and full value.
The Terms and Conditions must be ticked before clicking the PAY INVOICE button.
Once submitted, the customer must fill in their card details and click the PAY NOW button.
Once successfully processed, a paid screen will be displayed.
Clicking the down arrow in the green section shows payments processed for this order within BalancePay.
SwanFRS Processing
SwanFRS is configured to search for processed payment periodically, and will pull back the processed payment, thus updating the order balance within a short time period (subject to polling frequency).
There may be a slight delay between the payment being processed in BalancePay and the record landing in SwanFRS. This is dependent upon the frequency SwanFRS polls the BalancePay database.
If the payment notification is required urgently, this can be manually ‘pulled’ into SwanFRS via the GET PAYMENTS button within the Set Up BalancePay Configuration program.
-
Payments received from BalancePay are recorded against the sales order’s selling branch.
-
The reference recorded is the transaction reference from BalancePay
-
It is not possible to edit or void the payment.
Once received back into SwanFRS the yellow BALANCEPAY REQUESTED (or the red BALANCE PAYREQUESTED £XX.XX) payment button will disappear unless there is a balance left to pay on the order, whereby it will be replaced with a grey REQUEST BALANCEPAY button.
Cash Reconciliation
It is necessary to reconcile payments received from BalancePay however this is effectively just a confirmation of payment process.
Once the reconciliation has started and the cash declaration has been completed, the screen displays a grid of the various tender groups defined.
All payments received against the tender group linked to BalancePay will be marked as accepted.
If the tender group only contains BalancePay payments it will show as LINE COMPLETE, if there are other tender types in the group the legend will be PART RECONCILED.
Payments Via the Portal
Where appropriate, and after logging into the BalancePay administration screen, it is possible to process a payment on behalf of a customer.
Having logged in and where necessary clicking the PAYMENTS button lists the payments requested via SwanFRS.
Per row,
-
Clicking the Customer’s Name enables an email to be sent to the customer’s email address.
-
Clicking on the Payment Link will show you the payment request the customer will see.
-
Clicking the TO button opens the payment window, whereby it is possible to process the payment, should the customer prefer you to process the payment on their behalf, for exmaple a customer not present transaction. This generates a warning message as shown below.
Clicking OK produces the payment page.
There are three options for payment
-
To view previously processes payments click the X TRANSACTION button.
Files from the Confluence page
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article