Channels
To manage the channels (including business hours) on the platform, you must go to the Configuration menu and click on Channels. This section of the platform configuration allows you to create and manage your channels.
Channel management is restricted by specific roles. If you do not have access to this part of the platform and need to manage channel configurations, please contact your administrator.
Channel configuration
Channel list
In the channel list screen, you can:
-
Filter the list to view a more restricted list of channels or perform a search.
-
Create a new channel. For more details on creating a new channel, please refer to the section: Channel creation.
-
Reload the table content by clicking on the Refresh button.
By selecting a specific channel from the list, you can:
-
Display the entire history of the selected channel. All changes made to the channel since its creation are listed with the corresponding dates and the identity of the modifier.
-
View all channel details.
-
Edit the information of the selected channel.
-
Delete the selected channel. A confirmation dialog will be displayed. This action is final, please perform it with caution.
-
Postpone the business hour by n minutes/hours.
The Actions button allows you to:
-
Select all the channels in the list (including on the other pages).
-
Unselect all channels in the list (including on the other pages).
-
Bulk Postpone the selected business hours.
Postpone Business Hours
You can postpone a business hour for the current day. Only the next execution time of the End of the Day will be changed.
There are two possible scenarios for postponement:
-
The postponed End of Day is before the start of the day → The End of Day will be postponed.
-
The postponed End Of Day is after the start of the day → The business day will remain open and the execution of the End Of Day will be skipped.
Only open business hours can be postponed.
The offset value can be from 1 to 60 minutes or 1 to 12 hours.
Channel creation
General information step
Select the organization associated with the channel and click on Create. Only users with this organization will be able to use, edit, or delete this channel.
When creating a new channel, you need to specify all of the following general information:
-
The channel name to be able to easily find it.
-
The output file format to use when the payment uses this channel.
-
The output connectivity to used to send the output file.
-
The outbound frequency at which the files will be sent.
-
Fixed: Choose multiple times during the business day (after the start of the day and before the end of the day) to send the outbound file.
-
Immediately: The file is sent as soon as it is generated
-
Determination parameters step
A transaction must match all the channel determination parameters to use it. Correctly specify the following criteria to route a transaction to the correct output:
-
The payment type.
-
A list of forwarding BIC.
-
The receiver currency. Multiple currencies can be selected from the drop-down.
-
A list of receiver agent countries. Multiple countries can be selected from the drop-down.
Bulk step
When the outbound file is created, you can choose to:
-
Regroup outbound files according to the bulk configuration:
-
As-is: All transactions in an incoming file will be in the outgoing file.
-
One transaction in one file: Each transaction is sent with a different file.
-
One group in one file for all transactions: All transactions are sent in the same group, with the same file.
-
-
Split outbound files according to bulk criteria.
-
Transaction needing correction can be separated from the outbound file using Transaction Debulking:
-
Always: Sends completed transactions immediately, leaving out those needing correction.
-
Fixed schedule: Allows setting specific times and dates to send completed transactions, even if some are still in correction.
-
Never: Ensures all transactions from the same inbound file are sent together.
-
File ID & Limit step
Define custom IDs for:
-
Header ID
-
Group ID
-
Transaction ID
Custom IDs help
How to use
The outbound file ID pattern fields let you define the output Identification for Header, Group, and transactions with static and/or dynamic data. You can use three different options:
-
Keep received identification: the identification contained in the inbound file received will be used on the generated outbound file
-
Generate random identification: the platform will generate random UUIDs on the generated outbound files
-
Use specific identification: you can define a specific identification pattern based on static and dynamic data:
-
Static data: Use any characters like another file
-
Dynamic data: Use specific keywords to enable dynamic data like date, ids, sequence...
-
Note: Using specific ids will impact the performance. Note 2: Custom ids will be reduced at the end in size of 35 or 16 characters according to MX or MT mappings.
Keywords for Specific mode
Keywords can be use with the following pattern {XXX:YYY} or {XXX:YYY:NUMBER} or {XXX:NUMBER:NUMBER} (if XXX equal SEQ or DAILYSEQ) for some configuration, where:
-
XXX: Represent the type.
-
YYY: Represent the specification or values required.
-
NUMBER: Represent a number to truncate value. If positif, it will take the first x characters. If negatif, it will take the last x characters.
-
Available types are:
-
DATA for messaging data.
-
Values available:
-
MT
-
MX
-
CREDITORBIC
-
DEBTORBIC
-
FORWARDINGBIC
-
CURRENCYTO
-
CURRENCYFROM
-
ITN
-
-
Can be used multiple times
-
Support NUMBER information
-
Note: "CREDITORBIC" & "DEBTORBIC" & "CURRENCYTO" & "CURRENCYFROM" & "FORWARDINGBIC" & "ITN" can only be used for transaction level.
-
-
DATE for date format.
-
Specification available: "FORMAT" where FORMAT is a python datetime supported format. See this link for more details.
-
Can be used multiple times
-
-
SEQ for unique sequence for this configuration.
-
Specification available:
-
Optional: "n" where n is a number that represent a starting value for the sequence.
-
"n" where n is a number that represent digits length required ( Zero-padding ). You can set 0 if you want undefined length.
-
-
Can be used only once / pattern
-
-
DAILYSEQ for unique daily sequence for this configuration.
-
Specification available:
-
Optional: "n" where n is a number that represent a starting value for the sequence.
-
"n" where n is a number that represent digits length required ( Zero-padding ). You can set 0 if you want undefined length.
-
-
Can be used only once / pattern
-
-
FILESEQ for unique file sequence for this configuration. For each file, it will reset the counter to 1.
-
Specification available:"n" where n is a number that represent digits length required ( Zero-padding ). You can set 0 if you want undefined length.
-
Can be used only once / pattern
-
Can be used only for group or transaction
-
-
GROUPSEQ for unique group sequence for this configuration. For each file, it will reset the counter to 1.
-
Specification available:"n" where n is a number that represent digits length required ( Zero-padding ). You can set 0 if you want undefined length.
-
Can be used only once / pattern
-
Can be used only for group or transaction
-
-
Example
"CLIENTNAME_TEST123-{SEQ:17:10}-{DATA:MT}-{DATA:CREDITORBIC:5}-{DAILYSEQ:2}-{DATE:%Y-%m-%d}.txt"
-
Result: "CLIENTNAME_TEST123-0000001296-d0ysO3yjeUzzuEau-SVBKUS-84-2019-06-28.txt"
-
Explanation:
-
"0000001296" is the unique id for this configuration on 10 digits
-
"d0ysO3yjeUzzuEau" is the MT id of the outbound file
-
"84" is the daily unique id for this configuration on 2 digits
-
"2019-06-28" is the sent date with the format "%Y-%m-%d"
-
Everything else is static data
-
Add daily limit configuration to limit the amount of transactions to send into one channel. This limit is defined by:
-
Amount
-
Currency
-
FX (if all payments are not in the same currency)
The daily limit is reset every day.
Business Hours step
When creating a new business hour, you need to specify the following general information:
-
The start of day of the channel.
-
The end of day of the channel.
-
Channel always open when selected can keep the channels open all day with no time in which is closed.
-
The timezone associated with the business hours or payments (this timezone will be included in payment creation date).
Business hours allow you to set a period when your channel is open and transactions can be processed.
If a transaction is processed after the end of the day and before the start of the day, the transaction will either be rejected or planned according to the date configuration auto-forward option.
Create a new channel review step
You can now press the Create button to create the new channel. It will appear on the list screen.