Actualizar cobro
Actualizar cobro
Actualiza un cobro existente sin cancelarlo ni recrearlo, y reenvía el mensaje solo si lo pides.
PUT
Actualizar cobro
Actualiza un cobro en sitio: cambias monto, título, fecha u otros campos sin
cancelar el cobro ni crear uno nuevo. El mensaje al cliente se reenvía solo si
envías
Solo se modifican los campos que envías; el resto queda intacto. La idempotencia
(
resend: true.
Pensado para cobros que cambian a diario (por ejemplo, intereses de mora). En
lugar de cancelar y recrear el cobro en cada ajuste —lo que reenvía un mensaje
cada vez y satura al cliente— actualizas el mismo cobro y decides cuándo
notificar.
x-idempotency) no aplica a este endpoint.
Path Parameters
string
required
ID del cobro que quieres actualizar. Crear cobro.
Body
Todos los campos son opcionales.boolean
default:"false"
Si es
true, reenvía la solicitud de pago al cliente (WhatsApp) con los datos
actualizados. Si es false o se omite, el cobro se actualiza en silencio y no
se consume ningún mensaje.number
Nuevo monto a cobrar, en unidades mayores de la moneda (no en centavos), igual que al crear el cobro.
number
Nuevo monto de impuestos, en la misma moneda.
string
Breve mensaje que se muestra al cliente al pagar. Mínimo 4 caracteres.
string
Descripción del cobro. Mínimo 4 caracteres.
string
Referencia de pago para el portal de recaudo.
string
Número de teléfono del cliente al que se reenvía la solicitud vía WhatsApp.
string
Correo del cliente para la solicitud de pago.
string
URL de un documento (por ejemplo, la factura actualizada) que se mostrará al
cliente. Si lo envías, se usa tal cual; si no, y cambió el monto, título o
descripción, OnePay regenera automáticamente su propio documento.
date
Fecha de vencimiento del cobro, formato
YYYY-MM-DD HH:MM:SS. No bloquea el
pago: alimenta las reglas de cobranza ancladas al vencimiento (recordatorios
de “por vencer”, “vence hoy” y mora). Envía null para quitarla.date
Fecha de pago oportuno, formato
YYYY-MM-DD (también acepta fecha y hora):
último día para pagar
sin recargo ni suspensión del servicio. Es informativa —no bloquea el pago ni
expira el cobro— y distinta de due_date: un cobro puede tener las dos. Las
reglas de cobranza pueden anclar recordatorios a esta fecha. Envía null
para quitarla.date
Fecha de expiración del cobro, formato
YYYY-MM-DD HH:MM:SS. Al cumplirse, el
cobro pasa a expired y deja de poder pagarse. Envía null para que no expire.Cada fecha se actualiza por separado: si envías solo
due_date, el pago
oportuno y la expiración quedan como estaban, y al revés.Ejemplos de uso
- curl
- JavaScript
- Python
Response
Devuelve el cobro actualizado, con la misma estructura que Crear cobro.string
Identificador único del cobro.
number
Monto del cobro en pesos.
string
Estado del cobro.
string
Título del cobro.
string
Descripción del cobro.
string | null
Fecha de vencimiento del cobro (ISO 8601), si aplica. No bloquea el pago.
string | null
Fecha de pago oportuno (ISO 8601), si aplica: último día para pagar sin
recargo ni suspensión del servicio. Informativa: no bloquea el pago ni expira
el cobro.
string
Enlace de pago del cobro.