4. /party-entities
Purpose
La Party Entities API puede ser utilizada por las implementaciones cliente para consultar los datos de referencia de la industria y recuperar detalles adicionales de las parties involucradas en el pago. Los detalles devueltos incluyen otros identificadores por los que se conoce a la party, así como nombre y datos de dirección.
Los detalles recuperados mediante la API /party-entities pueden ser usados por las implementaciones cliente para propósitos de enriquecimiento de pagos.
Dynamic Configurations
La API /party-entities utiliza las siguientes configuraciones dinámicas para la recuperación de party entities.
| Dynamic Configuration | Optionality | Purpose | Reference |
|---|---|---|---|
Party Entity Directory |
Mandatory |
El Party Entity Directory contiene los registros cargados mediante datos de referencia de la industria y es la fuente de búsquedas para la API /party-entities. |
|
IBAN Plus |
Optional |
IBANPlus Directory es necesario si las implementaciones cliente desean usar identificadores de tipo IBAN para buscar registros de party entity. |
|
IBAN Structure |
Optional |
IBAN Structure Directory es necesario si las implementaciones cliente desean usar identificadores de tipo IBAN para buscar registros de party entity. |
|
Exclusion List |
Optional |
IBAN Exclusion List es necesario si las implementaciones cliente desean usar identificadores de tipo IBAN para buscar registros de party entity. |
Industry Reference Data
El Party Entity directory puede cargarse mediante cargas de datos de la industria para habilitar las búsquedas de registros de party entity. El servicio IPF CSM Reachability soporta la ingesta de los siguientes archivos de datos de referencia de la industria en Party Entity Directory.
-
SWIFTRef Bank Directory Plus
-
SIX Bank Master
Para más información sobre el mapeo desde cada archivo de referencia de la industria hacia party entity directory, consulta Party Entity Directory
Usage
-
La API /party-entities puede ser utilizada por las implementaciones cliente para recuperar detalles adicionales sobre las parties involucradas en el pago, para el enriquecimiento de identificadores/direcciones de los pagos.
-
La búsqueda de party entity también es usada por otras implementaciones del servicio en CSM Reachability para realizar búsquedas de identificadores para comprobaciones de reachability cuando las solicitudes de reachability no tienen los identificadores requeridos tal y como los usan los CSM Agents para registrar membresías en la configuración dinámica CSM Participants.
-
Los siguientes endpoints de CSM Reachability usan búsquedas de party entities internamente (Consulta CSM Reachability Operations)
-
Validate Intra Entity Reachability
-
Validate CSM Reachability
-
Select CSM Agent
-
Request and Response
/party-entities sigue la siguiente estructura de request y response. Esta sección proporciona información sobre las propiedades de request y response; para especificaciones detalladas del API, consulta CSM Reachability Service API
API Version 2
Request
| Request Property | Description |
|---|---|
entityIdentifier |
El identificador que debe usarse para buscar el registro de Entity en el Party Entity Directory. |
entityIdentifierType |
El tipo de identificador que se usa para buscar una entity. Consulta Party Identifiers Explained |
entityIdentifierSubType |
1. El subtipo del tipo de identificador que se usa para la búsqueda. 2. Para identificadores de tipo BIC, tanto ACCOUNT_ISSUING_BIC como SCHEME_MEMBERSHIP_BIC llevarán a la recuperación del identificador del registro con el valor BIC coincidente. 3. Aunque party entity directory mantiene los valores de subtipos de NCC tal como los define la fuente de datos de la industria correspondiente (p. ej., Bank Directory Plus), la API /party-entities soporta los valores de subtipos de NCC tal como se definen bajo los códigos ISO20022 External Clearing System para las búsquedas. |
entityCountry |
Código de país ISO3166-2 del registro de la entity que se consulta. entityCountry es requerido cuando se consultan registros de tipo LEI. |
entityDataSource |
La fuente de datos de la industria que debe usarse para la búsqueda del registro en Party Entity Directory. |
Response
| Response Property | Description |
|---|---|
entityUniqueId |
El ID único asignado a la entity según el mapeo desde la fuente de datos correspondiente hacia Party Entity Directory. |
entityDataSource |
Fuente de datos de la industria/personalizada que se ha usado para la búsqueda del registro de party entity. |
entityType |
El tipo de la entity cuando está disponible en Party Entity Directory. |
entityName |
Nombre de la entity según la fuente de datos de la industria/personalizada. |
entityAddress |
Dirección de la entity tal como se mapea desde la fuente de datos de la industria/personalizada. Los campos de dirección están alineados con el formato de campos de dirección especificado por ISO20022. |
entityIdentifiers (*) |
1. Lista de identificadores derivados del Party Entity Directory. Se pueden registrar múltiples identificadores del mismo tipo contra un registro (en caso de fusiones) y pueden devolverse múltiples identificadores de diferentes tipos si están registrados en Party Entity directory. 2. Consulta Party Identifiers Explained para más detalles sobre los tipos de identificador soportados en CSM Reachability Service. |
+identifier |
Valor del identificador para la entity. |
+IdentifierType |
El valor del tipo asociado con el identificador de la entity. |
+identifierSubType |
Subtipo del tipo de identificador devuelto. |
entityEmail |
Email de la entity tal como está registrado en Party Entity Directory. |
entityPhoneNumber |
El número de teléfono de la entity tal como está registrado en Party Entity Directory. |