Civica Pay - eStore2

We've now added no-code support for Civica Pay.

The functionality provided enables you to:

  • Add a fixed cost payment item control e.g. Black Bin is £35.00

  • Add a user entry based payment control e.g. Council Tax payment where the user enters in any amount

  • Add a payment summary where the total of all payments in a form are summarised and passed to the payment system i.e. a Shopping Basket

Set Up

CivicaPayTsbBaseUrl

This is the URL end point fo the payment system's URL. eDesigner enables you to build forms that integrate to payment systems without any technical knowledge.

CivicaPayTsbCallingAppIdentifier

This is first of three identifiers for Civica Payment system integration.

CivicaPayTsbCustomerID

This is second of three identifiers for Civica Payment system integration.

CivicaPayTsbCustomerPassword

This is third of three identifiers for Civica Payment system integration.

Raise a ticket with IEG4 Support

Adding Payment Items

A payment item is a fixed price item that a person can buy.

If you choose to add a payment item the following options are presented:

Adding a payment item in Civica Pay

The Field Label is what is shown to the customer when buying it in the form.

The Item Catalogue ID is more commonly known as the fund code but its terminology in Civica Pay.

The Item Reference is the specific payment item reference number of the item.

This manifests itself as illustrated below:

Payment item in a form

You can, of course, use conditional rules to dynamically show which payment items are presented to customers should you have multiple payment items but only one/or a selection of the total is/are relevant based upon circumstances.

On moving to Civica Pay - we can see the details pushed across:

Automatic population of the amount / type in Civica Pay

User Entered Payment

A user entered payment control enables the citizen to type in the amount that they wish to pay.

For this option there are a variety of additional fields that relate to controlling what a user entered amount looks like and its label.

I.e. the format of the numbers they can enter is controlled by a regular expression. We'd say keep this as it is as it's the standard format for currency based entry. You can also add validation and mandatory warnings too:

Functionality available for user entered payments

Above we can see that there's also an option for 'User entered reference'. If this is clicked there are the following additional options which provide you with control over what the format of the reference is in terms of:

  • Minimum / Maximum Length (E.g. 5 minimum 8 maximum)

  • Regular Expression (E.g. must start with a 4 contain 6 or 7 numbers but the final one can be x)

  • Failed Validation message to present if the validation rules above are not met

  • Mandatory warning text which if present make it mandatory and vice versa removing it makes it optional

User entered values cont.

If the user types things in wrong you can thus present messages:

Validation error message presentation layer

Payment Summary

A payment summary automatically tallies up any payment relevant payment items/user entered amounts and acts like a shopping basket.

The only thing required when adding a payment summary is a field id and should you support a different currency (unlikely!) the ability to change the currency symbol:

Changing the currency symbol

This is presented like so where two items were requested on earlier pages:

Payment Summary (Basket)

Last updated

Was this helpful?