Componente prediseñado de historial de transacciones

El componente prediseñado del historial de transacciones comprueba el nivel de autenticación del cliente y, a continuación, recoge el periodo de las transacciones y otros filtros que se aplican al recuperar el historial de transacciones. Este componente admite filtros para lo siguiente:

• Tipo de transacción
• Nombre del comerciante
• Importe de la transacción

Si el cliente tiene varias cuentas, el componente confirma la cuenta específica de la que quiere obtener el historial de transacciones. Este componente usa el componente prediseñado Authentication para autenticar a los usuarios y una versión personalizada de Date of birth collection para recoger las fechas de inicio y de finalización del historial de transacciones.

Limitaciones

Además de las limitaciones comunes de los componentes prediseñados, este componente prediseñado tiene las siguientes limitaciones:

• Este componente no cifra ningún dato.

Ejemplos de cuadros de diálogo

En los siguientes ejemplos de cuadros de diálogo se muestran situaciones habituales que gestiona este componente prediseñado. Los diálogos de ejemplo muestran el comportamiento cuando se llama al componente por telefonía, lo que activa el intent de bienvenida predeterminado y la primera respuesta del agente al inicio de la conversación.

Varias cuentas

El usuario final tiene varias cuentas. El agente confirma de qué cuenta solicita el historial de transacciones. El agente recoge las fechas de inicio y fin de las transacciones, los filtros que el usuario quiera aplicar a las transacciones y si el usuario quiere cifrar el historial de transacciones. El agente envía el historial de transacciones al usuario.

Entrada del usuario	Respuesta del agente
	El agente autentica al usuario mediante el componente prediseñado Autenticación.
	Gracias, se ha autenticado correctamente.
	Espera mientras obtenemos los detalles de tu cuenta. Hemos detectado que hay dos cuentas asociadas a tu número. ¿Puedes facilitarnos los últimos cuatro dígitos de la cuenta a la que te refieres?
1001
	Los cuatro últimos dígitos del número de cuenta que hemos recibido son 1001. ¿Es correcto?
Sí
	Indica la fecha de inicio de las transacciones, empezando por el mes, seguido del día y el año. Ten en cuenta que el historial de transacciones solo se proporcionará de los últimos 90 días.
	El agente recoge la fecha de inicio de las transacciones mediante el componente prediseñado Fecha de nacimiento.
	Genial, ya tenemos la fecha de inicio de tus transacciones. Indica la fecha de finalización de tus transacciones. Empieza por el mes, seguido del día y, por último, el año. Ten en cuenta que el historial de transacciones solo se proporcionará de los últimos 90 días.
	El agente recoge la fecha de inicio de las transacciones mediante el componente prediseñado Fecha de nacimiento.
	Gracias. ¿Podrías confirmar si buscas las transacciones realizadas entre el 25 de junio y el 21 de julio del 2023?
Sí
	Indícanos el nombre del comercio del que quieres obtener las transacciones.
Google
	El nombre del comerciante que hemos registrado es "Google". ¿Puedes confirmarlo con un sí o un no?
Sí
	¿Quieres ver el historial de transacciones de tus tarjetas de débito o crédito?
Crédito
	Indica un importe para obtener las transacciones que sean iguales o superiores a ese importe. Por ejemplo, si quieres encontrar transacciones superiores a 100,30 €, di "100".
500
	Espera mientras obtenemos los detalles de tus transacciones. Hemos encontrado transacciones del 2023-06-2 al 2023-07-21. ¿Quieres recibirlo por SMS o WhatsApp?
SMS
	¿Quieres cifrar el documento antes de que lo compartamos contigo?
Sí
	Los detalles de la contraseña se compartirán en el móvil registrado. Recibirás el extracto en un plazo de 15 minutos en el móvil registrado.

Convenciones de nombres

Este componente prediseñado usa las siguientes convenciones de nomenclatura:

Función	Formato	Ejemplo
Flujo	[Component Name]	Historial de transacciones
Intención específica del componente	prebuilt_components_[component_name]_[intent_name]	prebuilt_components_transaction_history_transaction_collection
Tipo de entidad	prebuilt_components_[component_name]_[entity_type]	prebuilt_components_transaction_history_det_cred
Webhook	prebuilt_components_[component_name]:[webhook_action]	prebuilt_components_transaction_history:get_transactions

Parámetros de entrada

Los parámetros de entrada son parámetros que se usan para configurar determinados comportamientos del componente. Los parámetros los usarán una o varias condiciones del flujo para determinar cómo debe comportarse el componente. Los parámetros de ámbito de flujo deben definirse en la página de inicio del componente, tal como se describe a continuación. Los parámetros de ámbito de sesión se pueden definir mediante un flujo de llamada o en la página de inicio de este componente.

Este componente prediseñado acepta los siguientes parámetros de entrada:

