> ## 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. # Obtener resumen del dashboard > Retorna contadores agregados de transferencias e instantánea de salud operacional para dashboards. ## OpenAPI ````yaml es/openapi/v3-current/ted.yaml get /v1/transfers/dashboard/summary openapi: 3.0.3 info: title: API del Plugin de Transferencia Bancaria (TED) description: >- API completa para transferencias bancarias brasileñas (TED OUT, TED IN, P2P) a través de la plataforma Lerian, incluyendo iniciación de transferencias, procesamiento, seguimiento de estado y cancelación. version: 1.1.9 servers: - url: https://ted.sandbox.lerian.net description: Sandbox (marcador de posición — aún no disponible para acceso público) security: - BearerAuth: [] - OAuth2ClientCredentials: - api - OAuth2Password: - api tags: - name: Transfers API description: Endpoints para iniciar, procesar, rastrear y cancelar transferencias. - name: Webhooks description: >- Endpoints para registrar y gestionar suscripciones de webhooks con alcance al tenant para eventos de transferencia. - name: Webhook DLQ description: >- Endpoints para inspeccionar y reintentar mensajes de la dead-letter queue de webhooks. paths: /v1/transfers/dashboard/summary: get: tags: - Transfers API summary: Obtener resumen del dashboard description: >- Retorna contadores agregados de transferencias e instantánea de salud operacional para dashboards. operationId: getDashboardSummary parameters: - $ref: '#/components/parameters/XOrganizationId' responses: '200': description: Resumen del dashboard retornado exitosamente. content: application/json: schema: $ref: '#/components/schemas/DashboardSummaryResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/RateLimitExceeded' '500': $ref: '#/components/responses/InternalServerError' '503': $ref: '#/components/responses/ServiceUnavailable' components: parameters: XOrganizationId: name: X-Organization-Id in: header required: true description: >- Alcance de organización Midaz para la solicitud, utilizado para las llamadas posteriores a CRM, Fees y Midaz. Es obligatorio en las rutas de transferencia con alcance de organización en todos los modos de despliegue; un valor faltante o que no sea un UUID devuelve 400. Este no es el identificador del tenant — el tenantId se deriva del JWT bearer o del contexto autenticado, nunca de este header. Los workers en segundo plano (poller de TED IN, conciliación) no tienen header de solicitud y, en modo single-tenant, recurren a la variable de entorno `ORGANIZATION_ID` del despliegue. schema: type: string format: uuid example: 019c96a0-0a98-7287-9a31-786e0809c769 schemas: DashboardSummaryResponse: type: object properties: contractVersion: type: string description: Versión del contrato de respuesta del dashboard. example: v1 totalTransfers: type: integer description: Número total de transferencias en el período. example: 128 byStatus: type: array description: Conteo de transferencias agrupado por estado. items: type: object properties: status: type: string example: COMPLETED count: type: integer example: 101 byType: type: array description: Conteo de transferencias agrupado por tipo. items: type: object properties: type: type: string example: TED_OUT count: type: integer example: 97 health: type: object description: Instantánea de salud operacional. properties: status: type: string enum: - UP - ATTENTION - DEGRADED description: >- Estado general de salud. `UP` está sano; `ATTENTION` señala una tasa de fallos elevada; `DEGRADED` indica que el propio resumen fue calculado en estado degradado. example: UP pendingCount: type: integer example: 0 processingCount: type: integer example: 7 terminalCount: type: integer example: 121 failureCount: type: integer example: 20 terminalFailRate: type: number format: float example: 0.1653 generatedAt: type: string format: date-time description: Timestamp de cuando se generó el resumen. example: '2026-02-01T12:00:00-03:00' degraded: type: boolean description: Si el sistema está en estado degradado. example: false degradationReasons: type: array description: Lista de razones de degradación cuando degraded es true. items: type: string ErrorResponse: type: object required: - error properties: error: type: object required: - code - service - category - message - requestId properties: code: type: string description: >- El código de error estable. Los errores del plugin usan el formato `BTF-XXXX`; los rechazos de negocio/autenticación de JD SPB transmiten el código del proveedor sin modificar (p. ej. `AAC90`, `ACE95`, `DVE01`), y los fallos de JD a nivel de transporte muestran los marcadores sintéticos `TRANSPORT` o `JD_MISSING_CODE`. Haga la coincidencia sobre este valor en lugar del estado HTTP. example: BTF-0010 service: type: string description: El servicio o dominio que produjo el error. example: plugin category: type: string description: >- Categoría de error legible por máquina utilizada para las decisiones de reintento. enum: - deterministic - transient - rate_limit - plugin example: deterministic message: type: string description: Un resumen del error legible por humanos. example: >- Transfers can only be initiated Monday-Friday between 06:30 and 17:00 Brasília time requestId: type: string description: >- El ID de correlación de la solicitud. Presente incluso cuando está vacío. example: 6d3e2a68-1f2b-4c3d-9e4f-5a6b7c8d9e0f fields: type: object additionalProperties: true description: >- Metadatos estructurados de validación o reintento cuando están disponibles. Los detalles de validación a nivel de campo, encabezado, ruta y consulta se devuelven todos aquí. example: currentTime: '2026-02-01T18:30:00-03:00' operatingHours: Mon-Fri 06:30-17:00 UTC-3 responses: BadRequest: description: >- Indica que la solicitud contiene datos de entrada inválidos. Verifique los detalles del campo para errores de validación 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 la solicitud no tiene un token de autenticación 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 el llamador está autenticado pero carece de permiso para esta operación, o el tenant no 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 RateLimitExceeded: description: >- Indica que se ha excedido el límite de solicitudes. Reintente después del número de segundos especificado en el encabezado Retry-After. headers: Retry-After: description: Segundos hasta que se restablezca el límite de solicitudes 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: > Las respuestas de límite de tasa usan el código dedicado `BTF-0429` con la categoría `rate_limit`. Los clientes deben aplicar backoff usando el estado HTTP `429` y el encabezado `Retry-After`. InternalServerError: description: Indica que ocurrió un error 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 un servicio externo (CRM, JD SPB, Midaz o Fees) no está disponible temporalmente. 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 securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Autenticación mediante token JWT Bearer. El tenantId se deriva del token bearer o del contexto autenticado de la solicitud y no se proporciona a través de X-Organization-Id. OAuth2ClientCredentials: type: oauth2 flows: clientCredentials: tokenUrl: /v1/login/oauth/access_token scopes: api: Acceso a la API de transferencias TED OAuth2Password: type: oauth2 flows: password: tokenUrl: /v1/login/oauth/access_token scopes: api: Acceso a la API de transferencias TED ````