Pular para o conteúdo principal
POST
curl
O endpoint Atualizar uma conexão bancária da Didit solicita uma sincronização imediata e responde com 202 e o sync_id. Envie "wait": true para aguardar até 25 segundos e receber a sincronização concluída em uma única chamada, sem custo adicional. O banco limita o acesso não supervisionado, por isso a chamada pode responder 429 refresh_limit_reached com Retry-After. Consulte Atualizar dados bancários sob demanda.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, obtida em Developers -> API keys no Business Console. A chave principal tem acesso completo. Uma chave nomeada pode ter escopo limitado: nenhum, leitura ou escrita por recurso, restrita a alguns fluxos ou a sessões aprovadas, a uma lista de endereços e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição partiu de um endereço fora da lista de endereços da chave; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status permitidos para a chave. Uma chave sem acesso a mídia recebe as URLs de imagem, vídeo e PDF como null, e uma chave sem escrita de sessões recebe os links e tokens de sessão como null. Veja https://docs.didit.me/console/api-keys.

Cabeçalhos

Idempotency-Key
string

Chave opcional de segurança para novas tentativas, que você escolhe para uma operação, com até 255 caracteres (um UUID funciona). Uma requisição repetida com a mesma chave, endpoint, query e corpo recebe a primeira resposta, com o mesmo status e o mesmo corpo, e não é executada nem cobrada uma segunda vez. A mesma chave com outro endpoint, query ou corpo retorna 409 idempotency_key_reused. Enquanto a primeira requisição ainda estiver em execução, retorna 409 idempotency_key_in_progress com Retry-After. Uma requisição com falha (qualquer 4xx ou 5xx) não é armazenada, então você pode enviá-la novamente com a mesma chave. As chaves pertencem à sua aplicação, seja você chamando com uma chave de API ou um token de acesso. Veja Novas tentativas e idempotência.

Required string length: 1 - 255
Prefer
string

wait=<seconds> mantém a chamada aguardando por até essa quantidade de segundos, no máximo 25, como wait: true no corpo.

Exemplo:

"wait=25"

Parâmetros de caminho

id
string<uuid>
obrigatório

O ID da conexão.

Corpo

application/json

Corpo opcional de uma atualização.

wait
boolean
padrão:false

true mantém a chamada aguardando por até 25 segundos e responde 200 com a sincronização concluída, de modo que uma única requisição retorna dados atualizados. Se o banco não tiver respondido nesse prazo, a chamada responde 202: consulte a sincronização com get_sync_run, usando o sync_id, ou assine bank.sync.completed. bank.data.updated é enviado somente quando a sincronização armazena alterações. O cabeçalho Prefer: wait=<seconds> (até 25) faz o mesmo.

Resposta

A sincronização terminou em até 25 segundos.

Uma sincronização finalizada retornada por uma atualização com wait: a execução de sincronização com seu outcome, as contagens por conta em results e balances_changed.

id
string<uuid>
obrigatório
connection_id
string<uuid>
obrigatório
trigger
enum<string>
obrigatório
Opções disponíveis:
initial,
scheduled,
requested
status
enum<string>
obrigatório
Opções disponíveis:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
obrigatório
finished_at
string<date-time> | null
obrigatório
results
object[]
obrigatório

O que a execução fez, por conta e por recurso.

error
object | null
obrigatório

Por que a execução falhou como um todo. null quando não falhou. Os erros de contas e recursos individuais estão em results.

outcome
enum<string>
obrigatório

Como a sincronização terminou.

Opções disponíveis:
succeeded,
partial,
failed
balances_changed
boolean
obrigatório

Se algum saldo mudou.

Última modificação em 22 de novembro de 2026