Login

Qué hace

Autentica al comercio y obtiene un JWT para consumir endpoints protegidos.

Cuándo usarlo

Úsalo al iniciar una sesión de integración o cuando el JWT actual expire.

Endpoint

POST https://devapi.forpayservices.cl/white/label/login

Autenticación

Requiere x-api-key. No requiere JWT previo.

Headers requeridos

• country: CL para 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 con currentDate.
• correlationId: UUID único de trazabilidad. En Postman se genera automáticamente antes de cada request.
• processId: Proceso funcional declarado para auditoría, por ejemplo HYBRID.
• 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

username debe corresponder al comercio/RUT configurado por Forpay y debe ser consistente con el header commerce.

Body / Parámetros

password debe venir en formato JWE. No se acepta la contraseña en texto plano.

Reglas de negocio

• Usar POST /login como estándar para nuevas integraciones.
• Guardar el token solo en backend seguro y renovarlo antes de expirar.

Respuesta exitosa

Devuelve un token JWT en el payload/response. Ese token se envía como Authorization: Bearer <JWT>.

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 <...>.