Consultar Pagos usando Filtros

Indice

📜 Descripción

Este endpoint permite obtener una lista paginada de pagos registrados en el sistema. Se pueden aplicar filtros dinámicos y ordenamientos mediante parámetros de consulta (query params).

🔗 URL

GET /pagos

🛡️ Autenticación

Requiere autenticación mediante token JWT. El token debe enviarse en el encabezado:

Authorization: Bearer {token}

📊 Parámetros de consulta

📊 Ejemplo de uso de filtros

filters[0][field]=status
filters[0][operation]=EQUAL
filters[0][value]=pending

filters[1][field]=request_date
filters[1][operation]=LESS_THAN
filters[1][value]=20250101T030000000-0300

🔃 Ejemplo de uso de sorts

sorts[request_date]=ascending
sorts[amount]=descending

🔎 Campos filtrables y operaciones válidas

📅 Uso de filtros de fecha

Para aplicar un filtro entre dos fechas no debe utilizarse la operación BETWEEN. En su lugar, se deben usar dos filtros separados, cada uno con su índice correspondiente, sobre el mismo campo.

✅ Ejemplo correcto (rango de fechas):

filters[0][field]=request_date
filters[0][operation]=GREATER_THAN_OR_EQUAL_TO
filters[0][value]=20250101T000000000-0300

filters[1][field]=request_date
filters[1][operation]=LESS_THAN
filters[1][value]=20250201T000000000-0300

Este ejemplo filtra todos los pagos cuya request_date esté entre el 1 de enero de 2025 a las 00:00 (GMT-3) y el 1 de febrero de 2025 a las 00:00 (GMT-3).

🕒 Formato de fechas

Las fechas deben enviarse en el siguiente formato:

yyyyMMdd'T'HHmmssSSSZ

- Ejemplo: 20250101T000000000-0300
- Representa: 1 de enero de 2025, 00:00:00.000 en hora UTC alineada a GMT-3

 ✅ Filtros mínimos requeridos

Debe incluirse al menos una de las siguientes combinaciones de filtros. Si no se cumple esta condición, el sistema responderá con un error.

 Combinaciones válidas:

1. 1. collector_id y request_date
   2. collector_id y paid_date
   3. collector_id y rejected_date
   4. collector_id y accreditation_date
   5. collector_id y refunded_date
   6. collector_id y payment_id
   7. owner.type y owner.id
   8. payer.email y request_date
   9. type y payment_methods.gateway.name

❌ Error en caso de no cumplir los filtros minimos:

{
  "code": 400,
  "message": "Query not have the minimum fields required for realm",
  "extended_code": 4501
}

❌ Posibles errores