Name

Customer name is usually represented in form of "Name Surname" and it is assigned during customer creation. It is possible to edit customer name on detail of customer by button "Edit customer", but we recommend changing the name of the original YSoft SafeQ user, because these data will be eventually synchronized into YSoft Payment System.

Lookup key

In case of SafeQ, lookup key represents username of YSoft SafeQ user.

Personal Balance

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

Virtual Balance

Virtual balance represents 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". In 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

Minimum balance represents a value below, which the personal balance cannot decrease. Its value can be positive, zero or even negative.

Status

Available values for customer status are:

• Enabled - Customer can settle transactions and customer data are visible in Administration web interface.

• Disabled - Customer cannot settle transactions and customer data are visible in Administration web interface.

Periodic recharges

List of assigned periodic recharges.

Debts

Debts represent total overdrawn value of personal balance. Similarly to virtual balance, each debt is assigned to a different API user merchant role. For more information about debt configuration, see Working with Payment System#Overdrawntransactions

Reservations

Reservations represent blocked personal or virtual balance (or both). For more information about reservations, see Working with Payment System#Reservations

Transactions

Transactions represent history of balance changes. For more information, see Working with Payment System#Transactionsettlement

Open deposits

Open deposits represent unfinished payment gateway deposits. For more information, see Deposit money through payment gateway

Edit customer

Change customer name, minimum balance or status.

Enable customer / Enable selected

Change customer status to "Enabled".

Disable customer / Disable selected

Change customer status to "Disabled".

Assign Selected

Assign selected customers to periodic recharge.

Import Customers

Import customers from CSV file.

Name

Cash desk name is used by cash desk operator in Cash Desk web interface as a 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 terminate the cash desk session.

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

• Removed - Cash desk in 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 detail of customer 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 customer.

• Merchant - This type is designed for environments with more than one API user merchant roles (usually there is only "safeq"). It will be always assigned to one merchant and it allows you to do only basic operations with customer 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 case of general cash desk type, the cash desk balance represents real money used for deposit or withdrawal from customer personal balance.

In case of merchant cash desk type, there in no balance, because all operations affects only virtual balances.

Enabled display of customer history

There are two possible values:

• Yes - This will display button "Customer history" on detail of customer 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 SafeQ users with role "cash desk operators". These users will see this cash desk after login into 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 in the Administration web 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 cash desk available for all assigned operators and it will allow administrator 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 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 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 Payment System.

Remove authorization / De-authorize selected

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

Rename YSoft Payment Machine

Shows dialog for renaming of YSoft Payment Machine.

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 type of customer's virtual balance to be credited.

Type

Periodic recharges can be set up to:

• recharge by amount - specified amount will be added with each execution

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

Recurrence

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

• daily - recharge will be executed every day

• weekly - recharge will be executed every week at specified day of week

• monthly - recharge will be executed at given day every month.

• yearly - recharge will be executed every year at given day of given month

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

Start

Recharge will start executing at the first possible moment after specified start date. 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 database for auditing purposes, but they are no longer visible in the Administration web. Recharge is inactive.

Create periodic recharge.

Opens "create periodic recharge" page.

View assigned customers

Shows page with list of customers currently assigned to the recharge. Customers can be assigned or unassigned from the recharge.

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 customers, 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 database for auditing purposes, but they are no longer visible in the Administration web.

Create API user

Opens create API user dialog.

Change password

Opens change password dialog.

Edit API user

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

Name

Descriptive name of the plugin.

URL

URL to the payment gateway plugin. At the moment YSoft 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 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 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 Payment System server (or server where your payment gateway plugins are installed) true IP instead of "YPS_HOST".

Minimum deposit amount

Minimum amount for one deposit. Bigger amount are usually used in case of 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 payment gateway deposit screen

Require confirmation of terms and conditions

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

Terms and conditions

Text of terms and conditions which is displayed when the 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 system for auditing purposes, but the payment gateway is not accessible from the the web administration.

Create connection to plug-in

Opens create plug-in connection dialog

Edit connection

Opens edit plug-in connection dialog

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 following values:

• Info - information message without need for administrative action.

• Warning - issue which does not prevent the system to operate normally. However, it is advised that the issue is analysed 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.

Decription

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 following values:

• Balance decrease - decrease a virtual balance for a specific merchant of a customer

• Balance increase - increase a virtual balance for a specific merchant of a customer

• Balance reset - increase a virtual balance for a specific merchant of a customer

• Cash desk deposit - deposit money to a specific customer's account through a cash desk

• Cash desk withdrawal - withdraw money from a specific customer's account through a cash desk

• Debt registration - one of customer's transactions registered/created new debt

• Debt write off - a part (or whole) of customer's debt was paid off

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

• Initial imported debt - debt created during creation of a new imported customer (a debt from a previous payment system)

• Initial imported deposit - initial balance of a new imported customer (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 customer's transaction

• Transaction settlement - settled customer's reservations (finish step of microtransaction)

• Voucher redemption - redemption of a voucher. Deposit money to a customers's account by a voucher through a YSoft Wallet or Cash Desk

• YSoft Payment Machine deposit event - deposited money through a 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 merchant.

Customer

Name of the customer, 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 CSV file.

Code

Unique code identifying the voucher.

Amount

Amount by which the personal balance would be or was increased.

Expiration date

If a voucher with New status exeeds this limit, it be 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 customer. It cannot be redeemed again.

Redemption date

Date when the voucher was redeemed.

Customer

Customer who redeemed the voucher.

Remove selected

Remove selected vouchers. Removed vouchers remain in database for auditing purposes, but they are no longer visible in the Administration web and they 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 - System will generate random codes for the given number of vouchers. Maximum number is 1000.

• Voucher value - Each generated voucher will have given amount value.

• Expiration date - Each generated voucher will have 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 given code from the CSV file. Possible columns in CSV file are:

• Code (first mandatory column) - Unique voucher code. Use 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 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 printable file. This action requires DocX template with updatable fields, where each field represents voucher code. Selected vouchers will be exported into this template. Here are possible attributes:

• Template file - You can use our example template Vouchers_mass_print.docx.

• Type - You can export either selected vouchers from you vouchers menu or records created after specific date.

• Output file format - Choose your output format

Export vouchers

This action allows you to export vouchers into 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.