Skip to content

Modificación de Monto de Cuota (por Monto)

Descripción

Modifica el monto de una o más cuotas programadas, reemplazando un monto determinado por otro. Permite modificar cuotas específicas dentro de una suscripción.

URL

PUT /api/subscriptions/modify-by-amount

Autenticación

Header Api-Token con token UUID proporcionado por MetrePay.

Petición

Headers

Header Valor
Api-Token Token UUID del comercio
Content-Type application/json

Cuerpo

Campo Condición Descripción
customIdentifier Requerido si no se indica customIdentifier2 Identificador único de la suscripción o del cliente (ej: número de cédula, de socio, código de operación).
customIdentifier2 Requerido si no se indica customIdentifier Segundo identificador personalizado del comercio (ej: número de contrato, número de abono).
quantity Requerido Cantidad de cuotas del mismo monto a modificar.
currentAmount Requerido Monto actual de la cuota que se desea modificar.
newAmount Requerido Nuevo monto a establecer para la cuota.

Ejemplo

{
  "customIdentifier": "123456789",
  "quantity": 1,
  "currentAmount": 201000,
  "newAmount": 200000
}

Respuesta

Respuesta Exitosa

Campo Descripción
customIdentifier Identificador único de la suscripción o del cliente.
customIdentifier2 Segundo identificador personalizado.
currentAmount Monto de la cuota que se solicitó modificar.
newAmount Nuevo monto establecido.
quantity Cantidad de cuotas que se solicitó modificar.
status "OK" o "Error", según el resultado.
quantityModified Cantidad de cuotas modificadas efectivamente.
{
  "customIdentifier": "123456654321",
  "currentAmount": 150000,
  "newAmount": 200000,
  "quantity": 2,
  "status": "OK",
  "quantityModified": 2
}

Respuestas de Error

Código HTTP Descripción
400 Petición inválida (campos requeridos faltantes o formato incorrecto).
401 Token de autenticación inválido o ausente.

Notas

  • Se requiere al menos uno de los dos identificadores (customIdentifier o customIdentifier2).
  • El campo quantityModified puede ser menor a quantity si no se encontraron suficientes cuotas pendientes con el monto indicado en currentAmount.