Programs

Actualizar

Actualiza un objeto Program.

put/programs/{id}

Request

  • Base URL
    https://api.ventipay.com/v1
  • URL
    https://api.ventipay.com/v1/programs/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

ID del objeto

Request body

namestring

Nombre interno del programa. El cliente solo lo verá si no se define description.

descriptionstring

Nombre del programa visible para el cliente al pagar. Si no se define, el cliente verá name.

status'active' | 'archived'

Estado del programa. Un programa archivado no permite crear nuevas cuentas ni pagar con las existentes.

default_credit_limitinteger

Límite de crédito por defecto para nuevas cuentas, en unidades menores.

max_credit_limitinteger

Límite de crédito máximo permitido para una cuenta, en unidades menores.

billing_cycle_daysinteger

Días del ciclo de facturación.

billing_anchorstring

Día del mes en que cierra el ciclo (1 a 31) o nearest.

grace_period_daysinteger

Días de gracia entre el cierre del ciclo y el vencimiento.

min_payment_type'full' | 'percentage' | 'fixed'

Cómo se calcula el pago mínimo del estado de cuenta.

min_payment_percentagenumber

Porcentaje del total adeudado para el pago mínimo.

min_payment_fixed_amountinteger

Monto fijo del pago mínimo en unidades menores.

metadatastring json

Pares clave-valor con información adicional del programa. No es visible para el cliente.

Changes

No recorded changes to this operation across all 1 revision of this API.