Connect
API REST

Sincronizar

Guarda saldos, movimientos y PDF. Conserva las cuentas autorizadas y sus saldos actuales; movimientos y cartolas son opcionales. Los movimientos cubren el mes solicitado: del primer al último día para meses anteriores, o hasta el día de lectura en Perú para el mes actual. La disponibilidad histórica depende del banco. Confirma todas las cuentas, el rango y las páginas antes de guardar. Conserva el corte informado sin afirmar el cierre del día actual. Cartolas conserva los PDF existentes del inventario observado, sin generar documentos nuevos ni interpretar su período o contenido.

POST
/v1/tools/bbva_peru_beta.conexion.sincronizar/execute

Authorization

AuthorizationBearer <token>

API key de la organización, en 'Authorization: Bearer connect_sk_…'. Es la credencial para tu backend y tus agentes propios; se crea en el dashboard con permisos explícitos y su valor completo se muestra una sola vez. Autentica como agente: la bitácora atribuye la acción a la clave, nunca a la persona que la creó.

In: header

Header Parameters

X-Connect-Connection*string

Cuál conexión (conn_…) ejecuta esta llamada. Obligatoria en todo sistema conectable y sin resolución implícita, ni siquiera cuando la organización tiene una sola conexión activa: la conexión ES la empresa, y elegir por ti una que hoy acierta mañana acierta distinto sin que nadie cambie nada. Los ids salen de la tool 'conexiones.estado.consultar'. Si falta, la respuesta es 'validation_error' y no se contacta al sistema externo.

Match^conn_

Request Body

application/json

La entrada de la tool, envuelta en 'input'. Manda '{"input": {}}' cuando la tool no toma argumentos: el sobre es obligatorio aunque esté vacío.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/tools/bbva_peru_beta.conexion.sincronizar/execute" \  -H "X-Connect-Connection: conn_9tKfR2mQx4Vb" \  -H "Content-Type: application/json" \  -d '{    "input": {      "periodo": "strings",      "alcances": [        "saldos"      ]    }  }'
{  "data": {    "periodo": "strings",    "estado": "encolado",    "jobId": "string",    "yaEnCurso": true,    "results": [      {        "alcance": "saldos",        "status": "ok",        "recordsSynced": 0,        "completo": true      }    ]  },  "meta": {    "request_id": "string",    "operation_request_id": "733a3a71-b72d-4633-94b1-070c6664565f",    "tool_id": "string",    "plane": "action",    "latency_ms": 0,    "audit_status": "recorded",    "idempotency": "replayed"  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}
{  "error": {    "code": "alcance_not_enabled",    "message": "string",    "suggested_fix": "string",    "request_id": "string",    "details": null  }}

Cartolas PDF POST

Antes de pedir datos nuevos, consulta atenciones en conexiones.estado.consultar. Si sincronizarSirve es false, sigue hacer: las indicaciones para pedir datos nuevos que siguen no aplican hasta resolver esa atención. La consulta de datos ya guardados sigue disponible según el plan. Lista PDF originales guardados. Corresponden a la última sincronización completa de una cuenta. Usa el accountId de saldos.consultar. Puede incluir enlaces de descarga válidos por cinco minutos. La cobertura corresponde a los PDF disponibles en el inventario observado; no interpreta el período ni el contenido del archivo. Sin lectura devuelve cobertura null, que no significa que no existan cartolas.

Movimientos POST

Antes de pedir datos nuevos, consulta atenciones en conexiones.estado.consultar. Si sincronizarSirve es false, sigue hacer: las indicaciones para pedir datos nuevos que siguen no aplican hasta resolver esa atención. La consulta de datos ya guardados sigue disponible según el plan. Consulta movimientos guardados. Corresponden a una cuenta y al intervalo exacto de una sincronización. Usa el accountId obtenido en saldos.consultar. Conserva importes, monedas y fechas originales. Para meses anteriores la sincronización cubre del primer al último día; para el mes actual, hasta el día de lectura en Perú. La disponibilidad histórica depende del banco. Sin lectura de ese intervalo devuelve cobertura null, que no significa cero movimientos.