Create User

Qué hace

Registra al cliente si aún no existe, gestiona su asociación al comercio y devuelve su internalUserId.

Cuándo usarlo

Úsalo antes de reutilizar un usuario en la creación de mandatos para asegurar su asociación al comercio en el ambiente correspondiente.

Endpoint

POST /user

Consulta URL base y rutas para seleccionar el ambiente de tu integración.

Autenticación

Requiere x-api-key y Authorization: Bearer <token> obtenido desde POST /login, con el contexto y permisos del comercio para esta operación.

Headers requeridos

• country obligatorio con valor CL.
• commerce obligatorio, de 5 a 30 caracteres, con el identificador de comercio asignado.
• channel obligatorio, de al menos 3 caracteres, con el canal autorizado.
• requestDateTime obligatorio, con fecha y hora en formato ISO 8601.
• correlationId obligatorio, de al menos un carácter. Se recomienda un UUID para trazabilidad.
• processId: obligatorio. Para el flujo de nuevas integraciones documentado en esta guía, utiliza HYBRID.
• salesExecutiveId obligatorio, de al menos un carácter.
• x-api-key correspondiente al ambiente y al plan de consumo asignado.

Identificadores soportados

customer.userId es el identificador externo que tu sistema asigna al cliente dentro del comercio; no es el RUT. El RUT se informa por separado en identificationDocument.

Forpay devuelve payload.customer.internalUserId. Guarda ese valor y utilízalo como customer.internalUserId en las operaciones posteriores que lo admiten. Donde el contrato ofrece ambas variantes, envía exactamente una; userId requiere que ese identificador externo esté asociado al cliente y comercio.

Body / Parámetros

Incluye documento de identificación, información personal, dirección opcional y contactos. El RUT debe ser válido y el email debe tener formato correcto.

Reglas de negocio

• userId identifica al cliente dentro del comercio.
• Si el cliente ya está asociado al comercio, una respuesta exitosa puede conservar su nombre, correo y teléfono existentes.
• personalInformation.name y lastName tienen un mínimo de tres caracteres.
• identificationDocument.verificationNumber contiene exactamente un carácter.
• Los objetos cerrados del contrato admiten las propiedades declaradas en su esquema.

Respuesta exitosa

Devuelve el cliente con internalUserId; si corresponde, puede incluir datos de activación inicial.

Errores comunes

• 400: validación de headers, path, query o body.
• 403: credenciales, API key o JWT inválidos/no autorizados.
• 404: recurso no encontrado cuando aplica.

Notas de integración

• Mantén correlationId único por intento para trazabilidad.
• No reutilices ejemplos con datos reales en producción; reemplaza placeholders por valores del comercio.

Ejemplo recomendado

Usa el ejemplo incluido en el body del request como plantilla inicial y reemplaza los placeholders {{...}} o <...>.