/
Personalization of PayXpress

PayXpert - User documentation

Personalization of PayXpress

Default configurations

A common setup for all your customers' devices allows you to personalize their devices into one group, having default behaviors based on their needs. Multiple groups of devices can therefore be deployed and maintained.

image-20251111-111327.png

 

Automatic deployment

If needed you can make a change to your live group of POS devices. This is done via the Central backoffice. The new parameters are silently communicated across systems, no interaction needed in PayXpress.

 

The controls:

The following personalizations can be added or hidden in the app:

Support page configuration

image-20251120-094540.png

 

 

You can control the text size and the text itself, controlling contact numbers etc.

This is done by providing your own Java parameters in the value for the support_page_content parameter.

Multi-currency

Payxpress can inherently accept cards with balances in other currencies, supporting business areas like tourism. The payout you receive is in your local currency (i.e. EUR).

However, the addition of the multicurrency_enabled parameter enables the merchant to select another currency in the Settings menu, to display the payment screen in that currency, and to be paid out in a settlement account in that currency.

If you have additional bank accounts you can be paid in other currencies such as GBP and USD.

Please note that processing multiple currencies is not the same thing as Currency Conversion (DCC), which requires an additional Merchant account and contractual agreements with the external provider.

 

Franc Pacifique (XPF) display amounts

In DOM/TOM territories we can display the sales amount in XPF for the local customers.

PayXpert must set the conversion_rate of this feature.

Available with Ezyness bank in Gateway mode.

Availble on the Castles S1F2.

xpf_3.png

 

Main menu and PIN/no PIN customization

You must enable the main menu and state which items you want to show. The items can be PIN-protected or open.

Personalization_9.jpg

Build a main menu

For your case, you can show/hide the areas relevant to your merchant. For the burger_menu_item parameter, give it the following values, as desired:

image-20251120-085745.png

 

 

On the Sunmi P2 Smartpad, the main menu is null. The app is controlled by the cash register and only the cardholder interacts with the device (presenting his card on the payment screen etc).

Show no Main menu at all

If you want to hide the Main menu completely, set burger_menu_item to null.

No main menu will be available in PayXpress, only the payment screen:

image-20260113-123848.png

Set up a hidden Main menu

It is possible to not show the Main menu per se (in order to avoid unwanted access) but to let the user activate it via a 'magical' invisible area on the screen. To do this, create a new parameter called hidden_burger_menu and set it to true.

In order to activate the hidden menu, the user must press and hold the area in the top right of the input amount / waiting screen for 5 seconds:

image-20260113-124051.png

PIN controls

Enforcing a PIN and where to enforce it is completely customizable.

Admin PIN
settings-20250410-140552.png

 

The Admin PIN must be configured remotely at the POS group level.

The merchant cannot set the Admin PIN at first Init.

The merchant cannot change the Admin PIN. If the merchant forgets it, he/she must contact the relevant Support team. The value must be retrieved by viewing the POS group.



 

 

Controlling access to the desired menu items (or not) is set via:

  • the Admin PIN (if not set to none)

    • Forces a PIN when trying to access

    • The PIN is the same value for all menu items

Available formats (one is needed):

  • Set the admin_code yourself: eg. 123456
    You can set the actual value of the PIN if setting a (6-digit PIN) and reference it when the customer forgets it.

  • Set the code to depend on ddmm:
    You can set the Admin PIN to have a special ddmm format so that the PIN changes daily.

Merchant code
merchant_code_en_4.jpg

This PIN code is also configured remotely, initially. It must be given an initial value when it is configured to exist for either or both operations.

However, the Merchant can reset his Merchant code if forgotten or not known—this action will require the Admin PIN if an Admin PIN is configured.

If the admin code is set to none, the merchant could change the Merchant code without this level of security. The reseller/partner is responsible for the app security they build.

A Merchant code can be set for Cancellations, Refunds, or both operations. This protects these operations.

Available formats (if not set to none):

  • set the merchant_code yourself

    You can set the actual value of the Merchant code if setting a (6-digit PIN).

  • set the code to depend on ddmm: You can set the Merchant code to have a special ddmm format so that the PIN changes daily.

