6. /settlement-agents
Purpose
CSM Reachability service usa múltiples estructuras de datos soportadas por "Dynamic Processing Settings". Las estructuras usan DPS setting management APIs que permiten crear/actualizar/eliminar registros de forma dinámica. Los flujos de pago de implementaciones cliente pueden usar las setting management APIs; sin embargo, esto expone los flujos al riesgo de que cambien las definiciones de las estructuras de datos, ya que los atributos devueltos pueden cambiar.
Por tanto, se propone que haya 'Domain APIs' disponibles para que las implementaciones cliente recuperen configuraciones dinámicas relacionadas. Los candidatos para las 'domain APIs' son los settings relacionados con Agent y los relacionados con Processing Entity.
La domain API /settlement-agents puede ser usada por las implementaciones cliente para recuperar detalles del agent y los clearing y settlement settings asociados.
Usage
La domain API de /settlement-agents puede ser usada por los flujos de pago de implementaciones cliente para recuperar los siguientes aspectos de las configuraciones dinámicas relacionadas con un agent. (Un agent es una party con la que la processing entity mantiene una relación de liquidación).
-
Agent Settings
-
Agent Settlement Settings
-
Agent Clearing Settings
Input Request
| Level | Input Attribute | Optionality | Description |
|---|---|---|---|
1 |
ProcessingEntity |
M |
La Processing Entity para la que se requiere la información del agent. |
1 |
AgentIdentifier |
M |
Un identificador que identifica al agent de la processing entity. |
1 |
AgentIdentifierType |
M |
El tipo del identificador especificado en la petición en el campo "AgentIdentifier". Se soportan los siguientes tipos de identificador. Los agent identifiers soportados son BIC, NCC, LEI y AgentUniqueId |
1 |
AgentIdentifierSubType |
C |
El subtipo del identificador proporcionado. BIC: accountIssuingBIC, schemeMembershipBIC NCC: Los subtipos están alineados con los códigos especificados por ISO20022. |
1 |
AgentCountry |
C |
Código de país de 2 caracteres del agent. Condicionalmente obligatorio cuando IdentifierType es LEI. |
1 |
IncludeSettlementSettings |
O |
Por defecto se considera 'False' si no se especifica. Cuando se establece a True, se devolverá el registro de Agent Settlement Settings para el agent y la divisa de transferencia especificados, si está configurado. |
2 |
+TransferCurrency |
C |
Código de divisa de 3 caracteres de la divisa de transferencia del pago. Condicionalmente obligatorio cuando 'IncludeSettlementSettings' se establece en TRUE. |
2 |
+TransferDirection |
C |
Condicionalmente obligatorio cuando 'IncludeSettlementSettings' se establece en TRUE. Debe especificarse la dirección de liquidación desde el punto de vista de la processing entity. |
1 |
IncludeClearingSettings |
O |
Por defecto se considera 'False'. Cuando se establece a True, se devolverá el registro de Agent Clearing Settings para el agent especificado, si está configurado. |
Response
| Level | Attribute | Optionality | Description |
|---|---|---|---|
1 |
Agent Settings |
M |
El registro de la configuración dinámica Agent Settings devuelto si se encuentra el Agent con el AgentIdentifier de la entrada. |
1 |
Agent Settlement Settings |
O |
El registro de la configuración dinámica Agent Settlement Settings devuelto si se solicita y si se encuentra el registro con la divisa de transferencia de la entrada. |
1 |
Agent Clearing |
O |
El registro de la configuración dinámica Agent Clearing Settings devuelto si se solicita y si se encuentra el registro con el AgentIdentifier de la entrada. |
- IMPORTANT
-
-
Se devuelven las settlement settings cuya transfer direction coincide con la transfer direction de la entrada o con la transfer direction "Bidirectional", si están configuradas.
-
Agent Settlement settings pueden tener configuradas las siguientes categorías de límites:
-
Agent Limits
-
Custom Participant Limits
-
Participant Country Limits
-
-
Los límites pueden tener transfer direction "Inbound" o "Outbound"
-
Los valores de límite en Agent Settlement Settings se devuelven con la transfer direction que coincide con la entrada, si están configurados. (Se devuelven límites Inbound cuando la transfer direction de la entrada es "Inbound" y límites Outbound cuando la transfer direction de la entrada es "Outbound")
-
Consulta las especificaciones detalladas del API aquí Integration.