openapi: 3.0.1
info:
  x-logo:
    url: https://s3.amazonaws.com/static.khipu.com/buttons/2024/200x75-white.png
  license:
    name: Khipu Open Data API
    url: https://khipu.com
  title: CEN HUB
  description: ''
  version: v1.0
servers:
  - url: https://api.khipu.com
    description: Production
paths:
  /v1/cl/services/cenhub.cl/token:
    post:
      summary: Account Link
      deprecated: true
      description: >-
        **Este método se está descontinuando y se retirará en los próximos
        meses. Migre su implementación actual para usar [tokens
        OAuth](https://docs.khipu.com/portal/es/authentication) en su lugar.**


        Este método se conecta a la cuenta del usuario en **CEN HUB** y retorna
        un token  vinculado a esa cuenta que puede ser usado en operaciones
        futuras, evitando la necesidad de enviar  sus credenciales en texto
        plano al llamar a los servicios bancarios.
      operationId: AccountLink
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthCredential'
        required: true
      responses:
        '200':
          description: >-
            Operación exitosa. Retorna un objeto JSON con el token de la cuenta
            en el campo `Data`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponseOk'
        '400':
          description: Solicitud Incorrecta
        '401':
          description: No autorizado - Credenciales inválidas o faltantes
        '404':
          description: No encontrado - Recurso no disponible
        '500':
          description: Error en el servicio remoto :(
  /v1/cl/services/cenhub.cl/hub/nonconformities-list:
    post:
      summary: Nonconformties List
      description: >-
        Este método se conecta a la plataforma del **Coordinador Eléctrico
        Nacional (CEN)** y obtiene la lista de disconformidades correspondientes
        a los filtros utilizados como parámetros. Retorna los datos resultantes
        de las disconformidades en formato JSON.


        El uso del campo `CallbackUrl` desencadenará un proceso asíncrono y los
        datos resultantes se enviarán más tarde al webhook especificado. Esta es
        la forma preferida de interactuar con nuestros servicios, ya que asegura
        que se harán todos los esfuerzos para extraer los datos y cumplir  con
        su solicitud dentro de un plazo razonable. Si desea la respuesta de
        inmediato, omita el campo `CallbackUrl` pero tenga en cuenta que puede
        provocar tiempos de espera dependiendo del tamaño del resultado de los
        datos y las condiciones de la red.
      operationId: HubNonconformitiesList
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HubNonconformitiesListRequest'
        required: true
      responses:
        '200':
          description: Operación exitosa. Retorna un objeto JSON con los datos solicitados.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubNonconformitiesListResponseSyncOk'
        '202':
          description: >-
            Operación exitosa. Retorna un mensaje JSON informando el resultado
            de la operación solicitada. La respuesta completa, con el mismo
            esquema que la versión síncrona, se enviará al URL de callback
            proporcionado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HubNonconformitiesListResponseAsync'
        '400':
          description: Solicitud incorrecta
        '401':
          description: No autorizado - Credenciales inválidas o faltantes
        '404':
          description: No encontrado - Recurso no disponible
        '500':
          description: Error en el servicio remoto :(
security:
  - JWT: []
  - Api-Key: []
components:
  securitySchemes:
    JWT:
      type: http
      scheme: bearer
      bearerFormat: JWT
    Api-Key:
      type: apiKey
      in: header
      name: x-api-key
  schemas:
    AuthCredential:
      title: AccountAuthCredential
      description: Valores necesarios para autenticar al usuario en el sitio web.
      properties:
        Username:
          description: >-
            Identificación del usuario con acceso a la cuenta en el sitio web
            (RUN, DNI).
          example: 11.111.111-1
          type: string
          maxLength: 12
          minLength: 1
        Password:
          description: Contraseña de la cuenta para el sitio web.
          example: wxyz1234!@#$
          type: string
          maxLength: 24
          minLength: 1
      required:
        - Username
        - Password
      type: object
    TokenResponseOk:
      additionalProperties: false
      description: >-
        Objeto con la respuesta desde el servicio OpenData, en modo Sincrónico,
        cuando `Status` es "OK"
      properties:
        OperationId:
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
          type: string
          maxLength: 36
        Status:
          description: >-
            Estado de la operación. `OK` significa que el servicio se ha
            ejecutado correctamente aunque no devuelva datos. `ERROR` indica que
            ha ocurrido algo que ha impedido la finalización con éxito del
            proceso.
          example: OK
          type: string
          enum:
            - OK
            - ERROR
        Data:
          description: >-
            Si la autenticación se ha realizado correctamente, incluye el
            'Account Link' para la cuenta.
          properties:
            AccountLink:
              description: Token generado para acceder a la cuenta del sitio web.
              example: >-
                dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB==
              type: string
          required:
            - AccountLink
          type: object
        AdditionalInformation:
          description: >-
            Este campo puede utilizarse para mostrar información relevante
            específica de la respuesta, por ejemplo indicando que el campo
            `Data` está incompleto.
          example: null
          type: string
          nullable: true
        Error:
          description: >-
            Objeto con los detalles del error, utilizado cuando `Status=ERROR`.
            Si `Status=OK` este campo será nulo. Puede leer una explicación
            completa de este objeto visitando [este
            enlace](https://docs.khipu.com/portal/en/errors/)
          example: null
          properties:
            Code:
              description: Código interno del sistema que identifica el error.
              example: E201
              type: string
            Type:
              description: >-
                Indica cómo tratar este código de error específico, en función
                del tipo de error.
              example: RETRY_IMMEDIATELY
              type: string
              enum:
                - RETRY_IMMEDIATELY
                - DO_NOT_RETRY
                - WAIT_4_HOURS_BEFORE_RETRY
                - RETRY_AFTER_NOTIFICATION
            Description:
              description: Descripción asociada al código de error.
              example: >-
                El servicio destino utilizado para la extracción de datos no se
                encuentra disponible.
              type: string
          required: []
          type: object
          nullable: true
        LifeSpan:
          description: '`null` en peticiones sincrónicas.'
          example: null
          type: string
          nullable: true
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      type: object
    HubNonconformitiesListRequest:
      additionalProperties: false
      description: Objeto para realizar una solicitud al servicio OpenData.
      properties:
        RequestData:
          additionalProperties: false
          description: >-
            Información necesaria para conectarse a la cuenta del usuario en el
            sitio web y extraer datos. Los campos obligatorios indican los
            valores necesarios para identificar la cuenta deseada.
          properties:
            FechaCreacionDelCasoDesde:
              type: string
              description: Fecha inicial para filtrar los casos (MM/DD/YYYY).
              example: 11/14/2019
            FechaCreacionDelCasoHasta:
              type: string
              description: Fecha final para filtrar los casos (MM/DD/YYYY).
              example: 11/05/2025
            RutDeudor:
              type: string
              description: RUT del deudor sin puntos ni guion.
              example: '76999999'
            Filas:
              type: string
              description: Cantidad de resultados que se mostrarán por página.
              example: '200'
            Paginas:
              type: string
              description: >-
                Define qué grupo de resultados se mostrará. Por ejemplo, si cada
                página muestra 200 resultados ('filas' = 200), la página 0
                mostrará los primeros 200, la página 1 los siguientes 200, y así
                sucesivamente.
              example: '0'
            AccountCredential:
              deprecated: true
              description: >-
                Atención: El uso de este campo es obligatorio cuando se utiliza
                autenticación por Api Key.
              oneOf:
                - title: AccountLinkCredential
                  description: >-
                    Utilice este valor para llamar al servicio utilizando el
                    'Account Link' previamente generado.
                  properties:
                    AccountLink:
                      description: Token generado para acceder a la cuenta del sitio web.
                      example: >-
                        dFyRCVYNM0aGb1LSR/0B8e+eSVr1Zf1xj9YHmMVoiZWk28XtWEyIxEbGXnr1EdvS+QBPzjweau7tbf5QlDv97IQ2jwfUB==
                      type: string
                  required:
                    - AccountLink
                  type: object
                - title: AccountAuthCredential
                  description: >-
                    Valores necesarios para autenticar al usuario en el sitio
                    web.
                  properties:
                    Username:
                      description: >-
                        Identificación del usuario con acceso a la cuenta en el
                        sitio web (RUN, DNI).
                      example: 11.111.111-1
                      type: string
                      maxLength: 12
                      minLength: 1
                    Password:
                      description: Contraseña de la cuenta para el sitio web.
                      example: wxyz1234!@#$
                      type: string
                      maxLength: 24
                      minLength: 1
                  required:
                    - Username
                    - Password
                  type: object
          required:
            - FechaCreacionDelCasoDesde
            - FechaCreacionDelCasoHasta
            - RutDeudor
            - Filas
            - Paginas
          type: object
        CallbackUrl:
          description: URL para enviar el mensaje de respuesta utilizando un método POST.
          example: https://my-api.my-business.com/api/open-data-response
          type: string
          maxLength: 255
      required:
        - RequestData
      type: object
    HubNonconformitiesListResponseSyncOk:
      additionalProperties: false
      description: >-
        Objeto con la respuesta desde el servicio OpenData, en modo Sincrónico,
        cuando `Status` es "OK"
      properties:
        OperationId:
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
          type: string
          maxLength: 36
        Status:
          description: >-
            Estado de la operación. `OK` significa que el servicio se ha
            ejecutado correctamente aunque no devuelva datos. `ERROR` indica que
            ha ocurrido algo que ha impedido la finalización con éxito del
            proceso.
          example: OK
          type: string
          enum:
            - OK
            - ERROR
        Data:
          additionalProperties: false
          type: object
          required:
            - NonconformitiesList
          properties:
            NonconformitiesList:
              type: object
              description: >-
                Contenedor de disconformidades retornadas por el servicio del
                Coordinador Eléctrico Nacional (CEN) para los filtros aplicados.
              required:
                - Disconformidades
                - TotalDisconformidades
              example:
                TotalDisconformidades: 4575
                Disconformidades: []
              properties:
                TotalDisconformidades:
                  type: integer
                  description: >-
                    Número total de disconformidades retornadas para los filtros
                    aplicados.
                  example: 4575
                Disconformidades:
                  type: array
                  description: >-
                    Lista de disconformidades que coinciden con los filtros
                    proporcionados.
                  example:
                    - FechaCreacionDelCasoHasta: 2021-08-11T08:43:21-0400
                      Nemotecnico: '[DISC_1833][P][SEN_[TEE_][Jun21][L][V01]][2881803]'
                      RutAcreedor: '96637520'
                      RazonSocialAcreedor: Empresa Eléctrica Capullo S.A.
                      RutDeudor: '76919070'
                      RazonSocialDeudor: NORVIND S.A.
                      TipodeDisconformidad1: Pago
                      MontoBrutoInstruccionDePago: 1113283
                      SaldoPendiente: 1113283
                      NumeroDeDisconformidad:
                        IDCaso: '3524'
                        NumeroDeDisconformidad: DISC_1833
                      FechaCierreCaso: 2021-08-30T12:03:59-0400
                      FechaDeVencimientoDesde: 2021-08-23T07:30:22-0400
                      DisconformidadAbiertaPor: Acreedor
                      TipoDeDisconformidad2: Pago
                      CodigoNemotecnico: ''
                      IdInstruccionDePagoPP: '2881803'
                      EstadoDeFacturacion: Facturado
                      EstadoDePago: No Pagado
                      EnEsperaDeEjecucion: ''
                      Estado: Cerrada
                      FechaSolicitudCierre: ''
                      DeudorSolicitaCierre: ''
                      AcreedorSolicitaCierre: ''
                      CierreAprobado: Si
                      CierreAutomatico: ''
                  items:
                    type: object
                    required:
                      - FechaCreacionDelCasoHasta
                      - Nemotecnico
                      - RutAcreedor
                      - RazonSocialAcreedor
                      - RutDeudor
                      - RazonSocialDeudor
                      - TipodeDisconformidad1
                      - MontoBrutoInstruccionDePago
                      - SaldoPendiente
                      - NumeroDeDisconformidad
                      - FechaCierreCaso
                      - FechaDeVencimientoDesde
                      - DisconformidadAbiertaPor
                      - TipoDeDisconformidad2
                      - CodigoNemotecnico
                      - IdInstruccionDePagoPP
                      - EstadoDeFacturacion
                      - EstadoDePago
                      - EnEsperaDeEjecucion
                      - Estado
                      - FechaSolicitudCierre
                      - DeudorSolicitaCierre
                      - AcreedorSolicitaCierre
                      - CierreAprobado
                      - CierreAutomatico
                    properties:
                      FechaCreacionDelCasoHasta:
                        type: string
                        description: >-
                          Límite superior de la fecha/hora de creación del caso
                          (ISO 8601 con zona).
                        example: 2021-08-11T08:43:21-0400
                      Nemotecnico:
                        type: string
                        description: >-
                          Cadena nemotécnica mostrada por el portal para el
                          caso/instrucción.
                        example: '[DISC_1888][P][SEN_[TEE_][Jun21][L][V01]][2888888]'
                      RutAcreedor:
                        type: string
                        description: RUT del acreedor sin formato.
                        example: '988888888'
                      RazonSocialAcreedor:
                        type: string
                        description: Razón social del acreedor.
                        example: Empresa Ejemplo
                      RutDeudor:
                        type: string
                        description: RUT del deudor sin formato.
                        example: '76999999'
                      RazonSocialDeudor:
                        type: string
                        description: Razón social del deudor.
                        example: Empresa Ejemplo
                      TipodeDisconformidad1:
                        type: string
                        description: Tipo de disconformidad principal.
                        example: Pago
                      MontoBrutoInstruccionDePago:
                        type: integer
                        description: >-
                          Monto bruto de la instrucción de pago relacionada
                          (CLP, sin formato).
                        example: 1111111
                      SaldoPendiente:
                        type: integer
                        description: >-
                          Saldo pendiente de la disconformidad (CLP, sin
                          formato).
                        example: 1111111
                      NumeroDeDisconformidad:
                        type: object
                        description: Identificadores del caso y de la disconformidad.
                        required:
                          - IDCaso
                          - NumeroDeDisconformidad
                        example:
                          IDCaso: '3524'
                          NumeroDeDisconformidad: DISC_8888
                        properties:
                          IDCaso:
                            type: string
                            description: Identificador interno del caso.
                            example: '3524'
                          NumeroDeDisconformidad:
                            type: string
                            description: Número de disconformidad mostrado.
                            example: DISC_8888
                      FechaCierreCaso:
                        type: string
                        description: >-
                          Fecha/hora de cierre del caso (ISO 8601 con zona) o
                          vacío si está abierto.
                        example: 2021-08-30T12:03:59-0400
                      FechaDeVencimientoDesde:
                        type: string
                        description: >-
                          Fecha/hora de vencimiento desde la cual aplica la
                          disconformidad (ISO 8601 con zona).
                        example: 2021-08-23T07:30:22-0400
                      DisconformidadAbiertaPor:
                        type: string
                        description: Parte que abrió la disconformidad.
                        example: Acreedor
                      TipoDeDisconformidad2:
                        type: string
                        description: Tipo de disconformidad secundario.
                        example: Pago
                      CodigoNemotecnico:
                        type: string
                        description: >-
                          Código nemotécnico asociado a la instrucción o entidad
                          (puede venir vacío).
                        example: ''
                      IdInstruccionDePagoPP:
                        type: string
                        description: >-
                          Identificador de la instrucción de pago relacionada en
                          el portal/proveedor.
                        example: '9999999'
                      EstadoDeFacturacion:
                        type: string
                        description: Estado de facturación mostrado por el portal.
                        example: Facturado
                      EstadoDePago:
                        type: string
                        description: Estado de pago mostrado por el portal.
                        example: No Pagado
                      EnEsperaDeEjecucion:
                        type: string
                        description: Indicador de espera de ejecución (puede venir vacío).
                        example: ''
                      Estado:
                        type: string
                        description: Estado general del caso.
                        example: Cerrada
                      FechaSolicitudCierre:
                        type: string
                        description: >-
                          Fecha/hora en que se solicitó el cierre (ISO 8601 con
                          zona) o vacío.
                        example: ''
                      DeudorSolicitaCierre:
                        type: string
                        description: >-
                          Si el deudor solicitó el cierre (p. ej., Si/No) o
                          vacío.
                        example: ''
                      AcreedorSolicitaCierre:
                        type: string
                        description: >-
                          Si el acreedor solicitó el cierre (p. ej., Si/No) o
                          vacío.
                        example: ''
                      CierreAprobado:
                        type: string
                        description: Si el cierre fue aprobado (p. ej., Si/No) o vacío.
                        example: Si
                      CierreAutomatico:
                        type: string
                        description: Si el cierre fue automático (p. ej., Si/No) o vacío.
                        example: ''
          nullable: true
        AdditionalInformation:
          description: >-
            Este campo puede utilizarse para mostrar información relevante
            específica de la respuesta, por ejemplo indicando que el campo
            `Data` está incompleto.
          example: null
          type: string
          nullable: true
        Error:
          description: >-
            Objeto con los detalles del error, utilizado cuando `Status=ERROR`.
            Si `Status=OK` este campo será nulo. Puede leer una explicación
            completa de este objeto visitando [este
            enlace](https://docs.khipu.com/portal/en/errors/)
          example: null
          properties:
            Code:
              description: Código interno del sistema que identifica el error.
              example: E201
              type: string
            Type:
              description: >-
                Indica cómo tratar este código de error específico, en función
                del tipo de error.
              example: RETRY_IMMEDIATELY
              type: string
              enum:
                - RETRY_IMMEDIATELY
                - DO_NOT_RETRY
                - WAIT_4_HOURS_BEFORE_RETRY
                - RETRY_AFTER_NOTIFICATION
            Description:
              description: Descripción asociada al código de error.
              example: >-
                El servicio destino utilizado para la extracción de datos no se
                encuentra disponible.
              type: string
          required: []
          type: object
          nullable: true
        LifeSpan:
          description: '`null` en peticiones sincrónicas.'
          example: null
          type: string
          nullable: true
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      type: object
    HubNonconformitiesListResponseAsync:
      type: object
      description: Objeto con la respuesta del servicio OpenData, en modo asíncrono.
      required:
        - OperationId
        - Status
        - Data
        - AdditionalInformation
        - Error
        - LifeSpan
      properties:
        OperationId:
          maxLength: 36
          type: string
          description: Identificador único de la operación.
          example: 6baf6c19-e485-463b-ae24-a821b025c8a4
        Status:
          type: string
          description: >-
            Estado de la operación. Al realizar solicitudes asíncronas, siempre
            devolverá `OK`.
          example: OK
        Data:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        AdditionalInformation:
          type: string
          description: >-
            Mensaje de la operación, puede usarse para mostrar información
            adicional.
          example: Data will be sent to the callback URL.
        Error:
          type: object
          description: '`null` en solicitudes asíncronas.'
          example: null
        LifeSpan:
          type: string
          format: date-time
          description: >-
            Fecha máxima estimada de entrega para solicitudes asíncronas, en
            formato de fecha y hora ISO 8601, zona horaria UTC.
          example: 2017-07-22T00:00:00-0400
