Pagos
Listar Pagos
Ofrece acceso a la lista de todos los pagos realizados.
get/payments
Query parameters
qstring
Parámetro para realizar búsquedas basadas en key y value de los datos o dentro del metadata usando metadata.key=value. Los criterios de búsqueda disponibles son:
- name
- date_from
- date_to
- page
- status
- external_id
- metadata Puedes proporcionar múltiples criterios separados por espacio. Ejemplo: external_id=123456 metadata.student_curp=12345
Headers
campusIDstring uuid required
ID del Campus que se desea trabajar.
periodIDstring uuid required
ID del periodo que se desea trabajar.
Response
Listar Pagos
Example response
{
"items": {
"items": 112,
"page": 1,
"total_pages": 11,
"data": [
{
"id": "a12a51c4-3f69-464f-93eb-cc8d355f68b2",
"created_at": "2023-09-01 14:44:17.600161",
"updated_at": "2023-09-01 14:44:17.600161",
"method": "cash",
"ticketReference": "pi_123456789",
"amount": 100.2,
"paymentDate": "2024-01-20",
"status": "successful",
"external_id": "123abc",
"metadata": {
"id_alumno": "123abc"
}
}
]
}
}