{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"0e67c617-416e-4d5b-8c15-a27b81c8b601","name":"API Xerpa Transaction Enrichment","description":"Bienvenido a la API Transaction Enrichment, esta documentación te ayudará a conocer los conceptos básicos como la autenticación, peticiones, respuestas, etc. para que puedas utilizar de mejor maneja los productos de Xerpa.\n\n## ¿Qué es Transaction Enrichment?\n\nServicio que agrega propiedades sobre las transacciones de cuentas y tarjetas para enriquecerlas y ofrecer un mejor contexto al usuario y al banco sobre el tipo de transacción y el comercio asociado a ella.\n\n### Características\n\n- Predicción de categorías para ingresos y gastos\n    \n- 80% tasa de categorización efectiva\n    \n- Más de 15,000 comercios identificados con su nombre y logo.\n    \n- Operación en línea y en batch.\n    \n\n### Disponibilidad\n\nActualmente la solución se encuentra disponible con comercios de los siguientes países:\n\n- 🇨🇱 Chile\n    \n- 🇵🇪 Perú\n    \n- 🇲🇽 México  \n    Próximamente en:\n    \n- 🇨🇴 Colombia\n    \n- 🇪🇨 Ecuador\n    \n- 🇦🇷 Argentina\n    \n\n## Ambientes\n\nNuestras APIs están disponibles en tres ambientes:\n\n| Nombre | API URL | Acceso |\n| --- | --- | --- |\n| **Sandbox** | [https://sandbox.getxerpa.com/data-enrichment/](https://sandbox.getxerpa.com/data-enrichment/) | Público |\n| **Producción** | [https://pro.getxerpa.com/data-enrichment/](https://pro.getxerpa.com/data-enrichment/) | Privado |\n\nEl ambiente de Sandbox está expuesto a internet y es de uso público con previo registro. El ambiente de producción es de exclusivo uso de clientes Xerpa.\n\n# Logos de comercio\n\nLos comercios que se logran identificar por cada transacción y que tienen un logo se disponibiliza bajo la propiedad `merchant_logo_url` que viene en la respuesta de la API.\n\nSe disponibilizan directamente desde el CDN de Xerpa para su uso.\n\n<img src=\"../assets/images/ec9ac56d-985d-4dcd-99b9-bcf92b96acdf.png\" alt=\"ec9ac56d-985d-4dcd-99b9-bcf92b96acdf.png\">\n\n<img src=\"../assets/images/0b506dba-d58e-4967-842a-10c677407901.png\" alt=\"0b506dba-d58e-4967-842a-10c677407901.png\">\n\n<img src=\"../assets/images/0eb1eee1-f64d-48e6-9f41-3f4e12983c4b.png\" alt=\"0eb1eee1-f64d-48e6-9f41-3f4e12983c4b.png\">\n\n## Formato\n\nLos logos son imágenes en formato `PNG` de dimensiones de `128x128` pixeles.\n\n# Versionamiento\n\nTodas las APIs están versionadas para identificar qué funcionalidades están disponibles en cada una de ellas.\n\nLas funcionalidades que se vayan agregando o deprecando entre versiones se comunicarán en el documento de change log de cada versión.\n\nEn cada petición se debe indicar de forma explícita la versión a la cual se hace referencia:\n\n`https://pro.getxerpa.com/data-enrichment/`\n\n## Campos requeridos\n\nA 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.\n\n## Códigos de Respuesta\n\n| Código | Descripción |\n| --- | --- |\n| 200 | OK |\n| 201 | Recurso creado (POST) |\n| 204 | OK, no se devolvió contenido (usar para PATCH) |\n| 304 | No modificado |\n| 400 | Petición Incorrecta |\n| 401 | No autorizado (para usuarios no autenticados) |\n| 403 | Prohibido (para usuarios autenticados que no tienen los permisos adecuados) |\n| 404 | No encontrado |\n| 408 | Timeout |\n| 415 | Tipo de acción no admitida |\n| 429 | Límite de peticiones alcanzado |\n| 500 | Error interno de servidor |\n\n### Códigos de Error\n\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.\n\nEl **case-id** es un identificador único de la petición para trazar el error en los logs internos y atender actividades de soporte.\n\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.\n\n#### Ejemplo error\n\n``` json\n{ \n  case-id: UUID\n  error-code: XX-XXX\n}\n\n ```\n\n## Reintento de peticiones\n\nLas peticiones a la API pueden fallar por múltiples 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:\n\n- **5xx** (Server errors)\n    \n- **429** (Rate Limits)\n    \n- **408** (Timeouts)\n    \n\n## Límite de peticiones\n\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 y producción) independientemente.\n\nSi se alcanza el límite, las peticiones responderán con un error `HTTP 429`.\n\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.\n\n## Timeouts\n\nTodas nuestras APIs tienen timeouts para identificar que ha ocurrido un error lo antes posible y con eso puedas reintentar la petición. Es recomendable manejar los mismos tiempos de timeouts para los clientes.\n\n**Tiempo por Defecto** - La mayoría de las APIs arrojará un timeout a los _29 segundos_.\n\n## Fechas\n\nPara los registros que hacen uso de fechas, estas se manejan bajo el estándar [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) con UTC.\n\n- Para solo fechas, la estructura debe ser: `YYYY-MM-DD`\n    \n- Para fechas que incluyen hora, el formato debe ser: `YYYY-MM-DDTHH:MM:SS`. Ej: 2007-11-03T24:12:03\n    \n\n## Regionalización\n\nLa API es capaz de procesar transacciones de distintos países. En cada transacción se debe especificar su país de origen y/o el tipo de moneda con el que realizó.\n\n| País | Código de País | Código de Moneda |\n| --- | --- | --- |\n| Argentina | AR | ARG |\n| Chile | CL | CLP |\n| Colombia | CO | COP |\n| España | ES | EUR |\n| Estados Unidos | US | USD |\n| México | MX | MXN |\n| Perú | PE | PEN |\n\n### Estándares\n\nPara los **códigos del país** de origen de las transacciones se utiliza el formato [ISO 3166 Alfa 2](https://es.wikipedia.org/wiki/ISO_3166-2)\n\nPara los **códigos de la moneda de origen** de las transacciones se utiliza el formato [ISO 4217](https://es.wikipedia.org/wiki/ISO_4217)\n\n> Incorporar estos datos dentro de la transacción aumentará la precisión de los datos enriquecidos \n  \n\n# Arquitectura\n\nLa API de enriquecimiento de transacciones utiliza los servicios de [Amazon Web Services](https://aws.amazon.com) para montar su infraestructura.\n\n<img src=\"../assets/images/data-enrichment-architecture.drawio.png\" alt=\"data-enrichment-architecture.drawio.png\">\n\n## Seguridad\n\nNuestras APIs usan un `API Key` el que debe ser incluído en la cabecera de todas las llamadas. Una API Key inválida o ausente retornará una respuesta `HTTP 403 Forbidden`.\n\nLos clusters de K8s están protegidos externamente por security groups (para nodos y pods) y IAM roles (para autenticación al cluster), además, los componentes internos usan RBAC.\n\nS3 no públicos y protegidos por políticas IAM.\n\n### Confidencialidad\n\nLas transacciones que se reciben son 100% anónimas.\n\n### Encriptación\n\nTodas las APIS utilizan TLS V 1.2\n\nBases de datos con encryption in transit con TLS y storage encrypted con KMS.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1972870","team":293513,"collectionId":"0e67c617-416e-4d5b-8c15-a27b81c8b601","publishedId":"2sBXijKXLX","public":true,"publicUrl":"https://te.docs.getxerpa.com","privateUrl":"https://go.postman.co/documentation/1972870-0e67c617-416e-4d5b-8c15-a27b81c8b601","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2026-03-23T18:13:58.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7eb908413a9a587c0f27186617f2037c5f82c0370f6739c364a8c9006dcdfb49","favicon":"https://getxerpa.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://te.docs.getxerpa.com/view/metadata/2sBXijKXLX"}