> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Probar la conectividad con Núclea para un participante

> Envía una sonda de conectividad adecuada para el rol por el canal REST (AGEN001 para el rol DOMICILE_IF y AGEN999 para los demás roles de participante) e informa el eco de ida y vuelta y la latencia en el estado del canal nucleaApi. El parámetro de ruta es el ISPB de 8 dígitos del participante, NO el UUID de participante que usan las operaciones hermanas de /v1/participants. Devuelve 404 cuando el ISPB no corresponde a un participante del catálogo del tenant. RBAC: connectivity:test (admin). Los canales cdConnection y rsfnConnection informan NOT_CONFIGURED porque los transportes administrados de archivos y de mensajería no están disponibles actualmente. Un transporte con el circuit breaker abierto devuelve un 503 reintentable.



## OpenAPI

````yaml es/openapi/v3-current/slc.yaml post /v1/participants/{participantIspb}/test-connectivity
openapi: 3.1.0
info:
  description: >-
    API de Lerian SLC — el rail del lado del participante que conecta la
    institución con la liquidación de tarjetas por neto diferido SLC de Núclea.
    Cubre la admisión y el ciclo de vida de las operaciones de liquidación, las
    posiciones de compensación, el registro de participantes y arreglos, los
    informes generados, la consulta de esquemas XSD integrados, la recuperación
    de transmisión y la conectividad con Núclea, la importación de clave de
    firma BYOK Modelo A y los webhooks con alcance al tenant.
  title: Lerian SLC API
  version: 1.0.0
servers:
  - url: https://slc.sandbox.lerian.net
security:
  - BearerAuth: []
tags:
  - description: >-
      Ciclo de vida de las operaciones de liquidación — crea, lista, consulta y
      controla las operaciones de tarjeta rastreadas por NUliquid (NUliquid = el
      id de 21 posiciones que Núclea asigna a cada operación aceptada) a través
      de la máquina de estados.
    name: Operations
  - description: >-
      Catálogo de participantes — los adquirentes, subadquirentes, IF Domicílio
      (banco donde el establecimiento recibe sus ventas) y las IF de liquidación
      (instituciones financieras) que participan en la liquidación de tarjetas.
    name: Participants
  - description: >-
      Arreglos de tarjeta (configuraciones de bandeira/esquema, p. ej.
      Visa/Master/Elo) asociados a un participante.
    name: Arrangements
  - description: >-
      Orquestación de transporte regulado hacia Núclea/SILOC (la cámara de
      compensación privada de tarjetas que opera el sistema de liquidación
      SILOC) — despacho, recuperación, retransmisión y prueba de conectividad
      sobre transferencia de archivos gestionada, broker de mensajes y REST.
    name: Connectivity
  - description: >-
      Posiciones de compensación de neteo multilateral — el monto neto que cada
      participante liquida por ciclo STR (STR = sistema de transferencia de
      reservas del Banco Central).
    name: Clearing
  - description: >-
      Aprovisionamiento de clave de firma SaaS BYOK (Bring Your Own Key) —
      importa parámetros y registra el material del certificado ICP-Brasil A1
      del cliente (certificado de servidor de la PKI brasileña, validez de 1
      año) usado para firmar archivos ASLC; la clave privada nunca sale del
      HSM/KMS/Vault del cliente.
    name: SigningKey
  - description: >-
      Admisión y estado de archivos ASLC — envío en modo passthrough y estado de
      procesamiento de los archivos XML oficiales de liquidación de tarjetas de
      Núclea (ASLC = Arquivo do Sistema de Liquidação de Cartões).
    name: Files
  - description: >-
      Introspección de solo lectura de los esquemas XSD ASLC/RSFN (Red del
      Sistema Financiero Nacional) integrados de Núclea usados para validar los
      mensajes salientes y entrantes.
    name: XSD Schemas
  - description: >-
      Informes de liquidación regulatorios, de cumplimiento y operativos, de
      solo lectura.
    name: Reports
  - description: >-
      Suscripciones a webhooks de eventos de negocio salientes y gestión de
      entrega para los consumidores (Midaz, ledgers del cliente, Cabine — todos
      opcionales).
    name: Webhooks
  - description: >-
      Operaciones administrativas — configuración de tiempo de ejecución
      recargable en caliente, inspección/reenvío de la cola de mensajes muertos
      y redespacho del outbox.
    name: Admin
