Summary

Summary used for better identification of entitlement in Administration web interface.

GUID

Unique entitlement identifier.

Type

There are four possible values:

• No access – Users are not allowed to use YSoft SafeQ Payment System. This means, that for example login into YSoft Embedded Terminal will be denied. This option is usually used as an equivalent of disabled or removed user.
  

• Page quota – Subjects assigned to this entitlement will use quota limits in order to use a different combination of services. For the list of available combinations, see chapter Quotas.
  

• Prepaid account – Subjects assigned to this entitlement will use money in order to pay for services. This option allows the use of initial and minimum balance and assignment of period recharges.

• Unlimited access – Users assigned to this entitlement are allowed to print and copy without any limit. Jobs are without any charge. A subject is not created.

Shared entitlement

This attribute distinguishes between two basic modes:

• Disabled – Each subject from entitlement has its own account (with information about balance or remaining quota). This is the default behavior when you have one YSoft SafeQ Payment System subject for each YSoft SafeQ user.

• Enabled – This will create a shared subject. All YSoft SafeQ users matched by entitlement criteria will share their balance or remaining quota. This means that a decrease of balance or remaining quota by one user will affect the whole group. This option is usually used in situations when you want to have for example shared balance for each cost center.

Cost center number

Cost center number or list of numbers used as entitlement matching criteria.

Usernames

YSoft SafeQ username or list of usernames used as entitlement matching criteria.

Assigned to

Table of entitlement matching criteria. There are two possible type values, Cost center, and User.

Initial balance

This attribute is specific to Prepaid account entitlement. It will grant an initial virtual balance to all newly created subjects matched by this entitlement. Existing subjects are not affected by this option. For more information about virtual balance, see chapter Subject Attributes.

Minimum balance

This attribute is specific to the Prepaid account entitlement type. It will set a minimum balance to all existing or new subjects matched by this entitlement. For more information about minimum balance, see chapter Subject Attributes.

Periodic recharges

This attribute is specific to the Prepaid account entitlement type. It defines a list of periodic recharges, which will be assigned to all existing or new subjects matched by this entitlement. For more information about periodic recharges, see chapter Periodic Recharges.

Quotas

This attribute is specific to the Page quota entitlement type. It defines a list of quotas, which will be assigned to all existing or new subjects matched by this entitlement. For more information about periodic recharges, see chapter Quotas.

Create entitlement

Opens a form for the creation of new entitlement. Saving of entitlement will create or update all subjects matched by entitlement criteria.

Edit

Opens a form for editing of entitlement.

Remove

Removes selected entitlement. All already assigned subjects or those matched by entitlement criteria will be assigned to a default entitlement. It is not possible to remove the default entitlement.

Refresh

The button is displayed only for non-default entitlements with disabled sharing. It checks YSoft SafeQ users in cost centers used in matching criteria of this entitlement and it assigns or reassigns found subjects from this entitlement. From the functional point of view, it is not necessary to use this button as the subjects are going to be reassigned to a correct entitlement as soon as they interact with the system (e.g. when they authenticate on the MFD or make a print). The benefit of using this button is to see the YSoft SafeQ users in the YSoft SafeQ Payment System Administration interface or to ensure that the Periodic Recharges will happen for all users assigned to the entitlement.

Name

Name is automatically assigned during subject creation. In the case of a Personal subject, the name is usually represented as follows "Name Surname (username)", where all values originate from the YSoft SafeQ user. In the case of a Shared subject, the name corresponds to the cost center number.

Active Entitlement

Type and name of the assigned entitlement.

Possible values are prepaid account , page quota, no access, and unlimited access. Their values correspond to the assigned entitlement. For more details, see entitlement types in chapter Entitlement Attributes.

Status

Status is indicated by the color of a user's account. If the account's background is green, then the account is active based on assigned entitlement. If it is grey, then the account is disabled. If it is orange, then the account is active based on assigned entitlement, however, the account is disabled (this should not be a common case).

