Sincronizar Estado de Cuenta
POST/v2/financial/accounts/:financial_account_uid/statement_transactions/sync
Sincroniza el estado de cuenta bancario de una cuenta financiera. Busca transacciones directamente de la institución financiera mediante API. Requiere conexión activa.
Procesamiento Asíncrono: Este endpoint se procesa de forma asincrónica y crea un comando de sincronización de estado de cuenta para la Cuenta Financiera.
La Sincronización de Estado de Cuenta de una Cuenta Financiera se realiza de forma asincrónica, es decir, al recibir la solicitud, nuestra API guarda los parámetros de la solicitud y crea un Comando. Este comando se procesa en segundo plano y después se confirma y las transacciones se importarán en la Cuenta Financiera. Recibe en la respuesta de esta solicitud el ID del comando creado y puede consultarlo en cualquier momento.
Vea más en Listar Comandos de una Cuenta Financiera y Ver un Comando.
Para que sea posible ejecutar la Sincronización de Estado de Cuenta, debe haber una Conexión activa (es decir, validada y habilitada) asociada a la Cuenta Financiera.
Período de la Sincronización
Los campos start_at y end_at son opcionales y delimitan la ventana a sincronizar.
Cuando se omiten, la ventana predeterminada va del primer día del mes corriente hasta hoy.
- informando solo
start_at, la fecha final asumida es hoy; - informando solo
end_at, la fecha inicial asumida es el primer día del mes deend_at; - la fecha final no puede ser futura;
- el período máximo es de 2 años hacia atrás a partir de hoy.
Ventanas que cruzan más de un mes-calendario se dividen en un comando por mes. Esto mantiene cada solicitud a la institución financiera dentro de un volumen que el banco puede responder, y permite reprocesar solo el mes que eventualmente falle. Una ventana dentro del mismo mes continúa creando un único comando.
Acompañando la Importación
Además del comando en data, la respuesta trae en sync el registro de la importación solicitada, con un uid
propio. Use este uid para acompañar el conjunto completo — especialmente en ventanas multi-mes, donde
varios comandos se crean — en
Consultar Sincronización de Estado de Cuenta.
Eventos de Webhook
Cuando se realiza la solicitud, un evento financial.account.statement_sync.requested es disparado.
Nuestro servidor entonces comienza la comunicación con la API de la institución financiera para buscar transacciones.
Solo después de confirmado en la institución financiera, entonces el estado de cuenta se actualiza.
En este momento el evento financial.account.statement_sync.confirmed es disparado.
Request
Responses
- 201
- 401
- 422
Comando creado por mes para ventana multi-mes
Error de autenticación. Token inválido
Conexión para Estado de Cuenta no activa