Documentation for a newer release is available. View Latest

Generic Processing Settings

Generic Processing Settings es una configuración dinámica extensible que proporciona la capacidad de configurar configuraciones genéricas adicionales a nivel de Processing Entity. IPF Core soporta las siguientes categorías de settings en Generic Processing Settings:

  • Intra Entity Parties:

    1. Las configuraciones permiten registrar entidades que forman parte de las processing entities. Las entidades especificadas en Intra Entity Parties no necesitan usar una settlement account cuando intercambian pagos con la Processing Entity. Las entidades son parte del mismo grupo bancario pero diferentes de un Agent con el flag Intra Group establecido en true.

    2. Un Intra Group agent forma parte del grupo bancario más amplio de la processing entity pero aún usa una settlement account al liquidar pagos con la processing entity y tiene un ledger separado. Las Intra Entity parties comparten ledger con la Processing Entity. Normalmente, las sucursales de las Processing entities pueden configurarse como Intra Entity parties.

  • Supported Transfer Currencies

    1. Supported transfer currencies es una configuración dinámica que permite mantener una lista de transfer currencies soportadas por la Processing Entity.

    2. Para cada divisa, puede mantenerse el soporte adicional en términos de intra entity transfer, intra group transfer o extra group transfer.

  • Processing Entity Accounts

    1. La categoría permite mantener las cuentas a nivel de Processing Entity.

    2. Normalmente son ledger accounts usadas por las Processing Entities y son diferentes de las settlement accounts usadas para liquidar con los Agents. Las settlement accounts se mantienen en Agent Settlement Settings para el Agent correspondiente.

Generic processing settings también puede ampliarse por las implementaciones cliente para definir sus propias categorías de settings personalizadas según requisitos.

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 identifier values specified on the IdentifierValueList. 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 2 Character ISO country code of the party identifiers. Conditionally mandatory when the party identifiers require a country code to understand their relevance, especially for type NCC.

PartyEntityLookupSource

The source of the data on party entity directory that should be performed for looking up party entity identifiers. The enum list is extensible for client implementations.

Default possible values are:

Bank_Directory_Plus

SIX_Bank_Master

Example

Below is an example of an Intra Entity parties configuration, for details on property names and schema, please consult the API specs on CSM Reachability Setting Management APIs.

{
  "processingEntity": "PE1",
  "payload": {
    "settingCategory": "INTRA_ENTITY_PARTIES",
    "categoryProcessingSettings": {
      "identifierValueList": ["600004","560061","601902","600127","010214"],
      "partyIdentifierType": "NCC",
      "partyIdentifierSubType": "GBDSC",
      "partyIdentifierCountry": "GB",
      "partyEntityLookupSource": "Bank_Directory_Plus"
    }
  }
}

Setting Category - Supported Transfer Currencies

Dynamic Configuration Properties

Name Description

TransferCurrencies

A list of the currencies that the processing Entity can process across a pattern.

+ Currency

ISO4217 Currency code

+ IntraEntityTransfer

The flag to indicate if that the transfer in a currency can be settled Intra Entity.

+ IntraGroupTransfer

The flag to indicate if that the transfer in a currency can be settled Intra Group.

+ ExtraGroupTransfer

The flag to indicate if that the transfer in a currency can be settled Extra Group.

Example

{
  "processingEntity": "PE1",
  "payload": {
    "settingCategory": "SUPPORTED_TRANSFER_CURRENCIES",
    "categoryProcessingSettings": {
      "transferCurrencies": [
        {"currency":"GBP","intraEntityTransfer":true,"intraGroupTransfer":true,"extraGroupTransfer":true},
        {"currency":"EUR","intraEntityTransfer":false,"intraGroupTransfer":true,"extraGroupTransfer":true},
        {"currency":"USD","intraEntityTransfer":false,"intraGroupTransfer":false,"extraGroupTransfer":true}
      ]
    }
  }
}

Setting Category - Processing Entity Accounts

Dynamic Configuration Properties

Name Description

ProcessingEntityAccounts

A set of accounts that are maintained at processing Entity level. These could include account types like Ledger Accounts or suspense accounts.

+ AccountId

The account identifier.

+ AccountCurrency

ISO4217 Currency code of the account.

+ AccountType

The type of the account. The enum list is extensible for client implementations.

+ AccountSubType

The sub type of the account type . The enum list is extensible for client implementations.

+ BranchIdentifier

The branch identifiers for the processing entity.

+ Identifier

The Identifier value for the branch

+ IdentifierType

The type of the identifier used for the branch. The enum list is extensible for client implementations. Default possible values are: BIC, NCC and LEI

+ 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.

Example

{
  "processingEntity": "PE1",
  "payload": {
    "settingCategory": "PROCESSING_ENTITY_ACCOUNTS",
    "categoryProcessingSettings": {
      "processingEntityAccounts": [
        {"accountId":"4892364923","accountCurrency":"CHF","accountType":"SuspenseAccount","accountSubType":"ReturnsRejects","branchIdentifier":{"identifier":"230","identifierType":"NCC","identifierSubType":"CHBCC"}},
        {"accountId":"98469834687","accountCurrency":"EUR","accountType":"SuspenseAccount","accountSubType":"ReturnsRejects","branchIdentifier":{"identifier":"230","identifierType":"NCC","identifierSubType":"CHBCC"}},
        {"accountId":"92374034762","accountCurrency":"CHF","accountType":"LedgerAccount","branchIdentifier":{"identifier":"230","identifierType":"NCC","identifierSubType":"CHBCC"}}
      ]
    }
  }
}