Update Installments

Qué hace

Actualiza estado de cuotas, por ejemplo marcarlas como pagadas o anuladas, usando IDs externos o internos segun el ejemplo.

Cuándo usarlo

Usalo cuando un evento externo o conciliacion confirma que una cuota cambio de estado y Forpay debe reflejarlo.

Endpoint

PUT /installments/status/change

Autenticación

Requiere x-api-key y Authorization: Bearer <JWT>, salvo endpoints publicos de autenticacion o contratos de webhook receptor del cliente.

Campos principales

Variantes soportadas

• Marcar cuotas como pagadas usando IDs externos.
• Marcar cuotas como pagadas usando IDs internos.
• Marcar cuotas como anuladas/canceladas usando IDs externos.
• Marcar cuotas como anuladas/canceladas usando IDs internos.

Reglas de negocio

• Envía product y exactamente una de las ramas installments o payments en la raíz.
• Usa product.id con IDs externos de cuotas o product.internalId con IDs internos. Aplica también a payments[].installment.
• Los IDs internos de las cuotas son números JSON. Los externos son strings.
• Cada elemento de payments debe incluir installment, con exactamente uno de id o internalId, además de sus datos de estado, descripción y fecha.
• La cuota debe pertenecer al mandato y comercio autenticado.
• Para pagos, informa fecha, monto, moneda y autorizacion cuando el contrato lo requiera.
• No marques como pagada una cuota sin evidencia de pago/conciliacion.

Validación de la solicitud Incluye la cuota en cada elemento de payments y utiliza una sola familia de IDs en todo el body. Omitir payments[].installment o mezclar IDs externos e internos puede pasar la validación inicial y fallar durante el procesamiento.

Respuesta exitosa

Responde 204 No Content cuando termina satisfactoriamente el cambio de estado. La respuesta se procesa sin leer un cuerpo JSON. Consulta las cuotas mediante GET /receivables para verificar su estado.