Configuración de cuotas (planSettings)
Extiende un plan con reglas de cuotas: cuántas son y de qué monto. Úsala cuando el plan no es indefinido sino un número finito de pagos (ej. una matrícula en 5 cuotas), o cuando cada cuota tiene un monto distinto.
Depende de: nada, pero se crea ANTES del plan que la va a referenciar. La necesitan: planes por cuotas.
Crear una configuración de cuotas
POST /plan-settings/companyScope requerido: planSettings.create
Cuerpo
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
numberOfInstallments | número | Sí | Número total de cuotas. Mayor a 0. |
amountPerInstallment | objeto | Sí | Mapa { "installment_N": monto }. Dos formas válidas (ver abajo). |
Formas válidas de amountPerInstallment:
- Monto uniforme — una sola llave; todas las cuotas valen lo mismo:
{ "numberOfInstallments": 5, "amountPerInstallment": { "installment_1": 20 } }- Montos distintos — exactamente
numberOfInstallmentsllaves correlativas (installment_1…installment_N):
{
"numberOfInstallments": 3,
"amountPerInstallment": {
"installment_1": 50,
"installment_2": 25,
"installment_3": 25
}
}Las llaves deben ser correlativas empezando en installment_1 — saltarse una produce
RIPEI-PSET-004. Y recuerda: la suma total debe coincidir con el amount del plan que la
referencie.
Ejemplo
curl -X POST https://api.qa.pagosripei.com/plan-settings/company \
-H "Authorization: Bearer $RIPEI_TOKEN" \
-H "company: 42" \
-H "Content-Type: application/json" \
-d '{
"numberOfInstallments": 3,
"amountPerInstallment": {
"installment_1": 50,
"installment_2": 25,
"installment_3": 25
}
}'Respuesta 201
{
"id": 33,
"numberOfInstallments": 3,
"amountPerInstallment": {
"installment_1": 50,
"installment_2": 25,
"installment_3": 25
}
}Usa el id como planSettingsId al crear el plan (con amount: 100 en este
ejemplo — la suma de las cuotas).
Errores
| Código | Causa |
|---|---|
RIPEI-PSET-001 | numberOfInstallments menor a 1. |
RIPEI-PSET-002 | Llaves con formato inválido (deben ser installment_N). |
RIPEI-PSET-003 | Cantidad de llaves inválida (1 global o exactamente N). |
RIPEI-PSET-004 | Falta una llave correlativa. |
Last updated on