Create User
Qué hace
Crea o actualiza funcionalmente un cliente del comercio en Forpay para habilitar mandatos, cuotas, firmas y pagos.
Cuándo usarlo
Úsalo antes de crear mandatos cuando el cliente aún no existe en Forpay o cuando necesitas asegurar sus datos base.
Endpoint
POST https://devapi.forpayservices.cl/white/label/user
Autenticación
Requiere x-api-key y, salvo login/JWE, Authorization: Bearer <JWT> obtenido desde POST /login.
Headers requeridos
country:CLpara integraciones en Chile.commerce: RUT o identificador del comercio entregado por Forpay. Debe coincidir con las credenciales/JWT.channel: Canal de integración acordado con Forpay.requestDateTime: Fecha y hora de la solicitud en formato ISO 8601. En Postman se genera concurrentDate.correlationId: UUID único de trazabilidad. En Postman se genera automáticamente antes de cada request.processId: Proceso funcional declarado para auditoría, por ejemploHYBRID.salesExecutiveId: Identificador del ejecutivo o integración comercial, cuando aplique.x-api-key: API key del ambiente. En documentacion se deja como placeholder.
Identificadores soportados
customer.userId es el id externo del comercio. Forpay responde con internalUserId, que puede usarse en operaciónes posteriores.
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
userIddebe ser único por comercio.- Si el usuario ya existe, el flujo debe tratarse como idempotente/actualización funcional según configuración.
- Nombres y apellidos deben venir sin payload sensible innecesario.
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 <...>.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