paths:
  /v1/participants/{participantIspb}/test-connectivity:
    post:
      tags:
        - Connectivity
      summary: Probar la conectividad con Núclea para un participante
      description: >-
        Envía una sonda de conectividad adecuada para el rol por el canal REST
        (AGEN001 para el rol DOMICILE_IF y AGEN999 para los demás roles de
        participante) e informa el eco de ida y vuelta y la latencia en el
        estado del canal nucleaApi. El parámetro de ruta es el ISPB de 8 dígitos
        del participante, NO el UUID de participante que usan las operaciones
        hermanas de /v1/participants. Devuelve 404 cuando el ISPB no corresponde
        a un participante del catálogo del tenant. RBAC: connectivity:test
        (admin). Los canales cdConnection y rsfnConnection informan
        NOT_CONFIGURED porque los transportes administrados de archivos y de
        mensajería no están disponibles actualmente. Un transporte con el
        circuit breaker abierto devuelve un 503 reintentable.
      operationId: testConnectivity
      parameters:
        - description: >-
            Participant ISPB (8 digits). A non-conforming value is rejected with
            400.
          in: path
          name: participantIspb
          required: true
          schema:
            description: >-
              Participant ISPB (8 digits). A non-conforming value is rejected
              with 400.
            examples:
              - '12345678'
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestConnectivityResponse'
          description: OK
        '501':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: >-
            Not Implemented: this capability is not part of this deployment.
            Operations are registered unconditionally so the published contract
            is identical across deploy shapes; when the capability behind one
            did not compose here (authentication disabled, no database, no
            outbound transport, or the feature switched off) it answers this
            coded SLC-0012 problem. It is definitive for this deployment:
            retrying does not help, and the `detail` is deliberately scrubbed
            (any status >= 500 is).
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    TestConnectivityResponse:
      additionalProperties: false
      properties:
        cdConnection:
          $ref: '#/components/schemas/ChannelStatus'
          description: >-
            managed file-transfer channel status (not yet configured:
            NOT_CONFIGURED).
        certificateExpiresAt:
          description: >-
            Signing-certificate expiry (RFC3339 UTC); not populated when
            certificate management is not configured.
          examples:
            - '2027-06-15T00:00:00Z'
          type: string
        certificateValid:
          description: >-
            Whether the signing certificate is valid (not populated when
            certificate management is not configured).
          examples:
            - true
          type: boolean
        nucleaApi:
          $ref: '#/components/schemas/ChannelStatus'
          description: >-
            Núclea REST-channel connectivity probe outcome: status is OK when
            the probe echo round-trips and DEGRADED otherwise. The probe sent is
            selected by the participant role: AGEN001 for the DOMICILE_IF (IF
            Domicílio) role, AGEN999 for other roles.
        participantId:
          description: Participant id (8-digit ISPB).
          examples:
            - '12345678'
          type: string
        rsfnConnection:
          $ref: '#/components/schemas/ChannelStatus'
          description: 'message-broker channel status (not yet configured: NOT_CONFIGURED).'
      required:
        - participantId
        - cdConnection
        - rsfnConnection
        - nucleaApi
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Stable, machine-readable domain error code scoped to the emitting
            service (format: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ChannelStatus:
      additionalProperties: false
      properties:
        latencyMs:
          description: >-
            Round-trip latency in milliseconds; omitted for channels that are
            not configured.
          examples:
            - 42
          format: int64
          type: integer
        status:
          description: >-
            Transport channel status: OK, DEGRADED, or NOT_CONFIGURED (a channel
            that is not yet available).
          examples:
            - OK
          type: string
      required:
        - status
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: JWT bearer token issued by the identity provider.
      scheme: bearer
      type: http

````