FITALAPI

Pagos, con su último estado conocido

GET /v1/payments

Pagos creados por esta API, con su último estado conocido, del más nuevo al más viejo. Para el estado más fresco de uno, usa GET /v1/payments/{id}.

DatoValor
Método y rutaGET /v1/payments
Servidorhttps://widget.fital.xyz
operationIdlistPayments
AccesoLlave con el scope payments:read
Firma de peticiónNo aplica
IdempotenciaNo aplica
  • Es una vista guardada: no lee en vivo y no lleva freshness. Puede ir una vuelta por detrás del detalle. Ver Lista y detalle.
  • failure_code llega en null en esta lista, también con failed: léelo en GET /v1/payments/{id} o en payment.failed.

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 pedido.
data[].beneficiary_idtexto o nullSíBeneficiario del pago.
data[].created_attexto o nullSíFecha de creación. ISO 8601 en UTC.
data[].currencytexto o nullSíMoneda pedida.
data[].external_reftexto o nullSíTu referencia.
data[].failure_codetexto o nullSíCódigo del catálogo de errores si el pago falló, null en cualquier otro estado. En GET /v1/payments siempre es null: léelo en GET /v1/payments/{id} o en payment.failed. Trata la lista como extensible. payment_rejected: Rechazado sin un motivo más específico. insufficient_funds: Saldo insuficiente al ejecutar. limit_exceeded: Se superó el tope acumulado de la empresa o un límite del riel. amount_below_minimum: El monto quedó por debajo del mínimo aplicable. account_restricted: La cuenta tiene una restricción. in_review: Una revisión detuvo la ejecución. quote_changed: El débito superaría lo permitido. quote_expired: La cotización venció antes de ejecutar.
data[].final_amounttexto o nullSíMonto final, cuando se conoce.
data[].final_currencytexto o nullSíMoneda del monto final.
data[].freshnessobjetoNoDe dónde sale status. Sólo en GET /v1/payments/{id}.
data[].freshness.as_oftexto o nullSíHora de esa lectura, de la última que se aplicó o de la cancelación confirmada. Null si aún no hay ninguna. ISO 8601 en UTC.
data[].freshness.statustextoSíDe dónde sale status. current: status sale de una lectura de ahora. delayed: La lectura no concluyó y status es lo último que se sabe. No lo tomes como un resultado nuevo.
data[].idtextoSíIdentificador del pago, con prefijo pay_.
data[].metadataobjetoSíLos pares que enviaste al crear el pago.
data[].referencetexto o nullSíConcepto del pago.
data[].statustextoSíEstado público. processing: Aceptado y en curso, o aún sin confirmar. Consúltalo hasta un estado terminal. in_review: En revisión. No lo repitas: el pago ya existe. completed: Se pagó. Aún puede pasar a returned. failed: No se hizo y no queda dinero en tránsito. returned: Se devolvió y el saldo ya volvió. canceled: Se canceló antes de ejecutarse.
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[].failure_code

ValorSignificado
payment_rejectedRechazado sin un motivo más específico.
insufficient_fundsSaldo insuficiente al ejecutar.
limit_exceededSe superó el tope acumulado de la empresa o un límite del riel.
amount_below_minimumEl monto quedó por debajo del mínimo aplicable.
account_restrictedLa cuenta tiene una restricción.
in_reviewUna revisión detuvo la ejecución.
quote_changedEl débito superaría lo permitido.
quote_expiredLa cotización venció antes de ejecutar.

Con failed, GET /v1/payments/{id} y payment.failed siempre traen un código: payment_rejected si no hay uno más específico. En cualquier otro estado, y en la lista GET /v1/payments, es null. Trata la lista como extensible.

Valores de data[].freshness.status

ValorSignificado
currentstatus sale de una lectura de ahora.
delayedLa lectura no concluyó y status es lo último que se sabe. No lo tomes como un resultado nuevo.

Valores de data[].status

ValorSignificado
processingAceptado y en curso, o aún sin confirmar. Consúltalo hasta un estado terminal.
in_reviewEn revisión. No lo repitas: el pago ya existe.
completedSe pagó. Aún puede pasar a returned.
failedNo se hizo y no queda dinero en tránsito.
returnedSe devolvió y el saldo ya volvió.
canceledSe canceló antes de ejecutarse.
{
  "data": [
    {
      "amount": "1500.00",
      "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
      "created_at": "2026-11-04T18:00:00.000Z",
      "currency": "MXN",
      "external_ref": "pedido-7731",
      "failure_code": null,
      "final_amount": "1500.00",
      "final_currency": "MXN",
      "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
      "metadata": {},
      "reference": "Factura 1042",
      "status": "completed"
    }
  ],
  "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
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": "payments: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-pagos.sh
curl -sS "$FITAL_API/payments" \
  -H "Authorization: Bearer $FITAL_KEY"

Guías

Ver esta página en Markdown

En esta página