Nombre del parámetro	Descripción	Formato de entrada
$session.params.auth_level	(Opcional) Indica el nivel de autenticación de la persona que llama.	entero
$session.params.auth_level_req	Indica el nivel de autenticación necesario para que un usuario pueda acceder a su historial de transacciones. Este valor se configura en los preajustes de parámetros del cumplimiento de la entrada de página de la página check auth level. De forma predeterminada, este valor es 1.	entero
$session.params.account_auth_enabled	Indica si el usuario debe autenticarse como titular de la cuenta, tal como se describe en Tipos de autenticación. Este valor se configura en los preajustes de parámetros del cumplimiento de la entrada de página de la página check auth level. De forma predeterminada, este valor es true.	booleano
$session.params.card_auth_enabled	Indica si el usuario debe autenticarse como titular de la tarjeta, tal como se describe en Tipos de autenticación. Este valor se configura en los preajustes de parámetros del cumplimiento de la entrada de página de la página check auth level. De forma predeterminada, este valor es false.	booleano
$session.params.phone_number	(Opcional) Número de teléfono registrado del cliente que se usa para la autenticación.	cadena
$session.params.account_count	Número de cuentas asociadas al usuario autenticado (opcional).	entero
$session.params.last_four_digit_of_account_number	(Opcional) Los cuatro últimos dígitos del número de cuenta del cliente del que se debe proporcionar el historial de transacciones. Si el cliente tiene una sola cuenta, esta información se obtiene automáticamente después de la autenticación. Si el cliente tiene varias cuentas, se le pedirá el número de cuenta específico.	cadena
$session.params.transaction_history_max_days	Especifica el número máximo de días antes de la fecha actual que se permite para la fecha de inicio de una transacción. De forma predeterminada, este valor es -90, lo que indica que las fechas de inicio de las transacciones no pueden ser anteriores a 90 días a la fecha actual. Este parámetro se define en la ruta de la página de inicio true.	entero
$flow.max_retry_count	Especifica el número de reintentos permitidos al pedir al usuario final que proporcione fechas de inicio y finalización de transacciones válidas. El valor predeterminado es 3.	entero

Parámetros de salida

Los parámetros de salida son parámetros de sesión que permanecerán activos después de salir del componente. Estos parámetros contienen información importante recogida por el componente. Este componente prediseñado proporciona valores para los siguientes parámetros de salida:

Nombre del parámetro	Descripción	Formato de salida
auth_level	Indica el nivel de autenticación de la persona que llama.	entero
phone_number	Número de teléfono local del usuario, sin el código de país, que se usa para identificar al usuario.	cadena
account_count	Número de cuentas asociadas al número de teléfono registrado. Estas cuentas incluyen cuentas propias y cuentas para las que el usuario tiene un poder notarial.	entero
last_four_digit_of_account_number	Si un usuario tiene una sola cuenta, se devuelven los cuatro últimos dígitos del número de cuenta. Si un usuario tiene más de una cuenta, el valor de este parámetro son los cuatro últimos dígitos del número de la cuenta que ha seleccionado para recibir el historial de transacciones.	cadena
transfer_reason	Este parámetro indica el motivo por el que se ha cerrado el flujo, si no se ha completado correctamente. El valor devuelto es uno de los siguientes: agent: el usuario final ha solicitado un agente humano en algún momento de la conversación. denial_of_information: el usuario final se ha negado a compartir la información solicitada por el componente. max_no_input: la conversación ha alcanzado el número máximo de reintentos para eventos sin entrada. Consulta los eventos integrados sin entrada. max_no_match: la conversación ha alcanzado el número máximo de reintentos para los eventos sin coincidencias. Consulte los eventos integrados sin coincidencias. webhook_error: se ha producido un error de webhook. Consulte el evento integrado webhook.error. webhook_not_found: no se ha podido acceder a una URL de webhook. Consulte el evento integrado webhook.error.not-found.	cadena

Configuración básica

Para configurar este componente prediseñado, sigue estos pasos:

1. Importa el componente precompilado.
2. Configura los webhooks flexibles proporcionados con la configuración que describe tus servicios externos. Consulta la sección Configuración de webhook más abajo.

Configuración de webhook

Para usar este componente, debes configurar los webhooks flexibles incluidos para obtener la información necesaria de tus servicios externos.

Autenticación

Si no has configurado previamente los servicios externos necesarios para la autenticación, tendrás que hacerlo para habilitar la autenticación de los usuarios de este componente. Consulta las instrucciones detalladas en el artículo sobre la configuración del webhook de autenticación.

Validar cuenta

El webhook prebuilt_components_account_services:validate_account se usa por el componente para verificar que existe una cuenta en función del número de teléfono registrado del usuario y los cuatro últimos dígitos del número de cuenta proporcionado. El webhook también devuelve el saldo de la cuenta, si existe.

Parámetros de solicitud a la API

El componente proporciona los siguientes parámetros como entradas para la solicitud de la API.

Nombre del parámetro	Descripción	Formato de entrada
$session.params.phone_number	Número de teléfono local del usuario, sin el código de país, que se usa para identificar al usuario.	cadena
$session.params.last_four_digit_of_account_number	Los cuatro últimos dígitos del número de la cuenta que el usuario ha seleccionado y confirmado para recibir información sobre el extracto de la cuenta.	cadena

Parámetros de respuesta de la API

