CredonixDocs
Referencia de la APIPagos

Editar

Actualiza la fecha o las notas de un pago.

Descripción general

Este endpoint permite actualizar parcialmente un pago. Solo se pueden editar payment_date y notes; el monto, la moneda, la forma de pago y la referencia no cambian. Todos los campos son opcionales y los que omitas no se tocan. Una solicitud exitosa devuelve 200 con el pago completo.

El campo note no se guarda en el pago: es el motivo del cambio y queda registrado en la actividad, igual que en la aplicación.

Pagos con complemento de pago. Si el pago tiene un complemento de pago emitted o pending (real o de prueba), la API rechaza payment_date con 409 y el código PAYMENT_HAS_COMPLEMENT. La única excepción es enviar la misma fecha que ya tiene el pago junto con note. Para cambiar la fecha, cancela el pago y su complemento.

Editar el pago no recalcula el saldo pendiente de la orden de cobro.

Requiere el permiso Administrar en Pagos.

Endpoint

PATCHhttps://app.credonix.mx/api/v1/payments/{paymentId}

Path param: paymentId — el ID del pago.

Actualiza las notas


Envía notes con el nuevo texto. El valor se guarda tal cual, sin recortar espacios; null limpia las notas.

{ "notes": "Pago confirmado por tesorería" }

Cambia la fecha del pago


Envía payment_date y, opcionalmente, note con el motivo del cambio. El pago de este ejemplo no tiene complemento de pago, así que la fecha se actualiza.

{
  "payment_date": "2026-09-13",
  "note": "Fecha corregida según el estado de cuenta"
}

Reglas de los campos

CampoTipoRequeridoNotas
payment_datestring (YYYY-MM-DD)NoNueva fecha del pago. Se rechaza si el pago tiene un complemento de pago emitted o pending, salvo la misma fecha con note.
notesstring | nullNoNotas del pago. No se recortan espacios; null las limpia.
notestringNoMáximo 500 caracteres. Motivo del cambio para la actividad; se recortan espacios y un texto vacío se ignora. No se guarda en el pago.

Un cuerpo vacío ({}) es válido y no cambia nada. Cualquier otro campo responde 400 con VALIDATION_ERROR.

Errores

StatusCódigoCausa
400VALIDATION_ERRORCampo inválido o desconocido.
401MISSING_API_KEY | INVALID_API_KEY | API_KEY_REVOKEDAPI key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Administrar en Pagos.
404NOT_FOUNDEl pago no existe en tu organización.
409PAYMENT_HAS_COMPLEMENTSe envió payment_date y el pago tiene un complemento de pago emitted o pending. La respuesta incluye { "message": "No es posible editar la fecha del pago, ya que cuenta con un complemento emitido. Para continuar, cancela el pago y el complemento de pago." }.
Abrir Credonix