Pacs.004.001.02 Mapper

Overview

The Pacs.004.001.02 mappers are used by SEPA Instant Credit Transfer(SCT Inst) Scheme for sending and receiving Payment Return(PmtRtr) messages between Clearing and Settlement Mechanisms(CSM) and FTM for Immediate Payments.

The Pacs.004.001.02 mappers are a pair of Inbound/Outbound mappers.

Pacs.004.001.02 Inbound Mapper: Map the SCT Inst Payment Return messages to ISF messages. The default mapper name is Pacs004ToISFMapper.
Pacs.004.001.02 Outbound Mapper: Map the ISF messages to SCT Inst Payment Return messages. The default mapper name is ISFToPacs004Mapper.

The details of the mapping specification for both inbound and outbound mappers are included in a separate document. Refer to Detailed pacs.004.001.02 mapping specification for more information about obtaining the documentation for the mapping specifications.

The inbound and outbound pacs.004.001.02 mappers can also be used in conjunction with the Wrapper mapper. Refer to SCT Inst Wrapper Mapper for more information.

Inbound Mapper

The CONFIG=entry in Channel parameter is required for inbound mapper. The mapper uses the setting to locate <msgTypeCfg> entry in Value table with child element <Type> containing pacs.004.001.02. The <msgTypeCfg> contains the configuration parameters for the inbound mapper.

For example, the default Request From Channel is configured with a CONFIG=IP_MAP_CFG_FROM_CHAN parameter. When a pacs.004.001.02 message is received , the mapper looks for the <msgTypeCfg> entry in the Value table with the following conditions:

In Value table, the value of Category is IP_MAP_CFG_FROM_CHAN.
In msgTypeCfg entry, the value of Type is pacs.004.001.02.

The default <msgTypeCfg> for IP_MAP_CFG_FROM_CHAN is as follows.

<msgTypeCfg>
	<class>PACS004</class>
	<subType>IP_FROM_CDTR_RET</subType>
	<extendedCfg>
		<name>MASTER_FLAG</name>
		<value>Y</value>
	</extendedCfg>
	<pt>
		<class>PACS004</class>
		<subType>IP_FROM_CDTR_RET</subType>
	</pt>
	<mapName>Pacs004ToISFMapper</mapName>
	<type>pacs.004.001.02</type>
</msgTypeCfg>

The inbound mapper uses the configuration parameters of the <msgTypeCfg> entry as follows:

<class> - value for TXN_PAYMENT_V.OBJ_CLASS
<subType> - value for TXN_PAYMENT_V.SUBTYPE and ISFMessage/Header/BusinessConcept
<extendedCfg>.<value> with <name>=MASTER_FLAG - value for MASTER_FLAG (for TXN_PAYMENT_V and TRANSMISSION_V)
<pt>.<class> - value for TRANSMISSION_V.OBJ_CLASS
<pt>.<subType> - value for TRANSMISSION_V.SUBTYPE

If the <msgTypeCfg> entry cannot be located, the mapper throws an exception with error 'subType not found'.

Table 1 shows the default configuration parameters for the channels using pacs.004.001.02 inbound mapper.

Table 1. Default configuration parameters for channels using pacs.004.001.02 inbound mapper
Channel	Category	Class	SubType	MASTER_FLAG	Pt.class	Pt.subType
Message From CSM	IP_MAP_CFG_FROM_CSM	PACS004	IP_FROM_CSM_RET	N	PACS004	IP_FROM_CSM_RET
Request From Channel	IP_MAP_CFG_REQ_FROM_CHAN	PACS004	IP_FROM_CDTR_RET	Y	PACS004	IP_FROM_CDTR_RET

The inbound mapper handles the Datetime elements with the rules as follows.

If a timezone offset is included in the datetime value, the datetime value is mapped to ISF with UTC timezone.
If a timezone off set is not included in a datetime value,
- if the Timezone is configured in the Channel table, the input datetime is recognized as the value in the format of the channel timezone, and is mapped to ISF with UTC timezone.
- if the Timezone is not configured in the Channel table, the input datetime is recognized as the value in the format of the local timezone in which the mapper is executing, and the input datetime is mapped to ISF with UTC timezone.

Outbound Mapper

The CONFIG=entry in Channel parameter is required for outbound mapper. The mapper uses the setting to locate <msgTypeCfg> entry in Value table with child element <subType> containing the same value as the ISF Business Concept. The <msgTypeCfg> contains the configuration parameters for the outbound mapper.

For example, the default Message To CSM channel is configured with a CONFIG=IP_MAP_CFG_TO_CSM parameter. When an ISF message is received, the mapper looks for the <msgTypeCfg> entry in the Value table with the following conditions:

In Value table, the value of Category is IP_MAP_CFG_TO_CSM.
In msgTypeCfg entry, the value of subType is the same as the ISF Business Concept.

The default <msgTypeCfg> for IP_MAP_CFG_TO_CSM is as follows.

<msgTypeCfg>
	<class>PACS004</class>
	<subType>IP_TO_CSM_RET</subType>
	<extendedCfg>
		<name>MASTER_FLAG</name>
		<value>N</value>
	</extendedCfg>
	<pt>
		<class>PACS004</class>
		<subType>IP_TO_CSM_RET</subType>
	</pt>
	<mapName>ISFToPacs004Mapper</mapName>
	<type>pacs.004.001.02</type>
</msgTypeCfg>

The outbound mapper uses the configuration parameter of the <msgTypeCfg> entry as follows:

<type> - value for the namespace of the output pacs.004.001.02 message. For SEPA SCT Inst, the value must be 'pacs.004.001.02'.

If the <msgTypeCfg> entry cannot be located, the mapper throws an exception with error 'subType not found'.

Table 2 shows the default configuration parameters for the channels using pacs.004.001.02 outbound mapper.

Table 2. Default configuration parameters for channels using pacs.004.001.02 outbound mapper
Channel	Category	Class	SubType	Type
Message To CSM	IP_MAP_CFG_TO_CSM	PACS004	IP_TO_CSM_RET	pacs.004.001.02

The outbound mapper handles the Datetime elements with the rules as follows.

If the Timezone is configured in the Channel table, the input datetime is mapped from the value with UTC timezone to the value in the format of the channel Timezone.
If the Timezone is not configured in the Channel table, the input datetime is mapped from the value with UTC timezone to the value in the format of the local timezone in which the mapper is executing.

The outbound mapper uses the channel parameter TS_INCLUDE_OFFSET to control whether the timezone offset is included in the output datetime values.

If TS_INCLUDE_OFFSET is set to Y, then the timezone offset is included in the output datetime values.
If TS_INCLUDE_OFFSET is set to N or not configured, then the timezone offset is not included in the output datetime values.