Merchant code restrictions

The merchant_code_restrictions control allows you to specify which transactions require a pin—Cancellations and/or Refunds.

The Merchant code can also be enabled when performing a “force transaction” operation which allows the operator to send a low-risk transaction if the POS prompts for it. This can happen on rare occasion when the merchant’s bank would like the PayXpress POS to accept a transaction whose authorization was inconclusive.

Android system bars
image-20251120-085950.png
Custom navbar prompts PIN

 

Limit accidental Android navigation access by selecting one of the following:

  • none - disables the bottom bar

  • custom_with_pin - operator must enter the Admin PIN to exit the payment screen or app

  • default - displays the full bottom bar, enabling standard Android navigation

Degraded mode

 

Enables the merchant to perform basic transactions if their POS loses connection

Within the degraded_enabled control you can have the feature perform silently or prompt the merchant if he would like to continue with the offline transaction. The controlling values are:

  • NOT_AUTHORIZE: Degraded mode will not be possible

  • AUTHORIZE: Degraded mode will work silently

  • WITH_CONFIRMATION: Degraded mode will work with a confirmation pop up for the merchant to continue

    degraded.png
    In this example, degraded_enabled = with_confirmation

 

You can also personalize the following limits:

  • maximum number of transactions to do offline by setting a value for offline_max_transactions

  • maximum amount for a transactions by setting a value for offline_max_transactions_amount

The POS and the Central backoffice remember that the transaction was performed this way, so when displaying it in the Transactions journal or in the Transaction details page it will be denoted.

transactions_journal_1-20251118-123622.png

For full rules, see https://payxpert-docs.atlassian.net/wiki/spaces/docs/pages/1181351939.

Company logo for screen saver

It is possible to use your own logo (replacing that of PayXpress) on the loading screen ->

GIFs and images are supported.

Ensure the image is of good quality and 2Mb or below.

For now, this control requires Concert to be enabled on the device.

To activate this personalization, set screensaver_enabled to true and request support for the insertion of your file.

Optionally, set a screensaver_delay parameter to a seconds (s) number value.

logo_1.png

This control is at the Company level and it is a POS group parameter.

Please contact Support so that we can perform this change in the Backoffice if desired.

 

Logo on ticket

image-20251128-073059.png

 

Allows you to parameterize a merchant’s logo to appear on the transaction ticket.

Reserved for custom arrangements.

This and other more generic look and feel personalizations are planned for future.

Card brand display

Personalization_3.png

 

Controls which card scheme icons to display on the payment screen.

image-20251120-130828.png

In process of being moved from Merchant account parameters

 

Tips

Personalization_4.jpg

You can enable the Tips feature for the whole group of like devices. Tips is a helpful personalization if your merchant is in Restaurants, Transpor, etc.

To activate Tips, set tips_activation to true.

To enable/disable the printing of the tip on the virtual/paper ticket, also set tips_printing_activation to true.

Then, the Partner can enforce remote ‘tips’ parameters by creating them on the POS Group. Otherwise, the merchant will have local control of the tips parameters on each device.

Explanation below.

 

Remote or local controls?

If you want to enforce tip values and format:

  • Set tips_values to the desired numbers (ex. 5,10,15) to enforce the tips %s, otherwise the merchant will be able to change them manually (locally) in the app.

  • also set tips_format to the desired format, otherwise the merchant will have the choice. If you need to set the format remotely, choose one of the following:

    • AMOUNT→display the amount rounded sup only (legacy mode)

    • PERCENT_ROUNDED→ display the amount rounded sup + the percent value

    • PERCENT-> display the amount NOT rounded sup + the percent value

In this example controls are enforced; the merchant does not have the option to adjust settings:

Tips_5.png

In this example, there are not tips parameters set remotely so the merchant can adjust them locally:

Personalization_10.png

For all the functionalities on Tips: https://payxpert-docs.atlassian.net/wiki/spaces/docs/pages/1180762121.

