API bancario (BaaS)

Escritura

Estas herramientas no vienen activadas. Se habilitan bajo solicitud y sólo funcionan para usuarios con credenciales del API bancario de Tilopay registradas por Tilopay del lado del servidor. Con el acceso MCP estándar el grupo no aparece; y si la herramienta se invoca sin esas credenciales, responde que no existen. Para pedirlo, usá el formulario de solicitud e indicá que necesitás el API bancario.

Qué cubre#

Once herramientas de consulta sobre el API bancario: contextos (assignments), diagnóstico de credenciales, cuentas, saldos, pagos, estados de cuenta y un informe analítico de pagos.

Ninguna de estas herramientas inicia, aprueba ni revierte transferencias. Sólo extraen información. La única que no es de lectura pura es baas_request_statement, que genera un documento de consulta: no mueve dinero.

Las cuentas se identifican con accountType: "IBAN" más accountValue, las fechas son RFC 3339 (2026-01-01T00:00:00Z) y assignmentId se envía únicamente cuando el usuario tiene varios contextos.

Herramientas#

Estas herramientas se activan bajo solicitud y sólo funcionan para usuarios con credenciales del API bancario de Tilopay. No forman parte del acceso MCP por defecto: Tilopay habilita el grupo caso por caso. Requiere: Credenciales del API bancario de Tilopay registradas por Tilopay para ese usuario.

Contextos (assignments) del API bancario

Sólo lectura

baas_list_assignments

Lista los contextos tenant/cuenta (assignments) disponibles para las credenciales del API bancario del usuario. Úsalo cuando otra herramienta pida assignmentId.

Parámetros

Sin parámetros.

Devuelve

{ assignments[] }

assignments = contextos disponibles con assignment_id, tenant_code, owner_type, country_code y status.

Diagnóstico del API bancario

Sólo lectura

baas_diagnostics

Verifica las credenciales del API bancario del usuario, el login, el intercambio de token y el acceso a cuentas. Úsalo cuando una consulta falle.

Parámetros

ParámetroTipoObligatorioDescripción
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ checks[], failed }

checks = una fila por verificación (credenciales, login + assignments, cuentas) con ok y detalle; failed = cuántas fallaron. El correo de la credencial se devuelve enmascarado.

Listar cuentas del API bancario

Sólo lectura

baas_list_accounts

Lista las cuentas accesibles del API bancario, sin saldos: tipo de identificador, valor y moneda.

Operación del API: GET /api/public/v1/accountsver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestringFiltro por esquema (IBAN)
accountValuestringFiltro por identificador
limitintegerTamaño de página, entre 1 y 100
cursorstringCursor de la página anterior
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual.

Saldos de las cuentas del API bancario

Sólo lectura

baas_list_balances

Lista los saldos en tiempo real de las cuentas accesibles: cuenta, montos y fecha de corte.

Operación del API: GET /api/public/v1/accounts/balancesver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestringFiltro por esquema (IBAN)
accountValuestringFiltro por identificador
limitintegerTamaño de página, entre 1 y 100
cursorstringCursor de la página anterior
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual.

Saldo de una cuenta

Sólo lectura

baas_get_balance

Obtiene el saldo actual de una cuenta del API bancario identificada por IBAN.

Operación del API: GET /api/public/v1/accounts/balancever la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestring (IBAN)Esquema del identificador de la cuenta (IBAN)
accountValuestringIdentificador de la cuenta (IBAN)
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual.

Listar pagos del API bancario

Sólo lectura

baas_list_payments

Consulta, sólo lectura, los pagos de una cuenta propia identificada por IBAN, con filtros de fecha, estado, moneda, método y dirección. Paginación por cursor.