Los siguientes parámetros se extraen de la respuesta de la API para que los use el componente.

Nombre del parámetro	Descripción	Formato de salida
account_found	Indica si existe una cuenta con los cuatro últimos dígitos proporcionados para la cuenta registrada del usuario.	booleano
saldo	El importe del saldo actual de la cuenta, si existe.	número

Obtener transacciones

El webhook prebuilt_components_transaction_history:get_transactions se usa para que el componente obtenga el número de transacciones de una cuenta a partir del número de teléfono registrado del usuario, los cuatro últimos dígitos del número de cuenta, el periodo del historial de transacciones y los filtros que haya seleccionado el usuario.

Parámetros de solicitud a la API

El componente proporciona los siguientes parámetros como entradas para la solicitud de la API.

Nombre del parámetro	Descripción	Formato de entrada
$session.params.phone_number	Número de teléfono local del usuario, sin el código de país, que se usa para identificar al usuario.	cadena
$session.params.last_four_digit_of_account_number	Los cuatro últimos dígitos del número de cuenta que el usuario ha seleccionado y confirmado para recibir el historial de transacciones.	cadena
$flow.statement_start_date	Fecha de inicio del extracto solicitado con el formato "AAAA-MM-DD".	cadena
$flow.statement_end_date	(Opcional) Fecha de inicio del extracto solicitado con el formato "AAAA-MM-DD". Si el usuario no proporciona ningún valor o rechaza proporcionar una fecha de finalización, el valor predeterminado es la fecha actual.	cadena
$flow.transaction_credit_debit	Tipo de transacción solicitada por el usuario. Los valores válidos se definen en la entidad personalizada prebuilt_components_transaction_history_det_cred. De forma predeterminada, se admiten "credit" y "debit". Si el usuario rechaza seleccionar un tipo, este valor será una cadena vacía "" y se deben contabilizar las transacciones de cualquier tipo.	cadena
$flow.merchant_name	Nombre del comerciante solicitado por el usuario. Si el usuario no proporciona un nombre de comerciante, este valor será una cadena vacía "" y se contabilizarán las transacciones de todos los comerciantes.	cadena
$flow.high_amount_value	Importe mínimo de transacción solicitado por el usuario. Si el usuario rechaza proporcionar un importe, este parámetro tiene el valor predeterminado 0.	entero

Parámetros de respuesta de la API

Los siguientes parámetros se extraen de la respuesta de la API para que los use el componente.

Nombre del parámetro	Descripción	Formato de salida
transactions_count	Número de transacciones encontradas en la cuenta especificada durante el periodo del extracto seleccionado con los filtros aplicados.	entero

Enviar información

El webhook prebuilt_components_transaction_history:send_info se usa para que el componente envíe un historial de transacciones a un canal seleccionado a partir del número de teléfono registrado del usuario, los cuatro últimos dígitos del número de cuenta, el periodo del historial de transacciones y los filtros que haya seleccionado el usuario.

Parámetros de solicitud a la API

El componente proporciona los siguientes parámetros como entradas para la solicitud de la API.

Nombre del parámetro	Descripción	Formato de entrada
$session.params.phone_number	Número de teléfono local del usuario, sin el código de país, que se usa para identificar al usuario.	cadena
$session.params.last_four_digit_of_account_number	Los cuatro últimos dígitos del número de cuenta que el usuario ha seleccionado y confirmado para recibir el historial de transacciones.	cadena
$flow.statement_start_date	Fecha de inicio del extracto solicitado con el formato "AAAA-MM-DD".	cadena
$flow.statement_end_date	(Opcional) Fecha de inicio del extracto solicitado con el formato "AAAA-MM-DD".	cadena
$flow.transaction_credit_debit	Tipo de transacción solicitada por el usuario. Los valores válidos se definen en la entidad personalizada prebuilt_components_transaction_history_det_cred. De forma predeterminada, se admiten "credit" y "debit". Si el usuario rechaza seleccionar un tipo, este valor será una cadena vacía "" y se deberán enviar transacciones de cualquier tipo.	cadena
$flow.merchant_name	Nombre del comerciante solicitado por el usuario. Si el usuario se niega a proporcionar un nombre de comerciante, este valor será una cadena vacía "" y se deberán enviar las transacciones de todos los comerciantes.	cadena
$flow.high_amount_value	Importe mínimo de transacción solicitado por el usuario. Si el usuario rechaza proporcionar un importe, este parámetro tiene el valor predeterminado 0.	entero
$flow.channel_medium	Canal que ha seleccionado el usuario para recibir el mensaje. Los valores válidos se definen mediante las entidades personalizadas prebuilt_components_transaction_history_phone y prebuilt_components_transaction_history_channel, en función de si el usuario tiene un correo registrado. De forma predeterminada, se admiten email, mobile y whatsapp.	cadena
$flow.encryption_status	Indica si el usuario quiere que el documento se cifre antes de enviarlo al canal especificado. Si el usuario no proporciona ningún valor o rechaza proporcionar una fecha de finalización, el valor predeterminado es true.	booleano

Completado

Tu agente y sus webhooks ya deberían estar configurados y listos para probarse.