Saltar al contenido principal
GET
/
v1
/
transfers
/
dashboard
/
summary
Obtener resumen del dashboard
curl --request GET \
  --url https://plugin-br-bank-transfer.sandbox.lerian.net/v1/transfers/dashboard/summary \
  --header 'Authorization: Bearer <token>'
{
  "contractVersion": "v1",
  "totalTransfers": 128,
  "byStatus": [
    {
      "status": "COMPLETED",
      "count": 101
    }
  ],
  "byType": [
    {
      "type": "TED_OUT",
      "count": 97
    }
  ],
  "health": {
    "status": "UP",
    "pendingCount": 0,
    "processingCount": 7,
    "terminalCount": 121,
    "failureCount": 20,
    "terminalFailRate": 0.1653
  },
  "generatedAt": "2026-02-01T12:00:00-03:00",
  "degraded": false,
  "degradationReasons": [
    "<string>"
  ]
}

Autorizaciones

​
Authorization
string
header
requerido

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.

Encabezados

​
X-Organization-Id
string<uuid>

Alcance de organización Midaz para la solicitud. En despliegues multi-tenant este header es obligatorio. Este no es el identificador del tenant; el tenantId se deriva del JWT bearer o del contexto autenticado. En despliegues single-tenant los valores de X-Organization-Id proporcionados por el llamador son rechazados y la organización es proporcionada por SINGLE_TENANT_ORGANIZATION_ID.

Respuesta

Resumen del dashboard retornado exitosamente.

​
contractVersion
string

Versión del contrato de respuesta del dashboard.

Ejemplo:

"v1"

​
totalTransfers
integer

Número total de transferencias en el período.

Ejemplo:

128

​
byStatus
object[]

Conteo de transferencias agrupado por estado.

​
byType
object[]

Conteo de transferencias agrupado por tipo.

​
health
object

Instantánea de salud operacional.

​
generatedAt
string<date-time>

Timestamp de cuando se generó el resumen.

Ejemplo:

"2026-02-01T12:00:00-03:00"

​
degraded
boolean

Si el sistema está en estado degradado.

Ejemplo:

false

​
degradationReasons
string[]

Lista de razones de degradación cuando degraded es true.