Operación del API: GET /api/public/v1/transactions/paymentsver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestring (IBAN)Esquema del identificador de la cuenta (IBAN)
accountValuestringIdentificador de la cuenta (IBAN)
dateFromstringDesde, RFC 3339 (2026-01-01T00:00:00Z)
dateTostringHasta, RFC 3339
statusstring (pending | processing | confirmed | posted | failed)Estado público del pago
currencystringMoneda ISO 4217 (CRC, USD)
paymentMethodCodestring (PIN | SINPE_MOVIL)Método de pago
directionstring (OUT | IN)OUT = envío, IN = recibido
clientReferencestringReferencia del comercio
limitintegerTamaño de página, máximo 100 (por defecto 20)
cursorstringCursor de la página anterior
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual, con su cursor de paginación.

Buscar un pago

Sólo lectura

baas_search_payment

Busca un pago dentro de una cuenta por exactamente uno de: paymentId (UUID), publicId (número) o clientReference. Si se envía más de uno, la herramienta devuelve error.

Operación del API: POST /api/public/v1/transactions/payments/searchver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestring (IBAN)Esquema del identificador de la cuenta (IBAN)
accountValuestringIdentificador de la cuenta (IBAN)
paymentIdstringUUID interno del pago
publicIdstringIdentificador público numérico
clientReferencestringReferencia del comercio
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual.

Detalle de un pago

Sólo lectura

baas_get_payment

Obtiene el detalle de un pago del API bancario por su UUID interno, sólo lectura.

Operación del API: GET /api/public/v1/transactions/payments/{payment_id}ver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
paymentIdstringUUID interno del pago
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual.

Solicitar un estado de cuenta

Escritura

baas_request_statement

Solicita la generación de un estado de cuenta para una cuenta del API bancario, con rango máximo de 60 días. No mueve dinero: genera un documento de consulta y devuelve request_id con status PENDING.

Operación del API: POST /api/public/v1/accounts/statementsver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestring (IBAN)Esquema del identificador de la cuenta (IBAN)
accountValuestringIdentificador de la cuenta (IBAN)
dateFromstringDesde, RFC 3339 (2026-01-01T00:00:00Z)
dateTostringHasta, RFC 3339, como máximo 60 días después de dateFrom
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario con request_id y status. La herramienta solicita el documento sin notificación por correo.

Estado de la solicitud de estado de cuenta

Sólo lectura

baas_get_statement_status

Consulta el estado de una solicitud de estado de cuenta. Cuando está DONE incluye el enlace de descarga firmado y su vencimiento.

Operación del API: GET /api/public/v1/accounts/statements/{request_id}ver la página de la operación

Parámetros

ParámetroTipoObligatorioDescripción
requestIdstringrequest_id devuelto al solicitar el estado de cuenta
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ result }

result = respuesta del API bancario tal cual.

Analista de pagos del API bancario

Sólo lectura

baas_analyze_payments

Analiza, sólo lectura, los pagos de una cuenta en un rango de fechas y devuelve un informe en lenguaje natural: éxito, fallas, reversiones, montos netos y recomendaciones. Usa un modelo de lenguaje sobre las cifras calculadas.

Parámetros

ParámetroTipoObligatorioDescripción
accountTypestring (IBAN)Esquema del identificador de la cuenta (IBAN)
accountValuestringIdentificador de la cuenta (IBAN)
dateFromstringDesde, RFC 3339
dateTostringHasta, RFC 3339
currencystringMoneda ISO 4217
directionstring (OUT | IN)OUT = envío, IN = recibido
questionstringEnfoque específico del análisis
maxItemsintegerMáximo de pagos a analizar, entre 1 y 1000 (por defecto 300)
assignmentIdstringContexto (assignment) del API bancario; se envía sólo cuando hay varios

Devuelve

{ summary }

summary trae account, range, totals {count, succeeded, failed, reversed, pending, successRate}, byCurrency con succeededAmount, reversedAmount, netAmount y averageTicket, failureReasons y sample. El informe redactado viene en el texto. Si no hay pagos en el rango, avisa y no analiza.

Última verificación: 2026-09-03 · Responsable: equipo-integraciones

Ver como Markdown crudo