The high value payments applications are based on FTM. They need
configuration data to be created in the FTM database.
General configuration
Table 1. Category: CORE
Key |
Configuration value |
ACK_REL_LOG_OPTION |
REQ_AND_MASTER |
IN_FRAG_BAT_GUARD |
Y |
IN_FRAG_PT_GUARD |
Y |
PROFILING_FLAGS |
MAPPERS=Y EVENTS=Y TRANSITIONS=Y ACTIONS=Y SQL=Y CUSTOM=Y PUBLISH=Y |
PROFILING_LEVEL |
0 |
PROFILING_MAX_SVC_TRACE_SIZE |
10 |
Table 2. Other categories
Category |
Description |
GUI |
This category contains the values that are used by FTM base to control aspects
of the FTM
Operations and Administration Console. |
Bank and process configuration
Typically, these configuration values need to be changed to values that are appropriate for your
environment.
Table 3. Category: TARGET2_CONFIG
Key |
Configuration value |
Description |
HVP_BANK_CODE |
BBBBUS33 |
The bank code of the participant. |
HVP_BANK_PART_ID |
N/A |
The participant ID assigned by T2. |
HVP_SERIAL_ID_3_CHAR |
N/A |
This key represents the three-character string that is used to create HVP message identifiers. The key
can be appended with the IBM® App Connect
Enterprise broker name (Integration node name) to distinguish
between different systems. For example, production, development, and test systems. |
HVP_SERIAL_ID_4_CHAR |
N/A |
This key represents the four-character string that is used to create HVP instruction identifiers. The
key can be appended with the IBM App Connect
Enterprise broker name (Integration node name) to distinguish
between different systems. For example, production, development, and test systems. |
HVP_SUSPENSE_ACCOUNT_CUSTOMER_CREDIT |
NULL |
If this key contains an account number, a suspense account credit entry is created in the message to
accounting. This value defaults to NULL so no suspense account entry is created. |
HVP_TARGET2_PART_ID |
N/A |
This key represents the T2 participant identifier. |
PROCESS_CONFIG_CATEGORY |
HVP_PROCESS_TWO_STEP_ACCNT |
This key defaults to HVP_PROCESS_TWO_STEP_ACCNT , but can be set to
HVP_PROCESS_ONE_STEP_ACCNT , depending on whether two-step or one-step accounting is
needed. |
PROCESS_CONFIG_CATEGORY_GEN_TXNS |
HVP_PROCESS_GENERIC_TXN |
|
PROCESS_CONFIG_CATEGORY_RET_OF_FUNDS |
HVP_PROCESS_RETURN_OF_FUNDS |
This value defaults to HVP_PROCESS_RETURN_OF_FUNDS , which matches a VALUE table
category that is used to define the incoming Request for Return of Funds precheck actions to be carried out
(if any). |
ROF_DUE_ALERT_TIME |
36:00 |
This value specifies the time period that an incoming Request for Return of Funds can be in an
unresolved state before an alert is raised. The format is either dd HH:mm or
HHH:mm . |
DEFAULT_ROI_NOTIFICATION_DEST |
CHANNEL1 |
The default channel that the notification for an outgoing response to recall is sent to. |
DEFAULT_RCL_NOTIFICATION_DEST |
CHANNEL1 |
The default channel that the notification for an outgoing request for recall is sent to. |
Table 4. Category: TARGET2_CHANNEL_CONFIG
Key |
Configuration value |
Description |
RANK_FOR_NOTIFICATION |
CHANNEL1 |
This configuration sets the RANK value for incoming requests from a specific (indicated by the category
prefix - TARGET2 as default) channel. This RANK value is later used to determine whether to send a
notification for the incoming request to the recipient client channel. |
CHANNEL_SEND_NOTIFICATION_RCL |
Y |
Determines whether a channel notification is sent for the T2 scheme. |
On-us bank codes
Typically, these configuration values need to be changed to values that are appropriate for your
environment.
The ONUS_BANK_CODE category is used to define bank codes that, for the purposes of outgoing payments, can
be settled internally without interaction with the CSM. Typically, this category is an enumeration of all the
BIC or routing numbers for the bank. If these numbers are defined, they are checked against the
DEST_BANK_CODE
of the outgoing credit transfer transactions. When the BIC or routing numbers
match, the prechecks that match the values in the HVP_OUTGOING_PRE_CHECK/ONUS
key for the
value table category HVP_PROCESS_ONE_STEP_ACCNT
or
HVP_PROCESS_TWO_STEP_ACCNT
are done. This situation typically means that an on-us payment
doesn't require a call to the sanction screening service or require a reservation of funds and the CSM
interaction is avoided.
Add a new key entry for each bank code. The value can be any non-null value. A null value can be used to
disable the bank code from the check.
Table 5. Category: ONUS_BANK_CODE
Key |
Configuration value |
FEUBAB20987 |
Y |
FEUBAB20XXX |
Y |
Duplicate checks
The key values that are set for the category
DUP_CHECK_TXNTYPES
represent the list of
transaction subtypes for messages that require a duplicate check. Deleting or setting one of the values to N,
causes duplicates not to be checked for those transaction subtypes. The duplicate check is based on the ID
references that are listed in either of the following locations in the
FTM database.
- The
DUP_CHECK_TXN_ID_REFS
value table entries.
- The channel rank added as a prefix to
DUP_CHECK_TXN_ID_REFS
. For example,
TARGET2_DUP_CHECK_TXN_ID_REFS
.
The duplicate check is done during the validation process.
Table 6. Category: DUP_CHECK_TXNTYPES
Key |
Configuration value |
HVP_FROM_CDTR_PACK |
Y |
HVP_FROM_CDTR_ROI_ACCEPT |
Y |
HVP_FROM_CDTR_ROI_ACCEPT_RETURN |
Y |
HVP_FROM_CDTR_ROI_REJECT |
Y |
HVP_FROM_CSM_INSTR |
Y |
HVP_FROM_CSM_INSTR_FI |
Y |
HVP_FROM_CSM_RCL |
Y |
HVP_FROM_CSM_ROI |
Y |
HVP_FROM_DBTR_INSTR |
Y |
HVP_FROM_DBTR_INSTR_FI |
Y |
HVP_FROM_DBTR_RCL |
Y |
HVP_FROM_DBTR_RET |
Y |
HVP_OUTGOING_ROI_ACCEPT |
Y |
HVP_OUTGOING_ROI_ACCEPT_RETURN |
Y |
HVP_OUTGOING_ROI_REJECT |
Y |
The values that are set for the
DUP_CHECK_TXN_ID_REFS
category represent the list of ID
references that are checked for duplicates for a specific subtype key. Examples are shown in the following
table. A category that uses the channel rank with the
DUP_CHECK_TXN_ID_REFS
values (for
example,
TARGET2_DUP_CHECK_TXN_ID_REFS
) provides for more granular duplicate checking by
payment scheme.
Table 7. Category: DUP_CHECK_TXN_ID_REFS
Key |
Configuration value |
HVP_FROM_CDTR_PACK |
MessageId |
HVP_FROM_CSM_INSTR |
MessageId |
HVP_FROM_CSM_INSTR_FI |
MessageId |
HVP_FROM_CSM_RET |
MessageId |
HVP_FROM_CSM_RCL |
AssignmentId |
HVP_FROM_CSM_ROI |
AssignmentId |
HVP_FROM_DBTR_INSTR |
MessageId InstructionId TransactionId UETRId |
HVP_FROM_DBTR_INSTR_FI |
MessageId InstructionId TransactionId UETRId |
The mappers set the ID references. If a mapper or post-mapper sets an ID reference, the reference can be
added to the list and is checked. If an ID reference is in the list but it wasn't set by a mapper, the
reference is not checked for duplicates.
If
DUP_CHECK_TXNTYPES
is set to Y for a specific transaction subtype and the
DUP_CHECK_TXN_ID_REFS
value table does not contain any entries for the subtype, duplicate
check is enabled and uses a default ID reference. The default ID reference can be specified in a VALUE table
entry that specifies the following information.
- The category is set to the scheme configuration. For example,
TARGET2_CONFIG
.
- The key is set to a specific value that depends on whether the transaction is inbound or outbound. The
values that you can use for the key are shown in the following table.
- The value (ID reference) can be set to the ID reference to use for the duplicate check. If this column
entry isn’t set, the hardcoded default is used instead.
Table 8. Default ID references for duplicate check
Category |
Key |
Value (ID reference) |
Hardcoded value |
TARGET2_CONFIG |
IN_PAY_DUP_CHECK_KEY |
|
TransactionId |
TARGET2_CONFIG |
IN_RCL_DUP_CHECK_KEY |
|
AssignmentId |
TARGET2_CONFIG |
IN_RET_DUP_CHECK_KEY |
|
MessageId |
TARGET2_CONFIG |
OUT_PAY_DUP_CHECK_KEY |
|
TransactionId |
TARGET2_CONFIG |
OUT_RCL_DUP_CHECK_KEY |
|
AssignmentId |
TARGET2_CONFIG |
OUT_RET_DUP_CHECK_KEY |
|
MessageId |
Timeouts
Typically, you can use the defaults for these configuration values.
The key values for this category represent transaction status values. The configuration values represent
the timeout interval, in seconds, after which transactions in that status time out. When no entry is provided
for one of the wait states, the wait is not retried for that state.
Table 9. Category: HVP_OBJ_STATUS_TIMEOUT
Key |
Configuration value |
Description |
S_WaitingCSMPACKResponse |
30 |
The timeout interval to wait for the response from CSM for an outgoing credit transfer status. |
S_WaitingCSMPayResponse |
300 |
The timeout interval to wait for the response from CSM for an outgoing payment. |
S_WaitOutPACKPreChecks |
5 |
The timeout interval to wait for precheck service responses for an outgoing credit transfer
status. |
S_WaitOutPreChecks |
5 |
The timeout interval to wait for precheck service responses for an outgoing payment. |
S_WaitOutPreChecksHold |
60 |
The timeout interval to wait for precheck service responses for an outgoing payment that is in the
prechecks hold state. |
S_WaitPreSubmit |
5 |
The timeout interval to wait for presubmit service responses for an outgoing payment. |
S_WaitingCSMResponse |
300 |
The timeout interval to wait for the response from CSM to an outgoing response to recall. |
S_WaitInRecallPreChecks |
5 |
The timeout interval to wait for precheck service responses for an incoming request for recall. |
S_WaitInPreChecks |
5 |
The timeout interval to wait for precheck service responses for an incoming payment. |
S_WaitInROIPreChecks |
5 |
The timeout interval to wait for precheck service responses for an incoming response to recall. |
S_WaitOutRecallPreChecks |
5 |
The timeout interval to wait for precheck service responses for an outgoing request for recall. |
S_WaitOutROIPreChecks |
300 |
The timeout interval to wait for precheck service responses for an outgoing response to recall. |
S_WaitRCLCSMResponse |
300 |
The timeout interval to wait for the response from CSM to an outgoing request for recall. |
The timeout interval can be configured as either a repeating, fixed interval or as a variable, increasing
interval. The variable interval can be used when retry handling is implemented. The formats for specifying the
timeout interval are shown in the following list.
- A single integer value that is the number of seconds to wait before the timeout.
- Two or three comma-separated integer values. The following list shows the formats of the timeout interval
when variable, increasing intervals are used.
TxnTimeoutDelay,TimeoutIncreaseRate
TxnTimeoutDelay,TimeoutIncreaseRate,MaxTimeoutDelay
The following list has a description of the values that you specify for the variable, increasing interval.
- TxnTimeoutDelay
- The interval, in seconds, between the timeouts.
- TimeoutIncreaseRate
- The rate at which the timeout interval increases. The formula to determine how the increase rate affects
the timeout interval
is:
Timeout interval = TxnTimeoutDelay + (FLOOR(Timeout counter / TimeoutIncreaseRate) * TxnTimeoutDelay)
The floor function returns the largest integer value that is less than or equal to the calculated value.
- MaxTimeoutDelay
- The maximum timeout interval to be used for this configuration.
For example,
10,5,60
specifies an initial timeout interval of 10 seconds, an increase rate
of 5 seconds, and a maximum timeout interval of 60 seconds. The resulting timeout intervals are shown in the
following table.
Table 10. Increasing timeout example
Timeout counter |
Timeout interval (seconds) |
1 |
10 |
2 |
10 |
5 |
20 |
10 |
30 |
15 |
40 |
20 |
50 |
25 |
60 |
30 |
60 |
100 |
60 |
Accounting process models
These key values define the different stages of the one-step and two-step accounting process.
The value entries represent what services and actions to call for each step in the configurable part of an
FSM. The following list describes the format of the value entries.
- Any of the key values that end with
/ONUS
represent the different stages that are defined
for on-us transactions. For example, on-us pacs.008 messages.
- Any of the key values that end with
/RETURN
or /RETURN_ONUS
represent
the different stages that are defined for payment returns. For example, pacs.004 messages.
- Any of the key values that end with
/FI
represent the different stages that are defined
for financial institutions. For example, a Financial Institution Credit Transfer message (pacs.009).
- Entries that are contained within parentheses and separated by a comma are done in parallel.
- Entries that are not in parentheses are done sequentially.
- Entries with the letter O in square brackets are optional. If the call receives a response of fail or
rejected, the accounting processing can continue.
- Entries with the letter M in square brackets or that do not have an entry in square brackets after them
are mandatory. The call must receive a response of pass or accepted for the accounting process to
continue.
In addition to the predefined service names, the list can contain any custom action that you define. You
must adhere to a few simple rules when it is called.
Table 11. Category: HVP_PROCESS_ONE_STEP_ACCNT
Key |
Configuration value |
HVP_INCOMING_POST_ACCEPT |
A_DoSendPaymentToChannel |
HVP_INCOMING_POST_ACCEPT/FI |
A_DoSendPaymentToChannel |
HVP_INCOMING_POST_ACCEPT/RETURN |
A_DoSendPaymentToChannel |
HVP_INCOMING_PRE_ACCEPT |
AccountCredit |
HVP_INCOMING_PRE_ACCEPT/FI |
AccountCredit |
HVP_INCOMING_PRE_ACCEPT/RETURN |
AccountCredit |
HVP_INCOMING_PRE_CHECK |
Sanction |
HVP_INCOMING_PRE_CHECK/FI |
Sanction |
HVP_INCOMING_PRE_CHECK/RETURN |
Sanction |
HVP_OUTGOING_POST_SUBMIT |
[NULL] |
HVP_OUTGOING_POST_SUBMIT/FI |
|
HVP_OUTGOING_PRE_CHECK |
(Sanction, Fraud) |
HVP_OUTGOING_PRE_CHECK/FI |
(Sanction, Fraud) |
HVP_OUTGOING_PRE_CHECK/ONUS |
Fraud |
HVP_OUTGOING_PRE_CHECK/RETURN |
(Sanction, Fraud) |
HVP_OUTGOING_PRE_CHECK/RETURN_ONUS |
Fraud |
HVP_OUTGOING_PRE_SUBMIT |
AccountDebit |
HVP_OUTGOING_PRE_SUBMIT/FI |
AccountDebit |
HVP_OUTGOING_PRE_SUBMIT/RETURN |
AccountDebit |
Table 12. Category: HVP_PROCESS_TWO_STEP_ACCNT
Key |
Configuration value |
HVP_INCOMING_POST_ACCEPT |
(AccountCredit, A_DoSendPaymentToChannel) |
HVP_INCOMING_POST_ACCEPT/FI |
(AccountCredit, A_DoSendPaymentToChannel) |
HVP_INCOMING_POST_ACCEPT/RETURN |
(AccountCredit, A_DoSendPaymentToChannel) |
HVP_INCOMING_PRE_ACCEPT |
|
HVP_INCOMING_PRE_ACCEPT/FI |
|
HVP_INCOMING_PRE_ACCEPT/RETURN |
|
HVP_INCOMING_PRE_CHECK |
(Sanction, A_RegisterPFSRequest, AccountInq) |
HVP_INCOMING_PRE_CHECK/FI |
(Sanction, A_RegisterPFSRequest, AccountInq) |
HVP_INCOMING_PRE_CHECK/RETURN |
(Sanction, A_RegisterPFSRequest, AccountInq) |
HVP_OUT_GEN_TXN_PRE_CHECK |
|
HVP_OUTGOING_PACK_PRE_CHECK |
|
HVP_OUTGOING_PACK_PRE_CHECK/ONUS |
|
HVP_OUTGOING_POST_SUBMIT |
AccountDebit |
HVP_OUTGOING_POST_SUBMIT/FI |
AccountDebit |
HVP_OUTGOING_POST_SUBMIT/RETURN |
AccountDebit |
HVP_OUTGOING_PRE_CHECK |
(Sanction, Fraud, A_RegisterPFSRequest, ReserveFunds) |
HVP_OUTGOING_PRE_CHECK/FI |
(Sanction, Fraud, A_RegisterPFSRequest, ReserveFunds) |
HVP_OUTGOING_PRE_CHECK/ONUS |
(Fraud, A_RegisterPFSRequest) |
HVP_OUTGOING_PRE_CHECK/RETURN |
(Sanction, Fraud, A_RegisterPFSRequest, ReserveFunds) |
HVP_OUTGOING_PRE_CHECK/RETURN_ONUS |
(Fraud, A_RegisterPFSRequest) |
HVP_OUTGOING_PRE_SUBMIT |
|
HVP_OUTGOING_PRE_SUBMIT/FI |
|
HVP_OUTGOING_PRE_SUBMIT/RETURN |
|
The key values in the following table represent what services and actions to call for each step in the
return of funds FSM.
Table 13. Category: HVP_PROCESS_RETURN_OF_FUNDS
Key |
Configuration value |
HVP_INCOMING_ROI_POST_ACCEPT |
A_DoSendROIToChannel |
HVP_INCOMING_ROI_POST_ACCEPT/ONUS |
A_DoSendROIToChannel |
HVP_INCOMING_ROI_PRE_CHECK |
Sanction |
HVP_OUTGOING_RCL_PRE_CHECK |
Sanction |
HVP_OUTGOING_RCL_PRE_CHECK/ONUS |
Sanction |
HVP_OUTGOING_ROI_PRE_CHECK |
Sanction |
HVP_OUTGOING_ROI_PRE_CHECK/ONUS |
Sanction |
The key values in the following table represent what services and actions to call for each step in the
generic transactions FSM.
Table 14. Category: HVP_PROCESS_GENERIC_TXN
Key |
Configuration value |
HVP_IN_GENERIC_POST_ACCEPT |
A_DoNotifyChannelGenericTxn |
The following predefined names map to the following actions:
Table 15. Predefined names and corresponding actions
Friendly name |
Action |
Fraud |
A_DoSendToFraudCheck |
Sanction |
A_DoSendToSanctScreen |
AccountInq |
A_DoSendAccountInquiry |
AccountCredit |
A_DoSendToAccounting |
AccountDebit |
A_DoSendDebitToAccounting |
ReserveFunds |
A_DoFundsReservation |
NotifyChannel |
A_DoNotifyChannel |
Routing
Typically, you can use the defaults for these configuration values.
Standard FTM routing mechanisms are used. The value table category
ROLE_FOR_TXN_TYPE
is used to define a Service Participant
role for each
outbound transaction type. When an outbound transaction is being created, the generic routing algorithm
locates the outbound channel from the Service Participant
whose role matches that defined for
the TRANSACTION.SUBTYPE
.
Map configuration
Typically, you can use the defaults for these configuration values.
These entries are used to define message-specific mapping configuration for a channel or mapper that can
process multiple message types. Essentially, it allows a common or channel map to be used and have the
configuration entries control key attributes such as the mapper, transaction, or message types.
<msgTypeCfg>
<class>PACS008</class>
<subType>HVP_TO_CSM_INSTR</subType>
<extendedCfg>
<name>MASTER_FLAG</name>
<value>N</value>
</extendedCfg>
<pt>
<class>PACS008</class>
<subType>HVP_TO_CSM_INSTR</subType>
</pt>
<mapName>ISFToPacs008Mapper</mapName>
<type>pacs.008.001.08</type>
</msgTypeCfg>
Finite state machine (FSM)
Typically, you can use the defaults for these configuration values. Changing them might cause the high
value payments application FSMs to fail.
Table 16. Other categories
Category |
Description |
E_FILTER_ALIAS |
This category is a shortcut that is enabled by FTM base. You can use it to
shorten the event filters in FSMs. The FSM transition uses the category, key format to identify the correct
event filter configuration value to use. |
O_SEL_ALIAS |
This category is a shortcut that is enabled by FTM base. You can use it to
shorten the object selector overrides in FSMs. The FSM transition uses the category, key format to identify
the correct object selector override configuration value to use. |
TXN_CLASS_ALIAS |
This category is a shortcut that is enabled by FTM base. You can use it to
shorten the OBJ_CLASS list that is used in the FSM object and override selectors. The
$ValueTxtList macro uses the category and value pair entries to return a list of OBJ_CLASS
(TXN_CLASS) values to use. |
TXN_TYPE_ALIAS |
This category is a shortcut that is enabled by FTM base. You can use it to
shorten the transaction SUBTYPE list that is used in the FSM object and override selectors. The
$ValueTxtList macro uses the category and value pair entries to return a list of SUBTYPE
(TXN_TYPE) values to use. |
TXN_STATE_ALIAS |
Used to denote a list of states and state types. For example, VALIDATING, FAILED. Used by the
validating step for credit transfers. |
REJECTION_EVENT_FOR_TXN_TYPES |
This category is used when a response message is received from the CSM and is correlated. If the
response message is a reject, this value and the request transaction subtype are used as the key to return a
rejection event. This event is raised to trigger the rejection path of the FSM. |
COMPLETION_EVENT_FOR_TXN_TYPES |
This category is used when a response message is received from the CSM and is correlated. The request
transaction subtype and the response transaction subtype are used as the key to return a completion event.
This event is raised to trigger an FSM transition path. |
These configuration values are used to set the OBJ_CLASS of the status message that is sent back to the CSM
in the Incoming Credit Transfer use case. The current scheme is used as the key to look up the configuration
value to return and use as the OBJ_CLASS. This category is used to configure whether to wait for a response to
the status message or not. Use the OUT_TXN_NOWAIT
value when you want to wait for a response.
Use the OUT_TXN_NOWAIT_COMPLETE
value when you don't need to wait for a response from the
CSM.
Table 17. Category: HVP_TO_CSM_PSTAT_CLASS
Key |
Configuration value |
TARGET2 |
[NULL] |
The
HVP_CSM_OUTGOING_SUBTYPE
category-and-key pair returns the key value to be used for
the subtype for the payment transaction to the CSM.
Table 18. Category: HVP_CSM_OUTGOING_SUBTYPE
Key |
Configuration value |
HVP_TO_CSM_RCL |
[NULL] |
HVP_TO_CSM_ROI |
[NULL] |
The key values in the following table represent the list of messages that are to be processed as generic
transactions. The subtype of a transaction needs to match with the key and the value. The value
OUT_GEN_TXN
is for the outgoing generic transactions and the value
IN_GEN_TXN_ONLY
is for the incoming generic transactions.
Table 19. Category: HVP_GEN_TXN_SUBTYPE
Key |
Configuration value |
HVP_FROM_CHAN_GEN_ACCNTREPORT |
OUT_GEN_TXN |
HVP_FROM_CHAN_GEN_ACCNTRPRT_REQ |
OUT_GEN_TXN |
HVP_FROM_CHAN_GEN_CUST_STMNT |
OUT_GEN_TXN |
HVP_FROM_CHAN_GEN_CDT_DBT_RPRT |
OUT_GEN_TXN |
HVP_FROM_CHAN_GEN_NOTIF_TO_RCV |
OUT_GEN_TXN |
HVP_FROM_CHAN_GEN_TXN |
OUT_GEN_TXN |
HVP_FROM_CSM_GEN_ACCNTREPORT |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_ACCNTRPRT_REQ |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_CUST_STMNT |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_CDT_DBT_RPRT |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_NOTIF_TO_RCV |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_CDT_DBT_RPRT |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_CDT_RPRT |
IN_GEN_TXN_ONLY |
HVP_FROM_CSM_GEN_DBT_RPRT |
IN_GEN_TXN_ONLY |
The key values in the following table represent what outgoing subtype to use for a specific subtype for the
outgoing generic flow.
Table 20. Category: OUT_GEN_SUBTYPE_MAPPING
Key |
Configuration value |
HVP_FROM_CHAN_GEN_ACCNTREPORT |
HVP_TO_CSM_GEN_ACCNTREPORT |
HVP_FROM_CHAN_GEN_ACCNTRPRT_REQ |
HVP_TO_CSM_GEN_ACCNTRPRT_REQ |
HVP_FROM_CHAN_GEN_CUST_STMNT |
HVP_TO_CSM_GEN_CUST_STMNT |
HVP_FROM_CHAN_GEN_CDT_DBT_RPRT |
HVP_TO_CSM_GEN_CDT_DBT_RPRT |
HVP_FROM_CHAN_GEN_NOTIF_TO_RCV |
HVP_TO_CSM_GEN_NOTIF_TO_RCV |
HVP_FROM_CHAN_GEN_TXN |
HVP_TO_CSM_GEN_TXN |
Message enrichment
For an outgoing message to the network, CSM, or Gateway, many fields are populated according to enrichment
configuration. This configuration allows the high value payments application to generate scheme-compliant
values to be used in the outgoing message, which is usually the default behavior. Or, a value that is provided
by the channel interface can be used without modification.
Enrichment rules are stored across multiple configuration categories that use the following patterns.
- The channel-specific pattern is
CHANNEL_SCHEME_USECASE_ENRICH
.
- The non-channel-specific pattern is
SCHEME_USECASE_ENRICH
.
Channel-specific configuration entries take priority over non-channel-specific configuration entries. Usage
of any specific configuration value is covered in the relevant functional flows topic for that use case.
Table 21. Category: CHANNEL1_SCHEME_PMT_ENRICH
Key |
Configuration value |
SCHEME=TARGET2 |
SCHEME=EURO1 |
SCHEME=CBPR+ |
ClrSysCd |
Assign |
Assign |
Remove |
CreDtTm |
Assign |
Assign |
Assign |
Default ClrSysCd |
TGT |
EBA |
NONE |
Default InstdAgt |
CSMBankCode |
CSMBankCode |
CSMBankCode |
Default InstgAgt |
BankCode |
BankCode |
BankCode |
Default SttlmMtd |
CLRG |
CLRG |
INDA |
InstdAgt |
Assign |
Assign |
Assign |
InstgAgt |
Assign |
Assign |
Assign |
InstrId |
Assign |
Assign |
Assign |
IntrBkSttlmDt |
Update |
Update |
Update |
MsgId |
Assign |
Assign |
Assign |
RtrId |
Assign |
Assign |
Assign |
SttlmMtd |
Assign |
Assign |
Assign |
TxId |
Remove |
Remove |
Assign |
Table 22. Category: CHANNEL1_SCHEME_RCL_REQ_ENRICH
Key |
Configuration value |
SCHEME=TARGET2 |
SCHEME=EURO1 |
SCHEME=CBPR+ |
Assgne |
Assign |
Assign |
Assign |
AssgnmtId |
Assign |
Assign |
Assign |
Assgnr |
Assign |
Assign |
Assign |
Case |
Remove |
Remove |
Assign |
CreDtTm |
Assign |
Assign |
Assign |
CxlId |
Assign |
Assign |
Assign |
Default Assgne |
CSMBankCode |
CSMBankCode |
CSMBankCode |
Default Assgnr |
BankCode |
BankCode |
BankCode |
Default CaseCretrBICFI |
None |
None |
Assgnr |
Default CaseId |
None |
None |
Allocate |
Table 23. Category: CHANNEL1_SCHEME_RCL_RSP_ENRICH
Key |
Configuration value |
SCHEME=TARGET2 |
SCHEME=EURO1 |
SCHEME=CBPR+ |
Assgne |
Assign |
Assign |
Assign |
AssgnmtId |
Assign |
Assign |
Assign |
Assgnr |
Assign |
Assign |
Assign |
CreDtTm |
Assign |
Assign |
Assign |
CxlStsId |
Assign |
Assign |
Assign |
Default Assgne |
CSMBankCode |
CSMBankCode |
CSMBankCode |
Default Assgnr |
BankCode |
BankCode |
BankCode |
RslvdCase |
Remove |
Remove |
Assign |
Status codes to the channel
The arrival of a network, CSM, or Gateway response to an outgoing request can trigger a status message to
the channel. The status message to the channel can be suppressed as determined by configuration, which is both
scheme and channel specific. The configuration uses the category pattern
CHANNEL_SCHEME_USECASE_STSCDS
. The
values that match each pattern entry are shown in the following list.
- CHANNEL
- Matches the channel rank value that was assigned to the original outgoing request when it was initially
mapped.
- SCHEME
- Matches the payment scheme value that was determined during the validation stage of the outgoing request.
For example, it is
TARGET2
, EURO1
, or CBPR+
.
- USECASE
- Matches PMT, RCL_REQ, or RCL_RSP, depending on whether the original outgoing request was a payment, recall
request or recall response.
The default channel rank value that is used for the product is CHANNEL1
. Therefore, the
example category pattern of CHANNEL1_TARGET2_PMT_STSCDS provides the configuration for status messages to
Channel1 for an outgoing payment to T2.
To determine whether a status is sent to the channel, the status code itself is checked against the keys in
the relevant
CHANNEL_SCHEME_USECASE_STSCDS
category. If the value of the status code has a corresponding key, the status is sent. When the status code
does not have a corresponding key, the status to the channel is suppressed instead.
When a status is to be sent to the channel, the status code in the message can be determined from the
status code that was received in the message from CSM. For each configuration entry, the key represents the
status code from CSM and the value represents the code that is used in the message to the channel. In the
first row of the following table, both the key and value are ACSC
. Therefore, the message is
sent to the channel with the status code unchanged.
The existing configuration value entries can be modified, added to or deleted as necessary.
Table 24. Category: CHANNEL1_SCHEME_PMT_STSCDS
Key |
Configuration value |
ACSC |
ACSC |
Accepted |
ACCP |
E005 |
E005 |
H001 |
H001 |
PDNG |
PDNG |
RJCT |
RJCT |
Table 25. Category: CHANNEL1_SCHEME_RCL_REQ_STSCDS
Key |
Configuration value |
NOT_CORRELATED |
RJCT |
PDNG |
ACSC |
REJECT |
RJCT |
RETURN |
ACCP |
RJCT |
RJCT |
Table 26. Category: CHANNEL1_SCHEME_RCL_RSP_STSCDS
Key |
Configuration value |
NOT_CORRELATED |
RJCT |
REJECT |
RJCT |
RETURN |
ACCP |
CSM status response configuration
After an outgoing request message is submitted to the network, CSM, or Gateway, one or more acknowledgment
messages can be expected in return. Configuration allows a received acknowledgment message to be treated as an
interim response or as the final, expected response. The configuration of interim and final acknowledgments is
scheme and use case specific. The configuration uses the category pattern
SCHEME_USECASE_CSM_ACK_VALUES
. The values that match
each pattern entry are shown in the following list.
- SCHEME
- Matches the payment scheme value that was determined during the validation stage of the outgoing request.
For example, it is
TARGET2
, EURO1
, or CBPR+
.
- USECASE
- Matches PMT, RCL_REQ, or RCL_RSP, depending on whether the original outgoing request was a payment, recall
request or recall response.
For example, category TARGET2_PMT_CSM_ACK_VALUES provides the configuration for response acknowledgment
messages from T2, for an outgoing payment.
The keys in these categories are defined as the subtype of the incoming acknowledgment and the value that
is contained in the message, separated by a comma. For example, the key
HVP_FROM_CSM_PSTAT,ACSC
provides configuration for a pacs.002 response that contains status
code ACSC.
If a response message is handled as an interim acknowledgment, a status update can be sent to the
originating client. After that update is sent, the process continues to wait for a final acknowledgment before
it proceeds to the post-submit stage.
The existing configuration value entries can be modified, added to, or deleted as necessary.
Table 27. Category: SCHEME_PMT_CSM_ACK_VALUES
Key |
Configuration value |
Description |
HVP_FROM_CSM_PSTAT,ACSC |
IN_FINAL_ACK |
Specifies that a pacs.002 message with status code ACSC is an interim response for an outgoing payment
and the final response is yet to arrive. |
HVP_FROM_CSM_PSTAT,RJCT |
IN_FINAL_ACK |
Specifies that a pacs.002 message with status code RJCT is a final response for an outgoing
payment. |
HVP_FROM_CSM_RCPT_ACK,H001 |
IN_FINAL_ACK |
Specifies that an admi.007 message with status code H001 is a final response for an outgoing
payment. |
HVP_FROM_CSM_RCPT_ACK,PDNG |
IN_INTERIM_ACK |
Specifies that an admi.007 message with status code PDNG is a final response for an outgoing
payment. |
HVP_FROM_CSM_RCPT_ACK,RJCT |
IN_FINAL_ACK |
Specifies that an admi.007 message with status code RJCT is a final response for an outgoing
payment. |
HVP_FROM_NETWORK_DELIVERY_NOTIF,Accepted |
IN_INTERIM_ACK |
Specifies that an xsys.011 message with status code Accepted is an interim response for an outgoing
payment and the final response is yet to arrive. |
HVP_FROM_NETWORK_DELIVERY_NOTIF_NACK,E005 |
IN_FINAL_ACK |
Specifies that an xsys.012 message with status code E005 is a final response for an outgoing
payment. |
Table 28. Category: SCHEME_RCL_REQ_CSM_ACK_VALUES
Key |
Configuration value |
Description |
HVP_FROM_NETWORK_DELIVERY_NOTIF_NACK,E005 |
IN_FINAL_ACK |
Specifies that an xsys.012 message with status code E005 is a final response for a request for
recall. |
HVP_FROM_NETWORK_DELIVERY_NOTIF_NACK,Failed |
IN_FINAL_ACK |
Specifies that an xsys.012 message with status code Failed is a final response for a request for
recall. |
HVP_FROM_NETWORK_DELIVERY_NOTIF,Accepted |
IN_FINAL_ACK |
Specifies that an xsys.011 message with status code Accepted is a final response for a request for
recall. |
Table 29. Category: SCHEME_RCL_RSP_CSM_ACK_VALUES
Key |
Configuration value |
Description |
HVP_FROM_NETWORK_DELIVERY_NOTIF_NACK,Failed |
IN_FINAL_ACK |
Specifies that an xsys.012 message is a final response for an outgoing response to recall. |
HVP_FROM_NETWORK_DELIVERY_NOTIF,Accepted |
IN_INTERIM_ACK |
Specifies that an xsys.011 message is an interim response for an outgoing response to recall and the
final response is yet to arrive. |
HVP_FROM_CSM_RCPT,ACPT |
IN_FINAL_ACK |
Specifies that a camt.025 message with status code ACPT is a final response for an outgoing response to
recall. |
HVP_FROM_CSM_RCPT,D004 |
IN_FINAL_ACK |
Specifies that a camt.025 message with status code D004 is a final response for an outgoing response to
recall. |
HVP_FROM_CSM_RCPT,D008 |
IN_FINAL_ACK |
Specifies that a camt.025 message with status code D008 is a final response for an outgoing response to
recall. |
HVP_FROM_CSM_RCPT,E094 |
IN_FINAL_ACK |
Specifies that a camt.025 message with status code E094 is a final response for an outgoing response to
recall. |
HVP_FROM_CSM_RCPT,Y058 |
IN_FINAL_ACK |
Specifies that a camt.025 message with status code Y058 is a final response for an outgoing response to
recall. |
HVP_FROM_CSM_RCPT,Y059 |
IN_FINAL_ACK |
Specifies that a camt.025 message with status code Y059 is a final response for an outgoing response to
recall. |
HVP_FROM_CSM_RCPT_ACK,E001 |
IN_FINAL_ACK |
Specifies that an admi.007 message with status code E001 is a final response for an outgoing response
to recall. |
HVP_FROM_CSM_RCPT_ACK,E002 |
IN_FINAL_ACK |
Specifies that an admi.007 message with status code E002 is a final response for an outgoing response
to recall. |
HVP_FROM_CSM_RCPT_ACK,E003 |
IN_FINAL_ACK |
Specifies that an admi.007 message with status code E003 is a final response for an outgoing response
to recall. |
HVP_FROM_CSM_RCPT_ACK,E005 |
IN_FINAL_ACK |
Specifies that an admi.007 message with status code E005 is a final response for an outgoing response
to recall. |
Channel configuration
The key values that are set for the
CHANNEL1_CHANNEL_CONFIG
category represent the channel
configuration that is specific to a particular channel, which is indicated by the category prefix. The default
category prefix is
CHANNEL1
.
Table 30. Category: CHANNEL1_CHANNEL_CONFIG
Key |
Configuration value |
ALLOW_RECALL_FOR_UNMATCHED_PAYMENT |
N |
ALLOW_RETURN_FOR_UNMATCHED_PAYMENT |
Y |
ALLOW_ROI_FOR_UNMATCHED_PAYMENT |
Y |
ALLOW_OUT_RECALL_FOR_UNMATCHED_PAYMENT |
N |
CHANNEL_SEND_NOTIFICATION_RCL |
Y |
SEND_ONUS_NOTIFICATION |
Y |
SEND_RETURN_NOTIFICATION |
Y |
You can configure the destination channel to use for notification messages for incoming generic messages.
The configuration uses the category pattern
SCHEME_RANK_FOR_NOTIF_SUBTYPE
.
The values that match each pattern entry are shown in the following list.
- SCHEME
- Matches the payment scheme value for the message that was received. For example,
TARGET2
,
EURO1
, or CBPR+
.
The keys in these categories are the subtype of the incoming message. The value is the channel to use to
send the notification.
The following table shows the notification destination channels for
T2
messages.
Table 31. Category: TARGET2_RANK_FOR_NOTIF_SUBTYPE
Key |
Configuration value |
HVP_FROM_CSM_GEN_ACCNTREPORT |
CHANNEL1 |
HVP_FROM_CSM_GEN_ACCNTRPRT_REQ |
CHANNEL1 |
HVP_FROM_CSM_GEN_CUST_STMNT |
CHANNEL1 |
HVP_FROM_CSM_GEN_CDT_DBT_RPRT |
CHANNEL1 |
HVP_FROM_CSM_GEN_NOTIF_TO_RCV |
CHANNEL1 |
HVP_FROM_CSM_GEN_CDT_DBT_RPRT |
CHANNEL1 |
HVP_FROM_CSM_GEN_CDT_RPRT |
CHANNEL1 |
HVP_FROM_CSM_GEN_DBT_RPRT |
CHANNEL1 |
The key values that are set for the
TARGET2_IN_GEN_SUBTYPE_MAPPING
category represent what
outgoing subtype to use for a specific subtype for the incoming generic flow. The following table shows the
outgoing subtype for messages that are received from
T2. You can configure similar
key-and-value pairs for the different payment schemes and message types.
Table 32. Category: TARGET2_IN_GEN_SUBTYPE_MAPPING
Key |
Configuration value |
HVP_FROM_CSM_GEN_ACCNTREPORT |
HVP_TO_CHNL_GEN_ACCNTREPORT |
HVP_FROM_CSM_GEN_ACCNTRPRT_REQ |
HVP_TO_CHNL_GEN_ACCNTRPRT_REQ |
HVP_FROM_CSM_GEN_CUST_STMNT |
HVP_TO_CHNL_GEN_CUST_STMNT |
HVP_FROM_CSM_GEN_CDT_DBT_RPRT |
HVP_TO_CHNL_GEN_CDT_DBT_RPRT |
HVP_FROM_CSM_GEN_NOTIF_TO_RCV |
HVP_TO_CHNL_GEN_NOTIF_TO_RCV |
HVP_FROM_CSM_GEN_CDT_DBT_RPRT |
HVP_TO_CHNL_GEN_CDT_DBT_RPRT |
HVP_FROM_CSM_GEN_CDT_RPRT |
HVP_TO_CHNL_GEN_CDT_RPRT |
HVP_FROM_CSM_GEN_DBT_RPRT |
HVP_TO_CHNL_GEN_DBT_RPRT |
The key values that are set for the
<Channel>_SCHEME_FOR_CLRSYS_ID
category map the
payment scheme to the corresponding clearing system code or the FIN copy ID. For example, the category for
CHANNEL1
is
CHANNEL1_SCHEME_FOR_CLRSYS_ID
.
Table 33. Category: <Channel>_SCHEME_FOR_CLRSYS_ID
Key |
Configuration value |
DDK |
Kronos2 |
DKD |
Kronos2 |
EBA |
Euro1 |
ERP |
Euro1 |
NBO |
NBO |
NOC |
NBO |
RIX |
RIX |
SEC |
RIX |
TGT |
Target2 |
The key values that are set for the
<MTChannel>_FINCOPYID_FOR_SCHEME
category map the
FIN copy ID to the corresponding the payment scheme. For example, the category for
CHANNEL2
is
CHANNEL2_FINCOPYID_FOR_SCHEME
.
Table 34. Category: <MTChannel>_FINCOPYID_FOR_SCHEME
Key |
Configuration value |
Euro1 |
EBA |
Kronos2 |
DKD |
NBO |
NOC |
RIX |
SEC |
Target2 |
TGT |
HVPS+ usage rules configuration
The key values that are set for the
CHECK_HVPS+
category represent the list of outbound
transaction subtypes whose ISF can be checked for compliance with the
HVPS+ usage
rules. Set the configuration value to Y to cause the ISF that was created for a transaction of that subtype to
be checked against the usage rules.
Table 35. Category: CHECK_HVPS+
Key |
Configuration value |
HVP_TO_CSM_INSTR |
Y |
HVP_TO_CSM_INSTR_FI |
Y |
HVP_TO_CSM_RET |
Y |
HVP_TO_CSM_RCL |
Y |
HVP_TO_CSM_ROI |
Y |
HVPS+ user exit configuration
The key values that are set for the
USER_EXITS
category represent the predetermined value
that is assigned to each action, which allows user exits to be called. The key, along with a label name that
is assigned to the configuration value, determines whether a user exit is called and which label it is routed
to. For more information, see
User exits.
Table 36. Category: USER_EXITS
Key |
Configuration value |
UX_CHECK_RESULTS |
<label name> |
UX_DO_FUNDS_RESERVATION |
<label name> |
UX_DO_NOTIFY_CHANNEL |
<label name> |
UX_DO_NOTIFY_CHANNEL_RECALL |
<label name> |
UX_DO_NOTIFY_CHANNEL_RETURN |
<label name> |
UX_DO_NOTIFY_CHANNEL_ROI |
<label name> |
UX_SEND_TO_ACCOUNTING |
<label name> |
UX_SEND_ACCOUNT_INQUIRY |
<label name> |
UX_SEND_CREDIT_REVERSE_TO_ACCOUNTING |
<label name> |
UX_SEND_DEBIT_TO_ACCOUNTING |
<label name> |
UX_SEND_DEBIT_REVERSE_TO_ACCOUNTING |
<label name> |
UX_SEND_RECALL_NACK_TO_CHANNEL |
<label name> |
UX_SEND_RECALL_STATUS_TO_CHANNEL |
<label name> |
UX_SEND_ROI_NACK_TO_CHANNEL |
<label name> |
UX_SEND_ROI_STATUS_TO_CHANNEL |
<label name> |
UX_SEND_CANCEL_STATUS_TO_CSM |
<label name> |
UX_SEND_PAYMENT_TO_CSM |
<label name> |
UX_SEND_RECALL_TO_CSM |
<label name> |
UX_SEND_RETURN_TO_CSM |
<label name> |
UX_SEND_ROI_TO_CSM |
<label name> |
UX_SEND_STATUS_TO_CSM |
<label name> |
UX_SEND_TO_FRAUD_CHECK |
<label name> |
UX_SEND_TO_SANCT_SCREEN |
<label name> |
UX_VALIDATE_INCOMING_RECALL |
<label name> |
UX_VALIDATE_INCOMING_ROI |
<label name> |
UX_VALIDATE_RECALL |
<label name> |
UX_VALIDATE_ROI |
<label name> |
UX_VALIDATE_TRANSACTION |
<label name> |
Load Gateway Server configuration
The key values that are set for the
PFS_INTEGRATION
category are used to determine whether
the message needs to be loaded into
Gateway Server. The messages that are loaded into
Gateway Server can be seen on only the
Control Center user interface. The key is the subtype of
the transmission that needs to be loaded and the value specifies whether the message is to be loaded or not.
Set the configuration value to Y to indicate that the message is to be loaded. Setting the value to N
indicates that the message is not to be loaded. The default for the value is Y.
Table 37. Category: PFS_INTEGRATION
Key |
Configuration value |
HVP_FROM_CDTR_INSTR_FI_DBIT |
Y |
HVP_FROM_CDTR_PACK |
Y |
HVP_FROM_CDTR_ROI |
Y |
HVP_FROM_CDTR_ROI_ACCEPT |
Y |
HVP_FROM_CDTR_ROI_ACCEPT_RETURN |
Y |
HVP_FROM_CDTR_ROI_REJECT |
Y |
HVP_FROM_CHAN_GEN_ACCNTREPORT |
Y |
HVP_FROM_CHAN_GEN_ACCNTRPRT_REQ |
Y |
HVP_FROM_CHAN_GEN_CDT_RPRT |
Y |
HVP_FROM_CHAN_GEN_CUST_STMNT |
Y |
HVP_FROM_CHAN_GEN_DBT_RPRT |
Y |
HVP_FROM_CHAN_GEN_MSG_RECEIPT |
Y |
HVP_FROM_CHAN_GEN_NOTIF_TO_RCV |
Y |
HVP_FROM_CSM_GEN_ACCNTREPORT |
Y |
HVP_FROM_CSM_GEN_ACCNTRPRT_REQ |
Y |
HVP_FROM_CSM_GEN_CDT_RPRT |
Y |
HVP_FROM_CSM_GEN_CUST_STMNT |
Y |
HVP_FROM_CSM_GEN_DBT_RPRT |
Y |
HVP_FROM_CSM_GEN_MSG_RECEIPT |
Y |
HVP_FROM_CSM_GEN_NOTIF_TO_RCV |
Y |
HVP_FROM_CSM_INSTR |
Y |
HVP_FROM_CSM_INSTR_FI |
Y |
HVP_FROM_CSM_INSTR_FI_DBIT |
Y |
HVP_FROM_CSM_RCL |
Y |
HVP_FROM_CSM_RET |
Y |
HVP_FROM_CSM_ROI |
Y |
HVP_FROM_DBTR_INSTR |
Y |
HVP_FROM_DBTR_INSTR_FI |
Y |
HVP_FROM_DBTR_RCL |
Y |
HVP_FROM_DBTR_RET |
Y |
HVP_OUTGOING_ROI |
Y |
HVP_OUTGOING_ROI_ACCEPT |
Y |
HVP_OUTGOING_ROI_ACCEPT_RETURN |
Y |
HVP_OUTGOING_ROI_REJECT |
Y |
IB_ISO |
Y |
IB_ISO_BAH |
Y |
PAY_ORIG |
Y |