Documentation for a newer release is available. View Latest

Agent Settings

An Agent es una entidad con la que la Processing Entity mantiene una relación de liquidación (settlement) en una o más Transfer Currencies.

Cuando se compensa y liquida un pago entre la Processing Entity y el Agent, debe usarse al menos una settlement account que permita a las dos entidades saldar la obligación. Si una entidad no necesita una settlement account y puede usar las ledger accounts de la Processing Entity para debitar/creditar directamente a los clientes, esa entidad no es un Agent; es una Intra Entity Party, una party que forma parte de la propia Processing Entity.

El Agent puede ser una entidad que forme parte del grupo bancario más amplio al que pertenece la Processing Entity. En este caso, el Agent es un Intra Group Agent.

El tipo de Agent se basa en el tipo de relación de liquidación que mantiene con la Processing Entity. Estos pueden ser:

DirectAccountAgent - El Agent mantiene una relación de liquidación de cuenta directa con la Processing Entity. Normalmente es otro banco/entidad financiera que no es una Clearing House.
ClearingAgent - El Agent es una Clearing House y facilita el clearing y la liquidación de pagos entre diferentes instituciones financieras.

Según la naturaleza de la relación de liquidación, el Agent puede desempeñar distintos roles (independientes del tipo de Agent). Los agent roles pueden ser:

Intermediary - Un Agent de tipo DirectAccount (una entidad financiera, no una clearing house) que facilita el clearing y la liquidación de pagos entre la Processing Entity y otras entidades financieras con las que no mantiene relaciones de liquidación directas.
Serviced Agent - Un Agent de tipo DirectAccount (una entidad financiera, no una clearing house) que utiliza la Processing Entity para compensar y liquidar pagos con otras entidades financieras. Un Serviced Agent usa la Processing Entity como intermediario.

En resumen, la relación de liquidación entre la Processing Entity y el Agent se define mediante tres atributos clave en Agent Settings:

Agent Type
Agent Role
Intra Group Flag

Cuando un agent puede facilitar el clearing y la liquidación de pagos entre la Processing Entity y otras entidades financieras, dichas instituciones deben añadirse como participants del Agent usando la estructura de datos de la industria CSM Participants. Los Participation details deben especificarse en Agent Settings para habilitar la comprobación de participación (participation check) para fines de Reachability de la contraparte.

Agent Settings es la configuración dinámica de tipo Processing Data que contiene los detalles del Agent (nombre, identificadores de la industria por los que se conoce al Agent, datos de dirección y los participation details).

Dynamic Configuration Properties

Name	Description
ProcessingEntity	The Processing entity namespace from IPF implementation / deployment point of view.
AgentUniqueId	A unique identifier assigned by the Processing Entity to the Agent
AgentName	Name of the agent
AgentIdentifiers	Industry identifiers for the agent. At least one identifier type should be specified
+ Identifier	The Identifier value for the Agent
+ 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.
AgentType	Type of the Agent (Refer agent type definitions above)
AgentRoles
+ ServicedAgent	The flag indicates whether the agent can be a serviced agent. The value true indicates that the Processing Entity is servicing the agent and the agent can use settlement relationship with the Processing entity to clear and settle the payments with other agents.
+ IntermediaryAgent	The flag indicates whether the agent is an intermediary agent for the processing entity. The value true would mean the agent is servicing the processing entity and that the processing entity can use the settlement relationship with the agent to clear and settle the payments with other agents .
IntraGroup	The flag identifies whether the agent is part of the banking the same banking group as that of the processing entity. A value False will mean the agent is an external entity.
ParticipationDetails
+ ParticipantCSMAgentId	The CSM Agent ID on the CSM Participant Records.
+ ParticipantIdentifierType	The identifier type value to be used for reachability checks for the agent. The enum list is extensible for client implementations. Default possible values are: BIC LEI NCC
+ ParticipantIdentifierSubType	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.
+ 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
AgentAddress	The address of the Agent. The address fields follow ISO20022 aligned address structure.
+ AddressType	ISO20022 defined address types. Supported values: ADDR, PBOX, HOME, BIZZ, MLTO, DLVY
+ Department	Department name
+ SubDepartment	SubDepartment name.
+ StreetName	Street name
+ BuildingNumber	Building number
+ BuildingName	Building Name
+ Floor	Floor
+ PostBox	Post box
+ Room	Room
+ PostCode	Post code
+ TownName	This can be a Town Name or name of the City.
+ TownLocationName	Town location name
+ DistrictName	District Name
+ CountrySubDivision	country subdivision
+ Country	ISO 3166 Alpha 2 Country Code
+ AddressLines	List of address lines
AgentEmail	Email of Agent
AgentPhoneNumber	Phone number of Agent. Support special characters. Regex: [0-9]{1,3}-[0-9()\-]{1,30}