Possible values are:

• Enabled - Most of the subjects are in this status. Each new subject uses this status.

• Disabled - Used only for Payment subjects (customers) migrated from a former version of YSoft SafeQ Payment System.
  
  

Personal Balance

The personal balance represents the subject's real money deposited by cash desk, payment gateway, or redeemed by a voucher. Each customer can have only one personal balance.

Virtual Balance

The virtual balance represents the customer's bonus or free credit. It can be provided by periodic recharge, manual increase, or by setting an initial account balance. Each customer can have many virtual balances, each assigned to a different API user merchant role, but in most cases, there is only one named safeq. Virtual balance is accessible only through the Merchant who granted it (i.e. virtual credit granted by one API account is not visible for another API account). In the case of transaction settlement, drawing of virtual balance take always precedence before personal balance. For more information about transaction settlement, see Working with Payment System.

Minimum Balance

The minimum balance represents a value below, which the personal balance cannot be decreased. Its value can be positive, zero, or even negative.

Periodic recharges

List of assigned periodic recharges.

Debts

Debts represent the total overdrawn value of personal balance. Similar to virtual balance, each debt is assigned to a different API user. For more information about debt configuration, see Working with Payment System (section Overdrawn transactions) and configuration of YSoft SafeQ Payment System.

Reservations

Reservations represent blocked personal and/or virtual balance. For more information about reservations, see Working with Payment System section Reservations.

Transactions

Transactions represent the history of balance changes. For more information about transaction types, see chapter Report Attributes.

Open deposits

Open deposits represent unfinished payment gateway deposits. For more information see Using YSoft SafeQ end user interface section Electronic Payment.

Quotas

Assigned Quotas and their consumed and remaining values. Each subject can have several different quota limits.

This action is available only for Page quota subject type. It serves for a manual increase of quota limit for the selected subject. For more detail about the quota limit, see the chapter Quotas.

Enable prepaid account

This action enables the prepaid account if it is disabled.

Disable prepaid account

This action disables the prepaid account if it is disabled.

Remove prepaid account

This action removes the prepaid account and also clears all balances and annul all debts.

Export filtered subjects to CSV file

All subjects which correspond with a current filter will be exported to a CSV file

Name

Unique quota name.

Limit

Quota limit. This limit will be assigned to each subject with this quota. This limit can be increased individually on the subject detail.

Identifiers / Applies to

Identifiers are in fact services available in YSoft SafeQ. These can be spent by a user. Not all combinations are valid (for example "Print Copy" is invalid).

Recurrence

Recurrence specifies how often should YSoft SafeQ Payment System reset a quota limit. Following options are possible:

• daily – Reset will be executed every day.

• weekly – Reset will be executed every week on the specified day of the week.

• monthly – Reset will be executed on a given day every month.

• yearly – Reset will be executed every year on a given day of the given month.

• at the end of month – Reset will be executed on the last day of every month (regardless of the number of days in the month).

Enable threshold notification

Enables configuration of threshold notification.

Threshold

Defines a proportion (in comparison to quota limit) or amount of consumed quota which will trigger quota notification.

Owner / Owner's username/email

If defined the notification is sent to:

• defined email address or YSoft SafeQ user if he has valid email address.

• and the user who reached the limit

If it is not defined only the user who reached the limit is notified.

Create quota

Displays "Create quota" page.

Edit quota

Displays "Edit quota" page.

Remove

Removes quotas. It is not possible to remove the assigned quota, at first, you should remove it from entitlement.

Name

Periodic recharge name

Description

Optional periodic recharge description

Status

There are two possible statuses:

• enabled – periodic recharge is enabled and will be executed on schedule

• disabled – periodic recharge will not be executed

Assigned merchant

Merchant (API user with merchant role), which identifies the type of subject's virtual balance to be credited.

Type

Periodic recharges can be set up to:

