Skip to Content
Documentación de integración del API de Ripei. ¿Dudas? soporte@pagosripei.com
EndpointsGrupos familiares

Grupos familiares

Un grupo agrupa a los clientes de tu empresa (típicamente una familia: un representante y sus miembros). Es el primer modelo que debes crear — los clientes con rol de grupo lo requieren.

Depende de: nada (solo tu empresa). Lo necesitan: clientes.


Crear un grupo

POST /group/company

Scope requerido: group.create

Cuerpo

CampoTipoRequeridoDescripción
namestringNombre del grupo (ej. “Familia Pérez”).

Idempotente por nombre: si ya existe un grupo con el mismo name en tu empresa, la API devuelve el grupo existente en lugar de crear un duplicado. Puedes reintentar la petición sin riesgo.

Ejemplo

curl -X POST https://api.qa.pagosripei.com/group/company \ -H "Authorization: Bearer $RIPEI_TOKEN" \ -H "company: 42" \ -H "Content-Type: application/json" \ -d '{ "name": "Familia Pérez" }'

Respuesta 201

{ "id": 15, "name": "Familia Pérez" }

Guarda el id — lo necesitas para crear los clientes del grupo.

Errores

CódigoCausa
RIPEI-GRUP-002Error interno creando el grupo — contacta a soporte con el código.
Last updated on