Common
Common is a core module that is used to implement common config and utils across all modules.
Critical User Information
Critical user information (processing entity and username) is taken from the headers or JWT token when used to create a record, this is for security purposes to ensure data can not be falsely created, edited, approved or accessed.
Configuration
Reason Codes
The source file for defaults is called reason-codes.conf and can be overridden per module.
reason-codes = [
{
reasonCode = "AB01",
definition = "Clearing process aborted due to timeout.",
source = "ISO"
},
{
reasonCode = "AB02",
definition = "Clearing process aborted due to a fatal error.",
source = "ISO"
},
{
reasonCode = "AB03",
definition = "Settlement aborted due to timeout.",
source = "ISO"
}
]Currency Codes
The source file for defaults is called currency-codes.conf and can be overridden per module. These are used when inputting values for either searching or creating data in various modules. Only Alphabetic Code and Currency parameters need to be defined.
currency-codes = [
{
"AlphabeticCode": "AFN",
"Currency": "Afghani",
"Entity": "AFGHANISTAN",
"MinorUnit": "2",
"NumericCode": 971.0,
"WithdrawalDate": null
},
{
"AlphabeticCode": "EUR",
"Currency": "Euro",
"Entity": "\u00c5LAND ISLANDS",
"MinorUnit": "2",
"NumericCode": 978.0,
"WithdrawalDate": null
},
{
"AlphabeticCode": "ALL",
"Currency": "Lek",
"Entity": "ALBANIA",
"MinorUnit": "2",
"NumericCode": 8.0,
"WithdrawalDate": null
}
]Time Zones
The source file for defaults is called time-zones.conf and can be overridden per module. These are used when inputting values for either searching or creating data in various modules.
time-zones = ["Africa/Abidjan", "Etc/GMT+0", "UTC"]Country Codes
The source file for defaults is called country-codes.conf and can be overridden per module. These are used when inputting values for either searching or creating data in various modules.
country-codes = [
{
"name": "Australia",
"alpha-2": "AU",
"alpha-3": "AUS",
},
{
"name": "Austria",
"alpha-2": "AT",
"alpha-3": "AUT",
},
{
"name": "Azerbaijan",
"alpha-2": "AZ",
"alpha-3": "AZE",
}
]Date Formats
This is currently only applicable for ods, htm and processing-settings
The source file for defaults is called date-formats.conf and can be overridden per module. This is used to define how the date fields appear in the GUI. If you don’t provide any values, the dates will be the UK standard
processingEntity The processing entity for which these formats will be applied
dateInput This is how any date inputs will be formatted and displayed (e.g. MM/DD/YYYY)
datetimeInput This is how any date inputs will be formatted and displayed (e.g. MM/DD/YYYY HH:mm:ss)
Please note, for the following two properties, 'dd' is used to signify the date rather than 'DD' (e.g. dd/MM/YYYY would equate 15/01/2025)
dateDisplay This is how any dates (not inputs) will be displayed.
datetimeDisplay This is how any date time fields will be displayed. This will also be the basis of how date time fields are formatted when payments are exported within ods
date-formats = {
BANK_ENTITY_1 = {
dateInput = "DD/MM/YYYY",
datetimeInput = "DD/MM/yyyy HH:mm:ss",
dateDisplay = "dd/MM/YYYY",
datetimeDisplay = "dd/MM/YYYY"
},
BANK_ENTITY_2 = {
dateInput = "DD/MM/YYYY",
datetimeInput = "DD/MM/yyyy HH:mm:ss",
dateDisplay = "dd/MM/YYYY",
datetimeDisplay = "dd/MM/YYYY"
}
}