• recharge by amount – the specified amount will be added with each execution

• recharge to amount – virtual balance will be set to the specified value if the current value is less than a specified value (i.e. the resulting value will be maximum of current value and specified value)

Recurrence

Recurrence specifies the periodicity of the recharge. Following options are possible:

• daily – recharge will be executed every day

• weekly – recharge will be executed every week on the specified day of the week

• monthly – recharge will be executed on the given day every month.

• yearly – recharge will be executed every year on the given day of the given month

• at the end of month – recharge will be executed on the last day of every month (regardless of the number of days in the month)

Start

Recharge will start executing at the first possible moment after the specified start date. The start date must be set to be in the future.

Enable recharge / Enable selected

Changes status of selected recharges to enabled.

Disable recharge / Disable selected

Changes status of selected recharges to disabled.

Remove recharge / Remove selected

Removes periodic recharge. Removed recharges remain in the database for auditing purposes, but they are no longer visible in the administration interface. Recharge is inactive.

Create periodic recharge.

Opens the "create periodic recharge" page.

View assigned customers

Shows page with a list of subjects currently assigned to the recharge. Subjects can be assigned or unassigned from the recharge.

Name

Cash desk name is used by cash desk operator in Cash Desk web interface as the main discriminator among different cash desks.

Status / Initial status

There are several available values for cash desk status:

• Closed – Cash Desk can be opened by cash desk operator in Cash Desk web interface.

• Opened – Cash Desk is already opened by cash desk operator. Other operators cannot use this cash desk until the present operator close it or the administrator terminates the cash desk session.

• Disabled – Cash desk is not visible in Cash Desk web interface (even for an assigned operator).

• Removed – Cash desk is not visible in Administration of Cash Desk web interface. This is a final state, without transition to any other state.

Type

Cash desk type affects functionality on the detail of the subject in the Cash Desk web interface. Possible types are:

• General – This type allows you to use all actions (deposit, withdraw, change of virtual balance, refund, redeem) and you will also see all virtual balances assigned to a subject.

• Merchant – This type is designed for environments with more than one API user merchant role (usually there is only "safeq"). It will be always assigned to one merchant and it allows you to do only basic operations with the subject's virtual balance. Only virtual balance assigned to the same merchant will be visible in the Cash Desk web interface.

Merchant

API user merchant role assigned to the cash desk with "merchant" type.

Balance / Initial balance

In the case of the general cash desk type, the cash desk balance represents real money used for deposit or withdrawal from the subject personal balance.

In the case of merchant cash desk type, there is no balance, because all operations affect only virtual balances.

Enabled display of customer history

There are two possible values:

• Yes – This will display the button "Customer history" in detail of the subject in the Cash Desk web interface.

• No –This will hide the button.

Current operator

Name of the cash desk operator, who lastly opened the cash desk.

Assigned operators

You can select YSoft SafeQ users with the role "cash desk operators". These users will see this cash desk after login into the Cash Desk web interface (assuming that the cash desk is not disabled).

Create cash desk

Create a new cash desk.

Edit cash desk

Edit cash desk attributes.

Remove cash desk / Remove selected

Remove the cash desk. It will be no longer visible on the administration interface or Cash Desk web.

Enable cash desk / Enable selected

Change cash desk status to "Enabled".

Disable cash deks / Disable selected

Change cash desk status to "Disabled".

Terminate cash desk session

Forcibly perform transition to "Closed" status. This will make the cash desk available for all assigned operators and it will allow administrators to edit cash desk attributes.

Name

Name of the YSoft Payment Machine. Name is used for better identification of YSoft Payment Machine in the web administration (e.g. location).

Status

Online status of the YSoft Payment Machine. Useful for troubleshooting.

Authorization

Authorization status. Unauthorized machines cannot communicate with YSoft SafeQ Payment System.

IP

YSoft Payment Machine IP address.

Firmware

YSoft Payment Machine firmware version.

Serial number

