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 unibroker.properties:
Property Definitions for unibroker.properties:
unibroker.app-host
Added On: 04/06/12
Legacy Name: proxy.properties:url.proxyServer
Group: General
Status: Active
Attributes:
Required
Host (URL) to access UniBroker instance from public network. The value is used for communication between UniBroker and clients that require tokenization services.
The communication between such clients and UniBroker is done via Ajax JavaScript calls and the property's value is used to determine where to send the information.
unibroker.content.passphrase
Added On: 07/11/13
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Encrypted
When remote connectivity is required (sFTP), passphrase on the private key used to authenticate with UniBroker, from which files should be loaded to FTP Gates.
unibroker.content.private-key
Added On: 07/11/13
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Private key for PGP encryption used by UniBroker to decrypt temporary files produced during tokenization process of the request files from invault folder.
The value of the property is the name of the file that contains the private key. The file must be located in ${unibroker}/resources/pgp
Public and private keys used by UniBroker must belong to different key pairs
unibroker.content.public-key
Added On: 07/11/13
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Public key for PGP encryption used by UniBroker to encrypt temporary files produced during tokenization process of the request files from invault folder.
The value of the property is the name of the file that contains the public key. The file must be located in ${unibroker}/resources/pgp
Public and private keys used by UniBroker must belong to different key pairs
unibroker.curator-host
Added On: 02/13/15
Legacy Name:
Group: General
Status: Active
Attributes:
Host (URL) and port to access ZooKeeper, which is a centralized service for providing distributed synchronization.
To avoid repeating sasl autorization that is not used by UniBroker, it is needed to settle Dzookeeper.sasl.client property as false during the connection with ZooKeeper. This option is also can be used in Apache Curator processing.
unibroker.data-encryption.bdk
Added On: 02/13/15
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Encrypted Default ( encrypted with separator )
When storage type is encrypted, default base derivation key is to be used to decrypt track data, when encrypted - MSRs are used.
When storage type is tokenized, decryption key represents token within StrongAuth where base derivation key is to be used to decrypt track data, when encrypted - MSRs are used.
unibroker.data-encryption.bdk-storage-type
Added On: 02/13/15
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Type of storage for the encryption key. Two options possible are:
1. encrypted – base derivation key is stored in unibroker.data-encryption.bdk ( see unibroker.data-encryption.bdk) with using encryption (deprecated).
2. tokenized – base derivation is stored with tokenization provider and this property contains the token that corresponds that key.
unibroker.debug-enabled
Added On: 04/06/12
Legacy Name: proxy.properties:isDebug
Group: Debug
Status: Active
Attributes:
Default ( false )
Indicates whether debug mode is turned on for UniBroker. 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.
unibroker.debug-passphrase
Added On: 06/03/15
Legacy Name:
Group: Debug
Status: Active
Attributes:
Encrypted passphrase used by UniBroker for debug log. If field is empty, debug log isn't recorded.
unibroker.ftp.directory
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
Remote directory to be used by UniBroker to exchange files with UniPay (when remote communication over FTP is used).
unibroker.ftp.host
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
When remote communication with UniPay over FTP is required, FTP host location, from which files should be loaded by UniBroker.
unibroker.ftp.passphrase
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
Encrypted
When remote communication with UniPay over FTP is required, pass phrase on the private key, used to authenticate with the FTP server, from which files should be loaded by UniBroker.
unibroker.ftp.password
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
Encrypted
When remote communication with UniPay over FTP is required, password on the FTP server, from which files should be loaded by UniBroker.
unibroker.ftp.port
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
When remote communication with UniPay over FTP is required, port for the FTP server, from which files should be loaded by UniBroker.
unibroker.ftp.private-key
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
When remote communication with UniPay over FTP is required, private key used to authenticate with the FTP server, from which files should be loaded by UniBroker.
The value of the property is the name of the file that contains the private key. The file must be located in unibroker/resources/ssh
unibroker.ftp.type
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
When remote communication with UniPay over FTP is required, type of connectivity used by UniBroker to retrieve files for processing.
Supported values are:
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
unibroker.ftp.username
Added On: 01/03/13
Legacy Name:
Group: FTP
Status: Active
Attributes:
When remote communication with UniPay over FTP is required, user name on the FTP server, from which files should be loaded by UniBroker.
unibroker.home
Added On: 07/13/12
Legacy Name:
Group: General
Status: Active
Attributes:
Required
Absolute path to the directory where web server (Tomcat) hosting UniBroker instance 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).
unibroker.node-code
Added On: 07/06/15
Legacy Name:
Group: System
Status: Active
Attributes:
Variable that defines the code of UniBroker's node, that is used in clustered system. Its value varies from 1 to 9 and is assigned by the system on the OS level or during the launch of the server by the parameter:
-Dunibroker.app-host.code=X.
unibroker.passphrase
Added On: 07/19/12
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Encrypted
Passphrase on the private key used for PGP decryption of all messages coming from UniBroker to UniPay.
unibroker.private-key
Added On: 07/18/12
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Private key for PGP encryption used by UniBroker to decrypt all incoming content from UniPay.
The value of the property is the name of the file that contains the private key. The file must be located in unibroker.home/pgp
Public and private keys used by UniBroker must belong to different key pairs
unibroker.proxy-enabled
Added On: 12/19/13
Legacy Name:
Group: Debug
Status: Active
Attributes:
Default ( false )
Indicates whether proxy emulator for UniBroker is turned on.
Possible types:
- true - test card numbers are replaced with tokens that were already created on UniBroker, i.e. without connecting to a tokenization service
- false - test card numbers are replaced with tokens that are created in real-time using a particular tokenization service
Note: When working with proxy profiles with UniBroker enabled, unibroker.proxy-enabled must be set to true. For integration testing, the property must be set to false.
unibroker.public-key
Added On: 07/19/12
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Public key for PGP encryption used by UniBroker to encrypt all outgoing content to UniPay.
The value of the property is the name of the file that contains the public key. The file must be located in unibroker.home/pgp
Public and private keys used by UniBroker must belong to different key pairs
unibroker.resource.pgp
Added On: 02/13/15
Legacy Name:
Group: Resources
Status: Active
Attributes:
Absolute path to the folder that contains PGP keys.
unibroker.resource.ssh
Added On: 02/13/15
Legacy Name:
Group: Resources
Status: Active
Attributes:
Absolute path to the folder that contains SSH keys.
unibroker.resources-home
Added On: 02/13/15
Legacy Name:
Group: Resources
Status: Active
Attributes:
Absolute path (or relative to unibroker: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.
unibroker.root
Added On: 07/18/12
Legacy Name:
Group: General
Status: Active
Attributes:
Required
Absolute path to the directory that serves as a root directory for UniBroker file exchange with UniPay. The directory must have two sub-directories - inbox and outbox.
UniPay is expected to upload request files and download response files from respective sub-directories of the root.
The path must be defined using path style of the application server's operating system (e.g. using '\' on Windows and '/' on Linux).
unibroker.root.inbox
Added On: 02/13/15
Legacy Name:
Group: General
Status: Active
Attributes:
Relative (to the connection's root) location of the inbox folder on the server where files are to be placed by UniBroker for encryption/decryption operations.
unibroker.root.outbox
Added On: 02/13/15
Legacy Name:
Group: General
Status: Active
Attributes:
Relative (to the connection's root) location of the outbox folder on the server, from which results of encryption/decryption processes should be downloaded by UniBroker.
unibroker.system.authentication-operation-enabled
Added On: 12/05/18
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Default ( false )
Indicates whether service users are allowed to authenticate (submit API requests) through UniBroker using a one-time session password.
unibroker.system.get-method-enabled
Added On: 10/03/18
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Default ( false )
Controls whether GET method is allowed within UniBroker.
Possible values:
true - GET method allowed
false - only POST method is allowed.
When the property is set to false or not present in the system settings, the S36 exception will return as a response to the GET request.
unibroker.system.truststore-password
Added On: 11/19/13
Legacy Name:
Group: Keystore
Status: Active
Attributes:
Encrypted
Password for UniBroker Java truststore.
unibroker.tokenization.batch.host
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Host name of an external tokenization service that is to be used by UniBroker for batch operations.
unibroker.tokenization.batch.inbox
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Relative (to the connection's root) location of the inbox folder on the server where files are to be placed by UniBroker for encryption/decryption operations.
unibroker.tokenization.batch.outbox
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Relative (to the connection's root) location of the outbox folder on the server, from which results of encryption/decryption processes should be downloaded by UniBroker.
unibroker.tokenization.batch.passphrase
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Encrypted
Passphrase on the private key used for sFTP authentication with an external tokenization service that is to be used by UniBroker for batch operations.
unibroker.tokenization.batch.password
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Encrypted
Password of an external tokenization service that is to be used by UniBroker for batch operations (for sFTP connectivity).
unibroker.tokenization.batch.port
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Port of an external tokenization service that is to be used by UniBroker for batch operations.
unibroker.tokenization.batch.private-key
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Private key for sFTP authentication with an external tokenization service that is to be used by UniBroker for batch operations.
The value of the property is the name of the file that contains the private key. The file must be located in unibroker.home/ssh
unibroker.tokenization.batch.username
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
User name of an external tokenization service that is to be used by UniBroker for batch operations (for sFTP connectivity).
unibroker.tokenization.integrated
Added On: 05/24/17
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Default ( false )
Indicates whether tokenization settings are imported from merchant's/merchant account's {UniPay} profile or from unibroker.properties.
Possible types:
- true - tokenization settings are imported from merchant's/merchant account's {UniPay} profile
- false - tokenization settings are imported from unibroker.properties
Note: If the type is true, unibroker.tokenization.type is only applied to proxy values of the card numbers received from {UniBill}.
unibroker.tokenization.realtime.domain-id
Added On: 07/24/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Domain ID (or other supplemental identifier, such as merchant id) to be used with external tokenization service employed by UniBroker for tokenization. Usually, domain ID services as an additional identifier on top of user name and password pair.
unibroker.tokenization.realtime.host
Added On: 07/18/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Host name of an external tokenization service that is to be used by UniBroker for real-time operations.
unibroker.tokenization.realtime.merchant-id
Added On: 02/13/15
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Merchant ID (or other supplemental identifier, such as domain id) to be used with external tokenization service employed by UniBroker for tokenization. Usually, merchant ID services as an additional identifier on top of user name and password pair.
unibroker.tokenization.realtime.password
Added On: 07/24/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Encrypted
Password for authentication with an external tokenization service used by UniBroker
unibroker.tokenization.realtime.username
Added On: 07/24/12
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
User name for authentication with an external tokenization service to be used by UniBroker
unibroker.tokenization.type
Added On: 02/13/15
Legacy Name:
Group: Tokenization
Status: Active
Attributes:
Default ( strong-auth )
Type of tokenization used by UniBroker.
Supported values are:
- strong-auth
- trust-commerce
Note: If it is desirable for tokenization to be done depending on the settings of the billing profile associated with a particular merchant/merchant account, then unibroker.tokenization.type should not be specified within unibroker.properties file at all.
unibroker.unipay-host
Added On: 04/06/12
Legacy Name: proxy.properties:url.applicationServer
Group: General
Status: Active
Attributes:
Host (URL) to access UniPay server from either internal or external (public) network. The value is used for communication between UniPay and UniBroker.
unibroker.userstore-password
Added On: 02/13/15
Legacy Name:
Group: Keystore
Status: Active
Attributes:
Encrypted
Password to the appropriate storage with client's certificates.
The keystore file is called unibroker.userstore and is located in $unibroker/unibroker.userstore directory.
unibroker.work-home
Added On: 02/13/15
Legacy Name:
Group: General
Status: Active
Attributes:
Absolute path (or relative to unibroker:app-home) of the temporary directory where work files are to be stored during the application processing.
unipay.ftp-gates.directory
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
Local or remote directory, from which files are to be loaded by UniBroker.
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 Gates server.
unipay.ftp-gates.host
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required, FTP Gates host location, from which files should be loaded by UniBroker.
unipay.ftp-gates.passphrase
Added On: 07/11/13
Legacy Name:
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 Gates server, from which files should be loaded by UniBroker.
unipay.ftp-gates.password
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
Encrypted
When remote connectivity is required (FTP and FTPs), password on the FTP Gates server, from which files should be loaded by UniBroker.
unipay.ftp-gates.port
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required, port for the FTP Gates server, from which files should be loaded by UniBroker.
unipay.ftp-gates.primary-passphrase
Added On: 04/08/15
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Encrypted
Secret password phrase for the primary PGP private key.
unipay.ftp-gates.primary-private-key
Added On: 04/08/15
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Primary PGP private key used for decryption of batch files that were encrypted by primary PGP public key.
The file must be located in ${unibroker}/resources/pgp
unipay.ftp-gates.private-key
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required (sFTP), private key used to authenticate with the FTP Gates server, from which files should be loaded by UniBroker.
The value of the property is the name of the file that contains the private key. The file must be located in unibroker/resources/ssh.
unipay.ftp-gates.secondary-passphrase
Added On: 04/08/15
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Encrypted
Secret password phrase for the secondary PGP private key.
unipay.ftp-gates.secondary-private-key
Added On: 04/08/15
Legacy Name:
Group: Encryption/Decryption
Status: Active
Attributes:
Secondary PGP private key used for decryption of batch files that were encrypted by secondary PGP public key.
The file must be located in ${unibroker}/resources/pgp
unipay.ftp-gates.type
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
Type of connectivity used by UniBroker to retrieve files for processing from invault folder of FTP Gates.
Supported values are:
file - UniBroker loads files from a local folder
ftp - UniBroker loads files from a remote location over FTP protocol
ftps - UniBroker loads files from a remote location over FTPs protocol
sftp - UniBroker loads files from a remote location over sFTP protocol
unipay.ftp-gates.username
Added On: 07/11/13
Legacy Name:
Group: FTP Gates
Status: Active
Attributes:
When remote connectivity is required (FTP and FTPs), user name on the FTP Gates server, from which files should be loaded by UniBroker.
unipay.unibroker.account-data-caching-period
Added On: 09/27/17
Legacy Name:
Group: Unibroker
Status: Active
Attributes:
Default ( 240 )
Time period during which sensitive card and account data associated with a transaction is stored in UniBroker cache. The minimum value is 240 seconds.
unipay.userstore-password
Added On: 02/13/15
Legacy Name:
Group: Keystore
Status: Active
Attributes:
Encrypted
Password to the appropriate storage of internal certificates for transmitting authorization data.
The keystore file is called unipay.userstore and is located in $unibroker/unipay.userstore directory.
| 