> ## 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.

# Testar as credenciais da conexão de agregador

> Executa uma verificação de conectividade ao vivo para uma conexão de agregador de dados Open-Finance (Pluggy/Belvo) existente usando sua credencial já selada, endereçada por (vendor, configName). Nenhuma credencial é fornecida ou retornada: o resultado é o booleano de saúde livre de segredos da conexão.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml post /v1/discovery/aggregator-connections/test
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/discovery/aggregator-connections/test:
    post:
      tags:
        - Discovery
      summary: Testar as credenciais da conexão de agregador
      description: >-
        Executa uma verificação de conectividade ao vivo para uma conexão de
        agregador de dados Open-Finance (Pluggy/Belvo) existente usando sua
        credencial já selada, endereçada por (vendor, configName). Nenhuma
        credencial é fornecida ou retornada: o resultado é o booleano de saúde
        livre de segredos da conexão.
      operationId: testAggregatorConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestAggregatorConnectionRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestAggregatorConnectionResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Erro
      security:
        - BearerAuth: []
components:
  schemas:
    TestAggregatorConnectionRequest:
      additionalProperties: false
      properties:
        configName:
          description: >-
            Nome da configuração da conexão de agregador existente a testar (com
            escopo de tenant)
          examples:
            - pluggy-main
          minLength: 1
          type: string
        vendor:
          description: 'Fornecedor de agregador: pluggy ou belvo'
          enum:
            - pluggy
            - belvo
          examples:
            - pluggy
          type: string
      required:
        - vendor
        - configName
      type: object
    TestAggregatorConnectionResponse:
      additionalProperties: false
      properties:
        configName:
          description: Nome da configuração da conexão que foi testada
          examples:
            - pluggy-main
          type: string
        healthy:
          description: >-
            Se a verificação de conectividade ao vivo passou com a credencial
            selada
          examples:
            - true
          type: boolean
        vendor:
          description: Fornecedor de agregador ao qual a conexão testada está vinculada
          enum:
            - pluggy
            - belvo
          examples:
            - pluggy
          type: string
      required:
        - vendor
        - configName
        - healthy
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina com escopo
            no serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            Uma explicação legível por humanos específica para esta ocorrência
            do problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalhes de erro individuais
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            Uma referência URI que identifica a ocorrência específica do
            problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível por humanos do tipo do problema. Este
            valor não deve mudar entre ocorrências do erro.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: >-
            Uma referência URI para documentação legível por humanos sobre o
            erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: 'Onde o erro ocorreu, ex.: ''body.items[3].tags'' ou ''path.thing-id'''
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor na localização informada
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````