Skip to main content
POST

Headers

string
required
Token único para garantizar la idempotencia de la petición

Body

string
required
Valor con el que el usuario podrá consultar su deuda y realizar el pago en el portal de pagos. Se recomienda utilizar el documento de identidad del titular del servicio. El uso del número de contrato es posible, pero no es la opción más recomendada.
string
Identificador único de cada factura utilizado internamente en su sistema. Usualmente corresponde al número de factura, número de contrato o UUID de identificación único.
string
required
Proveedor del sistema que se está integrando. Para solicitar la asignación de un proveedor, contacte al equipo de soporte a través de la burbuja de chat ubicada en la esquina inferior derecha del panel de administración.
number
required
Monto de la factura en pesos (COP). Debe estar entre 5.000 y 100.000.000.
string
required
Título con el que se le cobrará al usuario. Debe tener entre 5 y 100 caracteres.Ejemplos sugeridos:
  • Factura #12314235 de Febrero del 2024
  • Factura #2432543 | Mensualidad Internet
string
Descripción detallada de la factura. Se propaga al Payment asociado. Mínimo 4 y máximo 2000 caracteres.
string
Número de WhatsApp del usuario al que desea cobrar, en formato E.164. Si no se incluye este valor, el usuario no será notificado por medio de WhatsApp.
string
Correo electrónico del usuario al que desea cobrar. Si no se incluye este valor, el usuario no será notificado por medio de correo electrónico.
date
Fecha de vencimiento de la factura. Este valor se utilizará para crear reglas de cobranza ancladas al vencimiento (recordatorios de “por vencer”, “vence hoy” y mora) para esta factura en concreto.No bloquea el pago: pasada esta fecha la factura se sigue pudiendo pagar. Se copia al cobro que OnePay genera para cobrarla, así que aparece también como due_date del payment asociado.Una factura no recibe fecha de expiración propia: el cobro que la cobra expira según la configuración de tu empresa. Ver Crear cobro para la diferencia entre due_date, timely_payment_date y expiration_date.
date
Fecha de pago oportuno: último día en que el usuario puede pagar la factura sin recargo ni suspensión del servicio. Es distinta de due_date — un recibo puede tener las dos fechas.Es informativa: no bloquea el pago ni expira el cobro. Se copia al cobro que OnePay genera para cobrarla, así que aparece también como timely_payment_date del payment asociado. Las reglas de cobranza pueden anclar recordatorios a esta fecha (disparadores “antes”, “el día” y “después” del pago oportuno, configurables en el portal).
string
URL pública del documento PDF de la factura, en caso de tenerla.
object
Datos adicionales que desea persistir o guardar en la factura dentro de OnePay.
object
Configuración para pagos parciales. Permite que la factura sea pagada en múltiples transacciones.
Requiere que el feature Pagos Parciales esté habilitado en tu cuenta. Contacta a soporte para activarlo.
Al crear una factura, la respuesta incluye el campo id — este es el identificador único de la factura en OnePay. Guárdalo en tu sistema ya que lo necesitarás para actualizar o eliminar la factura posteriormente.Recomendación: Almacena este valor como external_id (o equivalente) en tu sistema de gestión para asociar fácilmente tus registros con OnePay.

Response