Documentation for a newer release is available. View Latest

3. /iban/deconstruct

Purpose

La API IBAN Deconstruct permite deconstruir un IBAN para proporcionar detalles de la entidad que emitió el IBAN. Los detalles proporcionados en la respuesta incluyen el 'Scheme Membership BIC' asociado con el IBAN, el national clearing code, el país donde se ubica la entidad emisora, así como el IBAN National ID y el Bank Identifier según están registrados en los archivos de la industria.

Industry Reference Data

IBAN Deconstruct utiliza las configuraciones dinámicas de datos de la industria para deconstruir los IBANs. Las configuraciones dinámicas deben poblarse mediante la ingesta de los archivos de la industria relevantes proporcionados.

Old and New Configuration

IBAN Deconstruct soporta dos modos, controlados por la propiedad de configuración swift-ref-directory:

  • IBAN_Plus (por defecto): usa IBAN Plus + Exclusion List (comportamiento legado).

  • Identifiers_All: usa Party Entity Directory como fuente primaria, con IBAN Plus solo como respaldo si es necesario.

Ambos modos están soportados para asegurar continuidad con implementaciones y baterías de pruebas existentes. El valor por defecto es el antiguo (IBAN_Plus).

Industry Data Purpose Additional References

IBAN Structure Directory

La configuración dinámica proporciona la estructura de los IBANs en distintos países, incluyendo posición y longitud de los identificadores relevantes embebidos en los IBANs emitidos en esos países.

IBAN Structure Directory

IBANPlus Directory (old configuration)

The dynamic configuration provides

IBAN Plus Directory

IBAN Exclusion List (old configuration)

Column 2, row 3

Exclusion List Directory

Party Entity Directory (new configuration)

Proporciona detalles de entidades (país, identificadores, BICs) tal como están registrados en el feed SWIFTRef Identifiers_All. Usado cuando swift-ref-directory=Identifiers_All está configurado.

4. /party-entities

Usage

  1. Las implementaciones cliente pueden invocar el endpoint /iban-deconstruct para deconstruir un IBAN y obtener los detalles de la entidad que emitió el IBAN.

  2. La implementación de IBAN Deconstruct también se usa internamente por distintos servicios de CSM Reachability para deconstruir el IBAN y usar los detalles de la entidad para realizar comprobaciones de reachability o búsquedas de party entity. Los siguientes endpoints de CSM Reachability usan IBAN deconstruct internamente (Consulta CSM Reachability Operations)

    1. Validate Intra Entity Reachability

    2. Validate CSM Reachability

    3. Select CSM Agent

    4. Party Entities

    5. Determine Processing Entity

Request and Response

IBAN Deconstruct 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

IBAN

The IBAN to be validated and deconstructed

Response

Response Property Description

entityCountry

Indica el país en el que se ubica la entidad que mantiene el IBAN. En modo Identifiers_All, se deriva de Party Entity. En modo IBAN_Plus, se deriva de IBAN Plus.

ibanCountry

Una lista de identificadores derivados del IBAN. - En modo Identifiers_All, BIC y NCC se obtienen principalmente de Party Entity. - En modo IBAN_Plus, se obtienen del directorio IBAN Plus. El mapeo de subtipos de NCC se mantiene consistente en ambos modos.

bankIdentifier

El bankIdentifier según está definido en IBANPlus Directory.

ibanNationalId

ibanNationalId según está definido en IBANPlus Directory.

entityIdentifiers (*)

1. Lista de identificadores derivados del IBAN usando las configuraciones dinámicas IBANPlus e IBAN Structure. Los tipos de identificador devueltos son de tipo BIC y NCC.

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 entidad asociada con el IBAN.

+IdentifierType

Tipo asociado con el identificador de la entidad.

+identifierSubType

Subtipo del tipo de identificador devuelto.

Notes

  1. La deconstrucción de IBAN se basa en los datos de la industria proporcionados por SWIFTRef.

    • En modo IBAN_Plus: se requieren IBAN Structure, IBAN Plus y Exclusion List.

    • En modo Identifiers_All: se requieren IBAN Structure y Party Entity Directory, usando IBAN Plus solo como respaldo.

  2. Si las entidades emisoras de IBAN no están registradas en IBAN Plus o Party Entity, podría no ser posible deconstruir el IBAN. Hay una excepción: los IBANs emitidos por Suiza (CH), donde la deconstrucción sigue siendo posible para sistemas de pago domésticos.

  3. Algunos países no emiten NCCs ya que los números de cuenta son asignados por bancos centrales. En estos casos, no se devolverán NCCs.

  4. Mapeo de subtipos NCC (códigos alineados con ISO20022):

IBAN Country Code NCC SUbType (ISO20022 Aligned)

AT

ATBLZ

CH

CHBCC

DE

DEBLZ

GB

GBDSC

IE

IENCC

MZ

MZBMO