Demat configuration

Cardholder

demat_3.jpg

 

Merchant

demat_2.jpg

 

You can personalize which Dematerialization options are offered to the cardholder. After setting demat_cardholder_enabled the following can be enabled or disabled:

  • Virtual ticket: virtual

  • paper ticket: paper

  • QR code: qrcode

  • Email ticket: email

For example: virtual,email,paper

 

 

 

 

 

 

For merchant ticket dematerialization, set demat_merchant_enabled to:

  • paper

  • email

  • qrcode

…as desired in order to show these options.

For example: virtual,paper

 

 

Full info on Dematerialization:

https://payxpert-docs.atlassian.net/wiki/spaces/docs/pages/1181581315.

 

Sessions

The merchant can organize their transaction activity into business hour work shifts if he or she desires, defining the end times of the shifts.

Merchants can also end / begin a session spontaneously.

sessions_close_3.jpg
Virtual session ticket

 

If Sessions are enabled, the merchant must be in a current session to process transactions. If he tries to use the app he is asked to start a session:

Sessions_4_en.jpg

 

More on Sessions: https://payxpert-docs.atlassian.net/wiki/spaces/docs/pages/638911972.

Setting session_enabled to true you can then personalize characteristics of the Session management functionality:

  • session_display_days controls how many days are displayed in the sessions report list screen:

    f646438e-b05d-4878-b023-ef6c42ea4c80.png
    Set the parameter to a real number

     

    Default value is 7.

  • With session_database_lifetime_days the POS device keeps the historical session data in it’s local memory for this number of days before clearing.

    Default value is 30.

  • The session_closing_option value lets you determine if you want to automatically close the session and define what hour:

    • NEVER : one continuous session; allows the merchant to spontaneously control his own session start and ends

    • AFTER_24H : 24-hour sessions rolling over after each session start

    • AT_SPECIFIC_TIME Set the value of this parameter in the “hh:mm” or “hh” fomats to customize the session closing time for the merchant (ex:

      • AT_SPECIFIC_TIME=3:00 for “hh:mm” format

      • or AT_SPECIFIC_TIME=3 for closing at 3am (“hh” is a 24-hour format)

Daily summary

 

Enables the merchant to set their business day hours and check current or most recent business day block of activity.

To enable, create a daily_summary_enabled parameter on the POS Group and give it the value true.

As for sessions, a recap ticket can be shared or printed. The merchant can have both Sessions and a Daily summary.

Daily_summary_2.jpg

 

 

File collection history

Enabling this PayXpress feature allows the merchant to get a TLC (File collection) overview of his group of POS terminals from any terminal. It is a shortcut for the merchant who has a more detailed File collection page in the Central Backoffice. Remitted files are listed in the terminal for the last 7 days. The backend sends the terminal info about “sent for settlement” or failed files only, not about files awaiting sending.

 

The file_collection_history_enabled parameter must be assigned to the POS Group and set to true.

The feature will be available on the main menu.

The 7-day default history is standard.

file_collec_POS_5.jpg

 

Concert on a group of POS devices

The Concert protocol can be enabled and set up for your POS groups if the devices will be communicating with cash registers (like is done with the Sunmi P2 Smartpad). You or your merchant are responsible for the Concert integration of their cash register systems to the protocol. The device can be configured to use the AP Concert Protocole (v3.0) in that case.

POS group parameters:

Enable concert:

Can be set to true to enable Concert in the app. Otherwise Concert is disabled by default.

Pair the device with the new POS group always for Concert:

This is needed to override any old data on the device and to keep it in synch with the POS group configuration in our Central backoffice.

Enable the Ingenico machines that we support

An additional parameter needed to enable Concert on one of these devices.

Concert configuration:

Concert protocol - the language of the devices

Besides pairing the device and defining what type of communication to use, a full Concert protocol integration is available.

See https://payxpert-docs.atlassian.net/wiki/spaces/docs/pages/841842689 for the controls within the Concert protocol.

Custom tags

Within concert there is custom mapping, please let us know if any will be integrated so we can align the tags.