FITALAPI

Depósitos recibidos y quién pagó

GET /v1/deposits

Depósitos recibidos y quién pagó, del más nuevo al más viejo. payer llega en null si no hay datos legibles.

DatoValor
Método y rutaGET /v1/deposits
Servidorhttps://widget.fital.xyz
operationIdlistDeposits
AccesoLlave con el scope deposits:read
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.

Parámetros

ParámetroEnTipoObligatorioDescripción
limitconsultatextoNoFilas por página, de 1 a 100. Por omisión, 25.
cursorconsultatextoNoValor de next_cursor de la página anterior. Hasta 1000 caracteres.

Respuestas correctas

200 Correcto

CampoTipoObligatorioDescripción
datalista de objetoSíFilas de esta página.
data[].amounttexto o nullSíMonto recibido.
data[].concepttexto o nullSíConcepto que escribió quien pagó.
data[].credited_amounttexto o nullSíMonto acreditado a tu saldo.
data[].credited_currencytexto o nullSíMoneda acreditada.
data[].currencytexto o nullSíMoneda recibida.
data[].idtextoSíIdentificador del depósito, con prefijo dpt_.
data[].payerobjeto o nullSíQuién pagó. null si no hay datos legibles: nunca se inventa.
data[].payer.addresstexto o nullSíDirección de origen. null si no se conoce.
data[].payer.banktexto o nullSíBanco de origen. null si no se conoce.
data[].payer.clabetexto o nullSíCLABE de origen. null si no se conoce.
data[].payer.nametexto o nullSíNombre de quien pagó. null si no se conoce.
data[].payer.rfctexto o nullSíRFC de quien pagó. null si no se conoce.
data[].receipt_urltexto o nullSíEnlace https al comprobante, si existe.
data[].received_attexto o nullSíFecha del depósito. ISO 8601 en UTC.
data[].referencetexto o nullSíReferencia del depósito.
data[].statustextoSíEstado del depósito. in_review: El depósito está en revisión. Aún no es dinero disponible. received: El dinero ya está acreditado. returned: El depósito se devolvió.
data[].tracking_keytexto o nullSíClave de rastreo del banco.
has_morebooleanoSítrue si hay más filas después de esta página.
next_cursortexto o nullSíCursor de la página siguiente. null si no hay.

Valores de data[].status

ValorSignificado
in_reviewEl depósito está en revisión. Aún no es dinero disponible.
receivedEl dinero ya está acreditado.
returnedEl depósito se devolvió.
{
  "data": [
    {
      "amount": "1250.00",
      "concept": "Pedido 7731",
      "credited_amount": "1250.00",
      "credited_currency": "MXN",
      "currency": "MXN",
      "id": "dpt_7bTcF2qXe9WmL4sD1nHrY6vK",
      "payer": {
        "address": null,
        "bank": "Banco de ejemplo",
        "clabe": "999180000000000022",
        "name": "CLIENTE FICTICIO SA DE CV",
        "rfc": "XAXX010101000"
      },
      "receipt_url": null,
      "received_at": "2026-11-04T18:00:00.000Z",
      "reference": "7731",
      "status": "received",
      "tracking_key": "CLAVE-DE-RASTREO-DEMO"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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_requestAlgún parámetro o campo no cumple el esquema. Mira details.fields.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
403forbidden_scopeLa llave no tiene el scope de esta operación. details.required_scope lo nombra.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 forbidden_scope:

{
  "error": {
    "code": "forbidden_scope",
    "message": "La llave no tiene permiso para esta operación",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {
      "required_scope": "deposits:read"
    },
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#forbidden_scope"
  }
}

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-listar-depositos.sh
curl -sS "$FITAL_API/deposits" \
  -H "Authorization: Bearer $FITAL_KEY"

Guías

Ver esta página en Markdown

En esta página