Programs

Crear

Crea un nuevo objeto Program.

post/programs

Request

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

Request body

namestring required

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.

currencystring required

Moneda de las cuentas del programa (ej: clp).

default_credit_limitinteger required

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

max_credit_limitinteger required

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

billing_cycle_daysinteger

Días del ciclo de facturación. Por defecto: 30. Se ignora si se define billing_anchor.

billing_anchorstring

Día del mes en que cierra el ciclo (1 a 31) o nearest. Si se define, el ciclo es mensual anclado a ese día.

grace_period_daysinteger

Días de gracia entre el cierre del ciclo y el vencimiento del estado de cuenta. Por defecto: 5.

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

Cómo se calcula el pago mínimo del estado de cuenta. Por defecto: full.

min_payment_percentagenumber

Porcentaje del total adeudado para el pago mínimo (solo con min_payment_type: percentage).

min_payment_fixed_amountinteger

Monto fijo del pago mínimo en unidades menores (solo con min_payment_type: fixed).

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.