Encrypt Password

Encrypt Password

Qué hace

Herramienta de desarrollo que genera un JWE compacto a partir de una contraseña de prueba y la llave pública Forpay del ambiente de desarrollo.

Cuándo usarlo

Se utiliza exclusivamente en desarrollo para preparar el valor password de una prueba de POST /login. En una integración productiva, genera el JWE en el backend de tu sistema siguiendo la guía de autenticación.

Endpoint

POST /jwe/encrypt

Solo para el ambiente de desarrollo. Configura FORPAY_BASE_URL con la base de desarrollo indicada en URL base y rutas. Usa las credenciales, llave pública y API key de ese ambiente.

Autenticación

Requiere x-api-key. No requiere JWT porque justamente se usa antes del login.

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

No usa identificadores de usuario o mandato. Usa commerce en headers para contextualizar el comercio.

Body / Parámetros

password es la contraseña original. publicKey es la llave pública Forpay entregada para el ambiente.

Reglas de negocio

  • No uses este helper como dependencia productiva; en producción el cliente debe implementar la encriptación JWE en su backend.
  • Nunca registres la contraseña en logs ni la compartas en tickets.

Respuesta exitosa

Devuelve payload.token, que corresponde al JWE compacto a enviar como password en POST /login.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 200

Password original entregada por Forpay para el cliente empresa. Solo debe enviarse a este helper en ambientes de prueba/desarrollo.

string
required
length between 100 and 10000

Llave pública entregada por Forpay para cifrar la password como JWE.

Headers
string
enum
required

Identificador de país donde proviene la solicitud

Allowed:
string
required
length between 5 and 30

Identificador único del comercio asociado definido por forpay

string
required
length ≥ 3

Tipo de plataforma usada por el comercio para integrarse con Forpay

date-time
required
Defaults to 2026-07-09T14:35:12.500Z

Fecha y hora de la solicitud en formato ISO 8601. En esta documentación se muestra un ejemplo precargado; al consumir la API debe enviarse la fecha/hora real de la solicitud.

string
required
length ≥ 1

Identificador de trazabilidad obligatorio. Se recomienda usar un UUID único por solicitud.

string
required
length ≥ 5

Proceso de la solicitud. Para el flujo de nuevas integraciones documentado, utiliza HYBRID.

string
required
length ≥ 1

Identificador del ejecutivo que realiza la venta

string
required

Clave x-api-key

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json