Listado de cobros suscritos a débitos de facturas

Obtenga el listado de débitos automáticos suscritos de tus clientes.

GET https://api.onepay.la/v1utilities/direct-debits/payments

Listado de cobros suscritos a débitos de facturas

cURL

curl --request GET \
  --url https://api.onepay.la/v1/utilities/direct-debits/payments \
  --header 'Authorization: Bearer <token>'

{
"data": [
  {
    "bill_id": "0196cf6b-71df-739f-a2c6-53c7f3757c63",
    "amount_in_cents": 100000,
    "status": "Aprobada",
    "created_at": "2025-05-14T15:30:47.000000Z",
    "updated_at": "2025-05-14T15:30:47.000000Z",
    "paid_at": "2025-05-14T15:40:47.000000Z",
    "reference": "REF123",
    "remarks": null,
    "payment_method_type": "Card",
    "payment_method_description": null,
    "paid_data": {
      "success": "00",
      "status": "paid",
      "message": "Pago aplicado con éxito.",
      "approval": "123ABC"
    }
  }
],
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 50,
"to": 1,
"total": 1
}

Consulta los pagos asociados a un débito automático específico utilizando su bill_id.

---

filter[bill_id] · string

Filtra por el ID de la domiciliación.
Debe usarse como filter[bill_id]=...

filter[reference] · string

Filtra por referencia del pago.

filter[status] · string

Filtra por estado del pago.
Ver los estados posibles en la sección “Estados posibles del pago”.

filter[amount_in_cents] · string

Filtra por monto exacto en centavos.

filter[paid_at] · string

(ISO 8601) | Filtra por fecha de pago.

sort · string

Ordena los resultados por un campo.
Ejemplo: sort=paid_at o sort=-amount_in_cents.
Campos soportados: amount_in_cents, status, created_at, paid_at.

{
"data": [
  {
    "bill_id": "0196cf6b-71df-739f-a2c6-53c7f3757c63",
    "amount_in_cents": 100000,
    "status": "Aprobada",
    "created_at": "2025-05-14T15:30:47.000000Z",
    "updated_at": "2025-05-14T15:30:47.000000Z",
    "paid_at": "2025-05-14T15:40:47.000000Z",
    "reference": "REF123",
    "remarks": null,
    "payment_method_type": "Card",
    "payment_method_description": null,
    "paid_data": {
      "success": "00",
      "status": "paid",
      "message": "Pago aplicado con éxito.",
      "approval": "123ABC"
    }
  }
],
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 50,
"to": 1,
"total": 1
}

📘 Campos importantes

Campo	Tipo	Descripción
bill_id	string	ID de la factura.
amount_in_cents	number	Monto en centavos.
status	string	Estado actual del pago.
created_at	string	Fecha de creación del registro.
updated_at	string	Última fecha de actualización del registro.
paid_at	string	Fecha efectiva del pago.
reference	string	Referencia del pago.
remarks	string	razón de fallo.
payment_method_type	string	Tipo de método de pago (Card o Account).
payment_method_description	string | null	Descripción del método, si aplica.
paid_data.success	string	Código de éxito de la conciliación.
paid_data.status	string	Estado devuelto por la conciliación.
paid_data.message	string	Mensaje informativo del estado de la conciliación.
paid_data.approval	string	Código de aprobación de la transacción en la conciliación.

---

🔄 Estados posibles del pago (status)

• Creada
• Pendiente
• Pagada
• Aprobada
• Confirmada
• Fallida
• Consulta fallida

---

💳 Tipos de método de pago (payment_method_type)

• Card
• Account

---

🔽 Ordenamiento posible (sort)

• amount_in_cents
• status
• created_at
• paid_at