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

# Disparar Poller de TED IN

> Use este endpoint para forçar um ciclo imediato de polling JD de entrada para o tenant atual. Este é um endpoint operacional destinado a acelerar o recebimento de mensagens de retorno do JD sem aguardar o intervalo de polling agendado. Não requer o cabeçalho `X-Organization-Id` — o tenant é derivado do contexto autenticado.

Reentregas com a mesma chave reproduzem a resposta em cache em vez de drenar o JD novamente. Uma duplicação em voo é rejeitada com 409 pelo middleware de idempotência no nível da rota.



## OpenAPI

````yaml pt/openapi/v3-current/ted.yaml post /v1/transfers/ted-in/poll
openapi: 3.0.3
info:
  title: API do Plugin de Transferência Bancária (TED)
  description: >-
    API completa para transferências bancárias brasileiras (TED OUT, TED IN,
    P2P) através da plataforma Lerian, incluindo iniciação de transferências,
    processamento, acompanhamento de status e cancelamento.
  version: 1.1.9
servers:
  - url: https://plugin-br-bank-transfer.sandbox.lerian.net
    description: Sandbox (placeholder — ainda não disponível para acesso público)
security:
  - BearerAuth: []
tags:
  - name: Transfers API
    description: Endpoints para iniciar, processar, acompanhar e cancelar transferências.
  - name: Webhooks
    description: >-
      Endpoints para registrar e gerenciar assinaturas de webhook com escopo de
      tenant para eventos de transferência.
  - name: Webhook DLQ
    description: >-
      Endpoints para inspecionar e reprocessar mensagens da dead-letter queue de
      webhooks.
paths:
  /v1/transfers/ted-in/poll:
    post:
      tags:
        - Transfers API
      summary: Disparar Poller de TED IN
      description: >-
        Use este endpoint para forçar um ciclo imediato de polling JD de entrada
        para o tenant atual. Este é um endpoint operacional destinado a acelerar
        o recebimento de mensagens de retorno do JD sem aguardar o intervalo de
        polling agendado. Não requer o cabeçalho `X-Organization-Id` — o tenant
        é derivado do contexto autenticado.


        Reentregas com a mesma chave reproduzem a resposta em cache em vez de
        drenar o JD novamente. Uma duplicação em voo é rejeitada com 409 pelo
        middleware de idempotência no nível da rota.
      operationId: triggerTEDInPoller
      parameters:
        - $ref: '#/components/parameters/XIdempotencyKey'
      responses:
        '200':
          description: >-
            Indica que o ciclo de polling foi concluído. O campo `outcome`
            reporta o resultado do ciclo: `success`, `empty`,
            `skipped_outside_window`, `skipped_busy`, `cancelled` ou `error`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TEDInPollResponse'
              examples:
                success:
                  summary: Ciclo drenou 3 mensagens
                  value:
                    outcome: success
                    processed: 3
                empty:
                  summary: Nada a processar
                  value:
                    outcome: empty
                    processed: 0
                error:
                  summary: O ciclo falhou antes de o tenant ser resolvido
                  value:
                    outcome: error
                    processed: 0
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: >-
            Indica que nenhum tenant/configuração de poller foi encontrado para
            o contexto autenticado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          $ref: '#/components/responses/TEDInPollerBusy'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
