Consultar | Credonix

Descripción general

Este endpoint devuelve un pago por su ID, incluso si está cancelado. La respuesta no incluye los complementos de pago; consúltalos con Listar complementos de pago.

Requiere el permiso Leer en Pagos.

Endpoint

GEThttps://app.credonix.mx/api/v1/payments/{paymentId}

Path param: paymentId — el ID del pago.

Consulta un pago

Sin cuerpo. Devuelve el pago con la forma descrita abajo; es la misma que usan el listado y las acciones sobre pagos.

Campos de la respuesta

Campo	Tipo	Descripcion
`id`	string	ID del pago.
`invoice_id`	string	Orden de cobro a la que se aplica el pago.
`amount`	string	Monto del pago, con 2 decimales.
`currency`	`MXN` \| `USD`	Moneda del pago.
`exchange_rate`	string \| null	Tipo de cambio USD→MXN guardado en el pago. `null` cuando no se requirió.
`payment_date`	string (`YYYY-MM-DD`)	Fecha del pago.
`payment_method`	string	Clave de forma de pago del catálogo.
`sat_payment_method`	string \| null	Clave SAT de la forma de pago. Es igual a `payment_method`, salvo `CX01` y `CX02`, que corresponden a `01`.
`funding_source`	`cash` \| `credit`	`cash` para pagos registrados con Registrar pago; `credit` para pagos cubiertos con saldo a favor.
`canceled`	boolean	`true` si el pago está cancelado.
`payment_group_id`	string \| null	UUID compartido por los pagos creados juntos en varias órdenes de cobro. `null` para un pago a una sola orden.
`reference`	string \| null	Referencia del pago.
`notes`	string \| null	Notas del pago.
`credit_generated`	objeto \| null	Saldo a favor que generó el excedente del pago: `{ "amount", "currency" }`. Se sigue devolviendo después de cancelar el pago.
`created_at`	string (fecha)	Momento de creación.
`updated_at`	string (fecha)	Última actualización.

Todos los importes se devuelven como string para no perder precisión decimal.

Errores

Status	Código	Causa
`401`	`MISSING_API_KEY` \| `INVALID_API_KEY` \| `API_KEY_REVOKED`	API key ausente, inválida o revocada.
`403`	`INSUFFICIENT_PERMISSIONS`	La API key no tiene el permiso Leer en Pagos.
`404`	`NOT_FOUND`	El pago no existe en tu organización. La respuesta incluye `{ "message": "El pago no fue encontrado." }`.