# Un pago

GET /v1/payments/{id}

Un pago de tu empresa. `completed` exige confirmación del riel. `freshness` dice de dónde sale el estado: con `current` es la lectura de ahora y `as_of` su hora; con `delayed` no hubo lectura concluyente y es lo último que se sabe, a la hora de `as_of`. Una cancelación confirmada responde `canceled` con `delayed` hasta que una lectura la confirme. Si un pago cancelado vuelve a `processing` con `current`, se reabrió de verdad.

| Dato | Valor |
|---|---|
| Método y ruta | `GET /v1/payments/{id}` |
| Servidor | `https://widget.fital.xyz` |
| `operationId` | `getPayment` |
| Acceso | Llave con el scope `payments:read` |
| Firma de petición | No aplica |
| Idempotencia | No aplica |

- `freshness` sólo existe aquí. Con `delayed`, consulta otra vez más tarde. Ver [Frescura del detalle](/docs/conceptos/#frescura-del-detalle).
- Con `failed`, `failure_code` siempre trae un código: `payment_rejected` si no hay uno más específico o si el detalle ya no se puede leer. En cualquier otro estado es `null`.

## Encabezados de la petición

| Encabezado | Obligatorio | Descripción |
|---|---|---|
| `Authorization` | Sí | `Bearer` y tu llave. |
| `X-Fital-Scenario` | No | Sólo simuladores: elige la respuesta que quieres practicar. |

## Parámetros

| Parámetro | En | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| `id` | ruta | texto | Sí | Identificador del recurso. Hasta 250 caracteres. |

## Respuestas correctas

### 200 Correcto

| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| `amount` | texto o `null` | Sí | Monto pedido. |
| `beneficiary_id` | texto o `null` | Sí | Beneficiario del pago. |
| `created_at` | texto o `null` | Sí | Fecha de creación. ISO 8601 en UTC. |
| `currency` | texto o `null` | Sí | Moneda pedida. |
| `external_ref` | texto o `null` | Sí | Tu referencia. |
| `failure_code` | texto o `null` | Sí | 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. |
| `final_amount` | texto o `null` | Sí | Monto final, cuando se conoce. |
| `final_currency` | texto o `null` | Sí | Moneda del monto final. |
| `freshness` | objeto | No | De dónde sale `status`. Sólo en `GET /v1/payments/{id}`. |
| `freshness.as_of` | texto o `null` | Sí | 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. |
| `freshness.status` | texto | Sí | 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. |
| `id` | texto | Sí | Identificador del pago, con prefijo `pay_`. |
| `metadata` | objeto | Sí | Los pares que enviaste al crear el pago. |
| `reference` | texto o `null` | Sí | Concepto del pago. |
| `status` | texto | Sí | 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. |

#### Valores de `failure_code`

| Valor | Significado |
|---|---|
| `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. |

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 `freshness.status`

| Valor | Significado |
|---|---|
| `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. |

#### Valores de `status`

| Valor | Significado |
|---|---|
| `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. |

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "processing",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

`processing` con `delayed`: la lectura no concluyó:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "processing",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "delayed",
    "as_of": "2026-11-04T18:00:30.000Z"
  }
}
```

En revisión: no lo repitas:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "in_review",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

`failed`, con su código:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "failed",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": "insufficient_funds",
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

`returned`: se devolvió después de `completed`:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "returned",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

`canceled` con `delayed`: falta la lectura que lo confirme:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "canceled",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "delayed",
    "as_of": "2026-11-04T18:01:30.000Z"
  }
}
```

Variante `payment_completed`:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "completed",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": "1500.00",
  "final_currency": "MXN",
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

Variante `payment_failed`:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "failed",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": "payment_rejected",
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

Variante `payment_returned`:

```json
{
  "id": "pay_6nRtY1wKs3QzD8cL5mVhF2gB",
  "status": "returned",
  "beneficiary_id": "ben_3kTMd9wQp2LxZ7vR1nYcA4bE",
  "amount": "1500.00",
  "currency": "MXN",
  "final_amount": null,
  "final_currency": null,
  "reference": "Factura 1042",
  "external_ref": "factura-1042",
  "metadata": {},
  "failure_code": null,
  "created_at": "2026-11-04T18:00:00.000Z",
  "freshness": {
    "status": "current",
    "as_of": "2026-11-04T18:00:00.000Z"
  }
}
```

## Encabezados de la respuesta

| Encabezado | Contenido |
|---|---|
| `X-Request-Id` | Identificador de la petición. Cítalo con soporte. |
| `Retry-After` | Segundos a esperar, con `429` y a veces con `503`. |

## Errores

Todos usan la forma de [Errores](/docs/errores/): `error.code`, `message`, `request_id`, `details`, `retryable` y `docs_url`. Decide por `code`.

| HTTP | Código | Cuándo sale | `retryable` |
|---|---|---|---|
| 400 | [`invalid_request`](/docs/errores/#invalid_request) | Algún parámetro o campo no cumple el esquema. Mira `details.fields`. | `false` |
| 401 | [`invalid_api_key`](/docs/errores/#invalid_api_key) | La llave falta, está mal formada, venció o fue revocada, o la empresa está suspendida. | `false` |
| 401 | [`wrong_environment`](/docs/errores/#wrong_environment) | La llave es de otro ambiente. | `false` |
| 403 | [`forbidden_scope`](/docs/errores/#forbidden_scope) | La llave no tiene el scope de esta operación. `details.required_scope` lo nombra. | `false` |
| 403 | [`ip_not_allowed`](/docs/errores/#ip_not_allowed) | La IP de origen no está activa en la lista de esa llave. | `false` |
| 403 | [`kyb_required`](/docs/errores/#kyb_required) | La empresa no tiene KYB aprobado o aún no está inscrita. | `false` |
| 403 | [`account_not_active`](/docs/errores/#account_not_active) | La cuenta no está activa. | `false` |
| 404 | [`not_found`](/docs/errores/#not_found) | El pago no existe o es de otra empresa. | `false` |
| 429 | [`rate_limited`](/docs/errores/#rate_limited) | Superaste un límite de peticiones. Llega con `Retry-After`. | `true` |
| 500 | [`internal_error`](/docs/errores/#internal_error) | Fallo nuestro. El resultado de la petición no se conoce. | `true` |
| 503 | [`service_unavailable`](/docs/errores/#service_unavailable) | El servicio no está disponible por ahora. El resultado de la petición no se conoce. | `true` |

### Ejemplos de error

`400 invalid_request`:

```json
{
  "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`:

```json
{
  "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`:

```json
{
  "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"
  }
}
```

`404 not_found`:

```json
{
  "error": {
    "code": "not_found",
    "message": "No encontrado",
    "request_id": "0123456789abcdef0123456789abcdef",
    "details": {},
    "retryable": false,
    "docs_url": "https://merchants.fital.xyz/docs/errores/#not_found"
  }
}
```

`429 rate_limited`:

```json
{
  "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`:

```json
{
  "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`:

```json
{
  "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](/docs/recetas/reintentos/) y [Límites](/docs/limites/).

## 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:

```bash
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](/docs/ambientes/).

