Set Up BalancePay Configurator (1206 onwards)

Created by Migration Bot, Modified on Fri, 23 Oct at 11:23 AM by Migration Bot

Originally written by John Hardwick, last updated Jan 30, 2026, on the Swan Retail knowledge base (FRS).


This routine holds the control data required for use with BalancePay

BalancePay is a ClearCourse product allows the retailer to send a payment request email to a customer when the balance of their sales order is ready for payment.

Menu Location: System Admin > Sales> Set Up BalancePay Configurator

  • ThePOST CLIENTbutton is used to test the connection to BalabcePay and will return a Success or Failure message.

  • Clicking GET PAYMENTS pulls back payments processed in BalancePay using the Maximum Number of IDs for GET setting to control how many are pulled back at any time. For example, if this is set to 10 and there are 50 payments waiting to be sent back to SwanFRS the process will run five times.

SwanFRS will check the order balance of each sale as it is viewed, and an automatic process runs polling new payments completed within BalancePay meaning this button need not be used.

  • A EDITallows settings to be changed.

Care should be taken when changing settings as this can adversely affect the ability of SwanFRS to communicate with BalancePay.

  • Select the CLOSEbutton to leave the program.

Item

Description

Use BalancePay

This field is controlled via the USE_BALANCEPAY application parameter.

Tender Type

This field shows the Tender Type ID and description set within SwanFRS

It is not possible to operate BalancePay until a tender type has been set

Bank Codes Active

This field indicates the number of Tender Type Bank Codes active.

Payments cannot be requested via BalancePay for a sales order until the sales order’s branch has a Bank code set for the BalancePay tender type.

BalancePay Name

Specify the name of the Request Payment button within FRS

It is recommended the button name be a short as possible

BalancePay Admin URL

Specify the URL for the Administrator page on the linked occurrence of BalancePay.

The URL will be similar to

https://balancepay.swanretail.co.uk/<App-Name>/admin

BalancePay URL

Specify the URL for the Administrator page on the linked occurrence of BalancePay.

The URL will be similar to

https://balancepay.swanretail.co.uk/<App-Name>/API

X_CLINIC_PAY_SYNCSVR

System Managed - Do Not change

X_APPLICATION_ORIGIN

System Managed - Do Not change

Client Code

System Managed - Do Not change

Username

Specify the BalancePay administrator's email address

Send Customer Email

Tick to instruct the payment engine to send the payment request notification to the customer’s email address.

Customer Mail Message

Specify the email’s narrative

See marker 2 in the example below

Sales Order Description

Specify a narrative to describe the sales order which will, where set, show instead of the order lines.

See marker 5 in the example below

Maximum Sales Order Lines

Specify the number of sales order lines to include in the payment request email, It is suggested this be set to 1, which will show the first line of the sales order. Setting to more than one may result in the email becoming confusing.

If the Sales Order Description is set, the email will not include products purchased.

See marker 5 in the example below

Request Timeout Seconds

System Managed - Do Not change

Maximum Number of IDs for GET

Specify the number of ‘paid’ payment requests the update process will pull back at any one time.

The larger the number, the more data retrieved from the payment portal. If there are more paid orders, the process will repeat until all are pulled back. It is quicker to pull smaller files than to retrieve larger files.

It is recommended this be set to 10.

JSON Log Filename

Specify the log path for saving data communications between SwanFRS and BalancePay.

It is recommended this be the Tmp Folder,

For hosted solution is would similar to

\\fs-0x\ImportExport\<Folder Name>\Tmp\BalancePay.log

Disable Logging

Tick to stop SwanFRS recording data communications with BalancePay

Disable Audit

Tick to stop SwanFRS recording a transaction audit with BalancePay

BalancePay ID

System Managed

The right-hand side of the screen is pulled in from settings within BalancePay

Currency Code

System Managed

Currency Symbol

System Managed

Account Suspended

System Managed

Merchant ID

System Managed

Merchant Account ID

System Managed

Merchant TO Account ID

System Managed

Company Name

System Managed

See marker 3 in the example below

Company Address

System Managed

See marker 4 in the example below

Company Telephone

System Managed

See marker 4 in the example below

Company Email

System Managed

See marker 4 in the example below

Client Short Code

System Managed

Minimum Payment Percentage

System Managed

Merchant Terms

System Managed

Post Client Results

This field will show either Success or Fail and is refreshed via the POSTCLIENT button.

If you receive a Fail notification, your BalancePay pay requests will cease to function,

The payment request email can be configured to include your corporate logo

Please ensure your implementation consultant has a copy of the required logo.

See marker 1 in the example below

Example of Payment Request Email

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

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article