Saltar al contenido principal
POST
curl
El endpoint de Didit para actualizar una conexión bancaria solicita una sincronización inmediata y responde con 202 y el sync_id. Envía "wait": true para esperar hasta 25 segundos y obtener la sincronización finalizada en una sola llamada, sin cargo adicional. El banco limita el acceso desatendido, por lo que la llamada puede responder 429 refresh_limit_reached con Retry-After. Consulta Actualizar los datos bancarios bajo demanda.

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, desde Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener permisos limitados: ninguno, lectura o escritura por recurso, restringida a algunos flujos o solo a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, está revocada o ha caducado; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud procede de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, vídeos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Encabezados

Idempotency-Key
string

Clave opcional que eliges para garantizar la seguridad de los reintentos en una operación, de hasta 255 caracteres (puede usarse un UUID). Una solicitud repetida con la misma clave, endpoint, parámetros de consulta y cuerpo recibe la primera respuesta, con el mismo código de estado y el mismo cuerpo, y no se ejecuta ni se factura de nuevo. La misma clave con otro endpoint, otros parámetros de consulta o un cuerpo distinto devuelve 409 idempotency_key_reused. Si la primera solicitud sigue en curso, devuelve 409 idempotency_key_in_progress con Retry-After. Una solicitud fallida (cualquier 4xx o 5xx) no se almacena, así que puedes volver a enviarla con la misma clave. Las claves pertenecen a tu aplicación, tanto si llamas con una clave de API como con un token de acceso. Consulta Reintentos e idempotencia.

Required string length: 1 - 255
Prefer
string

wait=<seconds> mantiene la llamada en espera durante hasta esa cantidad de segundos, como máximo 25, igual que wait: true en el cuerpo.

Ejemplo:

"wait=25"

Parámetros de ruta

id
string<uuid>
requerido

El id de la conexión.

Cuerpo

application/json

Cuerpo opcional de una actualización.

wait
boolean
predeterminado:false

true mantiene la llamada en espera durante hasta 25 segundos y responde 200 con la sincronización finalizada, de modo que una sola solicitud devuelve datos actualizados. Si el banco no ha respondido en ese tiempo, la llamada responde 202: consulta la sincronización con get_sync_run usando el sync_id, o suscríbete a bank.sync.completed. bank.data.updated se envía solo si la sincronización almacena cambios. El encabezado Prefer: wait=<seconds> (hasta 25) hace lo mismo.

Respuesta

La sincronización terminó en un plazo de 25 segundos.

Una sincronización finalizada, devuelta por una actualización con wait: la ejecución de sincronización con su outcome, los recuentos por cuenta en results y balances_changed.

id
string<uuid>
requerido
connection_id
string<uuid>
requerido
trigger
enum<string>
requerido
Opciones disponibles:
initial,
scheduled,
requested
status
enum<string>
requerido
Opciones disponibles:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
requerido
finished_at
string<date-time> | null
requerido
results
object[]
requerido

Lo que hizo la ejecución, por cuenta y recurso.

error
object | null
requerido

Por qué falló la ejecución en su conjunto. null si no falló. Los errores de cuentas y recursos individuales aparecen en results.

outcome
enum<string>
requerido

Cómo terminó la sincronización.

Opciones disponibles:
succeeded,
partial,
failed
balances_changed
boolean
requerido

Si algún saldo cambió.

Última modificación el 22 de noviembre de 2026