Meses sin intereses

Esta sección detalla el uso del endpoint para consultar los planes de meses sin intereses disponibles para tu comercio. Utiliza esta información para ofrecer opciones de pago en cuotas a tus clientes al crear links de pago.

Detalles del endpoint

Método: GET
URL: /api/v1/companies/installments

El endpoint devuelve la lista de planes de meses sin intereses habilitados para tu comercio, incluyendo el número de cuotas, descripción y monto mínimo requerido.

Configuración de la solicitud

Headers

Header	Descripción
`X-API-KEY`	API Key generada en Cubo Admin.

Si aún no has generado tu API Key, revisa nuestra sección de autenticación.

Ejemplos de uso

JavaScript


fetch('https://<CUBO_API_URL>/api/v1/companies/installments', {
  method: 'GET',
  headers: {
    'X-API-KEY': 'TU_API_KEY_AQUI',
  },
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Respuestas del servidor

✅ Respuesta exitosa

Devuelve la lista de planes de meses sin intereses disponibles:


{
  "data": [
    {
      "id": 3,
      "numberOfPayments": 6,
      "description": "6 Meses Sin Intereses",
      "minimumAmount": "200.00"
    }
  ]
}

Campo	Tipo	Descripción
`id`	`number`	Identificador del plan. Se envía como `monthlyInstallmentId` al crear un link de pago.
`numberOfPayments`	`number`	Número de cuotas mensuales del plan.
`description`	`string`	Descripción del plan de meses sin intereses.
`minimumAmount`	`string`	Monto mínimo requerido para utilizar este plan.

El id del plan es el valor que debes enviar en el campo monthlyInstallmentId al crear un link de pago con meses sin intereses.

❌ Respuesta de error


{
  "statusCode": 400,
  "message": ["Error en la solicitud"],
  "error": "Bad Request"
}