Otras operaciones
Incluye operaciones sensiblesContextos (assignments) del API BaaS
Sólo lecturabaas_list_assignments
Lista los contextos tenant/cuenta (assignments) disponibles para las credenciales BaaS 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 BaaS
Sólo lecturabaas_diagnostics
Verifica las credenciales BaaS del usuario, el login, el intercambio de token y el acceso a cuentas. Úsalo cuando una consulta BaaS falle.
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
assignmentId | string | — | Contexto a probar (opcional) |
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 BaaS
Sólo lecturabaas_list_accounts
Lista las cuentas accesibles del API BaaS (sin saldos): tipo de identificador, valor y moneda.
Operación del API: GET /api/public/v1/accounts — ver la página de la operación
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
accountType | string | — | Filtro por esquema (IBAN) |
accountValue | string | — | Filtro por identificador |
limit | integer | — | 1–100, junto con offset |
offset | integer | — | Desplazamiento de paginación |
assignmentId | string | — | Contexto BaaS (opcional) |
Devuelve
{ result }
result = respuesta del API bancario tal cual.
Saldo de una cuenta BaaS
Sólo lecturabaas_get_balance
Obtiene el saldo actual de una cuenta BaaS. La cuenta se elige por precedencia: accountValue (sólo si coincide con una cuenta del usuario) → currency (primera cuenta en esa moneda) → accountIndex (base 1) → cuenta única.
Operación del API: POST /api/public/v1/accounts/balance — ver la página de la operación
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
currency | string | — | Moneda de la cuenta (CRC o USD): primera cuenta en esa moneda. Precedencia para elegir la cuenta propia: accountValue (sólo si coincide con una cuenta del usuario) → currency (primera cuenta en esa moneda) → accountIndex (base 1: el número que muestra baas_list_accounts) → si hay una sola cuenta, esa. |
accountIndex | integer | — | Número de la cuenta en la lista que muestra baas_list_accounts (base 1). Precedencia para elegir la cuenta propia: accountValue (sólo si coincide con una cuenta del usuario) → currency (primera cuenta en esa moneda) → accountIndex (base 1: el número que muestra baas_list_accounts) → si hay una sola cuenta, esa. |
accountValue | string | — | Sólo si una herramienta ya lo devolvió y coincide con una cuenta del usuario; no escribir números de cuenta de memoria. Precedencia para elegir la cuenta propia: accountValue (sólo si coincide con una cuenta del usuario) → currency (primera cuenta en esa moneda) → accountIndex (base 1: el número que muestra baas_list_accounts) → si hay una sola cuenta, esa. |
assignmentId | string | — | Contexto BaaS (opcional) |
Devuelve
{ account: { value, currency }, amounts: { available, posted }, as_of }
account = la cuenta consultada; amounts.available = saldo disponible; amounts.posted = saldo registrado; as_of = fecha de corte.
Estado de la solicitud de estado de cuenta
Sólo lecturabaas_get_statement_status
Consulta el estado de una solicitud asíncrona de estado de cuenta BaaS. El API responde 200 con status PENDING, PROCESSING, DONE o ERROR. Cuando está DONE incluye download_url, válida por 48 horas, 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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
requestId | string | sí | request_id devuelto al solicitarlo |
assignmentId | string | — | Contexto BaaS (opcional) |
Devuelve
{ result }
result = respuesta del API bancario tal cual.
Número de cuenta completo del comercio
Sólo lecturabaas_get_account_number
Muestra el IBAN COMPLETO de una cuenta propia del comercio. Úsala SOLO cuando el comercio pide explícitamente su número de cuenta (por ejemplo para dárselo a un cliente o proveedor) y con confirm=true. Queda registrada en la auditoría. En cualquier otra respuesta se usa el número enmascarado. Acepta sólo currency o accountIndex para elegir la cuenta.
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
confirm | boolean | sí | true solo si el comercio pidió explícitamente su número de cuenta completo |
currency | string | — | Moneda de la cuenta (CRC o USD) |
accountIndex | integer | — | Número de la cuenta en la lista |
assignmentId | string | — | Contexto BaaS (opcional) |
Devuelve
{ result: { account_id, currency, iban } }
result = la cuenta propia con su IBAN completo.
Cancelar la transferencia pendiente
Escriturabaas_cancel_transfer
Cancela la transferencia que está esperando el código de autorización. Úsala cuando el comercio diga que no la quiere hacer.
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
intentId | string | — | Identificador de la intención (opcional) |
Devuelve
{ message }
message = confirmación de la cancelación.
Aprobar o rechazar una operación pendiente
Sensiblebanca_decide_approval
El aprobador del doble control aprueba o rechaza una transferencia pendiente, con el código de 6 dígitos que llegó a su correo. Nunca escribas el código en la respuesta.
Exige confirmación: Confirmaciones que exige Tilopay
Parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
decision | string (aprobar | rechazar) | sí | Decisión del aprobador |
code | string | sí | Código de 6 dígitos del correo del aprobador |
approvalId | string | — | Identificador de la aprobación (opcional; si se omite, se toma la aprobación pendiente más reciente) |
reason | string | — | Motivo del rechazo (máx. 255 caracteres, opcional) |
Devuelve
{ status, message }
status = resultado de la decisión; message = texto de confirmación.
Cerrar sesión bancaria
Escriturabaas_close_session
Cierra de inmediato la sesión bancaria activa (solo en el Asistente de WhatsApp).
Parámetros
Sin parámetros.
Devuelve
Estado y descarga del documento#
baas_get_statement_status consulta una solicitud creada de forma asíncrona (202 ACCEPTED, request_id, PENDING). El API responde 200 con PENDING, PROCESSING, DONE o ERROR; en DONE incluye download_url, válida por 48 horas.
Última verificación: 2026-10-22