Zip and Country Codes|
Development
Reference Materials
UniPay Properties Definition
Property Location Types:
| Database |
run-time property used by the application and stored within a database
|
| File | run-time property used by the application and stored within a file |
| Build | build-time property used by the application and stored within a file |
Available Properties for iapp_settings:
Property Definitions for iapp_settings:
defaults.franchise_fee.payment_rate
Added On: 08/09/23
Legacy Name: Defaults Franchise Fee Payment Rate
Group: Defaults
Status: Active
Attributes:
Default value for payment rate of franchise fee assigned to new Merchants with the specified owner.
defaults.franchise_fee.subscription_rate
Added On: 08/09/23
Legacy Name: Defaults Franchise Fee Subscription Rate
Group: Defaults
Status: Active
Attributes:
Default value for subscription rate of franchise fee assigned to new Merchants with the specified owner.
defaults.franchise_fee.tax_rate
Added On: 02/19/24
Legacy Name: Defaults Franchise Fee Tax Rate
Group: System
Status: Active
Attributes:
Default value for tax rate assigned to new Merchants with the specified owner. Used for prepayments when an invoice for an allocation does not yet exist.
defaults.merchant_account_group.chargeback_reserve_period
Added On: 08/08/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( 28 )
Default value for Chargeback Reserve Peroid field that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.chargeback_reserve_rate
Added On: 02/21/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Chargeback Reserve Rate (%) field that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.fee_withdrawal_policy_cl
Added On: 08/08/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( DD )
Default value for fee withdrawal policy flag that is used when a new merchant account group is created.
defaults.merchant_account_group.is_ignore_remittance_source
Added On: 03/28/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Remittance Source Usage flag that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.is_merchant_statement_archiving_enabled
Added On: 11/05/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( true )
Default value for Merchant Statement Archiving flag that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.is_merchant_statement_export_enabled
Added On: 07/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( false )
Default value for Merchant Statement Export flag that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.is_remittance_emailing_enabled
Added On: 03/16/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Remittance Emailing Usage flag that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.is_remittance_hold_enabled
Added On: 10/10/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( false )
Default value for Remittance Hold flag that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.max_withholding_amount
Added On: 10/10/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Maximum Withholding Amount field that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.return_reserve_period
Added On: 08/08/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( 28 )
Default value for Return Reserve Period field that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.return_reserve_rate
Added On: 02/21/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Return Reserve Rate (%) field that should be used when Merchant Account Group object is created.
defaults.merchant_account_group.statement_emailing_policy_cl
Added On: 08/08/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( NO )
Default value for statement emailing policy flag that is used when a new merchant account group is created.
defaults.merchant_account_group.statement_policy_cl
Added On: 08/08/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( PB )
Default value for statement policy flag that is used when a new merchant account group is created.
defaults.merchant_account_profile.is_file_notification_enabled
Added On: 12/09/13
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for File Notification flag that should be used when Merchant Account Profile object is created.
defaults.merchant_account_profile.is_settlement_notification_enabled
Added On: 12/09/13
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Settlement Notification flag that should be used when Merchant Account Profile object is created.
defaults.merchant_account_profile.max_transaction_amount
Added On: 08/02/18
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for maximum transaction amount (in dollars). Can be overridden at merchant, reseller and portfolio levels using the overriding mechanism on the user interface.
defaults.merchant_account_profile.realtime_period
Added On: 12/11/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Realtime Period field that should be used when Merchant Account Profile object is created.
defaults.merchant-account-group.statement_view_policy
Added On: 06/15/20
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( ARCF--DSB-- )
Default value for statement view policy which determines what information is included in the merchant statement.
Possible values:
- Activity Summary – A
- Rejects Summary – R
- Returns/Chargebacks Summary – C
- Fees – F
- Split Details – L
- Reserves – V
- Adjustments – D
- Statement Summary – S
- Submissions Summary - B
- Splits Summary - M
- Transactions Summary – T
- Return Details – N
defaults.merchant.ach_remittance_period
Added On: 02/22/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( 1 )
Default value for ACH Remittance Period that is used when Merchant object is created.
defaults.merchant.amex_remittance_period
Added On: 02/22/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( 2 )
Default value for Amex Remittance Period that is used when Merchant object is created.
defaults.merchant.batch_validation_threshold_amount
Added On: 06/21/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Batch Validation Threshold Amount field that should be used when Merchant object is created.
defaults.merchant.batch_validation_threshold_count
Added On: 06/21/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Batch Validation Threshold Count field that should be used when Merchant object is created.
defaults.merchant.cc_remittance_period
Added On: 02/22/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( 1 )
Default value for Bank Card Remittance Period that is used when Merchant object is created.
defaults.merchant.code_uniqueness_scope_cl
Added On: 09/10/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( M )
Default value for code uniqueness scope flag that is used when a new merchant is created.
defaults.merchant.collections_email_age1
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Age 1 that is used when Merchant object is created.
defaults.merchant.collections_email_age2
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Age 2 that is used when Merchant object is created.
defaults.merchant.collections_email_age3
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Age 3 that is used when Merchant object is created.
defaults.merchant.collections_email_age4
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Age 4 that is used when Merchant object is created.
defaults.merchant.collections_email_age5
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Age 5 that is used when Merchant object is created.
defaults.merchant.collections_email_code1
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Code 1 that is used when Merchant object is created.
defaults.merchant.collections_email_code2
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Code 2 that is used when Merchant object is created.
defaults.merchant.collections_email_code3
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Code 3 that is used when Merchant object is created.
defaults.merchant.collections_email_code4
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Code 4 that is used when Merchant object is created.
defaults.merchant.collections_email_code5
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Collections Email Code 5 that is used when Merchant object is created.
defaults.merchant.configure-remittance
Added On: 05/29/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( true )
Default value for Configure Remittance that is used when Merchant object is created (used on new Merchant or new Account extended forms).
defaults.merchant.email_code_agent_payment
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Agent Payment Email Code that is used when Merchant object is created.
defaults.merchant.email_code_cancel_credit
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Cancel Credit that is used when Merchant object is created.
defaults.merchant.email_code_cancel_refund
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Cancel Refund that is used when Merchant object is created.
defaults.merchant.email_code_chargeback
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Chargeback that is used when Merchant object is created.
defaults.merchant.email_code_credit
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Credit that is used when Merchant object is created.
defaults.merchant.email_code_draft_payment
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Draft Payment that is used when Merchant object is created.
defaults.merchant.email_code_hard_decline
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Hard Decline that is used when Merchant object is created.
defaults.merchant.email_code_invoice
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Invoice that is used when Merchant object is created.
defaults.merchant.email_code_invoice_notification
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Invoice Notification that is used when Merchant object is created.
defaults.merchant.email_code_late_fee
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Late Fee that is used when Merchant object is created.
defaults.merchant.email_code_portal_payment
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Portal Payment that is used when Merchant object is created.
defaults.merchant.email_code_refund
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Refund that is used when Merchant object is created.
defaults.merchant.email_code_soft_decline
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Soft Decline that is used when Merchant object is created.
defaults.merchant.email_code_void
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Code Void that is used when Merchant object is created.
defaults.merchant.email_code_welcome
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Welcome Email Code that is used when Merchant object is created.
defaults.merchant.email_invoice_notification_period
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Email Invoice Notification Period that is used when Merchant object is created.
defaults.merchant.is_account_aggregation_ach_enabled
Added On: 01/22/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Account Aggregation ACH Usage flag that should be used when Merchant object is created.
defaults.merchant.is_account_aggregation_cards_enabled
Added On: 01/22/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Account Aggregation Cards Usage flag that should be used when Merchant object is created.
defaults.merchant.is_batch_custom_field_enabled
Added On: 12/26/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Batch Custom Field flag that should be used when Merchant object is created.
defaults.merchant.is_batch_review_required
Added On: 02/22/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Batch Review flag that is used when Merchant object is created.
Possible values:
defaults.merchant.is_expiration_date_validation_enabled
Added On: 06/21/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( true )
Default value for Expiration Date Validation flag that should be used when Merchant object is created.
defaults.merchant.is_file_hash_validation_enabled
Added On: 12/08/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for File Hash Validation Usage flag that should be used when Merchant object is created.
defaults.merchant.is_import_log_review_required
Added On: 05/14/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( false )
Default value for Import Log Review flag that should be used when Merchant object is created.
defaults.merchant.is_merchant_statement_review_required
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Merchant Statement Review flag that is used when Merchant object is created.
Possible values:
defaults.merchant.is_required_balance_soft_decline_email
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default ( false )
Default value for Merchant Balance Soft Decline flag that is used when Merchant object is created.
Possible values:
defaults.merchant.is_reseller_statement_review_required
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Reseller Statement Review flag that is used when Merchant object is created.
Possible values:
defaults.merchant.is_routing_number_validation_enabled
Added On: 06/21/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( true )
Default value for Routing Number Validation flag that should be used when Merchant object is created.
defaults.merchant.is_skip_trace_enabled
Added On: 08/07/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( false )
Default value for Skip Trace flag that should be used when Merchant object is created.
defaults.merchant.is_transaction_processing_optimization_enabled
Added On: 07/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( false )
Default value for Transaction Processing Optimization flag that should be used when Merchant object is created.
defaults.merchant.is_use_blacklist
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Blacklist usage flag that is used when Merchant object is created.
Possible values:
defaults.merchant.mail_mode_cl
Added On: 08/07/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( D )
Default value for mail mode flag that is used when a new merchant is created.
defaults.merchant.notification_email_age1
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Notification Email Age 1 that is used when Merchant object is created.
defaults.merchant.notification_email_age2
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Notification Email Age 2 that is used when Merchant object is created.
defaults.merchant.notification_email_age3
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Notification Email Age 3 that is used when Merchant object is created.
defaults.merchant.notification_email_code1
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Notification Email Code 1 that is used when Merchant object is created.
defaults.merchant.notification_email_code2
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Notification Email Code 2 that is used when Merchant object is created.
defaults.merchant.notification_email_code3
Added On: 01/23/14
Legacy Name:
Group: Unibill
Status: Active
Attributes:
Default value for Notification Email Code 3 that is used when Merchant object is created.
defaults.merchant.processing_cutoff
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( 14 )
Default value for Processing Cut Off that is used when Merchant object is created.
Possible values:
- 1 = 1 am
- 2 = 2 am
- 3 = 3 am
- 4 = 4 am
- 5 = 5 am
- 6 = 6 am
- 7 = 7 am
- 8 = 8 am
- 9 = 9 am
- 10 = 10 am
- 11 = 11 am
- 12 = 12 pm
- 13 = 1 am
- 14 = 2 am
- 15 = 3 am
- 16 = 4 am
- 17 = 5 am
- 18 = 6 am
- 19 = 7 am
- 20 = 8 am
- 21 = 9 am
- 22 = 10 am
- 23 = 11 am
- 24 = 12 am
defaults.merchant.profile
Added On: 04/16/14
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( SSSSM )
Default value for Profile field that should be used when Merchant object is created.
defaults.merchant.remittance_basis_cl
Added On: 03/29/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( F )
Default value for remittance basis flag that is used when a new merchant is created.
Default value is F indicating that the remittance dates are calculated based off Funding Date.
defaults.merchant.remittance_mode_cl
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( NN )
Default value for Remittance Mode that is used when Merchant object is created.
Possible values:
- RetailAndBatch
- BatchOnly
- RetailOnly
defaults.merchant.remittance_period
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Remittance Period that is used when Merchant object is created.
defaults.merchant.remitter_fk
Added On: 02/23/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default value for Remitter reference that is used when Merchant object is created.
The value must be a valid ID of an active Merchant of type Remitter.
defaults.merchant.returns_delivery_mode_cl
Added On: 10/10/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Required Default ( M )
Default value for returns delivery mode flag that is used when a new merchant is created.
defaults.retail_profile.is_tokenization_required
Added On: 02/24/12
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( false )
Default value for Tokenization flag that is used when Retail Profile object is created.
Possible values:
ui.customer-account.modify.code.editable
Added On: 03/07/12
Legacy Name: ui-configuration.properties:CustomerView-CanChangeRefCode
Group: General
Status: Active
Attributes:
Default ( false )
Controls whether Code field is editable on Customer Account Modify form. In cases when arbitrary changes to the code field's value may cause synchronization problems with other systems, it is recommended to disable editing of this component.
Possible values:
- true - the field is editable
- false - the field is read-only
ui.customer-account.shipping-address.required
Added On: 05/20/15
Legacy Name:
Group: General
Status: Active
Attributes:
Default ( true )
Controls the validation of the shipping address value entered by a customer in customer account info on Customers form.
ui.menu.chargebacks.visible
Added On: 08/23/12
Legacy Name: ui-configuration.properties:Chargebacks
Group: General
Status: Active
Attributes:
Default ( false )
Controls Chargebacks menu button.
Possible values:
- true - the button is visible
- false - the button is hidden
ui.merchant.modify.is_tokenization_enabled.visible
Added On: 03/07/12
Legacy Name: ui-configuration.properties:MerchantModify-isTokenizationEnabled
Group: General
Status: Active
Attributes:
Default ( true )
Controls whether Tokenization Enabled field is editable on Merchant Modify form. In cases when tokenization is always required, it might be necessary to permanently hide this field (default value will be set for the field automatically).
Possible values:
- true - the field is visible
- false - the field is hidden
unicharge.ftp-gates.directory
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-folder
Group: FTP Gates
Status: Active
Attributes:
Local or remote directory, from which files are to be loaded by FTP Gates.
When local directory is used, the value of the property must be an absolute path to the directory.
When remote directory is used, the value must be a remote directory path understood by the underlying FTP server.
unicharge.ftp-gates.host
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-host
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required, FTP host location, from which files should be loaded by FTP Gates.
unicharge.ftp-gates.passphrase
Added On: 02/21/12
Legacy Name: unicharge.ftp-gates.pass-phrase; atlas.ftp-gates.ftp-ssh_pass_phrase
Group: FTP Gates
Status: Active
Attributes:
Encrypted
When remote connectivity is required (sFTP), pass phrase on the private key, used to authenticate with the FTP server, from which files should be loaded by FTP Gates.
unicharge.ftp-gates.password
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-password
Group: FTP Gates
Status: Active
Attributes:
Encrypted
When remote connectivity is required (FTP and FTPs), password on the FTP server, from which files should be loaded by FTP Gates.
unicharge.ftp-gates.port
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-port
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required, port for the FTP server, from which files should be loaded by FTP Gates.
unicharge.ftp-gates.private-key
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-ssh_private_key
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required (sFTP), private key used to authenticate with the FTP server, from which files should be loaded by FTP Gates.
The value of the property is the name of the file that contains the private key. The file must be located in unipay.resources-home/ssh
unicharge.ftp-gates.type
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-type
Group: FTP Gates
Status: Active
Attributes:
Default ( file )
Type of connectivity used by FTP Gates to retrieve files for processing.
Possible values:
- file - FTP gates loads files from a local folder
- ftp - FTP gates loads files from a remote location over FTP protocol
- ftps - FTP gates loads files from a remote location over FTPs protocol
- sftp - FTP gates loads files from a remote location over sFTP protocol
unicharge.ftp-gates.username
Added On: 02/21/12
Legacy Name: atlas.ftp-gates.ftp-username
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required (FTP and FTPs), user name on the FTP server, from which files should be loaded by FTP Gates.
unicharge.processing.debit-sale-auth-enabled
Added On: 05/08/20
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( false )
Indicates whether sale-auth processing is supported by the gateway for debit cards.
Possible values:
- true – sale-auth operation is supported by the debit network. In this case, sale-auth request submitted to the gateway is converted to the sale request and passed to the processor.
- false – sale-auth operation is not supported by the debit network. In this case, when sale-auth request is submitted to the gateway, the following error is returned: “This request type is not supported”.
unicharge.processing.notice-delivery-enabled
Added On: 08/08/14
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( true )
Indicates whether Notices of Change are included in the Transaction Export report which is available at two places:
- on the user interface,
- via the transaction-list API call in the reporting API.
unicharge.processing.payment-request-parameters
Added On: 11/02/23
Legacy Name:
Group: General
Status: Active
Attributes:
unicharge.statement-archiving.directory
Added On: 09/09/16
Legacy Name:
Group: System
Status: Active
Attributes:
Directory to which statements are uploaded if unicharge.statement-archiving.type is set to remote.
The value must be a remote directory path understood by the underlying FTP server.
unicharge.statement-archiving.type
Added On: 09/09/16
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( local )
A place to which merchant statements are uploaded if statement archiving is set to true for a corresponding merchant account.
Possible values:
- local - statements are uploaded to the local application server into resources catalog
- remote - statements are uploaded to an FTP server
unipay.app-home
Added On: 02/21/12
Legacy Name: isolutions.root-folder
Group: General
Status: Active
Attributes:
Required Default ( /home/jenkins/unipay )
Absolute path to the directory where application server (JBoss) hosting UniPay is installed.
The path must be defined using path style of the application server's operating system (e.g. using '\' on Windows and '/' on Linux).
unipay.app-host
Added On: 03/02/12
Legacy Name: iapp.properties:server.host
Group: General
Status: Active
Attributes:
Required
Host (URL) to access UniPay user interface from either internal or external (public) network. The value is used for inter-module communication, for Provider callbacks and in notifications sent to user, in which a link to the applications needs to be provided (e.g. integration instructions). For example, https://portal.unipay.com.
unipay.app-name
Added On: 02/21/12
Legacy Name: iapp.application.name; iapp.properties:iapp.title
Group: General
Status: Active
Attributes:
Required Default ( UniPay Gateway )
Official name of the application to be shown on UI. The value is used for rebranding.
unipay.audit.communication-decline-threshold
Added On: 05/28/24
Legacy Name:
Group: Unipay
Status: Active
Attributes:
A threshold for communication decline of a merchant. If the quantity of communication declines for a specific merchant exceeds this threshold, ID of that merchant will be inncluded in the "Decline Rate Deviations of Real-Time Transactions (ID: 203)" section of the quarter-hourly audit notifications.
unipay.audit.configuration-decline-threshold
Added On: 05/28/24
Legacy Name:
Group: Unipay
Status: Active
Attributes:
A threshold for configuration decline of a merchant. If the quantity of communication declines for a specific merchant exceeds this threshold, ID of that merchant will be included in the "Decline Rate Deviations of Real-Time Transactions (ID: 203)" section of the quarter-hourly audit notifications.
unipay.audit.decline-threshold-rate
Added On: 05/28/24
Legacy Name:
Group: Unipay
Status: Active
Attributes:
A threshold for decline rate of a merchant. If the decline rate of a specific merchant exceeds this threshold, ID of that merchant will be inncluded in the "Decline Rate Deviations of Real-Time Transactions (ID: 203)" section of the daily audit notifications.
unipay.audit.ignore-merchant-list
Added On: 05/25/14
Legacy Name:
Group: General
Status: Active
Attributes:
List of merchants to which ordered process is not apply. These merchants are ignored during the system ordered process.
unipay.audit.merchant-ignore-list
Added On: 05/25/14
Legacy Name:
Group: General
Status: Active
Attributes:
List of merchants to which ordered process is not apply. These merchants are ignored during the system ordered process.
unipay.audit.monitoring-log-file-list
Added On: 05/28/24
Legacy Name:
Group: Unipay
Status: Active
Attributes:
A list of log file names to be analyzed for size. Files exceeding 100MB are included in the "Log size increase errors (ID: 304)" section of the hourly audit notifications.
unipay.authentication.second-factor-role
Added On: 04/30/15
Legacy Name:
Group: System
Status: Active
Attributes:
Used to specify and store the user role, for which Two Factor Authentication will be applied.
Two Factor Authentication mechanism will be used for this user role and all roles that are higher.
For example:
The highest used portfolio role in the system is Por2. If you specify this role the authentication will be used for the Por2, Sys1 and Sys2 roles. If you specify Res2 role, - that is lower than Por2, - the authentication will be used for roles Res2, Por1, Por2 and so on till the highest role Sys2.
This mechanism works using a special application named Google Authenticator that generates code to access the system.
unipay.bin-db.directory
Added On: 02/24/12
Legacy Name: iapp.bin.ftp-folder
Group: Resources
Status: Active
Attributes:
Local or remote directory, from which BIN files are to be loaded.
When local directory is used, the value of the property must be an absolute path to the directory.
When remote directory is used, the value must be a remote directory path understood by the underlying FTP server.
unipay.bin-db.download-component
Added On: 08/08/14
Legacy Name:
Group: Resources
Status: Active
Attributes:
Default ( default )
Name of the component used to download BIN file from the provider's FTP. In some cases, custom component is required to accommodate specific behaviour or configuration of the remote FTP server.
By default, Camel component that connects to the FTP server, expects FTP server to have a root folder and a subfolder that will be used for file exchange. For those cases when FTP server is configured not to allow open those folders subsequently, a custom component is required.
Possible values:
- default - camel is used
- custom - custom UniPay logic is used
unipay.bin-db.host
Added On: 02/23/12
Legacy Name: iapp.bin.ftp-host
Group: Resources
Status: Active
Attributes:
When remote connectivity is required, FTP host location, from which BIN files should be loaded
unipay.bin-db.last-update-date
Added On: 02/22/12
Legacy Name: iapp.bin.last-update-date
Group: Resources
Status: Active
Attributes:
Date when credit card BINs were last imported from a Provider last time.
For internal use only.
unipay.bin-db.on-download-action
Added On: 08/08/14
Legacy Name:
Group: Resources
Status: Active
Attributes:
Default ( none )
Action that has to take place after BIN database is downloaded.
Possible values:
- none - no action will be taken
- delete - file that has been downloaded will be removed from the source FTP
unipay.bin-db.passphrase
Added On: 02/24/12
Legacy Name: unipay.bin-db.pass-phrase; iapp.bin.ftp-ssh_pass_phrase
Group: Resources
Status: Active
Attributes:
Encrypted
When remote connectivity is required (sFTP), pass phrase on the private key, used to authenticate with the FTP server, from which BIN files should be loaded.
unipay.bin-db.password
Added On: 02/24/12
Legacy Name: iapp.bin.ftp-password
Group: Resources
Status: Active
Attributes:
Encrypted
When remote connectivity is required (FTP and FTPs), password of the FTP server, from which BIN files should be loaded
unipay.bin-db.port
Added On: 02/23/12
Legacy Name: iapp.bin.ftp-port
Group: Resources
Status: Active
Attributes:
When remote connectivity is required, port for the FTP server, from which BIN files should be loaded.
unipay.bin-db.private-key
Added On: 02/24/12
Legacy Name: iapp.bin.ftp-ssh_private_key
Group: Resources
Status: Active
Attributes:
When remote connectivity is required (sFTP), private key used to authenticate with the FTP server, from which BIN files should be loaded.
The value of the property is the name of the file that contains the private key. The file must be located in unipay.resources-home/ssh
unipay.bin-db.type
Added On: 02/23/12
Legacy Name: iapp.bin.ftp-type
Group: Resources
Status: Active
Attributes:
Default ( file )
Type of connectivity required to load files into BIN database.
Possible values:
- file - BIN file is loaded from a local folder
- ftp - BIN file is loaded from a remote location over FTP protocol
- ftps - BIN file is loaded from a remote location over FTPs protocol
- sftp - BIN file is loaded from a remote location over sFTP protocol
unipay.bin-db.username
Added On: 02/24/12
Legacy Name: iapp.bin.ftp-username
Group: Resources
Status: Active
Attributes:
When remote connectivity is required, username of the FTP server, from which BIN files should be loaded
unipay.business.monthly-statement-day
Added On: 10/09/19
Legacy Name:
Group:
Status: Active
Attributes:
Default ( 1 )
Indicates the calendar day, when Monthly Statement report for the previous month will be generated and sent to a merchant.
Default value: 1.
unipay.business.net-funding-fee-day
Added On: 04/28/23
Legacy Name:
Group: General
Status: Active
Attributes:
unipay.business.payment-method-international
Added On: 12/11/23
Legacy Name:
Group: Remittance
Status: Active
Attributes:
Value that determines whether the ‘International Fees' category will be displayed on the UI. The presence of a value in this property results in the display of an additional panel on the Fees form, featuring buttons to toggle between different Fees categories. This value also controls the naming of the button corresponding to this category.
unipay.business.payment-method-local
Added On: 12/11/23
Legacy Name:
Group: Remittance
Status: Active
Attributes:
Value indicates the label for the 'Local Fees' category button on the UI, which is applicable only if an additional panel is to be displayed. The presence of this panel relies on whether there are values in two specific properties: unipay.remittance.payment-method-regional and unipay.remittance.payment-method-international.
unipay.business.payment-method-regional
Added On: 12/11/23
Legacy Name:
Group: Remittance
Status: Active
Attributes:
Value that determines whether the 'Regional Fees' category will be displayed on the UI. The presence of a value in this property results in the display of an additional panel on the Fees form, featuring buttons to toggle between different Fees categories. This value also controls the naming of the button corresponding to this category.
unipay.business.reconciliation-cutoff
Added On: 04/22/15
Legacy Name:
Group: Remittance
Status: Active
Attributes:
Time when the deposit statement is generated.
If the specified parameter is not set, the deposit statement is generated immediately after the creation of financial statistics.
unipay.business.reseller-statement-day-list
Added On: 10/22/12
Legacy Name:
Group: Remittance
Status: Active
Attributes:
The list of days (of a month) when reseller statements should be generated. Multiple days (possible values: 1 - 28) can be specified using comma as delimiter, e.g. 5,15.
unipay.cloud-code
Added On: 03/05/18
Legacy Name:
Group: System
Status: Active
Attributes:
Identifier of a gateway instance in the global UniPay Gateway Cloud. Used in UniPay-to-UniPay integrations as a prefix that is added to the satellite ID of the object during the request processing on base-unipay server. This prefix is used to differenciate between satellite and base servers' ID.
unipay.contacts.financial-services.email
Added On: 05/01/12
Legacy Name:
Group: Services
Status: Active
Attributes:
Email of the financial services department. The value is used in letters and emails that are sent on behalf of the department or mention this department's contact information.
Financial services department is the department responsible for the flow of transactions as well as remittances and reconciliations.
unipay.contacts.financial-services.name
Added On: 05/01/12
Legacy Name:
Group: Services
Status: Active
Attributes:
Official name of the financial services department. The value is used in letters and emails that are sent on behalf of the department or mention this department's contact information.
Financial services department is the department responsible for the flow of transactions as well as remittances and reconciliations.
unipay.contacts.tech-support.email
Added On: 05/01/12
Legacy Name:
Group: Services
Status: Active
Attributes:
Email of the tech support department. The value is used in letters and emails that are sent on behalf of the department or mention this department's contact information.
Tech support department is the department responsible for the system maintenance, user account setup and system integration certifications.
unipay.contacts.tech-support.name
Added On: 05/01/12
Legacy Name:
Group: Services
Status: Active
Attributes:
Official name of the tech support department. The value is used in letters and emails that are sent on behalf of the department or mention this department's contact information.
Tech support department is the department responsible for the system maintenance, user account setup and system integration certifications.
unipay.data-encryption.bdk
Added On: 06/05/14
Legacy Name:
Group: Resources
Status: Active
Attributes:
Default base derivation key to be used to decrypt track data when encrypted MSRs are used.
unipay.data-encryption.bdk-storage-type
Added On: 06/05/14
Legacy Name:
Group: Resources
Status: Active
Attributes:
Type of storage for the encryption key.
Possible values:
- encrypted – base derivation key is stored in unipay.data-encryption.bdk (see unipay.data-encryption.bdk) with using encryption
- tokenized – base derivation is stored with tokenization provider and this property contains the token that corresponds that key
unipay.features.terminal-last-activity-date-update-enabled
Added On: 12/05/18
Legacy Name:
Group: Services
Status: Active
Attributes:
Default ( true )
Indicates whether information about a last activity date and an operation submitted via TMS API for a terminal is updated.
unipay.headers.access-control-allow-origin
Added On: 07/05/20
Legacy Name:
Group: Resources
Status: Active
Attributes:
Default ( null )
Indicates whether Access-Control-Allow-Origin HTTP header is returned in proxynization API response and defines how the HPP resources are uploaded while processing proxynization API calls for HPP.
Possible values:
- null - Access-Control-Allow-Origin HTTP header is not generated
- [*] - start symbol is returned in Access-Control-Allow-Origin HTTP header, which means that HPP resources upload and processing is allowed from any third-party domain
- [domain] - a name of a specific domain is set in property and returned in Access-Control-Allow-Origin HTTP header, which means that HPP resources upload and processing is allowed only from the specified domain
unipay.hsm.host
Added On: 03/05/18
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
IP address of HSM (hardware security module) device used for tokenization.
unipay.keys.bdk
Added On: 05/11/22
Legacy Name: unipay.keys.bdk
Group: Defaults
Status: Active
Attributes:
Derivation key used to derive IPEKs (during injection process) for terminals beloning to the merchants of the Portfolio.
unipay.keys.bdk
Added On: 05/11/22
Legacy Name: unipay.keys.bdk
Group: Defaults
Status: Active
Attributes:
unipay.keys.tkek
Added On: 05/11/22
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Encryption key used to encrypt IPEKs (during injection process) for terminals belonging to the merchants of the Portfolio.
unipay.keys.tkek
Added On: 05/11/22
Legacy Name:
Group: Defaults
Status: Active
Attributes:
unipay.log-archive.host
Added On: 03/06/17
Legacy Name:
Group: System
Status: Active
Attributes:
Required
Host (URL) used to load logs from the log archive (ElasticSearch) via API. For example, https://elk-es.unitedthinkers.com
unipay.log-archive.password
Added On: 03/06/17
Legacy Name:
Group: System
Status: Active
Attributes:
Encrypted
Password used to access the log archive (ElasticSearch) via API.
unipay.log-archive.username
Added On: 03/06/17
Legacy Name:
Group: System
Status: Active
Attributes:
User name used to access the log archive (ElasticSearch) via API.
unipay.logging.log-level
Added On: 03/02/12
Legacy Name: iapp.properties:debugLog
Group: System
Status: Active
Attributes:
Default ( info )
Controls the level of logging used within the application.
Possible values:
- info - minimal information about system's execution
- debug - everything included in 'info' level plus execution times for internal processes
unipay.logging.realtime-merchant-list
Added On: 01/31/14
Legacy Name:
Group: System
Status: Active
Attributes:
The list of merchant codes for which debug logging is enabled.
unipay.logging.realtime-sensitive-data-included
Added On: 02/05/14
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( false )
Indicates whether sensitive information as passwords or credit card numbers are included in the realtime merchant log.
Please note that this option can only be used when a current user is watching the process and will destroy the log immediately after it is generated and reviewed.
unipay.mailer.admins-list
Added On: 02/21/12
Legacy Name: iapp.email.to
Group: Notifications
Status: Active
Attributes:
Default ( monitoring@unitedthinkers.com )
Semicolon (;) separated list of emails that receive all system level notifications addressed to system admins. Among emails sent to the people on this list are system errors and exceptions that occur within the system.
unipay.mailer.auditors-list
Added On: 03/02/18
Legacy Name:
Group: Notifications
Status: Active
Attributes:
A list of the auditors' emails that receive daily system audit notifications.
unipay.mailer.connection-mode
Added On: 11/05/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Default ( primary )
Identifies connection settings to be used by a mailer.
Possible values:
- PRIMARY – settings from primary connection
- BACKUP – settings from backup connection
unipay.mailer.from
Added On: 02/21/12
Legacy Name: iapp.email.from
Group: Notifications
Status: Active
Attributes:
Email address to use in 'From' field by internal mailer service to send out system notifications (errors, new user accounts, etc)
unipay.mailer.from-emergency
Added On: 12/08/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Default ( emergency@unitedthinkers.com )
Email address to use in 'From' field by internal mailer service to send out system notifications (errors, new user accounts, etc) in case of emergency.
unipay.mailer.host
Added On: 02/21/12
Legacy Name: iapp.email.server-host
Group: Notifications
Status: Active
Attributes:
Name of HTTP or SMTP host to be used my internal mailer service to send out system notifications (errors, new user accounts, etc)
unipay.mailer.host-backup
Added On: 10/31/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Alternative value of name of HTTP or SMTP host to be used by internal mailer service to send out system notifications (errors, new user accounts, etc) in case of main mailer failure.
unipay.mailer.managers-list
Added On: 02/16/18
Legacy Name:
Group: Notifications
Status: Active
Attributes:
List of emails that receive notifications about various application modules processes (pending statements, deposit returns etc).
unipay.mailer.password
Added On: 02/21/12
Legacy Name: iapp.email.password
Group: Notifications
Status: Active
Attributes:
Encrypted
Password for HTTP or SMTP connection to be used my internal mailer service to send out system notifications (errors, new user accounts, etc)
unipay.mailer.password-backup
Added On: 10/31/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Alternative value of password for HTTP or SMTP connection to be used by internal mailer service to send out system notifications (errors, new user accounts, etc) in case of main mailer failure.
unipay.mailer.port
Added On: 02/21/12
Legacy Name: iapp.email.server-port
Group: Notifications
Status: Active
Attributes:
Port for HTTP or SMTP connection to be used my internal mailer service to send out system notifications (errors, new user accounts, etc)
unipay.mailer.port-backup
Added On: 10/31/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Alternative value of port for HTTP or SMTP connection to be used by internal mailer service to send out system notifications (errors, new user accounts, etc) in case of main mailer failure.
unipay.mailer.terminal-managers-list
Added On: 02/16/18
Legacy Name:
Group: Notifications
Status: Active
Attributes:
List of emails that receive notifications about terminal order processing on a processor's side.
unipay.mailer.type
Added On: 02/21/12
Legacy Name: iapp.email.protocol
Group: Notifications
Status: Active
Attributes:
Default ( smtps )
Type (protocol) of the connection to be used my internal mailer service to send out system notifications (errors, new user accounts, etc).
Possible values:
- smtp - for standard SMTP configuration
- smtps - for secure smtp
- http - for web service based email submission
- https - for secure web service based email submission
Currently supported http/https based email service is JangoMail.
unipay.mailer.type-backup
Added On: 10/31/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Alternative value of type (protocol) of the connection to be used my internal mailer service to send out system notifications (errors, new user accounts, etc) in case of main mailer failure.
Currently supported http/https based email service is JangoMail.
unipay.mailer.username
Added On: 02/21/12
Legacy Name: iapp.email.username
Group: Notifications
Status: Active
Attributes:
User name for HTTP or SMTP connection to be used my internal mailer service to send out system notifications (errors, new user accounts, etc)
unipay.mailer.username-backup
Added On: 10/31/14
Legacy Name:
Group: Notifications
Status: Active
Attributes:
Alternative value of user name for HTTP or SMTP connection to be used by internal mailer service to send out system notifications (errors, new user accounts, etc) in case of main mailer failure.
unipay.onboarding.application-expiration-period
Added On: 04/24/19
Legacy Name:
Group:
Status: Active
Attributes:
Default ( 30 )
A period of time (in days) during which the onboarding application may remain in Hold Status before being submitted. Once this period expired, the application is canceled if not submitted for processing.
unipay.onboarding.fee-processor-template
Added On: 09/08/23
Legacy Name: Fee Processor Template
Group: Defaults
Status: Active
Attributes:
ID of an approved Onboarding Application that will be used as a template for the automatic creation of a Fee Processor (can be defined on the Reseller/Portfolio/System level)
unipay.owner-name
Added On: 03/02/12
Legacy Name: iapp.properties:owner.name
Group: General
Status: Active
Attributes:
Required Default ( United Thinkers )
Official name of the company that owns the application instance, and on behalf of which all actions on the server are taken. The value is used to sign outgoing correspondence (emails) and for general application re-branding.
unipay.profile-name
Added On: 02/21/12
Legacy Name: iapp.application.server-name
Group: General
Status: Active
Attributes:
Required
Name of the deployment profile used on this server. Profile is a group of settings and configurations necessary for application execution.
The name of the profile must be comprised of 2 parts separated with a dash (-):
- name - name of this specific deployment configuration;
- type - type of the deployment configuration.
Possible types:
- prod - production server
- test - staging server or QA server
- dev - developer' workstation or development server
Examples:
myserver-prod, myserver-test
unipay.profile-type
Added On: 03/02/12
Legacy Name: iapp.properties:server.type
Group: General
Status: Active
Attributes:
Required Default ( prod )
Type of the deployment profile used on this server. The value is used to identify the purpose of the server (certain processing logic might be handled differently depending on whether the server is in prod or test/dev mode).
Possible values:
- prod - production server
- test - staging server or QA server
- dev - developer workstation or development server
unipay.qa.system-time-offset
Added On: 02/15/18
Legacy Name:
Group: System
Status: Active
Attributes:
Sets a number of hours that are going to be added or subtracted from the current server time when using the emulation mode.
The default value is "0" (the current server time is used). To add a certain number of hours, a positive value should be indicated; to subtract a certain number of hours, a negative value should be indicated.
unipay.resources-home
Added On: 02/21/12
Legacy Name:
Group: Resources
Status: Active
Attributes:
Required Default ( /home/jenkins/unipay/resources )
Absolute path (or relative to unipay:app-home) to the resources directory that is to be used by the application.
Resources directory contains ssh and pgp keys as well as other artifacts needed by the application.
unipay.routing-number-db.host
Added On: 02/22/12
Legacy Name: iapp.routing-number.url
Group: Resources
Status: Active
Attributes:
Host (URL) to load routing numbers from the internal routing number database. For example, https://download.unitedthinkers.com/EPaymentsDirectory.
unipay.routing-number-db.last-update-date
Added On: 02/21/12
Legacy Name: iapp.last-routing_number-update-date
Group: Resources
Status: Active
Attributes:
Date when routing numbers were last imported from the federal reserve's database.
For internal use only.
unipay.routing-number-db.password
Added On: 03/14/16
Legacy Name:
Group: Resources
Status: Active
Attributes:
Required Encrypted
Password for Basic Auth authorization on the server. Used to update routing number information.
unipay.routing-number-db.username
Added On: 03/14/16
Legacy Name:
Group: Resources
Status: Active
Attributes:
Required
User name for Basic Auth authorization on the server. Used to update routing number information.
unipay.system.absolute-style-path-allowed
Added On: 08/01/17
Legacy Name:
Group: General
Status: Active
Attributes:
Default ( 1 )
Indicates whether an absolute path, providing access to the CSS file associated with an HPP page, is allowed to be submitted via styleURL API field.
unipay.system.authentication-period-password-reset
Added On: 12/06/23
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( 30 )
The maximum period of time when the reset password link is active. The allowed range of values is from 0 to 30 minutes.
unipay.system.cache-type
Added On: 12/08/14
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( Local )
Type of the system cache.
Possible values:
- Local - recommended when running in a standalone mode
- Infinispan - recommended for a cluster mode
unipay.system.curator-host
Added On: 04/16/14
Legacy Name:
Group: System
Status: Active
Attributes:
Host (URL) and port to access the curator, which is a centralized service for providing distributed synchronization.
unipay.system.debug-enabled
Added On: 02/21/12
Legacy Name: debug-on
Group: System
Status: Active
Attributes:
Default ( true )
Indicates whether debug mode is turned on. When set to true, the application will generate additional debug information that can be used to diagnose problems. debug mode is not recommended for production environments.
unipay.system.deployment-practice-data
Added On: 10/02/18
Legacy Name:
Group: QA
Status: Active
Attributes:
unipay.system.encryption-allowed
Added On: 03/16/12
Legacy Name: account-number.encryption_allowed
Group: System
Status: Active
Attributes:
Default ( true )
Controls whether internal encryption mechanism is allowed to be used for the credit card storage.
Setting the value to false will result in an error while attempting to save a credit card number or a bank account number under a Merchant record, which has no tokenization settings specified.
Disabling encryption is only recommended when usage of tokenization must be enforced on all Merchants maintained within the system. It is not recommended to disable encryption in development environment.
unipay.system.free-email-service-list
Added On: 04/11/23
Legacy Name:
Group: System
Status: Active
Attributes:
List of free public email service domains, that are prohibited for being used in the part of the System where a business email is required. Use semicolon as a separator.
For example: @gmail.com; @hotmail.com; @yahoo.com.
unipay.system.gzip-enabled
Added On: 02/21/12
Legacy Name: atlas.gzip-on
Group: System
Status: Active
Attributes:
Default ( true )
Controls whether compression is used when data streams are handled by the application.
Enabling stream compression reduces the load on RAM, but increases processing time. The property is false by default and should only be enabled when the amount of RAM on the application server is not sufficient to handle character or binary streams (interchange files) that the application has to handle.
unipay.system.help-service-host
Added On: 01/12/16
Legacy Name:
Group: System
Status: Active
Attributes:
Host (URL) to access documentation via API. For example, https://unidoc.unitedthinkers.com.
unipay.system.hpp-framing-allowed
Added On: 05/14/19
Legacy Name:
Group: General
Status: Active
Attributes:
Required Default ( false )
Indicates whether a HPP can be opened in a frame.
Possible values:
- true - allows to load a page in the frame;
- false - does not allow to load a page in the frame if the source doesn't match the UniPay domain (header x-frame-options:SAMEORIGIN is added to the request).
unipay.system.human-user-notification-expiration-period
Added On: 08/23/16
Legacy Name:
Group: System
Status: Active
Attributes:
Time period (in days) before the expiration date, during which human user receives notifications about password expiration. It is required to change the current account's password within this time period.
unipay.system.human-user-password-expiration-period
Added On: 04/13/12
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( 90 )
Time period (in days) after the date when a human user's password has been changed, during which the password remains valid. After the time period ends, the user is required to change the current account's password.
unipay.system.jms-broker-host
Added On: 02/25/12
Legacy Name: iapp.jms_broker.url
Group: System
Status: Active
Attributes:
Host (URL) to communicate with JMS broker (ActiveMQ) responsible for orchestration of the internal services.
unipay.system.jms-console-protocol
Added On: 02/10/16
Legacy Name:
Group: System
Status: Active
Attributes:
Protocol to be used for console broker host.
Possible values:
unipay.system.max-records-limit
Added On: 08/29/19
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( 5000 )
Maximum number of values that will be returned in response to a Reporting API request.
unipay.system.merchant-auth-mode
Added On: 03/06/12
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( code )
Mode of authentication that is to be used when a connection is attempted using API on behalf of a merchant.
Possible values:
- code - Merchant Code is used as the user name
- refCode - Merchant's Reference Code is used as the user name
In some instances, it might be easier for an integrator to use some value other than Merchant Code to authenticate into the system. For such cases, this value can be saved into the Reference Code field of the Merchant object and refCode authentication mode can be used instead of the default mode.
unipay.system.merchant-deactivation-grace-period
Added On: 06/18/24
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Time period in days during which an inactive merchant is still treated as conditionally active for certain processes like returns and chargebacks.
unipay.system.merchant-selection-enabled
Added On: 03/02/12
Legacy Name: iapp.properties:canChangeMerchant
Group: System
Status: Active
Attributes:
Default ( true )
Indicates whether combobox for Merchant selection located on top of the screen is enabled. When set to false, users will be unable to change active merchant (even if multiple merchants are defined in the application) and will be limited in access to the default merchant assigned to them.
This setting is only useful on servers configured for use by a single multi-account merchant.
unipay.system.module-key
Added On: 03/02/12
Legacy Name: application.modules
Group: System
Status: Active
Attributes:
Required Default ( A )
A configuration key consisting of 1-7 letters, indicating which modules of the UniPay suite are deployed to the server. You should set on the user interface the values corresponding to the specified property values. The letters comprising the key can be used in any order. The absence of a letter in the property indicates the absence of the corresponding module.
Possible values:
- A - UniCharge
- B - UniBill
- P - UniBill Customer Portal
- I - API
- D - Detokenization
- H - UniCharge-proxy
- E - UniRead (Cloud)
- L - Console
- Q - QA_UTILS
The value in the file controls application assembly process. You can verify whether all modules are installed with the checkModules pingdom check.
In case there are letters in the settings on the user interface identifying the module which
was not installed, pingdom check will result in the following error: MODULE_PROBLEM.
unipay.system.next-merchant-id
Added On: 10/10/18
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( true )
Contains the ID that is going to be used for the next merchant created/onboarded within the system. When the merchant is being onboarded, the system automatically derives the ID value from the property and assigns it to the merchant, adding 1 to the ID (for example, the next reserved ID is 2001. When a merchant is created, it's ID is 2002). In case when the merchant's creation has not been completed, the reserved value is not used for merchant creation/onboarding anymore.
unipay.system.node-codes
Added On: 02/08/18
Legacy Name:
Group: Services
Status: Active
Attributes:
Code(s) of the UniPay node(s) that are going to be monitored by the JavaMelody service.
The following rules must be followed while setting the property:
- Batch node codes must be listed first;
- Real-time node codes must be listed second;
- Batch and real-time node codes must be separated by a semicolon sign (;). On the user interface, batch and real-time nodes are already separated by being indicated in the different textboxes. For this reason, there is no need to use a semicolon sign for separation;
- Node codes within a group (batch or real-time) must be separated by a comma sign (,);
- Code(s) of the master node(s) must be followed by an asterisk sign (*), otherwise, the first node in the list is identified as a master node.
For example: unipay.system.node-codes=1,2*,3;1,4,5, where
- 1 is both batch and real-time backup node;
- 2 is a batch master node;
- 3 is a batch backup node;
- 4 and 5 are real-time backup nodes.
To apply changes in the node codes, you must restart Camel via the Job Object form on the System perspective.
unipay.system.optional-fields-validation-mode
Added On: 02/01/18
Legacy Name:
Group: General
Status: Active
Attributes:
Default ( Cleanup )
Type of the field validation that is applied to optional fields (zipCode, street1, street2, state, countryCode, transactionCode, customerAccountCode) in the submitted request.
Possible values:
- Validate - if an invalid field value is submitted, the HPP request fails and validation error is shown on the screen. Used by default.
- Cleanup - if an invalid field value is submitted, the HPP request is processed but invalid symbols in the values are cleaned up (replaced with gaps).
unipay.system.payment-method-policy
Added On: 12/07/23
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( VMXDN---A----S )
List of payment methods enabled on Gateway`s user interface.
Possible values:
- Visa - V
- MasterCard - M
- AmEx – X
- Discover - D
- Diners - N
- Gift Card - G
- Fleet Card - F
- Bank Card - B
- Bank Accounts - A
- UnionPay - U
- PayPal - P
- ApplePay - L
- GooglePay - O
- MADA - S
unipay.system.purging_disabled
Added On: 07/08/19
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( false )
Defines how purging data from the database is carried out.
Possible values:
- true - purging process stops once the current iteration is complete;
- false - purging process continues automatically after the end of the iteration.
unipay.system.raw-account-data-mode
Added On: 12/05/18
Legacy Name:
Group: System
Status: Active
Attributes:
Required Default ( TT )
Indicates whether only tokenized or both tokenized and non-tokenized bank account numbers are allowed for processing.
The values can be the following:
TT - only tokenized bank account numbers are allowed for processing via the gateway.
TR - both tokenized and non-tokenized bank account numbers are allowed for processing via the gateway.
unipay.system.reporting-service-host
Added On: 04/12/14
Legacy Name:
Group: System
Status: Active
Attributes:
Host (URL) to access report generation service. For example, https://portal.unipay.com/reports/ReportBuilder.
unipay.system.security-image-enabled
Added On: 04/07/15
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( true )
Indicates whether the security image mechanism is enabled in the system.
unipay.system.service-user-notification-expiration-period
Added On: 08/23/16
Legacy Name:
Group: System
Status: Active
Attributes:
Time period (in days) before the expiration date, during which service user receives notifications about password expiration. It is required to change the current account's password within this time period.
unipay.system.service-user-password-expiration-period
Added On: 08/23/16
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( 90 )
Time period (in days) after the date when a service user's password has been changed, during which the password remains valid. After the time period ends, user's account gets blocked.
unipay.system.sql-batch-size
Added On: 02/21/12
Legacy Name: iapp.sql.batch-size
Group: System
Status: Active
Attributes:
Required Default ( 1000 )
Maximum batch size to be used on SQL batch inserts.
The larger the batch size, the more data rows will get sent to the server in a single batch. Very large batch sizes may cause performance issues and transaction deadlocks.
Batch inserts are used in business logic that handles large groups of records.
unipay.system.sql-in-statement-limit
Added On: 02/22/12
Legacy Name: iapp.query.in-statement
Group: System
Status: Active
Attributes:
Default ( 1000 )
Maximum number of values that be in included within SQL IN statement.
For example:
SELECT * FROM customer_account WHERE Id IN (2992, 3346, 8765, 9983)
The parameters affects a small number of SQL statements used in batch processing business logic. The larger the number, the more values can be processed in a single SQL statement, but he heavier the actual statement becomes.
unipay.system.sql-version
Added On: 06/23/14
Legacy Name:
Group: System
Status: Active
Attributes:
Shows the version of SQL used in the application.
unipay.system.temporary-password-expiration-period-hpp
Added On: 01/11/20
Legacy Name: temporary-password-expiration-period-hpp
Group: System
Status: Active
Attributes:
Default ( 15 )
The maximum period of time when the HPP temporary password is being active. The allowed range of values is from 0 to 30 minutes.
unipay.system.temporary-password-expiration-period-onboarding
Added On: 01/11/20
Legacy Name: temporary-password-expiration-period-onboarding
Group: System
Status: Active
Attributes:
Default ( 20 )
The maximum period of time when the onboarding temporary password is being active. The allowed range of values is from 0 to 45 minutes.
unipay.system.temporary-password-expiration-period-processing
Added On: 01/11/20
Legacy Name: iapp.temporary-password-expiration-period-processing
Group: System
Status: Active
Attributes:
Default ( 10 )
The maximum period of time when the processing API temporary password is being active. The allowed range of values is from 0 to 15 minutes.
unipay.system.terminal-authentification-expiration-period
Added On: 01/06/23
Legacy Name:
Group: System
Status: Active
Attributes:
Required Default ( 15 )
Value specifies the expiration period of the terminal activation code (in minutes).
unipay.system.terminal-failed-authentication-limit
Added On: 01/06/23
Legacy Name:
Group: System
Status: Active
Attributes:
Required Default ( 5 )
Value specifies the maximum number of attempts to activate the terminal (via sms).
unipay.system.truststore-password
Added On: 03/15/12
Legacy Name:
Group: System
Status: Active
Attributes:
Required Encrypted
Password on the keystore with trusted SSL certificates. The file is called unipay.truststore and is located in resources directory.
unipay.system.user-failed-login-limit
Added On: 01/10/14
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( 5 )
The number of failed login attempts after which a user's account gets deactivated.
unipay.system.user-session-expiration-period
Added On: 05/28/24
Legacy Name:
Group: Unipay
Status: Active
Attributes:
Sets and regulates the duration of user sessions on the server.
unipay.system.user-truststore-password
Added On: 12/08/14
Legacy Name:
Group: System
Status: Active
Attributes:
Password for the TrustStore system (unipay.truststore).
unipay.system.userstore-password
Added On: 09/11/13
Legacy Name:
Group: System
Status: Active
Attributes:
Encrypted
Password on the keystore with client's certificates. The keystore file is called unipay.userststore and is located in resources directory.
unipay.system.verification-session-date
Added On: 02/15/18
Legacy Name:
Group: System
Status: Active
Attributes:
Date when the last verification session occurred on a production portal.
Additionally, the property allows to verify a proper execution of database update operation through MySQL WorkBench.
unipay.system.xss-validation-enabled
Added On: 03/02/12
Legacy Name: iapp.properties:xssValidation
Group: System
Status: Active
Attributes:
Default ( true )
Indicates whether XSS validation is turned on. When set to true, all content submissions will be scanned for XSS injections. Since validation introduces additional processing overhead, it can be disabled in development environments.
unipay.temp-last-legacy-statement-id
Added On: 08/12/20
Legacy Name:
Group: Remittance
Status: Active
Attributes:
Identifies the ID of the lastest merchant statement absent in Merchant Statement Extended database table (calculated automatically).
The property value defines which version of the PDF Statement is returned when the merchant-statement API call is submitted:
- if the ID of the requested statement is equal or less than the property value, the old version of the report is generated;
- if the ID of the requested statement is greater than the property value, the new version of the report is generated.
unipay.temp.api-username-enabled
Added On: 05/03/18
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( false )
Temporary flag controlling whether usernames of service users must be preceded by api- or tms- prefix to access terminal API.
Possible values:
- true - only users with usernames preceded by either api- or tms- prefix can be authorized
- false - all users with valid usernames can be authorized
unipay.temp.default-settlement-status
Added On: 10/24/19
Legacy Name:
Group: Defaults
Status: Active
Attributes:
Default ( settled )
Defines which types of transactions are included in the Transaction List report.
Possible values:
- settled – only settled transactions are generated in the report (default).
- unsettled – only unsettled transactions are generated in the report.
- all – both settled and unsettled transactions are generated in the report.
unipay.temp.httpform-url-enabled
Added On: 08/12/20
Legacy Name:
Group: Remittance
Status: Active
Attributes:
Identifies the ID of the lastest merchant statement absent in Merchant Statement Extended database table (calculated automatically).
The property value defines which version of the PDF Statement is returned when the merchant-statement API call is submitted:
- if the ID of the requested statement is equal or less than the property value, the old version of the report is generated;
- if the ID of the requested statement is greater than the property value, the new version of the report is generated.
unipay.temp.remittance-type
Added On: 10/25/23
Legacy Name:
Group: System
Status: Active
Attributes:
Default ( Old )
Defines the primary type of remittance used on the server.
Possible values:
- If the value 'Old' is specified, new merchants will operate under the old remittance system. In the New Merchant (Extended) forms and the Onboarding Application Wizard, the Remittance Type field will automatically be set to 'Old' as the default option. Additionally, in the Pricing Policy field, only old templates will be available for selection.
- If the value 'New' is specified, new merchants will operate under the new remittance system. Similarly, this selection affects the New Merchant (Extended) forms and the Onboarding Application Wizard, where 'New' will appear as the default value in the Remittance Type field, and only new templates will be displayed in the Pricing Policy field.
- If no remittance type is specified, the system defaults to the new remittance for new merchants. In this scenario, the Remittance Type field will be omitted from both the New Merchant (Extended) forms and the Onboarding Application Wizard.
unipay.tokenization.domain-id
Added On: 02/21/12
Legacy Name: iapp.tokenization.did
Group: Tokenization
Status: Active
Attributes:
Domain ID (or other supplemental identifier, such as merchant id) to be used with external tokenization service, which is used by internal tokenization mechanism. Usually, domain id services as an additional identifier on top of user name and password pair.
unipay.tokenization.host
Added On: 02/21/12
Legacy Name: iapp.tokenization.host
Group: Tokenization
Status: Active
Attributes:
Host (URL) name of an external tokenization service that is to be used by internal tokenization service. For example, https://tokenization.service.com:8181.
unipay.tokenization.password
Added On: 02/21/12
Legacy Name: iapp.tokenization.password
Group: Tokenization
Status: Active
Attributes:
Encrypted
Password for authentication with an external tokenization service, which is used by internal tokenization mechanism.
unipay.tokenization.type
Added On: 02/21/12
Legacy Name: iapp.tokenization.type
Group: Tokenization
Status: Active
Attributes:
Default ( strongauth )
Type of tokenization mechanism to be used by internal tokenization service.
Possible values:
- default - encryption based, not available on servers with encryption disabled
- strongauth - StrongAuth appliance based tokenization
unipay.tokenization.username
Added On: 02/21/12
Legacy Name: iapp.tokenization.username
Group: Tokenization
Status: Active
Attributes:
User name for authentication with an external tokenization service, which is used by internal tokenization mechanism.
unipay.unibroker.batch.directory
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Local or remote directory, used to exchange files between UniBroker and UniPay instances to handle batch requests.
When local directory is used, the value of the property must be an absolute path to the directory.
When remote directory is used, the value must be a remote directory path understood by the underlying FTP server.
unipay.unibroker.batch.host
Added On: 07/18/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
When remote connectivity is required (sFTP), host (url) of the UniBroker instance used by the running instance of the UniPay server to handle batch requests.
unipay.unibroker.batch.passphrase
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Encrypted
When remote connectivity is required (sFTP), passphrase of the private key used to authenticate with the FTP server, which is used to exchange files with UniBroker instance.
unipay.unibroker.batch.password
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Encrypted
Password for the connection to the UniBroker instance used by the running instance of the UniPay server to handle batch requests.
unipay.unibroker.batch.port
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Port of the UniBroker instance used by the running instance of the UniPay server to handle batch requests.
unipay.unibroker.batch.private-key
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
When remote connectivity is required (sFTP), private key used to authenticate with the FTP server, which is used to exchange files with UniBroker instance.
The value of the property is the name of the file that contains the private key. The file must be located in unipay.resources-home/ssh
unipay.unibroker.batch.type
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Type of connectivity to use to exchange files with UniBroker instance to handle batch requests.
When value is set, UniBroker will be used to filter all batch incoming and outgoing traffic of the application.
Possible values:
- file - files are exchanged through a local directory or a mapped remote directory in the same network
- sftp - files are exchanged through sFTP connection using SSH key
unipay.unibroker.batch.username
Added On: 07/19/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
User name for the connection to the UniBroker instance used by the running instance of the UniPay server to handle batch requests.
unipay.unibroker.node-codes
Added On: 02/08/18
Legacy Name:
Group: Services
Status: Active
Attributes:
Code(s) of the UniBroker node(s) that are going to be monitored by the JavaMelody service.
The following rules must be followed while setting the property:
- Batch node codes must be listed first;
- Real-time node codes must be listed second;
- Batch and real-time node codes must be separated by a semicolon sign (;). On the user interface, batch and real-time nodes are already separated by being indicated in the different textboxes. For this reason, there is no need to use a semicolon sign for separation;
- Node codes within a group (batch or real-time) must be separated by a comma sign (,);
- Code(s) of the master node(s) must be followed by an asterisk sign (*), otherwise, the first node in the list is identified as a master node.
For example: unipay.system.node-codes=1,2*,3;1,4,5, where
- 1 is both batch and real-time backup node;
- 2 is a batch master node;
- 3 is a batch backup node;
- 4 and 5 are real-time backup nodes.
To apply changes in the node codes, you must restart Camel via the Job Object form on the System perspective.
unipay.unibroker.passphrase
Added On: 07/24/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Encrypted
Passphrase on the private key used for PGP decryption of all messages coming from UniPay to UniBroker.
unipay.unibroker.private-key
Added On: 07/24/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Private key for PGP encryption used by UniPay to decrypt all incoming content from UniBroker.
The value of the property is the name of the file that contains the private key. The file must be located in unipay.resources-home/pgp.
Public and private keys used by UniPay to UniBroker communication process must belong to different key pairs.
unipay.unibroker.public-key
Added On: 07/24/12
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Public key for PGP encryption used by UniPay to encrypt all outgoing content to UniBroker.
The value of the property is the name of the file that contains the public key. The file must be located in unipay.resources-home/pgp.
Public and private keys used by UniPay to UniBroker communication process must belong to different key pairs.
unipay.unibroker.realtime.host
Added On: 02/22/12
Legacy Name: unipay.system.unibroker-host; iapp.proxy.url
Group: Unibroker
Status: Active
Attributes:
Host (URL) of the UniBroker instance used by the running instance of the UniPay server to handle real-time requests. For example, https://unibroker.unipay.com.
When value is set, UniBroker will be used to filter all real-time incoming and outgoing traffic of the application.
unipay.work-home
Added On: 02/21/12
Legacy Name: work_folder
Group: General
Status: Active
Attributes:
Required Default ( /home/jenkins/unipay/work )
Absolute path (or relative to unipay:app-home) of the temporary directory where work files are to be stored during the application processing.
| 