{"info":{"_postman_id":"c94b80db-98a6-4a5c-ab3a-4f46de26b72d","name":"Monibyte API","description":"<html><head></head><body><p>Bienvenido a las APIs públicas de Monibyte. Este conjunto de APIs permite que\nlas aplicaciones y sistemas de un cliente —sistemas contables, ERPs o\nherramientas internas— consuman de forma segura la información que Monibyte\nadministra, para automatizar procesos que hoy se realizan de forma manual.</p>\n<p>La primera API disponible expone la <strong>exportación de transacciones\nconfirmadas</strong>: permite descargar, con múltiples filtros, un archivo (CSV/XLSX)\nlisto para conciliar o importar en el sistema contable del cliente.</p>\n<p>Todas las APIs se consumen sobre HTTPS, se autentican con un <strong>API Key</strong> y están\npensadas para integrarse desde cualquier lenguaje o plataforma.</p>\n<h2 id=\"ambientes\">Ambientes</h2>\n<p>El API cuenta con dos ambientes:</p>\n<ul>\n<li><strong>Sandbox:</strong> <code>https://sandbox.monibyte.com</code></li>\n<li><strong>Producción:</strong> <code>https://api.monibyte.com</code></li>\n</ul>\n<p>Durante el desarrollo de la integración se recomienda usar el <strong>Sandbox</strong>, para\nprobar sin afectar datos de producción. Una vez que la integración esté lista y\nprobada, cambiar a <strong>Producción</strong>.</p>\n<h2 id=\"prerrequisitos\">Prerrequisitos</h2>\n<p>Antes de consumir el API es necesario generar un <strong>API Key</strong> desde la consola de\nMonibyte. Al crearlo se definen también las <strong>IPs permitidas</strong> y los <strong>permisos</strong>\nde acceso.</p>\n<blockquote>\n<p>El módulo de API Keys puede requerir la activación del paquete correspondiente.\nSi no aparece en la consola, ponerse en contacto con su asesor de ventas o con\nel equipo de Monibyte para solicitar su habilitación.</p>\n</blockquote>\n<h3 id=\"generar-un-api-key\">Generar un API Key</h3>\n<ol>\n<li>En la consola de Monibyte, seleccionar <strong>Integraciones</strong>.</li>\n<li>Abrir la pestaña <strong>Configuración de API Key</strong>.</li>\n<li>En la parte inferior derecha, presionar <strong>Crear API Key</strong>.</li>\n<li>Ingresar el <strong>nombre</strong> del API Key.</li>\n<li>Definir la <strong>expiración</strong>: sin expiración, o con una <strong>fecha de expiración</strong>.</li>\n<li>Agregar las <strong>IPs permitidas</strong> con el botón correspondiente (se pueden agregar\nvarias). Solo esas IPs podrán consumir el API.</li>\n<li>Seleccionar los <strong>permisos</strong> requeridos para este API: <strong>Transacciones\ngenerales</strong> y <strong>Exportar reporte de transacciones</strong>.</li>\n<li>Presionar <strong>Siguiente</strong>. El sistema envía un <strong>código OTP</strong> al correo.</li>\n<li>Copiar el OTP recibido y presionar <strong>Verificar token</strong>.</li>\n<li>En el último paso se muestra el <strong>token</strong> (el API Key). Copiarlo y guardarlo\nen un lugar seguro: <strong>se muestra una sola vez</strong>.</li>\n<li>Una vez guardado, presionar <strong>Ya guardé el token</strong>.</li>\n</ol>\n<p>Ese token es el que se envía en el header <code>x-api-key</code> (ver Autenticación).</p>\n<h2 id=\"autenticación\">Autenticación</h2>\n<p>El API se autentica con un <strong>API Key</strong> enviado en el header <code>x-api-key</code>. El API\nKey es el token que se genera desde la consola de Monibyte (ver Prerrequisitos).</p>\n<p>Ejemplo del header:</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>x-api-key: &lt;API Key&gt;\n</code></pre><h2 id=\"manejo-de-errores\">Manejo de errores</h2>\n<p>Ante un error, el servicio responde con un código HTTP y un mensaje. Los\nprincipales:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>HTTP</th>\n<th>Mensaje</th>\n<th>Causa</th>\n<th>Cómo resolverlo</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>400</td>\n<td><code>startDate/endDate must be in format YYYY-MM-DD</code></td>\n<td>Formato de fecha inválido</td>\n<td>Enviar las fechas en formato <code>YYYY-MM-DD</code>.</td>\n</tr>\n<tr>\n<td>400</td>\n<td><code>DATE_RANGE_EXCEEDS_MAX_PERIOD (max: 1 year)</code></td>\n<td>El rango supera 1 año</td>\n<td>Reducir el rango a máximo 1 año.</td>\n</tr>\n<tr>\n<td>404</td>\n<td><code>NOT_FOUND_REPORT_ID</code></td>\n<td>El <code>templateId</code> no existe</td>\n<td>Verificar el identificador de la plantilla.</td>\n</tr>\n<tr>\n<td>401 / 403</td>\n<td>(auth)</td>\n<td>API Key ausente o inválida</td>\n<td>Enviar un <code>x-api-key</code> válido.</td>\n</tr>\n<tr>\n<td>403</td>\n<td>(IP no autorizada)</td>\n<td>La IP no está en la lista blanca</td>\n<td>Registrar la IP en la lista blanca.</td>\n</tr>\n<tr>\n<td>429</td>\n<td>(límite excedido)</td>\n<td>Se superó el límite de peticiones</td>\n<td>Reintentar más tarde o revisar la velocity.</td>\n</tr>\n</tbody>\n</table>\n</div><blockquote>\n<p>⚠️ Pendiente de confirmar el <strong>status y cuerpo exactos</strong> que devuelve el\nGateway para: API Key inválida, IP no autorizada y límite de peticiones.</p>\n</blockquote>\n<h2 id=\"disponibilidad-por-país\">Disponibilidad por país</h2>\n<p>El API está disponible actualmente en los siguientes países:</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>País</th>\n<th>Disponible</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>Costa Rica</td>\n<td>✓</td>\n</tr>\n<tr>\n<td>México</td>\n<td>✓</td>\n</tr>\n<tr>\n<td>Guatemala</td>\n<td>✓</td>\n</tr>\n</tbody>\n</table>\n</div></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17879691","collectionId":"c94b80db-98a6-4a5c-ab3a-4f46de26b72d","publishedId":"2sBYB1P8SW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-09-24T17:26:37.000Z"},"item":[{"name":"Transacciones","item":[{"name":"Exportar archivo de transacciones","id":"151cd773-b663-4277-9126-b1a83b53807f","request":{"method":"GET","header":[],"url":"https://sandbox.monibyte.com/transactions/v1/export/:templateId?startDate=2025-01-01&endDate=2025-12-31&extension=csv","description":"<p>Exporta las transacciones confirmadas del cliente en un archivo (CSV/XLSX) según la plantilla indicada y los filtros enviados. La respuesta es el archivo en el cuerpo, con <code>Content-Disposition: attachment</code>.</p>\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c94b80db-98a6-4a5c-ab3a-4f46de26b72d","id":"c94b80db-98a6-4a5c-ab3a-4f46de26b72d","name":"Monibyte API","type":"collection"}},"urlObject":{"path":["transactions","v1","export",":templateId"],"host":["https://sandbox.monibyte.com"],"query":[{"description":{"content":"<p>Fecha de inicio del rango a exportar (inclusive). Tipo: string, formato <code>YYYY-MM-DD</code>. Obligatorio. Propósito: acota el período.</p>\n","type":"text/plain"},"key":"startDate","value":"2025-01-01"},{"description":{"content":"<p>Fecha de fin del rango (inclusive). Tipo: string, formato <code>YYYY-MM-DD</code>. Obligatorio. El rango no puede superar 1 año.</p>\n","type":"text/plain"},"key":"endDate","value":"2025-12-31"},{"description":{"content":"<p>Formato del archivo de salida. Tipo: string (enum): <code>CSV</code> (por defecto) / <code>XLSX</code>. Opcional. Propósito: define el tipo de archivo que se descarga.</p>\n","type":"text/plain"},"key":"extension","value":"csv"}],"variable":[{"id":"fc22a7ee-94cc-4de2-943b-eace06a516da","description":{"content":"<p>Identificador del <strong>archivo exportable</strong>: la plantilla que define las columnas y el formato del archivo a descargar. Tipo: string. Obligatorio (va en la ruta).</p>\n","type":"text/plain"},"type":"any","value":"13c4628c78b74a61bafc6bce37fb503e","key":"templateId"}]}},"response":[{"id":"ced1e74b-46bb-4809-8c83-769bfb3db753","name":"Archivo con las transacciones confirmadas, en el formato indicado por `extension` (CSV por defecto, o XLSX). El archivo viene en el cuerpo de la respuesta con `Content-Disposition: attachment`. Las columnas del archivo las define la plantilla (`templateId","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.monibyte.com/transactions/v1/export/:templateId?startDate=2025-01-01&endDate=2025-12-31&extension=csv","host":["https://sandbox.monibyte.com"],"path":["transactions","v1","export",":templateId"],"query":[{"key":"startDate","value":"2025-01-01","description":"Fecha de inicio del rango a exportar (inclusive). Tipo: string, formato `YYYY-MM-DD`. Obligatorio. Propósito: acota el período."},{"key":"endDate","value":"2025-12-31","description":"Fecha de fin del rango (inclusive). Tipo: string, formato `YYYY-MM-DD`. Obligatorio. El rango no puede superar 1 año."},{"key":"extension","value":"csv","description":"Formato del archivo de salida. Tipo: string (enum): `CSV` (por defecto) / `XLSX`. Opcional. Propósito: define el tipo de archivo que se descarga."}],"variable":[{"key":"templateId","value":"13c4628c78b74a61bafc6bce37fb503e","description":"Identificador del **archivo exportable**: la plantilla que define las columnas y el formato del archivo a descargar. Tipo: string. Obligatorio (va en la ruta)."}]},"description":"Exporta las transacciones confirmadas del cliente en un archivo (CSV/XLSX) según la plantilla indicada y los filtros enviados. La respuesta es el archivo en el cuerpo, con `Content-Disposition: attachment`."},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/csv"},{"key":"Content-Disposition","value":"attachment; filename=\"export-transactions.csv\""}],"cookie":[],"responseTime":null,"body":"\"TRANSACCIÓN.FECHA DE LA TRANSACCIÓN\",\"TRANSACCIÓN.REFERENCIA\",\"TRANSACCIÓN.MONTO DE LA TRANSACCIÓN\",\"TRANSACCIÓN.CÓDIGO ALPHA DE LA MONEDA DE LA TRANSACCIÓN\",\"TRANSACCIÓN.NOMBRE DE LA CATEGORÍA DE COMERCIO\",\"TRANSACCIÓN.DESCRIPCIÓN\",\"TRANSACCIÓN.TARJETAHABIENTE\",\"TRANSACCIÓN.NÚMERO DE TARJETA ENMASCARADO\",\"TRANSACCIÓN.TIPOTRANSACCIÓN(D DÉBITO, C CRÉDITO)\",\"TRANSACCIÓN.DESCRIPCIÓN DE MONEDA DE LA TRANSACCIÓN\",\"TRANSACCIÓN.ESTADO DEL REPORTE DE GASTOS\",\"TRANSACCIÓN.REFERENCIA REPORTE DE GASTOS\",\"TRANSACCIÓN.CÓDIGO CENTRO DE COSTO\",\"TRANSACCIÓN.DESCRIPCIÓN CENTRO DE COSTO\",\"TRANSACCIÓN.CÓDIGO CUENTA CONTABLE\",\"TRANSACCIÓN.ESTADO\",\"TRANSACCIÓN.DESCRIPCIÓN CUENTA CONTABLE\",\"TRANSACCIÓN.ADJUNTOS\",\"TRANSACCIÓN.DETALLE\",\"SISTEMA.FECHA DE GENERACIÓN\",\"SISTEMA.HORA DE GENERACIÓN\",\"SISTEMA.GENERADO POR\",\"SISTEMA.CLIENTE\"\n\"2026-06-08\",\"987654\",\"1,250.75\",\"USD\",\"Restaurantes\",\"Consumo en restaurante corporativo\",\"José Mario Reyes\",\"**** **** **** 4587\",\"D\",\"Dolar\",\"Aprobado\",\"EXP-2026-001\",\"CC001\",\"Tecnología\",\"11010101\",\"Liquidado\",\"Gastos de Alimentación\",\"2 adjuntos\",\"Almuerzo de trabajo con cliente\",\"2026-07-15\",\"14:35:22\",\"Usuario Ejemplo\",\"Cliente Ejemplo S.A.\"\n\"2026-06-09\",\"987655\",\"8,500.00\",\"USD\",\"Tecnología\",\"Compra de equipo de cómputo\",\"Ana Vargas Mora\",\"**** **** **** 7788\",\"C\",\"Dolar\",\"Pendiente\",\"EXP-2026-002\",\"CC002\",\"Operaciones\",\"11010102\",\"Aprobado\",\"Equipo y Software\",\"1 adjunto\",\"Compra de laptop corporativa\",\"2026-07-15\",\"14:35:22\",\"Usuario Ejemplo\",\"Cliente Ejemplo S.A.\"\n\"2026-06-10\",\"987656\",\"3,200.00\",\"CRC\",\"Transporte\",\"Servicio de transporte ejecutivo\",\"Luis Castro Solís\",\"**** **** **** 1122\",\"D\",\"Colón de Costa Rica\",\"\",\"\",\"CC003\",\"Administración\",\"11010103\",\"Aprobado\",\"Gastos de Transporte\",\"Sin adjuntos\",\"Traslado a reunión con cliente\",\"2026-07-15\",\"14:35:22\",\"Usuario Ejemplo\",\"Cliente Ejemplo S.A.\"\n"},{"id":"d06cf588-23c8-4c74-839c-2b08a25572c4","name":"Parámetros inválidos. Mensajes posibles: `startDate/endDate must be in format YYYY-MM-DD`, `DATE_RANGE_EXCEEDS_MAX_PERIOD (max: 1 year)`.","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.monibyte.com/transactions/v1/export/:templateId?startDate=2025-01-01&endDate=2025-12-31&extension=csv","host":["https://sandbox.monibyte.com"],"path":["transactions","v1","export",":templateId"],"query":[{"key":"startDate","value":"2025-01-01","description":"Fecha de inicio del rango a exportar (inclusive). Tipo: string, formato `YYYY-MM-DD`. Obligatorio. Propósito: acota el período."},{"key":"endDate","value":"2025-12-31","description":"Fecha de fin del rango (inclusive). Tipo: string, formato `YYYY-MM-DD`. Obligatorio. El rango no puede superar 1 año."},{"key":"extension","value":"csv","description":"Formato del archivo de salida. Tipo: string (enum): `CSV` (por defecto) / `XLSX`. Opcional. Propósito: define el tipo de archivo que se descarga."}],"variable":[{"key":"templateId","value":"13c4628c78b74a61bafc6bce37fb503e","description":"Identificador del **archivo exportable**: la plantilla que define las columnas y el formato del archivo a descargar. Tipo: string. Obligatorio (va en la ruta)."}]},"description":"Exporta las transacciones confirmadas del cliente en un archivo (CSV/XLSX) según la plantilla indicada y los filtros enviados. La respuesta es el archivo en el cuerpo, con `Content-Disposition: attachment`."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"46a1d70d-3256-4d4d-b9be-54d0e3079749","name":"El `templateId` indicado no existe (`NOT_FOUND_REPORT_ID`).","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox.monibyte.com/transactions/v1/export/:templateId?startDate=2025-01-01&endDate=2025-12-31&extension=csv","host":["https://sandbox.monibyte.com"],"path":["transactions","v1","export",":templateId"],"query":[{"key":"startDate","value":"2025-01-01","description":"Fecha de inicio del rango a exportar (inclusive). Tipo: string, formato `YYYY-MM-DD`. Obligatorio. Propósito: acota el período."},{"key":"endDate","value":"2025-12-31","description":"Fecha de fin del rango (inclusive). Tipo: string, formato `YYYY-MM-DD`. Obligatorio. El rango no puede superar 1 año."},{"key":"extension","value":"csv","description":"Formato del archivo de salida. Tipo: string (enum): `CSV` (por defecto) / `XLSX`. Opcional. Propósito: define el tipo de archivo que se descarga."}],"variable":[{"key":"templateId","value":"13c4628c78b74a61bafc6bce37fb503e","description":"Identificador del **archivo exportable**: la plantilla que define las columnas y el formato del archivo a descargar. Tipo: string. Obligatorio (va en la ruta)."}]},"description":"Exporta las transacciones confirmadas del cliente en un archivo (CSV/XLSX) según la plantilla indicada y los filtros enviados. La respuesta es el archivo en el cuerpo, con `Content-Disposition: attachment`."},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"151cd773-b663-4277-9126-b1a83b53807f"}],"id":"c592fb80-46bc-4e31-b861-b83765ee8d78","_postman_id":"c592fb80-46bc-4e31-b861-b83765ee8d78","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"c94b80db-98a6-4a5c-ab3a-4f46de26b72d","id":"c94b80db-98a6-4a5c-ab3a-4f46de26b72d","name":"Monibyte API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":""}]}},"variable":[{"key":"baseUrl","value":"https://sandbox.monibyte.com","type":"string"},{"key":"apiKey","value":"","type":"string"}]}