FITALAPI

Estado por capacidad

GET /v1/status

Estado de pagos, cobros, webhooks y API para tu empresa. Acepta cualquier llave válida. not_enabled indica que tu empresa no tiene esa capacidad y unknown que no hay medición reciente.

DatoValor
Método y rutaGET /v1/status
Servidorhttps://widget.fital.xyz
operationIdgetStatus
AccesoCualquier llave válida
Firma de peticiónNo aplica
IdempotenciaNo aplica

Encabezados de la petición

EncabezadoObligatorioDescripción
AuthorizationSíBearer y tu llave.
X-Fital-ScenarioNoSólo simuladores: elige la respuesta que quieres practicar.

Respuestas correctas

200 Correcto

CampoTipoObligatorioDescripción
capabilitieslista de objetoSíUna fila por capacidad.
capabilities[].idtextoSíIdentificador de la capacidad. payments_mxn: Pagos por SPEI. payments_latam: Pagos por el riel latam. payments_pix: Pagos por PIX. collections: Cobros. webhooks: Entrega de webhooks. api: La API.
capabilities[].nametextoSíNombre legible.
capabilities[].sincetexto o nullSíDesde cuándo está en ese estado. null si no se sabe.
capabilities[].statustextoSíEstado de la capacidad. operational: Funciona con normalidad. degraded: Funciona con problemas. outage: No funciona. unknown: Sin medición reciente. not_enabled: No está habilitada para tu empresa.
updated_attextoSíMomento en que se armó esta respuesta.

Valores de capabilities[].id

ValorSignificado
payments_mxnPagos por SPEI.
payments_latamPagos por el riel latam.
payments_pixPagos por PIX.
collectionsCobros.
webhooksEntrega de webhooks.
apiLa API.

El contrato lo declara como texto: trata la lista como extensible.

Valores de capabilities[].status

ValorSignificado
operationalFunciona con normalidad.
degradedFunciona con problemas.
outageNo funciona.
unknownSin medición reciente.
not_enabledNo está habilitada para tu empresa.
{
  "capabilities": [
    {
      "id": "payments_mxn",
      "name": "Pagos MXN",
      "since": "2026-11-04T10:00:00.000Z",
      "status": "operational"
    },
    {
      "id": "payments_pix",
      "name": "Pagos PIX",
      "since": null,
      "status": "not_enabled"
    }
  ],
  "updated_at": "2026-11-04T18:00:00.000Z"
}

Variante status_degraded:

{
  "updated_at": "2026-11-04T18:00:00.000Z",
  "capabilities": [
    {
      "id": "payments_mxn",
      "name": "Pagos MXN",
      "status": "degraded",
      "since": "2026-11-04T10:00:00.000Z"
    },
    {
      "id": "webhooks",
      "name": "Webhooks",
      "status": "operational",
      "since": "2026-11-04T09:00:00.000Z"
    },
    {
      "id": "api",
      "name": "API",
      "status": "operational",
      "since": "2026-11-04T09:00:00.000Z"
    }
  ]
}

Encabezados de la respuesta

EncabezadoContenido
X-Request-IdIdentificador de la petición. Cítalo con soporte.
Retry-AfterSegundos a esperar, con 429 y a veces con 503.

Errores

Todos usan la forma de Errores: error.code, message, request_id, details, retryable y docs_url. Decide por code.

HTTPCódigoCuándo saleretryable
400invalid_request (sólo cuenta de prueba)El encabezado X-Fital-Scenario trae un escenario desconocido.false
401invalid_api_keyLa llave falta, está mal formada, venció o fue revocada, o la empresa está suspendida.false
401wrong_environmentLa llave es de otro ambiente.false
403ip_not_allowedLa IP de origen no está activa en la lista de esa llave.false
403kyb_requiredLa empresa no tiene KYB aprobado o aún no está inscrita.false
403account_not_activeLa cuenta no está activa.false
429rate_limitedSuperaste un límite de peticiones. Llega con Retry-After.true
500internal_errorFallo nuestro. El resultado de la petición no se conoce.true
503service_unavailableEl servicio no está disponible por ahora. El resultado de la petición no se conoce.true

Ejemplos de error

400 invalid_request:

{
  "error": {
    "code": "invalid_request",
    "message": "Petición inválida",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {
      "fields": {
        "limit": "Entre 1 y 100"
      }
    },
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#invalid_request"
  }
}

401 invalid_api_key:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Credencial inválida",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#invalid_api_key"
  }
}

403 ip_not_allowed:

{
  "error": {
    "code": "ip_not_allowed",
    "message": "IP no permitida para esta llave",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#ip_not_allowed"
  }
}

429 rate_limited:

{
  "error": {
    "code": "rate_limited",
    "message": "Demasiadas peticiones",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": true,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#rate_limited"
  }
}

500 internal_error:

{
  "error": {
    "code": "internal_error",
    "message": "Error interno",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": true,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#internal_error"
  }
}

503 service_unavailable:

{
  "error": {
    "code": "service_unavailable",
    "message": "Servicio no disponible",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": true,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#service_unavailable"
  }
}

Reintentos

Es una lectura: repetirla no tiene efecto.

  • 429 rate_limited: Espera lo que indique Retry-After y repite.
  • 500 internal_error: Repite con espera exponencial.
  • 503 service_unavailable: Repite con espera exponencial. Respeta Retry-After si viene.

Ver Reintentos y Límites.

Muestras

Variables de estas muestras: simulador público, sin cuenta

Define esto en tu terminal. Con estos valores las muestras corren tal cual contra el simulador público:

export FITAL_API="https://widget.fital.xyz/explorar/v1"
export FITAL_KEY="sk_test_sandbox_publica"

En la cuenta de prueba o en producción cambia la base, la llave y el secreto, y sustituye los id de ejemplo por los tuyos. Ver Ambientes.

op-consultar-estado.sh
curl -sS "$FITAL_API/status" \
  -H "Authorization: Bearer $FITAL_KEY"

Guías

Ver esta página en Markdown

En esta página