Documentation for a newer release is available. View Latest

Database Settings

List of CSM Reachability dynamic settings collections can be split to industry data and processing data structures.

  • Industry data

    • Participant

    • IbanPlus

    • IbanStructure

    • ExclusionList

    • PartyEntity

    • BicDir2018

  • Processing data

    • ProcessingEntity

    • AgentSettings

    • AgentClearingSettings

    • AgentSettlementSettings

    • CsAgentSelectionSettings

    • GenericProcessingSettings

Examples of data models:

V2

{
  "_id": "",
  "source": "manual",
  "createdBy": "user",
  "status": "ACTIVE",
  "processingEntity": "001",
  "_class": "com.iconsolutions.ipf.dynamicsettings.v2.repository.mongo.entity.SettingDocumentV2",
  "recordType": "AgentSettlementSettings",
  "values": [
    {
      "activeFromDate": {
        "$date": "2024-04-22T17:24:15.455Z"
      },
      "createdBy": "user",
      "version": 2,
      "payload": {
        "_class": "com.iconsolutions.ipf.dynamicsettings.domain.AgentSettlementSettings",
        "agentUniqueId": "Citi_US",
        "transferCurrencies": [
          "USD",
          "CAD",
          "MXN"
        ],
        "transferDirection": "OUTBOUND",
        "settlementAccount": {
          "accountId": "87364567",
          "accountIdType": "OTHR",
          "accountCurrency": "USD",
          "accountType": "NOSTRO",
          "accountServicingAgent": {
            "agentName": "Citi_US",
            "agentIdentifiers": [
              {
                "identifier": "CITIUS33XXX",
                "identifierType": "BIC",
                "identifierSubType": "SCHEME_MEMBERSHIP_BIC"
              }
            ],
            "agentCountry": "GB"
          }
        },
        "agentLimits": [
          {
            "limitType": "INDIVIDUAL_MAX_AMOUNT_VALUE",
            "limitValue": {
              "$numberDecimal": "100000.00"
            },
            "limitDirection": "OUTBOUND"
          }
        ],
        "customParticipantLimits": [],
        "participantCountryLimits": [],
        "higherParticipantLimitAllowed": false
      }
    },
    {
      "activeFromDate": {
        "$date": "2026-04-22T17:24:15.455Z"
      },
      "createdBy": "user",
      "version": 2,
      "payload": {
        "_class": "com.iconsolutions.ipf.dynamicsettings.domain.AgentSettlementSettings",
        "agentUniqueId": "Citi_US",
        "transferCurrencies": [
          "USD",
          "CAD",
          "MXN"
        ],
        "transferDirection": "OUTBOUND",
        "settlementAccount": {
          "accountId": "87364567",
          "accountIdType": "OTHR",
          "accountCurrency": "USD",
          "accountType": "NOSTRO",
          "accountServicingAgent": {
            "agentName": "Citi_US",
            "agentIdentifiers": [
              {
                "identifier": "CITIUS33XXX",
                "identifierType": "BIC",
                "identifierSubType": "SCHEME_MEMBERSHIP_BIC"
              }
            ],
            "agentCountry": "GB"
          }
        },
        "agentLimits": [
          {
            "limitType": "INDIVIDUAL_MAX_AMOUNT_VALUE",
            "limitValue": {
              "$numberDecimal": "74999.00"
            },
            "limitDirection": "OUTBOUND"
          }
        ],
        "customParticipantLimits": [],
        "participantCountryLimits": [],
        "higherParticipantLimitAllowed": false
      }
    }
  ]
}

V1 (DEPRECATED)

{
  "_id": "",
  "source": "manual",
  "createdBy": "user",
  "status": "ACTIVE",
  "processingEntity": "001",
  "_class": "com.iconsolutions.ipf.dynamicsettings.repository.AgentSettlementSettingsSettings",
  "recordType": "AgentSettlementSettings",
  "version": 1,
  "activeFromDate": {
    "$date": "2024-04-22T17:24:15.462Z"
  },
  "payload": {
    "agentUniqueId": "SicInst",
    "transferCurrencies": [
      "CHF"
    ],
    "transferDirection": "INBOUND",
    "settlementAccount": {
      "accountId": "3368790372",
      "accountIdType": "OTHR",
      "accountCurrency": "CHF",
      "accountType": "NOSTRO",
      "accountServicingAgent": {
        "agentName": "UBS Switzerland AG",
        "agentIdentifiers": [
          {
            "identifier": "UBSWCHZH80A",
            "identifierType": "BIC"
          }
        ],
        "agentCountry": "GB"
      }
    },
    "agentLimits": [
      {
        "limitType": "INDIVIDUAL_MAX_AMOUNT_VALUE",
        "limitValue": {
          "$numberDecimal": "100000.00"
        }
      },
      {
        "limitType": "INDIVIDUAL_MAX_AMOUNT_VALUE",
        "limitValue": {
          "$numberDecimal": "100000.00"
        },
        "limitDirection": "INBOUND"
      }
    ],
    "customParticipantLimits": [
      {
        "limitType": "INDIVIDUAL_MAX_AMOUNT_VALUE",
        "limitValue": {
          "$numberDecimal": "125000.00"
        },
        "participantIdentifier": "CHASDEFXXXX"
      }
    ],
    "participantCountryLimits": [
      {
        "limitType": "INDIVIDUAL_MAX_AMOUNT_VALUE",
        "limitValue": {
          "$numberDecimal": "100000.00"
        },
        "country": "DE"
      }
    ],
    "higherParticipantLimitAllowed": true
  }
}