Listar
Obtiene un listado paginado de los pagos de tu organización.
Descripción general
Este endpoint permite obtener un listado paginado de los pagos registrados en tu organización. Los resultados se devuelven en formato JSON e incluyen metadatos de paginación. Cada pago corresponde a una sola orden de cobro (invoice_id); los pagos distribuidos en varias órdenes de cobro comparten el mismo payment_group_id. El listado incluye los pagos cancelados, a menos que filtres con canceled. El tamaño de página es fijo en 20 resultados.
Los pagos se ordenan por payment_date descendente y, con la misma fecha, por created_at descendente. Consulta los campos de cada pago en Consultar pago.
Requiere el permiso Leer en Pagos.
Endpoint
https://app.credonix.mx/api/v1/paymentsConsulta múltiples pagos
Filtra por cliente, orden de cobro, grupo de pagos, estatus de cancelación o rango de fechas. Los filtros de ID aceptan varios valores, repitiendo el parámetro (?invoice_id=a&invoice_id=b) o separados por comas (?invoice_id=a,b).
Query params
| Parametro | Tipo | Requerido | Default | Descripcion |
|---|---|---|---|---|
page | integer ≥ 1 | No | 1 | Página solicitada. El tamaño de página es fijo en 20. |
customer_id | string | No | - | Pagos de las órdenes de cobro de estos clientes. |
invoice_id | string | No | - | Pagos de estas órdenes de cobro. |
payment_group_id | string | No | - | Pagos de estos grupos de pagos. |
canceled | true | false | No | - | Filtra por pagos cancelados o activos. |
payment_date_from | YYYY-MM-DD | No | - | Pagos con payment_date igual o posterior a esta fecha. |
payment_date_to | YYYY-MM-DD | No | - | Pagos con payment_date igual o anterior a esta fecha. |
Consulta los pagos de una orden de cobro
Envía invoice_id para obtener los pagos aplicados a una orden de cobro. Si la orden de cobro recibió parte de un pago distribuido, el pago trae el payment_group_id del grupo.
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVALID_PAGE | page no es un número entero entre 1 y 107374183. |
400 | INVALID_QUERY_PARAMETER | canceled no es true o false, o payment_date_from / payment_date_to no tienen el formato YYYY-MM-DD. |
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. |