Xerpa expone a través de su API, servicios para que el banco o institución financiera pueda acceder a la información necesaria para ejecutar sus actividades.
\nEstos servicios consideran endopints de los productos de Control de Gastos y Ahorro Automático.
\n\n\nAcceso Restringido
\n
Esta API solo está disponible para los bancos e instituciones financieras que forman parte de la cartera de clientes de Xerpa.
A menos de que se especifique lo contrario, todos los campos de las peticiones son obligatorios. Solo bajo ciertas circunstancias y donde quede explícitamente documentado se manejarán campos opcionales para las peticiones. Estos campos opcionales se indicarán en cada endpoint que lo permita.
\nSe utilizan códigos de error internos para problemas relacionados al uso de la API, estos códigos se retornarán dentro del cuerpo de la respuesta.
\nEl case-id es un identificador único de la petición para trazar el error en los logs internos y atender actividades de soporte.
\nEl error-code es un código que se puede buscar en el diccionario de errores y donde se puede encontrar más información del problema.
\nLas peticiones a la API pueden fallar por múltipes razones, desde problemas de red, límite de peticiones, timeouts o errores de servicios. Como recomendación, sugerimos desarrollar un sistema de reintento de peticiones cuando se obtengas las siguientes respuestas HTTP:
\n5xx (Server errors)
\n429 (Rate Limits)
\n408 (Timeouts)
\nEl límite por defecto de las peticiones desde una misma IP son de 1,000 peticiones por minuto. El límite aplica para cada ambiente (sandbox, QA y producción) independientemente.
\nSi se alcanza el límite, las peticiones responderán con un error HTTP 429.
\nEn caso de ser necesario el límite se puede aumentar para ambientes productivos con previo análisis con el equipo responsable de las APIs en Xerpa.
\nTodas nuestras APIs tienen tomeouts para identificar que ha ocurrido un error lo antes posible y con eso puedas reintentar la petición. Es recomentadble manejar los mismos tiempos de timeouts para los clientes.
\nTiempo por Defecto - La mayoría de las APIs arrojará un timeout a los 29 segundos.
\nLa paginación cuando esté disponible se explicitará en la documentación respectiva de cada recurso.
\nPara paginación se debe usar los siguientes parámetros como query-param:
\nstart: Inicio de la paginación
\nlimit: Items por página
\nhttps://api.getxerpa.com/api/V1.1/resource/?start=0&limit=10
En los recursos donde los filtros estén disponibles se indicará explícitamente en la documentación, asi como los parámetros por los cuales se puede filtrar y el ordenamiento.
\nEn algunos recursos se permite el parámetro expand para mostrar los objetos anidados. Este parámetro se usa principalmente para expandir los objetos de catálogos dentro de las respuestas.
\nhttps://api.getxerpa.com/api/V1.1/resource/?expand=project_category,project_status
La variables de entorno para utilizar con esta documentación son las siguientes:
\nhost_login_middleware: URL para endpoint Obtener Token app
middleware-auth-api-key****: api-key requerida para utilizar el endpoint Obtener Token app
host_middleware****: URL para otros endpoints del middleware que requiere el token_app
login_username_middleware****: username para autenticarse en el middleware y obtener token_app
login_password_middleware****: password para autenticarse en el middleware y obtener token_app
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25856993","collectionId":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","publishedId":"2sB3BGHA8f","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-08-13T19:42:36.000Z"},"item":[{"name":"Autenticación","item":[{"name":"Obtener token app","event":[{"listen":"test","script":{"id":"db3a92ab-a5ca-49ab-8897-51f831e53f60","exec":["const response = pm.response.json();","pm.environment.set(\"token_app\", response.token);","pm.environment.set(\"token_middleware\", response.token)"],"type":"text/javascript","packages":{}}}],"id":"d57e723b-d6e0-4bc8-8013-956b0d4ec459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{middleware-auth-api-key}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"{{login_username_middleware}}\",\n \"password\": \"{{login_password_middleware}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{host_login_middleware}}/token-app","description":"Estas variables de entorno serán entregadas al equipo de implementación por Xerpa y serán distintas para los ambientes de QA y PRO
\n
Este endpoint permite a los servicios autenticarse y obtener un Client Token mediante una solicitud HTTP POST. Se requiere que el usuario proporcione su nombre de usuario y contraseña para recibir una respuesta que incluye información del usuario y detalles sobre las operaciones disponibles.
Metodo: POST
\nURL: {{host_login_middleware}}/token-app
\nusername (string): El nombre de usuario del usuario que intenta autenticarse.
password (string): La contraseña asociada al nombre de usuario.
{\n \"username\": \"usuario_prueba\",\n \"password\": \"clave_usuario\"\n}\n\ntoken(string): Token generado para el usuario.{\n \"token\":\"string\"\n}\n\nNuestras APIs usan OAuth 2.0 Bearer Token para autenticar los requests.
Todas las llamadas a la API deben incluir el token.
Existen dos tipos de token que se utilizan para acceder a distintos tipos de servicios:
\nClient Tokens: Para consumo de APIs de sistema y que pueden acceder a la información de múltiples usuarios y tienen permisos amplios. Duración hasta 24hrs.
\nUser Tokens: Para consumo de APIs desde el frontend y están restringidos a la consulta de información específica por usuario. Duración hasta 5 min.
\nEl uso de cada tipo de token de describe en el siguiente diagrama:
\n![](\"https://lh7-rt.googleusercontent.com/slidesz/AGV_vUcFzD6no-RGWwFyPAD9Vw3ZVGJf3ce21ygXihWYyDt0VVG0VzIf9sou6JsjnaYso1HwVFZu0xzRLYygHIYboavi8m4Ehbv2atrSD5XU2bhknHab2mMa4ADUmcSSdcEZX3iXkwJjrw=s2048?key=SmcJkW1I-s0Xg8fRA-aSgyak\")
","_postman_id":"5a0b8437-2abb-49af-a000-bf35eeb89afb","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}}},{"name":"Usuarios","item":[{"name":"Usuarios con Contrato","item":[{"name":"Registro y actualización de usuario, cuentas, contratos y progress","event":[{"listen":"test","script":{"id":"db3a92ab-a5ca-49ab-8897-51f831e53f60","exec":["const response = pm.response.json();","pm.environment.set(\"token_user\", response.token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"6a899f1c-beb9-460b-9e94-0a400674ed4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_app}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"user_id\": \"test_user_api_020326_201\",\n \"accounts\": [\n {\n \"account\": {\n \"account_id\": \"test_user_api_020326_10_ac_1\",\n \"account_number\": \"9f3c2e7a-6b41-4d8f-9a2c-1e5b7c8d4f90\",\n \"account_type\": \"cuenta_ahorro\",\n \"account_status\": \"cuenta_activa\",\n \"account_currency\": \"CLP\"\n },\n \"contract\": {\n \"contract_id\": \"9f3c2e7a-6b41-4d8f-9a2c-1e5b7c8d4f90\",\n \"contract_role\": \"owner\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v2/core-service/middleware-contract/init-user/","description":"En la solución de Ahorro Automático, puedes generarse descuadres en los progresos de las metas que tiene registrado Xerpa y el saldo de las cuentas en donde se almacenan los ahorros. Es por esto que este endpoint permite hacer una actualización del saldo de las cuentas y progresos de las metas asociadas al momento de iniciar sesión.
\nAgregando la propiedad projects_balance el sistema automáticamente actualizará el saldo asociado a la cuenta y el progreso de la meta de ahorro asociado a el.
Método: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.
accounts(array): Array de cuentas asociadas al usuario. Cada cuenta debe tener los siguientes campos:
\naccount_id(string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
account_number(string): Identificador de cuenta que será visible en el frontend.
account_type(string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
projects_balance(array): Array de balances de proyectos asociados al usuario. Cada balance debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único del producto.
balance(string): Balance del producto.
{\n \"external_id\": \"test_user_api_2\",\n \"accounts\": [\n {\n \"account_id\": \"test_user_api_2_account_1\",\n \"account_number\": \"aaaabbbb\",\n \"account_type\": \"cuenta_ahorro\"\n }\n ],\n \"projects_balance\": [\n {\n \"account_id\": \"test_user_api_2_account_4\",\n \"balance\": \"8000.00\"\n }\n ]\n}\n\ntoken(string): Token generado para el usuario.{\n \"type\": \"object\",\n \"properties\": {\n \"token\": {\n \"type\": \"string\"\n }\n }\n}\n\nEste endpoint permite obtener un token de usuario asociado al external_id enviado como parámetro en el cuerpo de la solicitud.
Si es el primer ingreso del usuario, se creará el usuario en las bases de Xerpa y se retornará el token correspondiente.
\nMétodo: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.{\n \"external_id\": \"test_user_api_2\"\n}\n\ntoken(string): Token generado para el usuario.{\n \"token\": \"string\"\n}\n\nAdicionamente al registro de usuarios y la obtención del token, de forma simultánea se pueden crear y actualizar las cuentas de los usuarios registradas en Xerpa en la misma petición.
\nUsuario nuevo o sin cuentas previas: Se crearán todas las cuentas y se le asociarán al usuario.
\nUsuario con cuentas creadas: Si el usuario ya tiene cuentas, se compararán las existente en la base de Xerpa con las recibidas en la petición:
\nSe crearán todas las cuentas que no existan en la base Xerpa y se asociarán al usuario
\nSe actualizarán todas las cuentas según el account_id.
\n\nNo se pueden eliminar cuentas desde este endpoint
\n
Método: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.
accounts(array): Array de productos asociados al usuario. Cada producto debe tener los siguientes campos:
account_id(string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
account_number(string): Identificador de cuenta que será visible en el frontend.
account_type(string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
{\n \"external_id\": \"test_user_api_2\",\n \"accounts\": [\n {\n \"account_id\": \"test_user_api_2_account_1\",\n \"account_number\": \"aaaabbbb\",\n \"account_type\": \"cuenta_ahorro\"\n }\n ]\n}\n\ntoken(string): Token generado para el usuario.{\n \"type\": \"object\",\n \"properties\": {\n \"token\": {\n \"type\": \"string\"\n }\n }\n}\n\nEn la solución de Ahorro Automático, puedes generarse descuadres en los progresos de las metas que tiene registrado Xerpa y el saldo de las cuentas en donde se almacenan los ahorros. Es por esto que este endpoint permite hacer una actualización del saldo de las cuentas y progresos de las metas asociadas al momento de iniciar sesión.
\nAgregando la propiedad projects_balance el sistema automáticamente actualizará el saldo asociado a la cuenta y el progreso de la meta de ahorro asociado a el.
Método: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.
accounts(array): Array de cuentas asociadas al usuario. Cada cuenta debe tener los siguientes campos:
\naccount_id(string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
account_number(string): Identificador de cuenta que será visible en el frontend.
account_type(string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
projects_balance(array): Array de balances de proyectos asociados al usuario. Cada balance debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único del producto.
balance(string): Balance del producto.
{\n \"external_id\": \"test_user_api_2\",\n \"accounts\": [\n {\n \"account_id\": \"test_user_api_2_account_1\",\n \"account_number\": \"aaaabbbb\",\n \"account_type\": \"cuenta_ahorro\"\n }\n ],\n \"projects_balance\": [\n {\n \"account_id\": \"test_user_api_2_account_4\",\n \"balance\": \"8000.00\"\n }\n ]\n}\n\ntoken(string): Token generado para el usuario.{\n \"type\": \"object\",\n \"properties\": {\n \"token\": {\n \"type\": \"string\"\n }\n }\n}\n\nPending
\nMétodo: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.
products(array): Array de productos asociados al usuario. Cada producto debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
product_number(string): Identificador de cuenta que será visible en el frontend.
product_type(string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
projects_balance(array): Array de balances de proyectos asociados al usuario. Cada balance debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único del producto.
balance(string): Balance del producto.
{\n \"external_id\": \"test_user_api_2\",\n \"products\": [\n {\n \"product_id\": \"test_user_api_2_account_1\",\n \"product_number\": \"aaaabbbb\",\n \"product_type\": \"cuenta_ahorro\"\n }\n ],\n \"projects_balance\": [\n {\n \"product_id\": \"test_user_api_2_account_4\",\n \"balance\": \"8000.00\"\n }\n ]\n}\n\ntoken(string): Token generado para el usuario.{\n \"type\": \"object\",\n \"properties\": {\n \"token\": {\n \"type\": \"string\"\n }\n }\n}\n\nPendiente
\nMétodo: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.
products(array): Array de productos asociados al usuario. Cada producto debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
product_number(string): Identificador de cuenta que será visible en el frontend.
product_type(string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
projects_balance(array): Array de balances de proyectos asociados al usuario. Cada balance debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único del producto.
balance(string): Balance del producto.
{\n \"external_id\": \"test_user_api_2\",\n \"products\": [\n {\n \"product_id\": \"test_user_api_2_account_1\",\n \"product_number\": \"aaaabbbb\",\n \"product_type\": \"cuenta_ahorro\"\n }\n ],\n \"projects_balance\": [\n {\n \"product_id\": \"test_user_api_2_account_4\",\n \"balance\": \"8000.00\"\n }\n ]\n}\n\ntoken(string): Token generado para el usuario.{\n \"type\": \"object\",\n \"properties\": {\n \"token\": {\n \"type\": \"string\"\n }\n }\n}\n\nEn la solución de Ahorro Automático, puedes generarse descuadres en los progresos de las metas que tiene registrado Xerpa y el saldo de las cuentas en donde se almacenan los ahorros. Es por esto que este endpoint permite hacer una actualización del saldo de las cuentas y progresos de las metas asociadas al momento de iniciar sesión.
\nAgregando la propiedad projects_balance el sistema automáticamente actualizará el saldo asociado a la cuenta y el progreso de la meta de ahorro asociado a el.
Método: POST
\nURL: {{host_middleware}}/token-user
\nexternal_id(string): Identificador alfanumérico único del usuario dentro de la solución Xerpa.
accounts(array): Array de cuentas asociadas al usuario. Cada cuenta debe tener los siguientes campos:
\naccount_id(string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
account_number(string): Identificador de cuenta que será visible en el frontend.
account_type(string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
projects_balance(array): Array de balances de proyectos asociados al usuario. Cada balance debe tener los siguientes campos:
product_id(string): Identificador alfanumérico único del producto.
balance(string): Balance del producto.
{\n \"external_id\": \"test_user_api_2\",\n \"accounts\": [\n {\n \"account_id\": \"test_user_api_2_account_1\",\n \"account_number\": \"aaaabbbb\",\n \"account_type\": \"cuenta_ahorro\"\n }\n ],\n \"projects_balance\": [\n {\n \"account_id\": \"test_user_api_2_account_4\",\n \"balance\": \"8000.00\"\n }\n ]\n}\n\ntoken(string): Token generado para el usuario.{\n \"type\": \"object\",\n \"properties\": {\n \"token\": {\n \"type\": \"string\"\n }\n }\n}\n\nLos usuarios son la base para toda la información que se genera con la plataforma. Independiente de la solución implementada Control de Gastos y/o Ahorros Automáticos, siempre todos los registros tendrán el identificador del usuarios al que pertenecen.
\nEl usuario se crea comunicando un external_id, que es un indicador único del usuario y el retornará siempre un user_token con el cual se podrán invocar las APIs de PFM.
\nEl external_id debe ser un dato anonimizado del usuario del banco ya que Xerpa no almacena información personal.
\nEl endpoint de registro de usuarios tiene múltiples funciones que se pueden activar dependiendo del caso de uso que se quiera implementar. El endpoint automáticamente identificará que tareas ejecutar dependiendo del request que se realice.
\n","_postman_id":"45b81d19-771b-4aea-8a92-4379b41a4e59","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}}},{"name":"Cuentas","item":[{"name":"Añadir cuentas a un usuario","id":"335a8711-3d76-4a31-900e-c35d4622fc90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_app}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"product_id\": \"user-qa-2-ahorro\",\r\n \"product_number\": \"user-qa-2-number-ahorro\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2-vista\",\r\n \"product_number\": \"user-qa-2-number-vista\",\r\n \"product_type\": \"cuenta_vista\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2-tc\",\r\n \"product_number\": \"user-qa-2-number-tc\",\r\n \"product_type\": \"tarjeta_debito\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v1/core-service/users/{{user_external_id}}/products/","description":"Este endpoint permite asociar un listado de cuentas al usuario con el external_id indicado en la URL. Solo se persisten las cuentas con account_id que aún no se hayan registrado en Xerpa.
Método: POST
URL: /api-middleware/v1/core-service/users/{{user_external_id}}/accounts/
Parámetros de ruta:
\nArray de cuentas asociados al usuario. Cada producto debe tener los siguientes campos:
\naccount_id (string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
\naccount_number (string): Identificador de cuenta que será visible en el frontend.
\naccount_type (string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
[\n {\n \"account_id\": \"user-qa-2-ahorro\",\n \"account_number\": \"user-qa-2-number-ahorro\",\n \"account_type\": \"cuenta_ahorro\"\n },\n {\n \"account_id\": \"user-qa-2-vista\",\n \"account_number\": \"user-qa-2-number-vista\",\n \"account_type\": \"cuenta_vista\"\n },\n {\n \"account_id\": \"user-qa-2-tc\",\n \"account_number\": \"user-qa-2-number-tc\",\n \"account_type\": \"tarjeta_debito\"\n }\n]\n\nRetorna un JSON vacio, indicando que se realizo correctamente la operación.
\n","urlObject":{"path":["api-middleware","v1","core-service","users","{{user_external_id}}","products",""],"host":["{{host_middleware}}"],"query":[],"variable":[]}},"response":[{"id":"199bd65c-6030-4647-9577-561bc5314442","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n [\r\n {\r\n \"product_id\": \"user-qa-2e\",\r\n \"product_number\": \"user-qa-2-number-e\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2f\",\r\n \"product_number\": \"user-qa-2-number-f\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n }\r\n ]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}api-middleware/v1/core-service/users/{{user_external_id}}/products/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2e\",\n \"product_number\": \"user-qa-2-number-e\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2f\",\n \"product_number\": \"user-qa-2-number-f\"\n }\n]"},{"id":"aa51f9e4-ee8b-4b65-8a57-7e85625dff57","name":"Añadir cuentas a un usuario","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"product_id\": \"user-qa-2-ahorro\",\r\n \"product_number\": \"user-qa-2-number-ahorro\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2-vista\",\r\n \"product_number\": \"user-qa-2-number-vista\",\r\n \"product_type\": \"cuenta_vista\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2-tc\",\r\n \"product_number\": \"user-qa-2-number-tc\",\r\n \"product_type\": \"tarjeta_debito\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v1/core-service/users/{{user_external_id}}/products/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"335a8711-3d76-4a31-900e-c35d4622fc90"},{"name":"Añadir cuentas a un usuario v2","id":"8e6a2821-d5cb-4120-9621-7f4131ad2022","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_app}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"product_id\": \"user-qa-2-ahorro\",\r\n \"product_number\": \"user-qa-2-number-ahorro\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2-vista\",\r\n \"product_number\": \"user-qa-2-number-vista\",\r\n \"product_type\": \"cuenta_vista\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2-tc\",\r\n \"product_number\": \"user-qa-2-number-tc\",\r\n \"product_type\": \"tarjeta_debito\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v1/core-service/users/{{user_external_id}}/accounts/","description":"(CAMBIAR PRODUCT POR ACCOUNT)
\nEste endpoint permite persistir un listado de productos asociados al usuario con el external_id indicado en la URL. Solo se persisten los productos con product_id que aún no se hayan registrado en Xerpa.
Método: POST
URL: /api-middleware/v1/core-service/users/{{user_external_id}}/accounts/
Parámetros de ruta:
\nArray de productos asociados al usuario. Cada producto debe tener los siguientes campos:
\nproduct_id (string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa.
\nproduct_number (string): Identificador de cuenta que será visible en el frontend.
\nproduct_type (string): Identificador del tipo de cuenta. Ej: cuenta_ahorro, cuenta_vista. Deben definirse los tipos que serán usados por el banco de acuerdo a sus productos habilitados para usar la solución Xerpa.
[\n {\n \"product_id\": \"user-qa-2-ahorro\",\n \"product_number\": \"user-qa-2-number-ahorro\",\n \"product_type\": \"cuenta_ahorro\"\n },\n {\n \"product_id\": \"user-qa-2-vista\",\n \"product_number\": \"user-qa-2-number-vista\",\n \"product_type\": \"cuenta_vista\"\n },\n {\n \"product_id\": \"user-qa-2-tc\",\n \"product_number\": \"user-qa-2-number-tc\",\n \"product_type\": \"tarjeta_debito\"\n }\n]\n\nRetorna un JSON vacio, indicando que se realizo correctamente la operación.
\n","urlObject":{"path":["api-middleware","v1","core-service","users","{{user_external_id}}","accounts",""],"host":["{{host_middleware}}"],"query":[],"variable":[]}},"response":[{"id":"9d392ed8-2a40-4666-b7f5-5861ca6bdb7a","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n [\r\n {\r\n \"product_id\": \"user-qa-2e\",\r\n \"product_number\": \"user-qa-2-number-e\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n },\r\n {\r\n \"product_id\": \"user-qa-2f\",\r\n \"product_number\": \"user-qa-2-number-f\",\r\n \"product_type\": \"cuenta_ahorro\"\r\n }\r\n ]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}api-middleware/v1/core-service/users/{{user_external_id}}/products/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2e\",\n \"product_number\": \"user-qa-2-number-e\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2f\",\n \"product_number\": \"user-qa-2-number-f\"\n }\n]"}],"_postman_id":"8e6a2821-d5cb-4120-9621-7f4131ad2022"},{"name":"Obtener cuentas de un usuario","id":"ca61c96c-fe05-4616-b55a-6313c257aa32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_middleware}}/api-middleware/v1/core-service/users/{{user_external_id}}/accounts/","urlObject":{"path":["api-middleware","v1","core-service","users","{{user_external_id}}","accounts",""],"host":["{{host_middleware}}"],"query":[],"variable":[]}},"response":[{"id":"55281b3e-c133-45f1-a341-6f378606997f","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"{{host_middleware}}api-middleware/v1/core-service/users/{{user_external_id}}/products/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"product_type\": \"cuenta_vista\",\n \"product_id\": \"xh-user-qa-1-dev2\",\n \"product_number\": \"xxxxx-123-xxx\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"xh-user-qa-1-dev\",\n \"product_number\": \"xxxxx-456-xxx\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"xh-user-qa-1-dev3\",\n \"product_number\": \"xxxxx-789-xxx\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2c\",\n \"product_number\": \"user-qa-2-number-a\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2d\",\n \"product_number\": \"user-qa-2-number-b\"\n },\n {\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"1b776e47-9ef2-4536-b1ea-c62700e15bf8\",\n \"product_number\": \"7dc3cb92-810e-431f-b82f-ef814ad18c92\"\n }\n]"}],"_postman_id":"ca61c96c-fe05-4616-b55a-6313c257aa32"},{"name":"Cambiar estado de cuenta","id":"d79f1407-3549-4bda-bd72-c0666b6f3aec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":false},"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"product_status\": \"uuid_cuenta_activa\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v1/core-service/users/{{user_external_id}}/products/{{account_id}}/","urlObject":{"path":["api-middleware","v1","core-service","users","{{user_external_id}}","products","{{account_id}}",""],"host":["{{host_middleware}}"],"query":[],"variable":[]}},"response":[{"id":"937f0eba-481f-4f7a-99f4-8cd45a437037","name":"Successful Response","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"product_status\": \"cuenta_activa\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}api-middleware/v1/core-service/users/{{user_external_id}}/products/{{account_id}}/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"product_type\": \"cuenta_ahorro\",\n \"product_id\": \"user-qa-2e\",\n \"product_number\": \"user-qa-2-number-e\"\n}"}],"_postman_id":"d79f1407-3549-4bda-bd72-c0666b6f3aec"}],"id":"2804de5a-0f22-42b5-91d8-a3d44f637fbf","description":"A través de las cuentas se registran todos los productos financieros asociados a los usuarios. Sobre las cuentas después se puende registrar transacciones de ingresos y gastos.
\nLa información de las cuentas de recibe de forma anonimizada y se identifican a través de un account_id. De forma adicional se recibe un account number, que corresponde a un número enmascarado de la cuenta para mostrarle al usuario final.
\nLas cuentas que se vinculan a un usuario deben contener la siguiente información.
\nSe pueden recibir los siguientes productos financieros para asociarlos al usuario
\n","_postman_id":"2804de5a-0f22-42b5-91d8-a3d44f637fbf","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}}},{"name":"Ahorros","item":[{"name":"Flujo de ahorros en batch","item":[],"id":"c569b656-ebe5-41cd-b47c-3269e9a5d124","_postman_id":"c569b656-ebe5-41cd-b47c-3269e9a5d124","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}}},{"name":"Ahorros y retiros manuales","item":[{"name":"Transaccion manual de ahorro","id":"92316e50-f315-4597-9b3a-cf9c999bdd83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9ee8ef8e\",\r\n \"pk\": \"{{project_id}}\",\r\n \"amount\": 10.00,\r\n \"from_account\": \"test_user_api_2_account_1\",\r\n \"to_account\": \"test_user_api_2_account_2\",\r\n \"operation_id\": \"91f2c328-11b7-4376-a0c8-a74f45e66daa\",\r\n \"date_time\": \"20230804150250\",\r\n \"authorization\": {\r\n \"token\": \"token de banco\",\r\n \"jwToken\": \"token\"\r\n },\r\n \"metadata\":{\r\n \"type\": \"saving\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v1/savings/manual-movement/","description":"Este endpoint permite realizar un movimiento manual de ahorros entre cuentas de usuario en el sistema.
\nMétodo: POST
\nURL: {{host_middleware}}/api-middleware/v1/savings/manual-movement/
\nuser_id (string): Identificador único del usuario que realiza el movimiento.
pk (string): Identificador del proyecto asociado al movimiento.
amount (integer): Monto a mover entre las cuentas.
from_account (string): Cuenta de origen desde la cual se retira el monto.
to_account (string): Cuenta de destino a la cual se deposita el monto.
operation_id (string): Identificador único de la operación.
date_time (string): Fecha y hora del movimiento en formato YYYYMMDDHHMMSS.
authorization (object): Información de autorización que incluye:
token (string): Token de autorización del banco.
jwToken (string): Token JWT para la sesión.
metadata (object): Información adicional sobre el movimiento, que incluye:
type (string): Tipo de movimiento, en este caso \"saving\".{\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9e...\",\n \"pk\": \"{{project_id}}\",\n \"amount\": 10,\n \"from_account\": \"test_user_api_2_account_1\",\n \"to_account\": \"test_user_api_2_account_2\",\n \"operation_id\": \"91f2c328-11b7-4376-a0c8-a74f45...\",\n \"date_time\": \"20230804150250\",\n \"authorization\": {\n \"token\": \"token de banco\",\n \"jwToken\": \"token\"\n },\n \"metadata\": {\n \"type\": \"saving\"\n }\n}\n\nResponse:
\nstatusCode (integer): Código de estado de la respuesta, donde 0 indica éxito.
body (object): Contenido del cuerpo de la respuesta que incluye:
message (string): Mensaje de confirmación o error.headers (object): Encabezados de la respuesta que pueden incluir información adicional sobre la respuesta.
Response Format:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"statusCode\": {\n \"type\": \"integer\",\n \"const\": 200\n },\n \"body\": {\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"const\": \"OK\"\n }\n }\n },\n \"headers\": {\n \"type\": \"object\",\n \"properties\": {\n \"Content-Type\": {\n \"type\": \"string\",\n \"const\": \"application/json\"\n },\n \"Access-Control-Allow-Origin\": {\n \"type\": \"string\",\n \"const\": \"*\"\n },\n \"Access-Control-Allow-Credentials\": {\n \"type\": \"boolean\",\n \"const\": true\n }\n }\n }\n }\n}\n\nEste endpoint permite realizar un movimiento manual de ahorros de manera asíncrona entre cuentas de usuario. Se utiliza para transferir un monto específico de una cuenta a otra, registrando la operación y su estado.
\nMétodo: POST
\nURL: {{host_middleware}}/api-middleware/v1/savings/manual-movement-async/
user_id(string): Identificador único del usuario que realiza la operación.
pk(string): Identificador del proyecto relacionado con la operación.
amount(number): Monto a transferir entre las cuentas.
from_account(string): Cuenta de origen desde la cual se transfiere el monto.
to_account(string): Cuenta de destino a la cual se transfiere el monto.
operation_id(string): Identificador único de la operación de movimiento.
date_time(string): Fecha y hora en formato YYYYMMDDHHMMSS en la que se realiza la operación.
authorization(object): Información de autorización para la operación.
token(string): Token de autorización del banco.
jwToken(string): Token JWT para la autorización.
metadata(object): Metadatos adicionales sobre la operación.
type(string): Tipo de operación, en este caso, \"saving\".{\n \"user_id\": \"7a1cb76c-9af3-4557-bc6c-f56f9e ...\",\n \"pk\": \"{{project_id}}\",\n \"amount\": 10,\n \"from_account\": \"test_user_api_2_account_1\",\n \"to_account\": \"test_user_api_2_account_2\",\n \"operation_id\": \"91f2c328-11b7-4376-a0c8-a74f45 ...\",\n \"date_time\": \"20230804150250\",\n \"authorization\": {\n \"token\": \"token de banco\",\n \"jwToken\": \"token\"\n },\n \"metadata\": {\n \"type\": \"saving\"\n }\n}\n\njob(object): Información sobre el trabajo de movimiento.
id(string): Identificador del trabajo.
job_type(object): Tipo de trabajo.
id(string): Identificador del tipo de trabajo.
catalog(string): Catálogo del tipo de trabajo.
item_name(string): Nombre del ítem del tipo de trabajo.
description(string): Descripción del tipo de trabajo.
metadata(object): Metadatos del tipo de trabajo.
max_waiting_seconds_at_origin(number): Tiempo máximo de espera en segundos en el origen.job_status(object): Estado del trabajo.
id(string): Identificador del estado del trabajo.
catalog(string): Catálogo del estado del trabajo.
item_name(string): Nombre del ítem del estado del trabajo.
description(string): Descripción del estado del trabajo.
metadata(object): Metadatos del estado del trabajo.
external_id(string): Identificador externo del trabajo.
user_id(string): Identificador del usuario que realizó la operación.
created_at(string): Fecha y hora de creación del trabajo.
updated_at(string): Fecha y hora de actualización del trabajo.
metadata(object): Metadatos adicionales sobre el trabajo.
service_response(object): Respuesta del servicio.
request_id(string): Identificador de la solicitud.
status_code(number): Código de estado de la respuesta.
{\n \"type\": \"object\",\n \"properties\": {\n \"job_type\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"max_waiting_seconds_at_origin\": { \"type\": \"integer\" }\n },\n \"additionalProperties\": false\n }\n }\n },\n \"job_status\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"catalog\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"item_name\": { \"type\": \"string\" },\n \"description\": { \"type\": \"string\" },\n \"metadata\": { \"type\": \"object\" }\n }\n },\n \"external_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"user_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"created_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"updated_at\": { \"type\": \"string\", \"format\": \"date-time\" },\n \"metadata\": { \"type\": \"object\" },\n \"service_response\": {\n \"type\": \"object\",\n \"properties\": {\n \"request_id\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"status_code\": { \"type\": \"integer\" }\n }\n }\n }\n \"additionalProperties\": false\n}\n\nGenerated from cURL: curl --location 'localhost:8000/api-middleware/v1/savings/callbacks/transfer-status/'
--header 'Content-Type: application/json'
--data '{\n \"operation_id\": \"76bc81e6-9f7d-461e-96c6-a63ca9d6eeaf\",\n \"status\": \"error\",\n \"error_code\": \"3\",\n \"error_message\": \"Error al procesar llamada al servicio abonar excepcion\",\n \"bank_reference\": \"ref-banco-002\"\n}'
Este endpoint permite actualizar proyectos de ahorro asociados a una cuenta específica de un usuario externo. Se utiliza para modificar el progreso de los proyectos en función de la cuenta de destino proporcionada.
\nMétodo: POST
\nURL: {{host_middleware}}/api-middleware/v1/savings/projects/update-by-to-account/
external_user_id (string): Identificador del usuario externo que está realizando la actualización.
update_projects (array of objects): Lista de proyectos a actualizar.
to_account (string): Cuenta de destino a la que se asocia el proyecto.
progress (string): Progreso del proyecto en formato de cadena.
{\n \"external_user_id\": \"test_user_api_2\",\n \"update_projects\": [\n {\n \"to_account\": \"test_user_api_2_account_4\",\n \"progress\": \"440.20\"\n }\n ]\n}\n\nmessage (string): Mensaje de respuesta del servidor.{\n \"type\": \"object\",\n \"properties\": {\n \"message\": {\n \"type\": \"string\",\n \"const\": \"project updated\"\n }\n }\n}\n\nPermite el registro de transacciones asociadas a múltiples usuarios. Se recibe la información desde un archivo que cuenta con una estructura definida para luego ser procesada e ingresado los registros en la base
\nToda la información se comunica mediante archivos en un filesystem que provee Xerpa y donde sólo el banco tiene acceso mediante credenciales de autenticación.
\nDiariamente se deposita un archivo con los identificadores de los usuarios registrados en la solución para que el banco consulte sus transacciones. Este archivo se genera automáticamente a una hora en específico a definir por el banco.
ej: 11 PM
Este paso es opcional y depende si el banco necesita o no un registro de usuarios para la consulta de transacciones del paso siguiente.
\nEl banco consulta las transacciones de los productos del usuario registradas desde el último archivo.
El período de consulta dependerá de que tan frecuente se haga este proceso. La recomendación es que sea diario y en los días hábiles del banco. Esto significa de lunes a viernes exceptuando festivos.
Las transacciones que se deben enviar deben incluir productos como:
\nCuentas
\nTarjetas débito
\nTarjetas crédito
\nSe comunican las transacciones en archivos con una estructura definida. Pueden ser uno o más archivos.
\nJunto a cada archivo de datos, se debe adjuntar un archivo bandera con el mismo nombre y extensión .data para indicar al filewatcher que el archivo original fue subido exitosamente y lo pueda leer.
\nCada archivo es validado y en caso de error se deja un archivo de control con el código de error.
\nEn caso de ser válido, se procesa el archivo y se genera un archivo de control con la cantidad de registros procesados.
\nInternamente las transacciones son limpiadas y clasificadas.
\nEl archivo corresponde a un documento de texto plano donde las columnas están separadas por pipe | y donde se incluyen las cabeceras de cada columna.
transactions.txt
\ntransaction_id|user_id|account_id|transaction_type|transaction_date|description|amount|transaction_code\n64163688-75A9-E935-7B8B-674188B35234|619A8DFD-2A48-D08A-DBAC-20553AA324D2|5264427F-C862-6A9C-57E0-D01C8AB8562E|product_cc|2022-05-03|NETFLIX|86.71|665\n033D42A6-1CC2-31B6-DC67-703DB2661F14|DA3356AD-D4B9-FC82-3C31-AC436E6667EA|065A72DE-56D1-47DF-5D53-E9841D9B02E8|product_cc|2022-05-04|AMAZON|157.77|200\nD02085FD-077E-C8C3-5A06-C0988845A717|F26303B8-48C5-A0A6-9025-D9A1D1B45D7D|31190A0B-2FC2-16CE-5171-55DBCD903E51|product_ca|2022-05-05|MC Donalds|102.81|574\n7A03C20D-F77D-6532-067C-BAE5A8429F2C|C47F4E49-08E0-3316-ACEB-F56876F89D44|8B93B55B-EB90-4DD6-6E2D-4FF8A1419008|product_cc|2022-05-06|ATM|8.19|509\n436A356A-B04F-FF11-E15F-19E7D95E91F1|568637AD-41EA-CDDC-624F-5696EC7642B3|99CE730B-481A-2B8E-A418-79E6AA4FE6B2|product_cc|2022-05-07|WALMART|76.12|753\nD1D50F6A-F19E-D02E-37AC-BFF3AA3C6E57|436E4E0C-BD96-B055-EECF-2A922D14A9CF|E19BAE90-54EA-2719-84C1-AA9E4D5A7F05|product_ca|2022-05-08|SEVEN11|150.6|783\n3CC87066-D1B9-7684-FAF3-0E07658CAFA6|4B55441C-B39D-A411-8AEA-CC97AD3AAF2A|291066CA-03C6-6AD6-7727-DB6E5EA677B7|product_cc|2022-05-09|HM|236.76|223\n\nEste endpoint permite persistir un listado de transacciones para ser procesados y registrados por Xerpa. Las transacciones pueden pertenecer a uno o múltiples usuarios.
\nEl servicio responde con un objeto donde indica cuántas de las transacciones fueron correctamente registradas y cuántas hubo error.
\n\n\nCada transacción debe tener un transaction_id único el cual será validado con las transacciones recibidas para identificar si exite duplicación con algún registro anterior.
\n
Método: POST
\nURL: {{host_middleware}}/api-middleware/v1/pfm-service/transactions/
\nArray de transacciones que se desea registrar. Cada transacción debe tener los siguientes campos:
\ntransaction_id (string): Identificador único de la transacción dentro de los sistemas del Banco. Permite identificar si la transacción ya ha sido registrada en la solución Xerpa y evitar duplicación.
account_id (string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa. Permite asociar la transacción a una cuenta de usuario que debe existir previamente.
transaction_date (string): Fecha de la transacción en formato YYYY-MM-DD.
amount (string): Monto de la transacción. Un gasto es un monto negativo. Un ingreso es un monto positivo.
description (string): Descripción de la transacción.
currency (string): Moneda en la que está expresado el monto de la transacción.
transaction_mcc (string, opcional): MCC código asignado por el procesador de la transacción y es un número de cuatro dígitos listado en ISO 18245.
transaction_type (string, opcional): Código de catálogo interno del banco que representa tipos de transacciones de acuerdo a canal, medio de pago, origen u otro criterio relevante para el banco.
[\n {\n \"user_id\": \"id_user_1\",\n \"transaction_id\": \"invalid\",\n \"account_id\": \"invalid\", (external id)\n \"transaction_date\": \"2024-09-20\",\n \"transaction_type\": \"\",\n \"amount\": \"-6000\",\n \"description\": \"NETFLIX 2\",\n \"transaction_mcc\": \"\",\n \"currency\": \"CLP\"\n }\n]\n\ncreated (integer): Cantidad de transacciones creadas.
\nerrors (array): Lista de errores que ocurrieron durante el proceso.
\nreceived (integer): Cantidad de transacciones recibidas.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"created\": {\n \"type\": \"integer\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"received\": {\n \"type\": \"integer\"\n }\n }\n}\n\nEste endpoint permite persistir un listado de transacciones para distintos usuarios y cuentas.
\nMétodo: POST
\nURL: {{host_middleware}}/api-middleware/v2/pfm-service/transactions/
\nArray de transacciones que se desea registrar. Cada transacción debe tener los siguientes campos:
\ntransaction_id (string): Identificador único de la transacción dentro de los sistemas del Banco. Permite identificar si la transacción ya ha sido registrada en la solución Xerpa y evitar duplicación.
user_id (string): Identificador del usuario al que le pertence la transacción
account_id (string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa. Permite asociar la transacción a una cuenta de usuario que debe existir previamente.
transaction_date (string): Fecha de la transacción en formato YYYY-MM-DD.
amount (string): Monto de la transacción. Un gasto es un monto negativo. Un ingreso es un monto positivo.
description (string): Descripción de la transacción.
currency (string): Moneda en la que está expresado el monto de la transacción.
transaction_mcc (string, opcional): MCC código asignado por el procesador de la transacción y es un número de cuatro dígitos listado en ISO 18245.
transaction_type (string, opcional): Código de catálogo interno del banco que representa tipos de transacciones de acuerdo a canal, medio de pago, origen u otro criterio relevante para el banco.
[\n {\n \"transaction_id\": \"invalid\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"transaction_date\": \"2024-09-20\",\n \"transaction_type\": \"\",\n \"amount\": \"-6000\",\n \"description\": \"NETFLIX 2\",\n \"transaction_mcc\": \"\",\n \"currency\": \"CLP\"\n }\n]\n\ncreated (integer): Cantidad de transacciones creadas.
\nerrors (array): Lista de errores que ocurrieron durante el proceso.
\nreceived (integer): Cantidad de transacciones recibidas.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"created\": {\n \"type\": \"integer\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"received\": {\n \"type\": \"integer\"\n }\n }\n}\n\nEste endpoint permite registrar las transacciones de uno o más usuarios y recibir como respuesta las transacciones enriquecidas de acuerdo al motor de enriquecimiento de Xerpa. En esta respuesta de enriquecimiento no se aplican las reglas personalizadas de los usuarios
\n\n\nEste endpoint permite hasta 100 transacciones distintas por petición.
\n
Método: POST
\nURL: {{host_middleware}}/api-middleware/v2/pfm-service/transactions-sync/
\nArray de transacciones que se desea registrar. Cada transacción debe tener los siguientes campos:
\ntransaction_id (string): Identificador único de la transacción dentro de los sistemas del Banco. Permite identificar si la transacción ya ha sido registrada en la solución Xerpa y evitar duplicación.
user_id (string): Identificador del usuario al que le pertence la transacción
account_id (string): Identificador alfanumérico único de la cuenta o producto del usuario dentro de la solución Xerpa. Permite asociar la transacción a una cuenta de usuario que debe existir previamente.
transaction_date (string): Fecha de la transacción en formato YYYY-MM-DD.
amount (string): Monto de la transacción. Un gasto es un monto negativo. Un ingreso es un monto positivo.
description (string): Descripción de la transacción.
currency (string): Moneda en la que está expresado el monto de la transacción.
transaction_mcc (string, opcional): MCC código asignado por el procesador de la transacción y es un número de cuatro dígitos listado en ISO 18245.
transaction_type (string, opcional): Código de catálogo interno del banco que representa tipos de transacciones de acuerdo a canal, medio de pago, origen u otro criterio relevante para el banco.
[\n {\n \"transaction_id\": \"invalid\",\n \"user_id\": \"\",\n \"account_id\": \"\",\n \"transaction_date\": \"2024-09-20\",\n \"transaction_type\": \"\",\n \"amount\": \"-6000\",\n \"description\": \"NETFLIX 2\",\n \"transaction_mcc\": \"\",\n \"currency\": \"CLP\"\n }\n]\n\ncreated (integer): Cantidad de transacciones creadas.
\nerrors (array): Lista de errores que ocurrieron durante el proceso.
\nreceived (integer): Cantidad de transacciones recibidas.
\n{\n \"type\": \"object\",\n \"properties\": {\n \"created\": {\n \"type\": \"integer\"\n },\n \"errors\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"received\": {\n \"type\": \"integer\"\n }\n }\n}\n\nSe diponibiliza un endpoint para recibir las transacciones de los usuarios. Este servicio permite un array de transacciones que pueden pertenecer a uno a varios usaurios. La información esperada es la misma que e
\n","_postman_id":"722e5ebe-030d-48eb-8342-a276b997cce9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}}},{"name":"Ingesta de transacciones","id":"e99b0df6-6c65-45db-abc5-cdc1e6576ba2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_app}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"transaction_id\": \"trx-batch-002\",\n \"user_id\": \"user-001\",\n \"transaction_date\": \"2026-01-15\",\n \"amount\": \"50000\",\n \"description\": \"transferencia\",\n \"transaction_mcc\": \"9999\",\n \"transaction_type\": \"100\",\n \"currency\": \"CLP\",\n \"account\": {\n \"account_id\": \"acc-100\",\n \"account_number\": \"**** 1234\",\n \"account_currency\": \"CLP\",\n \"account_type\": \"cuenta_vista\"\n },\n \"contract\": {\n \"contract_id\": \"con-50\",\n \"contract_role\": \"contract_user_role_owner\"\n }\n}\n]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v2/pfm-service/transactions-sync/","urlObject":{"path":["api-middleware","v2","pfm-service","transactions-sync",""],"host":["{{host_middleware}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e99b0df6-6c65-45db-abc5-cdc1e6576ba2"},{"name":"load-and-get-report","id":"58238d6b-48b7-4b19-9ed5-f58b10e4b3ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"transaction_id\": \"54576a41-ceee-4a3f-bea1-e102f3c7911b\",\n \"user_id\": \"{{user_id}}\",\n \"account_id\": \"user-qa-2e\",\n \"transaction_date\": \"2025-09-10\",\n \"transaction_type\": \"\",\n \"amount\": \"-1234\",\n \"description\": \"SALCOBRAND 578 ANTOF \",\n \"transaction_code\": \"\",\n \"currency\": \"CLP\",\n \"external_user_id\": \"xh-user-qa-1\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{host_middleware}}/api-middleware/v2/pfm-service/transactions/load-and-get-report/","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}},"urlObject":{"path":["api-middleware","v2","pfm-service","transactions","load-and-get-report",""],"host":["{{host_middleware}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"58238d6b-48b7-4b19-9ed5-f58b10e4b3ee"}],"id":"efaafbc7-0ef9-41b7-ae85-0396e775aff0","description":"Las transacciones son todos los movimientos de cuentas y tarjetas (débito y crédito) que se generan en los productos del cliente.
\nEn Xerpa se utilizan para aplicación de las reglas de ahorro transaccionales y también para la presentación de todas las funcionalidades del módulo de Control de Gastos.
\nLas transacciones siempre están asociadas a un usuario y a una cuenta que este usuario tiene.
\nCada transacción se compone con la siguiente información
\nLas transacciones son insumos para las soluciones de Ahorro Automático y Control de Gastos. Sin embargo, dependiendo de los servicios contratados los diferentes tipos de transacciones pueden o no ser necesarios.
\nPara la solución de Control de Gastos, se buscan todas aquellas transacciones que impacten en los saldos de los productos del cliente.
\nPara el Ahorro Automático se necesitan las compras realizadas con sus cuentas y tarjetas principalmente
\nTodas las transacciones son procesadas por el servicio para identificar un comercio, asociarles una categoría y extraer otra información relevante para ser utilizada dentro del PFM
\n\n\n+100K Comercios registrados
\n
+90% Categorización
+70% Identificación de comercios
Este servicio puede agregar hasta 12 campos de información a cada transacción. Un equipo Xerpa se preocupa de alimentar y actualizar la base de comercios y glosas para mantener las métricas de cobertura
\n![](\"https://lh7-rt.googleusercontent.com/slidesz/AGV_vUdScLR9GtZGGnS1pl23MIl7uBoIBhxpyWZmjl1D6_RGQv2mw9iFYLDL9CXxMgDeSASM8Vg0oZ3OKOiWKbA7i0vQTJFhDQRKR3Q2JPtDgiojTRs0qYxuFd5wndfQvYM1Q1HD8s5Y=s2048?key=SmcJkW1I-s0Xg8fRA-aSgyak\")
\n\nSe disponibilizan directamente desde el CDN de Xerpa para su uso. Los logos son imágenes en formato PNG de dimensiones de 128x128 pixeles.
\n![](\"https://lh7-rt.googleusercontent.com/slidesz/AGV_vUd21xexCjzG0rp3FbbgoxXvMDlKbjiYACScCAfymgRRjYghv37DhJ4bUuBCpR9OUPw8ja7yJNjAcmIH6ZWVB5eEOEjovzFeM1gdaV-GuHSSrFOexfFfqcAo_T6YHcmUUU0y5AhmXw=s2048?key=SmcJkW1I-s0Xg8fRA-aSgyak\")
\n\n![](\"https://lh7-rt.googleusercontent.com/slidesz/AGV_vUdWgkyHdfbkzQEShwUiKhVPYeekxztpmhsXanpaQY4gJ1a5KpNNseTOhLVcV98lisIWxp7FYCasTT5L9qhmCZ0upw5phCG_u6oGRNJ5zZcbCSzA1i_o0bv3ZEzPucZXaUeCtb4t=s2048?key=SmcJkW1I-s0Xg8fRA-aSgyak\")
\n\n![](\"https://lh7-rt.googleusercontent.com/slidesz/AGV_vUdHegHw12DlppOYS2Rgo-dXMsbH9SR1mhhZgmvIkETBpXc6Q49BT2kFn7wHpOATVZXqIzUVUAbU5ZCIG7a3w16xmyqU6Ox2Apa7HXPScGTqUkS8F4MgvsymV2G0PokCZapWOI2b9g=s2048?key=SmcJkW1I-s0Xg8fRA-aSgyak\")
\n\nXerpa permite la recepción de las transacciones con distintos mecanismos para adaptarse a las necesidades técnicas y de negocio del cliente.
\nIndependiente del mecanismo de ingesta son necesarios los mismos datos para registrar cada transacción.
\n","_postman_id":"efaafbc7-0ef9-41b7-ae85-0396e775aff0","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":true,"source":{"_postman_id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","id":"4e622036-5dc7-4ba2-8e66-c5f3ec1321df","name":"API Xerpa Middleware","type":"collection"}}},{"name":"Notificaciones","item":[{"name":"Lista de notificaciones externas","id":"34ec1057-6d20-450d-bbaf-2a8e126ef10c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token_middleware}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_middleware}}/api-middleware/v1/notification-api/notifications/?page=1&page_size=5","description":"Este endpoint permite obtener información sobre las notificaciones asociadas al usuario. Devuelve detalles sobre el estado de las notificaciones, incluyendo su tipo, campaña asociada y otros atributos relevantes.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/notifications/
Parámetros de query:
\npage (número): Número de página a obtener (Opcional).
page_size (número): Número de notificaciones por página (Opcional).
send (booleano): Filtrar notificaciones enviadas (Opcional).
active (booleano): Filtrar notificaciones activas (Opcional).
ignored (booleano): Filtrar notificaciones ignoradas (Opcional).
read (booleano): Filtrar notificaciones leídas (Opcional).
expired (booleano): Filtrar notificaciones expiradas (Opcional).
notification_campaign (string): Filtrar por campaña de notificación (Opcional).
Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
next (string): URL para la siguiente página de resultados.
previous (string): URL para la página anterior de resultados.
total_pages (integer): Total de páginas disponibles.
current_page (integer): Página actual de resultados.
offset (integer): Desplazamiento de los resultados.
results (array): Lista de notificaciones.
id (string): Identificador único de la notificación.
created_at (string): Fecha de creación de la notificación.
updated_at (string): Fecha de última actualización de la notificación.
notification_type (string): Tipo de notificación.
notification_campaign (string): Campaña asociada a la notificación.
user_id (string): Identificador del usuario asociado a la notificación.
ignored (boolean): Indica si la notificación fue ignorada.
read (boolean): Indica si la notificación ha sido leída.
sent (boolean): Indica si la notificación fue enviada.
publication_date (string): Fecha de publicación de la notificación.
expiration_date (string): Fecha de expiración de la notificación.
priority_level (integer): Nivel de prioridad de la notificación.
content (object): Contenido de la notificación.
image (string): URL de la imagen asociada a la notificación.
title (string): Título de la notificación.
action (object): Acción asociada a la notificación.
event (object): Evento relacionado.
reportId (string): Identificador del reporte (Opcional).
pageEvent (string): Evento de página (Opcional).
route (string): Ruta asociada a la acción.
origin (string): Origen de la acción.
subtitle (string): Subtítulo de la notificación (Opcional).
user_external_id (string): Identificador externo del usuario (Opcional).
count (integer): Número total de notificaciones.
{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri-reference\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri-reference\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"notification_type\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"notification_campaign\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"user_id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"ignored\": {\n \"type\": \"boolean\"\n },\n \"read\": {\n \"type\": \"boolean\"\n },\n \"sent\": {\n \"type\": \"boolean\"\n },\n \"publication_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"expiration_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"priority_level\": {\n \"type\": \"integer\"\n },\n \"content\": {\n \"type\": \"object\",\n \"properties\": {\n \"image\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"subtitle\": {\n \"type\": \"string\"\n },\n \"action\": {\n \"type\": \"object\",\n \"properties\": {\n \"event\": {\n \"type\": \"object\",\n \"properties\": {\n \"projectId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"isProjectCreate\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"route\": {\n \"type\": \"string\"\n },\n \"origin\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"user_external_id\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite recuperar las notificaciones de un usuario específico en el sistema. Se puede paginar la respuesta utilizando los parámetros de consulta.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/users/{{user_external_id}}/notifications/
Parámetros de ruta:
\nuser_external_id(string): ID externo del usuario para el cual se desean obtener las notificaciones.Parámetros de query:
\npage_size(integer): Número de notificaciones a retornar por página (Opcional).
page(integer): Número de página a retornar (Opcional).
Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
next(string): URL para la siguiente página de resultados.
previous(string|null): URL para la página anterior de resultados.
total_pages(integer): Total de páginas de resultados.
current_page(integer): Página actual de resultados.
offset(integer): Desplazamiento de los resultados.
results(array): Lista de notificaciones.
id(string): ID de la notificación.
created_at(string): Fecha y hora de creación de la notificación.
updated_at(string): Fecha y hora de actualización de la notificación.
notification_type(string): Tipo de notificación.
notification_campaign(string): Campaña de notificación asociada.
user_id(string): ID del usuario asociado a la notificación.
ignored(boolean): Indica si la notificación fue ignorada.
read(boolean): Indica si la notificación fue leída.
sent(boolean): Indica si la notificación fue enviada.
publication_date(string): Fecha de publicación de la notificación.
expiration_date(string): Fecha de expiración de la notificación.
priority_level(integer): Nivel de prioridad de la notificación.
content(object): Contenido de la notificación.
image(string): URL de la imagen asociada a la notificación.
title(string): Título de la notificación.
action(object): Acción asociada a la notificación.
event(object): Evento relacionado.
reportId(string): ID del informe asociado al evento.
pageEvent(string): Evento de página relacionado.
route(string): Ruta a la que se redirige al usuario.
origin(string): Origen de la acción.
subtitle(string): Subtítulo de la notificación.
user_external_id(string): ID externo del usuario asociado a la notificación.
count(integer): Número total de notificaciones retornadas.
{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri-reference\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri-reference\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"notification_type\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"notification_campaign\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"user_id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"ignored\": {\n \"type\": \"boolean\"\n },\n \"read\": {\n \"type\": \"boolean\"\n },\n \"sent\": {\n \"type\": \"boolean\"\n },\n \"publication_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"expiration_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"priority_level\": {\n \"type\": \"integer\"\n },\n \"content\": {\n \"type\": \"object\",\n \"properties\": {\n \"image\": {\n \"type\": \"string\"\n },\n \"title\": {\n \"type\": \"string\"\n },\n \"subtitle\": {\n \"type\": \"string\"\n },\n \"action\": {\n \"type\": \"object\",\n \"properties\": {\n \"event\": {\n \"type\": \"object\",\n \"properties\": {\n \"projectId\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"isProjectCreate\": {\n \"type\": \"boolean\"\n }\n }\n },\n \"route\": {\n \"type\": \"string\"\n },\n \"origin\": {\n \"type\": \"string\"\n }\n }\n }\n }\n },\n \"user_external_id\": {\n \"type\": \"string\"\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite cambiar el estado de ignorado de una notificación específica para un usuario registrado en el sistema.
\nMétodo: POST
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/users/{{user_external_id}}/notifications/{{notification_id}}/change-ignored/
El cuerpo de la solicitud debe ser un objeto JSON con el siguiente parámetro:
\nignored (boolean): Indica si la notificación debe ser ignorada o no.{\n \"ignored\": true\n}\n\nLa respuesta será un objeto JSON que contiene información sobre la notificación actualizada. Los campos de la respuesta incluyen:
\nid (string): ID de la notificación.
created_at (string): Fecha de creación de la notificación.
updated_at (string): Fecha de la última actualización de la notificación.
notification_type (string): Tipo de notificación.
notification_campaign (string): Campaña asociada a la notificación.
user_id (string): ID del usuario al que pertenece la notificación.
ignored (boolean): Estado de ignorado de la notificación.
read (boolean): Estado de lectura de la notificación.
sent (boolean): Estado de envío de la notificación.
publication_date (string): Fecha de publicación de la notificación.
expiration_date (string): Fecha de expiración de la notificación.
priority_level (integer): Nivel de prioridad de la notificación.
content (object): Contenido de la notificación, que incluye:
image (string): URL de la imagen asociada.
title (string): Título de la notificación.
action (object): Acción asociada a la notificación, que incluye:
event (object): Evento relacionado, que incluye:
reportId (string): ID del reporte.
pageEvent (string): Evento de página.
route (string): Ruta asociada a la acción.
origin (string): Origen de la acción.
subtitle (string): Subtítulo de la notificación.
user_external_id (string): ID externo del usuario.
\"content\": {\n \"type\": \"object\",\n \"properties\": {\n \"image\": { \"type\": \"string\" },\n \"title\": { \"type\": \"string\" },\n \"subtitle\": { \"type\": \"string\" },\n \"action\": {\n \"type\": \"object\",\n \"properties\": {\n \"event\": {\n \"type\": \"object\",\n \"description\": \"Estructura dinámica según tipo de evento\",\n \"unevaluatedProperties\": true,\n \"properties\": {},\n \"required\": []\n },\n \"route\": { \"type\": \"string\" },\n \"origin\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nEste endpoint permite cambiar el estado de lectura de una notificación específica para un usuario determinado. Al enviar una solicitud a este endpoint, se actualiza el estado de la notificación a \"leída\".
\nMétodo: POST
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/users/{{user_external_id}}/notifications/{{notification_id}}/change-read/
Parámetros de ruta:
\nuser_external_id(string): Identificador externo del usuario.
notification_id(string): Identificador de la notificación.
read(boolean): Indica si la notificación ha sido leída.{\n \"read\": true\n}\n\nid(string): Identificador de la notificación.
created_at(string): Fecha de creación de la notificación.
updated_at(string): Fecha de actualización de la notificación.
notification_type(string): Tipo de notificación.
notification_campaign(string): Campaña de notificación asociada.
user_id(string): Identificador del usuario.
ignored(boolean): Indica si la notificación fue ignorada.
read(boolean): Indica si la notificación ha sido leída.
sent(boolean): Indica si la notificación ha sido enviada.
publication_date(string): Fecha de publicación de la notificación.
expiration_date(string): Fecha de expiración de la notificación.
priority_level(integer): Nivel de prioridad de la notificación.
content(object): Contenido de la notificación.
image(string): URL de la imagen asociada a la notificación.
title(string): Título de la notificación.
action(object): Acción asociada a la notificación.
event(object): Evento relacionado.
reportId(string): Identificador del reporte.
pageEvent(string): Evento de página.
route(string): Ruta de la acción.
origin(string): Origen de la acción.
subtitle(string): Subtítulo de la notificación.
user_external_id(string): Identificador externo del usuario.
\"content\": {\n \"type\": \"object\",\n \"properties\": {\n \"image\": { \"type\": \"string\" },\n \"title\": { \"type\": \"string\" },\n \"subtitle\": { \"type\": \"string\" },\n \"action\": {\n \"type\": \"object\",\n \"properties\": {\n \"event\": {\n \"type\": \"object\",\n \"description\": \"Estructura dinámica según tipo de evento\",\n \"unevaluatedProperties\": true,\n \"properties\": {},\n \"required\": []\n },\n \"route\": { \"type\": \"string\" },\n \"origin\": { \"type\": \"string\" }\n },\n \"required\": [\"event\", \"route\", \"origin\"],\n \"additionalProperties\": false\n }\n },\n \"required\": [\"image\", \"title\", \"subtitle\", \"action\"],\n \"additionalProperties\": false\n}\n\n\nEste endpoint permite obtener las notificaciones asociadas a un usuario específico utilizando su identificador externo y el identificador de la notificación.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/users/{{user_external_id}}/notifications/{{notification_id}}/
Parámetros de ruta:
\nuser_external_id(string): Identificador externo del usuario.
notification_id(string): Identificador de la notificación.
Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
id(string): Identificador único de la notificación.
created_at(string): Fecha y hora de creación de la notificación.
updated_at(string): Fecha y hora de la última actualización de la notificación.
notification_type(string): Tipo de notificación.
notification_campaign(string): Campaña asociada a la notificación.
user_id(string): Identificador del usuario asociado a la notificación.
ignored(boolean): Indica si la notificación fue ignorada.
read(boolean): Indica si la notificación ha sido leída.
sent(boolean): Indica si la notificación ha sido enviada.
publication_date(string): Fecha de publicación de la notificación.
expiration_date(string): Fecha de expiración de la notificación.
priority_level(integer): Nivel de prioridad de la notificación.
content(object): Contenido de la notificación.
image(string): URL de la imagen asociada a la notificación.
title(string): Título de la notificación.
action(object): Acción asociada a la notificación.
event(object): Evento relacionado con la acción.
reportId(string): Identificador del reporte.
pageEvent(string): Evento de la página.
route(string): Ruta asociada a la acción.
origin(string): Origen de la acción.
subtitle(string): Subtítulo de la notificación.
user_external_id(string): Identificador externo del usuario.
\"content\": {\n \"type\": \"object\",\n \"properties\": {\n \"image\": { \"type\": \"string\" },\n \"title\": { \"type\": \"string\" },\n \"subtitle\": { \"type\": \"string\" },\n \"action\": {\n \"type\": \"object\",\n \"properties\": {\n \"event\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"projectId\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"isProjectCreate\": { \"type\": \"boolean\" }\n }\n },\n {\n \"type\": \"object\",\n \"properties\": {\n \"reportId\": { \"type\": \"string\", \"format\": \"uuid\" },\n \"pageEvent\": { \"type\": \"string\" }\n }\n }\n ]\n },\n \"route\": { \"type\": \"string\" },\n \"origin\": { \"type\": \"string\" }\n }\n }\n }\n}\n\nEste endpoint permite recuperar una lista de campañas de notificación basadas en varios parámetros de filtrado, como el tipo de notificación, el nombre, la fecha de creación y el estado activo. También soporta paginación para facilitar la navegación a través de grandes conjuntos de datos.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/campaigns/
Parámetros de query:
\npaginate (bool): Indica si se debe paginar la respuesta.
active (bool): Filtra las campañas activas o inactivas.
notification_type (string): ID del Tipo de notificación a filtrar.
name (string): Nombre de la campaña a filtrar.
created_at (string): Fecha de creación de la campaña.
notification_schedule_date (string): Fecha programada para la notificación.
ordering (string): Criterio de ordenamiento de los resultados.
page_size (integer): Número de resultados por página.
page (integer): Número de la página a recuperar.
Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
(No se incluye ejemplo ya que no hay cuerpo en la solicitud.)
\nnext (string): URL para la siguiente página de resultados.
previous (string): URL para la página anterior de resultados.
total_pages (integer): Total de páginas disponibles.
current_page (integer): Página actual de los resultados.
offset (integer): Desplazamiento actual en los resultados.
results (array of object): Lista de campañas de notificación.
id (string): Identificador único de la campaña.
created_at (string): Fecha de creación de la campaña.
updated_at (string): Fecha de última actualización de la campaña.
name (string): Nombre de la campaña.
description (string): Descripción de la campaña.
notification_type (string): Tipo de notificación de la campaña.
notification_schedule_date (string): Fecha programada para la notificación.
notification_built_date (string): Fecha en que se construyó la notificación.
metadata (object): Metadatos relacionados con la campaña.
channel_type_id (array of string): Identificadores de tipo de canal.active (bool): Indica si la campaña está activa.
internal_only (bool): Indica si la campaña es solo para uso interno.
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"notification_type\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"notification_schedule_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"notification_built_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"channel_type_id\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n }\n }\n }\n },\n \"active\": {\n \"type\": \"boolean\"\n },\n \"internal_only\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nEste endpoint permite obtener información detallada sobre una campaña específica en el sistema de notificaciones. Al realizar una solicitud GET a este endpoint, se recuperan los datos de la campaña identificada por el campaign_id.
Método: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/campaigns/{{campaign_id}}/
Parámetros de ruta:
\ncampaign_id (string): Identificador único de la campaña que se desea consultar.Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
id (string): Identificador único de la campaña.
created_at (string): Fecha y hora de creación de la campaña.
updated_at (string): Fecha y hora de la última actualización de la campaña.
name (string): Nombre de la campaña.
description (string): Descripción de la campaña.
notification_type (string): Tipo de notificación asociada a la campaña.
notification_schedule_date (string): Fecha programada para la notificación.
notification_built_date (string): Fecha en la que se construyó la notificación.
metadata (objeto): Metadatos adicionales sobre la campaña.
channel_type_id (array of strings): Identificadores de los tipos de canal asociados a la campaña.active (boolean): Indica si la campaña está activa.
internal_only (boolean): Indica si la campaña es solo para uso interno.
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"notification_type\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"notification_schedule_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"notification_built_date\": {\n \"type\": \"string\",\n \"format\": \"date\"\n },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"channel_type_id\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n }\n }\n }\n },\n \"active\": {\n \"type\": \"boolean\"\n },\n \"internal_only\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nEste endpoint permite obtener información sobre los tipos de canales de notificación disponibles en el sistema, con opciones de paginación.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/channel-type/
Parámetros de query:
\npaginate(booleano): Indica si se debe paginar la respuesta.
page_size(entero): Número de resultados por página.
Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
next(string): URL para la siguiente página de resultados (Opcional).
previous(string): URL para la página anterior de resultados (Opcional).
total_pages(entero): Número total de páginas disponibles.
current_page(entero): Número de la página actual.
offset(entero): Desplazamiento de los resultados.
results(array of object): Lista de resultados que contiene información sobre los tipos de canales.
id(string): Identificador único del canal.
created_at(string): Fecha de creación del canal.
updated_at(string): Fecha de última actualización del canal.
name(string): Nombre del canal.
description(string): Descripción del canal.
metadata(object): Metadatos adicionales del canal (Opcional).
internal_only(booleano): Indica si el canal es solo para uso interno.
{\n \"type\": \"object\",\n \"properties\": {\n \"next\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"previous\": {\n \"type\": [\"string\", \"null\"],\n \"format\": \"uri\"\n },\n \"total_pages\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"current_page\": {\n \"type\": \"integer\",\n \"minimum\": 1\n },\n \"offset\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"count\": {\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"results\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"metadata\": {\n \"type\": \"object\"\n },\n \"internal_only\": {\n \"type\": \"boolean\"\n }\n }\n }\n }\n }\n}\n\nEste endpoint permite obtener información sobre un tipo de canal de notificación específico en el sistema.
\nMétodo: GET
\nURL: /api-middleware/v1/notification-api/channel-type/{{channel_type_id}}/
Parámetros de ruta:
\nchannel_type_id (string): ID del tipo de canal (obligatorio).Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
La respuesta de este endpoint incluye los siguientes campos:
\nid (string): ID del tipo de canal.
created_at (string): Fecha y hora de creación del tipo de canal.
updated_at (string): Fecha y hora de la última actualización del tipo de canal.
name (string): Nombre del tipo de canal.
description (string): Descripción del tipo de canal.
metadata (object): Metadatos asociados al tipo de canal.
internal_only (boolean): Indica si el canal es solo para uso interno.
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"metadata\": {\n \"type\": [\"object\", \"null\"]\n },\n \"internal_only\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nEste endpoint permite recuperar los tipos de notificación disponibles en el sistema, con la opción de paginación para limitar la cantidad de resultados devueltos.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/notification-type/
Parámetros de query:
\npaginate(booleano): Indica si se debe paginar la respuesta.
page_size(entero): Número de resultados por página.
Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
next(string): URL para la siguiente página de resultados, si existe.
previous(string): URL para la página anterior de resultados, si existe.
total_pages(integer): Total de páginas disponibles.
current_page(integer): Número de la página actual.
offset(integer): Desplazamiento de los resultados.
results(array of object): Lista de tipos de notificación.
id(string): Identificador único del tipo de notificación.
created_at(string): Fecha de creación del tipo de notificación.
updated_at(string): Fecha de última actualización del tipo de notificación.
name(string): Nombre del tipo de notificación.
description(string): Descripción del tipo de notificación.
notification_category(string): Categoría de la notificación.
metadata(object): Metadatos asociados al tipo de notificación.
channels(array of string): Canales a través de los cuales se puede enviar la notificación.
priority_level(integer): Nivel de prioridad de la notificación.
expiration_days(integer): Días de validez de la notificación.
active(bool): Indica si el tipo de notificación está activo.
internal_only(bool): Indica si el tipo de notificación es solo para uso interno.
count(integer): Número total de tipos de notificación disponibles.
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"notification_category\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"channels\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"priority_level\": {\n \"type\": \"integer\"\n },\n \"expiration_days\": {\n \"type\": \"integer\"\n }\n }\n },\n \"active\": {\n \"type\": \"boolean\"\n },\n \"internal_only\": {\n \"type\": \"boolean\"\n }\n }\n}\n\nEste endpoint permite obtener información sobre un tipo de notificación específico utilizando su ID. Devuelve detalles como el nombre, la descripción, la categoría de notificación y metadatos asociados.
\nMétodo: GET
\nURL: {{host_middleware}}/api-middleware/v1/notification-api/notification-type/{{notification_type_id}}/
Parámetros de ruta:
\nnotification_type_id(string): ID del tipo de notificación que se desea consultar.Este request de tipo GET no requiere cuerpo. El cuerpo de la solicitud debe enviarse vacío.
id(string): Identificador único del tipo de notificación.
created_at(string): Fecha y hora de creación del tipo de notificación.
updated_at(string): Fecha y hora de la última actualización del tipo de notificación.
name(string): Nombre del tipo de notificación.
description(string): Descripción del tipo de notificación.
notification_category(string): Categoría a la que pertenece el tipo de notificación.
metadata(object): Metadatos asociados al tipo de notificación.
priority_level(integer): Nivel de prioridad de la notificación.
expiration_days(integer): Días hasta la expiración de la notificación.
active(boolean): Indica si el tipo de notificación está activo.
internal_only(boolean): Indica si la notificación es solo para uso interno.
{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"created_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"updated_at\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"notification_category\": {\n \"type\": \"string\",\n \"format\": \"uuid\"\n },\n \"metadata\": {\n \"type\": \"object\",\n \"properties\": {\n \"priority_level\": {\n \"type\": \"integer\"\n },\n \"expiration_days\": {\n \"type\": \"integer\"\n }\n }\n },\n \"active\": {\n \"type\": \"boolean\"\n },\n \"internal_only\": {\n \"type\": \"boolean\"\n }\n }\n}\n\n