Referencia de la API del panel
Referencia completa del endpoint de la API del panel. Úsalo para mostrar un resumen de los enlaces de pago, intents, transacciones y saldos del comercio.
URL base
https://api.orcarail.com/api/v1
Obtener el resumen del panel
Obtén un resumen del panel del usuario autenticado: totales (enlaces, intents, transacciones, USDC ganados/retirados/restantes), serie de volumen y transacciones recientes.
GET /dashboard/summary
Autenticación
- Token Bearer (JWT): obligatorio
Respuesta
{
"totals": {
"links": 12,
"intents": 8,
"transactions": 42,
"totalEarnedUsdc": "1250.50",
"withdrawnUsdc": "500.0",
"remainingUsdc": "750.5"
},
"volumeSeries": [
{
"month": "2026-01",
"transactionCount": "42"
},
{
"month": "2025-12",
"transactionCount": "38"
}
],
"recentTransactions": [
{
"id": 101,
"status": "confirmed",
"amount": "0.25",
"amountReceived": "0.25",
"createdAt": "2026-01-22T10:45:12.123Z",
"paymentLinkTitle": "Subscription January",
"paymentLinkSlug": "550e8400e29b41d4a716446655440000",
"tokenSymbol": "USDC",
"networkName": "Ethereum",
"payerTokenSymbol": "ETH",
"payerAmount": "0.0012"
}
]
}
Campos de la respuesta
| Campo | Tipo | Descripción |
|---|---|---|
totals.links | number | Número de enlaces de pago |
totals.intents | number | Número de payment intents |
totals.transactions | number | Número de transacciones |
totals.totalEarnedUsdc | string | Volumen total ganado en USDC |
totals.withdrawnUsdc | string | Total retirado en USDC |
totals.remainingUsdc | string | Saldo restante en USDC |
volumeSeries | array | Número de transacciones por mes (mes en formato YYYY-MM) |
recentTransactions | array | Transacciones recientes con el enlace de pago y la información de token y red |
Códigos de estado
| Código de estado | Descripción |
|---|---|
200 | Correcto |
401 | No autorizado |
500 | Error interno del servidor |