Name

Description

ProcessingEntity

The Processing entity namespace from IPF implementation / deployment point of view.

AgentUniqueId

A unique identifier assigned by the Processing Entity to the Agent

AgentName

Name of the agent

AgentIdentifiers

Industry identifiers for the agent. At least one identifier type should be specified

+ Identifier

The Identifier value for the Agent

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

AgentType

Type of the Agent (Refer agent type definitions above)

AgentRoles

+ ServicedAgent

The flag indicates whether the agent can be a serviced agent. The value true indicates that the Processing Entity is servicing the agent and the agent can use settlement relationship with the Processing entity to clear and settle the payments with other agents.

+ IntermediaryAgent

The flag indicates whether the agent is an intermediary agent for the processing entity. The value true would mean the agent is servicing the processing entity and that the processing entity can use the settlement relationship with the agent to clear and settle the payments with other agents .

IntraGroup

The flag identifies whether the agent is part of the banking the same banking group as that of the processing entity. A value False will mean the agent is an external entity.

ParticipationDetails

+ ParticipantCSMAgentId

The CSM Agent ID on the CSM Participant Records.

+ ParticipantIdentifierType

The identifier type value to be used for reachability checks for the agent. The enum list is extensible for client implementations.

Default possible values are:

BIC

LEI

NCC

+ ParticipantIdentifierSubType

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.

+ 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

AgentAddress

The address of the Agent. The address fields follow ISO20022 aligned address structure.

+ AddressType

ISO20022 defined address types.

Supported values: ADDR, PBOX, HOME, BIZZ, MLTO, DLVY

+ Department

Department name

+ SubDepartment

SubDepartment name.

+ StreetName

Street name

+ BuildingNumber

Building number

+ BuildingName

Building Name

+ Floor

Floor

+ PostBox

Post box

+ Room

Room

+ PostCode

Post code

+ TownName

This can be a Town Name or name of the City.

+ TownLocationName

Town location name

+ DistrictName

District Name

+ CountrySubDivision

country subdivision

+ Country

ISO 3166 Alpha 2 Country Code

+ AddressLines

List of address lines

AgentEmail

Email of Agent

AgentPhoneNumber

Phone number of Agent. Support special characters.

Regex: [0-9]{1,3}-[0-9()\-]{1,30}

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 = "agentsettings"

Searchable Fields

Searchable fields for Agent Settings are:

agentUniqueId
identifier
identifierType
identifierSubType
country

Indexes

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

ipf.dps.mongodb.index-config.agentsettings{
    index-1 = ["status:ASC"]
    index-2 = ["processingEntity:ASC"]
    index-3 = ["values.payload.agentUniqueId:ASC"]
    index-4 = ["values.payload.agentIdentifiers.identifier:ASC"]
    index-5 = ["values.payload.agentIdentifiers.identifierType:ASC"]
    index-6 = ["values.payload.agentAddress.country: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.agent-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.agent-settings-settings = true

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