Opt-In y Opt-Out

La gestión de Opt-in y Opt-out es una parte esencial del proceso de integración de los Participantes Beneficiarios a la Plataforma CREA.

Estas operaciones permiten que los Participantes Beneficiarios comuniquen la autorización o suspensión del derecho de acceso a los Cupones de Tarjeta e Inventario otorgada por su Titular.

• Opt-In: comunicación de la autorización del Titular para la Consulta de Cupones de Tarjeta de su titularidad por parte de un Participante designado.
• Opt-Out: comunicación del Titular para suspender o revocar la autorización de Consulta de Cupones de Tarjeta de su titularidad por parte de un Participante designado.

A continuación, se detallan los pasos para realizar los comandos de Opt-in y Opt-out en el entorno de CREA:

Pruebas Funcionales:

Para garantizar la eficacia de las pruebas, el equipo de integración de CREA proporcionará datos ficticios y aleatorios de Titulares (Comerciantes), Cupones de Tarjeta e Inventarios. Estos datos servirán como base para la ejecución de las pruebas. Los Participantes deberán utilizar estos datos como objetivos para realizar pruebas de envío de instrucciones, incluyendo Anotaciones, Opt-Ins y Opt-Outs.

1. Envío de Opt-In

Para realizar el Opt-In, utilice la información proporcionada en el correo electrónico de pruebas masivas. Debe enviar las solicitudes debidamente completadas a través del endpoint correspondiente proporcionado por la API de CREA.

• Acceda aquí a la referencia de la API – Opt-In para la ejecución de las pruebas.

Asegúrese de que toda la información sea correcta y esté completa para evitar errores en el envío.
Si el registro de Opt-in se realiza correctamente, el Participante Beneficiario quedará habilitado para realizar la Consulta de Cupones de Tarjeta e Inventario objeto del Opt-In.
Consulte aquí más detalles sobre el procedimiento de Consulta de Cupones de Tarjeta y Consulta de Inventario.

2. Envío de Opt-Out

De manera similar al proceso de Opt-In, la ejecución del Opt-Out requiere que envíe, a través del endpoint apropiado, la información necesaria utilizando los datos de la masa de pruebas.

La solicitud al endpoint de Opt-Out debe utilizar como referencia la clave de identificación (key) obtenida previamente durante el proceso de Opt-In.

Asegúrese de que el payload sea correcto y contenga todos los detalles necesarios. La respuesta de la API confirmando el Opt-Out debe ser almacenada como evidencia de la finalización exitosa de la operación.

• Acceda aquí a la referencia de la API – Opt-Out para la ejecución de las pruebas.

3. Cambio de Vigencia de Opt-In

El proceso de Cambio de Vigencia de Opt-In es necesario cuando hay un cambio en las fechas para las cuales es válida la autorización de acceso a los Cupones de Tarjeta e Inventario.

Esta operación permite que los Participantes Beneficiarios ajusten el período de vigencia según sea necesario, asegurando la continuidad o suspensión del acceso a la información de los Cupones de Tarjeta e Inventario dentro del nuevo período especificado.

La solicitud al endpoint de Cambio de Vigencia de Opt-In debe utilizar como referencia la clave de identificación (key) obtenida previamente durante el proceso de Opt-In.

• Acceda aquí a la referencia de la API – Cambio de Vigencia de Opt-In para la ejecución de las pruebas.

4. Consulta

Después de registrar el Opt-In, este podrá ser consultado a través de las APIs de Consulta de Opt-In.

• Acceda aquí a la referencia de la API – Consulta por Clave de Opt-In para la ejecución de las pruebas.
• Acceda aquí a la referencia de la API – Consulta por Parámetros de Opt-In para la ejecución de las pruebas.

5. Recepción y Consulta de Notificación de Opt-In

Toda creación o modificación de Opt-In genera una Notificación asíncrona con el resultado del procesamiento del Opt-In (eventType = consent):

• Acceda aquí a la referencia de la API – Notificación de Opt-In

En caso de que el Participante no tenga un Webhook configurado para recibir esta Notificación de Opt-In, también podrá consultarla a través del siguiente endpoint:

• Acceda aquí a la referencia de la API – Consulta de Notificación de Opt-In

Material de Soporte:

• Cupón de Tarjeta (CT)
• Registro y Actualización de Cupones de Tarjeta (CT);
• Inventario;
• Opt-In (Anuencia) y Opt-Out;