```bash
curl -sS "$FITAL_API/payments/pay_6nRtY1wKs3QzD8cL5mVhF2gB" \
  -H "Authorization: Bearer $FITAL_KEY"
```

```js
const r = await fetch(`${process.env.FITAL_API}/payments/pay_6nRtY1wKs3QzD8cL5mVhF2gB`, {
  headers: {
    Authorization: `Bearer ${process.env.FITAL_KEY}`,
  },
});
console.log(r.status, await r.json());
```

```python
import json, os, urllib.error, urllib.request
pet = urllib.request.Request(os.environ["FITAL_API"] + "/payments/pay_6nRtY1wKs3QzD8cL5mVhF2gB", method="GET",
    headers={"Authorization": "Bearer " + os.environ["FITAL_KEY"]})
try:
    with urllib.request.urlopen(pet) as r:
        print(r.status, json.load(r))
except urllib.error.HTTPError as e:
    print(e.code, e.read().decode())
```

```php
<?php
$c = curl_init(getenv('FITAL_API') . '/payments/pay_6nRtY1wKs3QzD8cL5mVhF2gB');
curl_setopt_array($c, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer ' . getenv('FITAL_KEY'),
  ],
]);
echo curl_exec($c), "\n";
```

## Guías

- [Conceptos](/docs/conceptos/)
- [Conciliar](/docs/recetas/conciliar/)
- [Reintentos](/docs/recetas/reintentos/)
- [Ambientes](/docs/ambientes/)
- [Autenticación](/docs/autenticacion/)