YSoft Payment Machine serial number.

MAC address

YSoft Payment Machine mac address.

Closure

List of deposits for a certain time period. For more details see Operating YSoft Payment Machine.

Grant authorization / Authorize selected

Authorizes YSoft Payment Machine allowing it to connect to YSoft SafeQ Payment System.

Remove authorization / De-authorize selected

De-authorizes Payment Machine making it unable to connect to YSoft SafeQ Payment System.

Rename YSoft Payment Machine

Shows dialog for the renaming of YSoft Payment Machine.

Name

Descriptive name of the plugin.

URL

URL to the payment gateway plugin. At the moment YSoft SafeQ Payment System supports two types with these default URLs:

• PayPal plugin URL https://<YPS_HOST>:8443/paypal-integration/api/v1

• DIBS plugin URL https://<YPS_HOST>:8443/dibs-integration/api/v1

Use YSoft SafeQ Payment System server (or server where your payment gateway plugins are installed) true IP instead of "YPS_HOST".

Icon URL

URL to the payment gateway icon. This icon helps visually distinguish the payment gateways. You can use either URL to the image from the internet or you can use these two defaults:

• PayPal icon http://<YPS_HOST>:8080/paypal-integration/assets/icon.png

• DIBS icon http://<YPS_HOST>:8080/dibs-integration/assets/icon.png

Use YSoft SafeQ Payment System server (or server where your payment gateway plugins are installed) true IP instead of "YPS_HOST".

Minimum deposit amount

The minimum amount for one deposit. Bigger amounts are usually used in the case of a payment gateway, which charges transaction fees.

Status

Possible values are:

• enabled – user can deposit through the payment gateway

• disabled – user cannot deposit through the payment gateway and it is not visible on the payment gateway deposit screen

Require confirmation of terms and conditions

Flag indicating whether the user must accept terms and conditions prior to transferring money through the payment gateway.

Terms and conditions

Text of terms and conditions is displayed when confirmation is required.

Enable connection / Enable selected

Enables selected payment gateway connection

Disable connection / Disable selected

Disables selected payment gateway connection.

Remove connection / Remove selected

Removes selected payment gateway connection. Payment gateway information is still kept in the system for auditing purposes, but the payment gateway is not accessible from the administration interface.

Create connection to plug-in

Opens create plug-in connection dialog

Edit connection

Opens edit plug-in connection dialog

Code

Unique code identifying the voucher.

Amount

The amount by which the personal balance would be or was increased.

Expiration date

If a voucher with New status exceeds this limit, it is automatically switched to Expired status. Vouchers with no expiration date will never expire.

Status

Possible values are:

• New – Voucher can be redeemed.

• Expired – Voucher expired and it cannot be redeemed.

• Redeemed – Voucher was already redeemed by some subject. It cannot be redeemed again.

Redemption date

Date when the voucher was redeemed.

Customer

subject who redeemed the voucher.

Remove selected

Remove selected vouchers. Removed vouchers remain in the database for auditing purposes, but they are no longer visible on the administration interface and cannot be redeemed.

Generate vouchers

This action allows you to generate many New vouchers with random codes in one batch. Possible attributes are:

• Number of vouchers – The system will generate random codes for the given number of vouchers. The maximum number is 1000.

• Voucher value – Each generated voucher will have a given amount value.

• Expiration date – Each generated voucher will have a given expiration date. This field is optional. If you omit it, generated vouchers will never expire.

Import vouchers

This action allows you to import many New vouchers with the given code from the CSV file. Possible columns in CSV file are:

• Code (first mandatory column) – Unique voucher code. Use a maximum of 10 characters.

• Amount (second mandatory column) – Decimal value from 0.0001 up to 1000000000.

• Expiration date (third optional column) – Date in the yyyy-mm-dd format. It has to be in the future. If you omit it, generated vouchers will never expire.

Vouchers to template