components:
  parameters:
    XIdempotencyKey:
      name: X-Idempotency
      in: header
      required: true
      description: >-
        Chave de idempotência obrigatória para tentativas seguras. Use um UUID
        v4 ou identificador de negócio único. Se a mesma chave for enviada
        novamente e a solicitação original já tiver sido processada, a resposta
        em cache será retornada.


        Consulte [Tentativas e idempotência](/pt/reference/retries-idempotency)
        para detalhes.
      schema:
        type: string
        maxLength: 255
      example: 019c96a0-aa10-7abc-d1e2-8c9d0e1f2a3b
  schemas:
    TEDInPollResponse:
      type: object
      required:
        - outcome
        - processed
      properties:
        outcome:
          type: string
          enum:
            - success
            - empty
            - skipped_outside_window
            - skipped_busy
            - cancelled
            - error
          description: >-
            Rótulo do resultado do ciclo. `success` e `empty` são caminhos
            felizes terminais; `skipped_*` indica que o ciclo não foi executado;
            `cancelled` e `error` indicam trabalho abortado.
          example: success
        processed:
          type: integer
          minimum: 0
          description: >-
            Número de mensagens de entrada drenadas e processadas durante este
            ciclo.
          example: 3
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - service
            - category
            - message
            - requestId
          properties:
            code:
              type: string
              description: >-
                O código de erro estável. Erros do plugin usam o formato
                `BTF-XXXX`; rejeições de negócio/autenticação do JD SPB repassam
                o código bruto do fornecedor literalmente (por exemplo, `AAC90`,
                `ACE95`, `DVE01`), e falhas de transporte no nível do JD expõem
                os marcadores sintéticos `TRANSPORT` ou `JD_MISSING_CODE`. Faça
                a correspondência com base neste valor, e não no status HTTP.
              example: BTF-0010
            service:
              type: string
              description: O serviço ou domínio que produziu o erro.
              example: plugin
            category:
              type: string
              description: >-
                Categoria de erro legível por máquina usada para decisões de
                reprocessamento.
              enum:
                - deterministic
                - transient
                - rate_limit
                - plugin
              example: deterministic
            message:
              type: string
              description: Um resumo do erro legível por humanos.
              example: >-
                Transferências só podem ser iniciadas de segunda a sexta entre
                06:30 e 17:00 horário de Brasília
            requestId:
              type: string
              description: O ID de correlação da requisição. Presente mesmo quando vazio.
              example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            fields:
              type: object
              additionalProperties: true
              description: >-
                Metadados estruturados de validação ou reprocessamento quando
                disponíveis. Detalhes de validação em nível de campo, cabeçalho,
                caminho e consulta são todos retornados aqui.
              example:
                currentTime: '2026-02-01T18:30:00-03:00'
                operatingHours: Mon-Fri 06:30-17:00 UTC-3
  responses:
    BadRequest:
      description: >-
        Indica que a requisição contém entrada inválida. Verifique os detalhes
        do campo para erros de validação específicos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidInput:
              summary: Validation error
              value:
                error:
                  code: BTF-0001
                  service: plugin
                  category: deterministic
                  message: >-
                    The request contains invalid fields. Check the field details
                    below.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
                  fields:
                    recipientIspb: must be 8 digits
                    amount: must be positive
    Unauthorized:
      description: Indica que a requisição não possui um token de autenticação válido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              summary: Missing authorization
              value:
                error:
                  code: BTF-0401
                  service: plugin
                  category: deterministic
                  message: Missing or invalid authentication token
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    Forbidden:
      description: >-
        Indica que o chamador está autenticado mas não tem permissão para esta
        operação, ou o tenant não está licenciado para este endpoint.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            notLicensed:
              summary: Tenant not licensed
              value:
                error:
                  code: BTF-0403
                  service: plugin
                  category: deterministic
                  message: Tenant is not licensed to use this endpoint
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            permissionDenied:
              summary: Caller lacks permission
              value:
                error:
                  code: BTF-0405
                  service: plugin
                  category: deterministic
                  message: Caller lacks permission for this resource
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    TEDInPollerBusy:
      description: >-
        Indica que outro ciclo de polling ou reprocessamento de TED IN já está
        em andamento para este tenant.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            busy:
              summary: Cycle already in progress
              value:
                error:
                  code: BTF-0107
                  service: plugin
                  category: transient
                  message: ted in poll cycle already in progress
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    RateLimitExceeded:
      description: >-
        Indica que o limite de requisições foi excedido. Tente novamente após o
        número de segundos especificado no cabeçalho Retry-After.
      headers:
        Retry-After:
          description: Segundos até o limite de requisições ser redefinido
          schema:
            type: integer
            example: 60
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimitExceeded:
              summary: Too many requests
              value:
                error:
                  code: BTF-0429
                  service: plugin
                  category: rate_limit
                  message: >-
                    Too many requests. Retry after the interval indicated by the
                    `Retry-After` header.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
              description: >
                As respostas de rate-limit usam o código dedicado `BTF-0429` com
                a categoria `rate_limit`. Os clientes devem aplicar backoff
                usando o status HTTP `429` e o cabeçalho `Retry-After`.
    InternalServerError:
      description: Indica que ocorreu um erro interno inesperado.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Internal error
              value:
                error:
                  code: BTF-9000
                  service: plugin
                  category: plugin
                  message: Unexpected error while processing the request
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    ServiceUnavailable:
      description: >-
        Indica que um serviço externo (CRM, JD SPB, Midaz ou Fees) está
        temporariamente indisponível.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            crmUnavailable:
              summary: CRM service down
              value:
                error:
                  code: BTF-0502
                  service: crm
                  category: transient
                  message: >-
                    Unable to validate account. The CRM service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            jdUnavailable:
              summary: JD SPB unavailable
              value:
                error:
                  code: TRANSPORT
                  service: jd_spb
                  category: transient
                  message: >-
                    Unable to submit transfer. The JD SPB service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            midazUnavailable:
              summary: Midaz ledger unavailable
              value:
                error:
                  code: BTF-2000
                  service: midaz
                  category: transient
                  message: >-
                    Unable to process transfer. The Midaz ledger service is
                    temporarily unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            feeServiceUnavailable:
              summary: Fee service unavailable (fail-closed mode)
              value:
                error:
                  code: BTF-3000
                  service: fees
                  category: transient
                  message: >-
                    Unable to calculate fee. The fee service is temporarily
                    unavailable. Try again later.
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
            dlqInspectorUnavailable:
              summary: DLQ inspector not configured
              value:
                error:
                  code: BTF-9005
                  service: plugin
                  category: deterministic
                  message: DLQ inspector is not configured
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
    GatewayTimeout:
      description: >-
        Indica que a operação upstream não foi concluída antes do deadline da
        requisição.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            timeout:
              summary: Drain exceeded deadline
              value:
                error:
                  code: BTF-9000
                  service: plugin
                  category: plugin
                  message: 'trigger ted in poller: request timed out'
                  requestId: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Autenticação por token JWT Bearer. O tenantId é derivado do token bearer
        ou do contexto de requisição autenticado e não é fornecido por meio do
        X-Organization-Id.

````