Documentation for a newer release is available. View Latest

Generic Processing Settings

Generic Processing Settings is an extensible dynamic configuration that provides ability to configure additional generic configurations at Processing entity level. IPF Core supports below setting categories on Generic Processing Settings

  • Intra Entity Parties:

    1. The configurations allow registering entities that are part of the processing entities. The entities specified on the Intra Entity Parties do not need a settlement account used when exchanging payments with the Processing Entity. The entities are part of the same banking group but are different from an Agent with the flag Intra Group set to true.

    2. An Intra Group agent is part of wider banking group as that of the processing entity but still uses a settlement account when settling payments with processing entity and has a separate ledger. Intra Entity parties share ledger with the Processing Entity. Usually branches of Processing entities can be configured as Intra Entity parties.

  • Supported Transfer Currencies

    1. Supported transfer currencies is a dynamic configuration that allows maintenance of a list of supported transfer currencies by the Processing Entity.

    2. For each currency, a further support in terms of intra entity transfer, intra group transfer or extra group transfer can be maintained.

  • Processing Entity Accounts

    1. The setting category allows maintenance of the accounts maintained at Processing Entity Level.

    2. These are usually ledger accounts used by the Processing Entities and are different from the settlement accounts used for settling with the Agents. The settlement accounts are maintained at Agent Settlement Setting level for corresponding Agent.

Generic processing settings can also be extended by client implementations to define their own custom setting categories as per requirements.

Generic Processing Settings

Dynamic Configuration Properties

Name Description

ProcessingEntity

The Processing entity associated with the Generic processing settings.

SettingCategory

Each setting object needs to have a unique setting category ID.

Possible values provided by core implementation: PROCESSING_ENTITY_ACCOUNTS SUPPORTED_TRANSFER_CURRENCIES INTRA_ENTITY_PARTIES

CategoryProcessingSettings

The data structure of the settings. Each setting category has its own data structure.

Setting Type

DPS v2 introduced new attribute of Setting Type. This is used for generation of all API endpoints for a particular setting. It is also used in index-config.<setting type> construct. SETTING_TYPE = "genericprocessingsettings"

Searchable Fields

Searchable field for Generic Processing Settings are:

  • settingCategory

  • accountCurrency

  • accountType

  • transferCurrency

  • partyIdentifierType

  • partyIdentifierSubType

  • partyIdentifierCountry

  • identifierValueList

Indexes

DPS v2 provides an option to configure indexes for each setting. Default indexes for Generic Processing Settings are:

mongodb.index-config.genericprocessingsettings {
  index-1 = ["status:ASC"]
  index-2 = ["source:ASC"]
  index-3 = ["values.payload.entityIdentifiers.identifier:ASC"]
  index-4 = ["values.payload.settingCategory:ASC"]
  index-5 = ["values.payload.categoryProcessingSettings.processingEntityAccounts.accountCurrency:ASC"]
  index-6 = ["values.payload.categoryProcessingSettings.processingEntityAccounts.accountType:ASC"]
  index-7 = ["values.payload.categoryProcessingSettings.transferCurrencies.currency:ASC"]
  index-8 = ["values.payload.categoryProcessingSettings.partyIdentifierType:ASC"]
  index-9 = ["values.payload.categoryProcessingSettings.partyIdentifierSubType:ASC"]
  index-10 = ["values.payload.categoryProcessingSettings.identifierValueList:ASC"]
}

This can be overridden or updated. Just note that when the field is under payload, you need to provide an index like: index-x = ["values.payload.fieldX:ASC"].

Notifications

DPS v2 can provide notification after certain CRUD operation on a setting is performed. There is an option to enable notifications on setting level. Notifications are disabled by default:

ipf.csm-reachability.should-send-notification.generic-processing-settings-settings = false

History

There is an option to disable history on setting level. History is enabled by default:

ipf.csm-reachability.should-save-history.generic-processing-settings-settings = true

Setting Category - Intra Entity Parties

Dynamic Configuration Properties

Name Description

IdentifierValueList

A list of the identifiers that match with the PartyIdentifierType definition specified above.

PartyIdentifierType

The type of the identifiers that will be used to identify the parties that are intra entity. The enum list is extensible for client implementations.

Default possible values are:

BIC

LEI

NCC

PartyIdentifierSubType

Conditionally mandatory when identifier type is: BIC or NCC.

Enum list is specific to the identifier type.

BIC : accountIssuingBIC, schemeMembershipBIC

NCC: Subtype enums are aligned to ISO20022 specified codes.

PartyIdentifierCountry

The ISO3166-2 country code indicating which country specified identifier belongs to.

Conditionally mandatory when IdentifierType = LEI.

PartyEntityLookUpSource

Industry source of the data to Party Entity Directory to enable looking up of the identifiers to enable an accurate look up of Intra Entity Parties. The enum list is extensible for client implementations.

Default possible values are:

Bank_Directory_Plus

SIX_Bank_Master

Setting Category - Supported Transfer Currencies

Dynamic Configuration Properties

Name Description

TransferCurrencies

A list of transfer currencies supported by the Processing Entity.

+ Currency

ISO 4217 transfer currency code.

+ IntraEntityTransfer

Boolean (True/False). True - The currency can be used for transfers within the Processing Entity.

+ IntraGroupTransfer

Boolean (True/False). True - The currency can be used for transfers to other agents which are marked with Group Entity = True.

+ ExtraGroupTransfer

Boolean (True/False). True - This currency can be used for transfers with agents which are not marked as Group Entity (e.g. Group Entity = False)

Searchable Fields

Searchable fields for Supported Transfer Currencies is:

  • currency

For this field index in the database should be created.

Setting Category - Processing Entity Accounts

Dynamic Configuration Properties

Name Description

ProcessingEntityAccounts

A list of accounts at the processing entity level. These accounts are not settlement accounts to settle with an agent but internal within the processing entity.

+ AccountId

Account number of the Suspense account. The account ID is an ID that should be used in the booking without having to be processed any further.

+ AccountCurrency

ISO 4217 Currency Code

+ AccountType

The AccountType values for accounts should be defined per implementation as this depends on the Operational model of the clients using IPF. The enum list for the types is client implementation specific and defined as static configuration.

+ AccountSubType

The AccountSubType values for accounts should be defined per implementation as this depends on the Operational model of the clients using IPF. The enum list for the subtypes is client implementation specific and defined as static configuration>

+ BranchIdentifier

An optional identifier that can be specified for the suspense account

++ Identifier

The Identifier value

++ IdentifierType

Identifier Type, next default values are supported:

BIC

LEI

NCC

++ IdentifierSubType

Conditionally mandatory when identifier type is: BIC or NCC

Enum list is specific to the identifier type.

BIC : accountIssuingBIC, schemeMembershipBIC

NCC: Subtype enums are aligned to ISO20022 specified codes.

Searchable Fields

Searchable fields for Processing Entity Accounts are:

  • accountCurrency

  • accountType

For these fields indexes in the database should be created.

Please refer Dynamic Configuration Management Guidelines for steps to be followed for configuring the dynamic configurations.