In order to distribute new voucher codes to your money account owners, you can export your vouchers into a printable file. This action requires a DocX template with updatable fields, where each field represents a voucher code. Selected vouchers will be exported into this template. Here are the possible attributes:

• Template file – Select a DocX template.

• Type – You can export either selected vouchers from your vouchers menu or records created after a specific date.

• Output file format – Choose your output format.

Export vouchers

This action allows you to export vouchers into a CSV file. There are two basic modes.

• export new vouchers – When you select this type, you will export vouchers in New status from the specific date.

• export voucher changes – When you select changed vouchers type, you will export all status changes from all vouchers and from the specific date.

Name

Name of the API user. Used for API authentication.

Password

Password used for API authentication.

Status

Current status of the API user. Possible values are:

• enabled – API user can access the APIs

• disabled – API user cannot access the APIs

• locked – API user used more than 5 wrong passwords and cannot access the APIs. Action Enable will unlock the API user.

Merchant API

Access to Merchant APIs – APIs for transaction processing (reservations, settlements).

Cashdesk API

Access to Cashdesk APIs – APIs for deposits, withdrawals, or closures on a Cashdesk.

Admin API

Access to Admin APIs – APIs for management of subjects, money accounts or periodic recharges.

Balance Management API

Access to Balance Management API – APIs for increasing or decreasing virtual account balance.

Enable API user / Enable selected

Enables or unlocks selected API users.

Disable API user / Disable selected

Disables selected API users.

Remove API user / Remove selected

Removes selected API users. Removed API users remain in the database for auditing purposes, but they are no longer visible on the administration interface.

Create API user

Opens the create API user dialog.

Change password

Opens the change password dialog.

Edit API user

Opens the edit API user dialog used for the change of the API user access.

Count

Incident occurrence count. Incidents of the same kind may occur many times so they are grouped together for better readability.

Severity

Severity can have the following values:

• Info – information message without the need for administrative action.

• Warning – an issue that does not prevent the system to operate normally. However, it is advised that the issue is analyzed and resolved by the administrator.

• Error – serious problem which should be immediately resolved by the administrator.

Incident source

Identifies part of the system, which generated the error.

Description

Incident description.

Occurrence date

Date of incident occurrence.

Incident detail

More detailed incident description.

Remove selected incidents

Permanently deletes selected incidents.

ID

Internal system identifier of the transaction.

Type

Type of transaction can have the following values:

• Balance decrease – decrease a virtual balance for a specific subject

• Balance increase – increase a virtual balance for a specific subject

• Balance reset – increase a virtual balance for a specific subject

• Cash desk deposit – deposit money to a specific subject's account through a cash desk

• Cash desk withdrawal – withdraw money from a specific subject's account through a cash desk

• Debt registration – transactions, which registered/created new debt

• Debt write off – a part of subject's debt, which was decreased from debt amount

• Deposit via payment gateway – subject deposited some money to his/her YPS account through a payment gateway

• Initial imported debt – debt created during the creation of a new imported subject (a debt from a previous payment system)

• Initial imported deposit – the initial balance of a newly-imported subject (a balance of an account from a previous payment system)

• Money transfer – money transferred by one step transaction

• Recharge event – virtual money deposited by a periodic recharge

• Transaction refund – partly or fully refunded a subject's transaction

• Transaction settlement – settled subject's reservations (finish step of microtransaction)

• Voucher redemption – the redemption of a voucher. Deposit money to a subjects' account by a voucher through a YSoft SafeQ end user interface or Cash Desk

• YSoft Payment Machine deposit event – deposited money through the YSoft Payment Machine

Balance change

Amount of the transaction.

Final balance

Account balance after the transaction was performed.

Date

Transaction processing date.

Description

Transaction description – provided by the merchant.

Customer

Name of the subject, whose account participated in the transaction.

Merchant

API user, who initiated the transaction.

Export filtered transactions to CSV file

Download currently filtered transaction records as a CSV file.