Saltar para o conteúdo principal
POST
curl
A API Refresh a Bank Connection da Didit pede uma sincronização imediata e responde com 202 e o sync_id. Envie "wait": true para aguardar até 25 segundos e obter a sincronização concluída numa única chamada, sem custos adicionais. O banco limita o acesso sem supervisão, pelo que a chamada pode responder com 429 refresh_limit_reached e Retry-After. Consulte Atualizar os dados bancários a pedido.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, obtida em Developers -> API keys na Business Console. A chave principal tem acesso total. Uma chave com nome pode ter o âmbito limitado: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou apenas a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que não foi enviada nenhuma chave, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe os URLs de imagem, vídeo e PDF como null, e uma chave sem escrita em sessões recebe os links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Cabeçalhos

Idempotency-Key
string

Chave opcional, à sua escolha, para garantir a segurança de novas tentativas numa operação, com até 255 caracteres (um UUID funciona). Um pedido repetido com a mesma chave, endpoint, parâmetros de query e corpo recebe a primeira resposta, com o mesmo código de estado e o mesmo corpo, e não é executado nem faturado uma segunda vez. A mesma chave com outro endpoint, outros parâmetros de query ou outro corpo devolve 409 idempotency_key_reused. Enquanto o primeiro pedido ainda estiver em execução, devolve 409 idempotency_key_in_progress com Retry-After. Um pedido falhado (qualquer 4xx ou 5xx) não é guardado, pelo que pode ser enviado novamente com a mesma chave. As chaves pertencem à sua aplicação, quer chame a API com uma chave de API, quer com um token de acesso. Consulte Novas tentativas e idempotência.

Required string length: 1 - 255
Prefer
string

wait=<seconds> mantém a chamada em espera durante até esse número de segundos, no máximo 25, tal como wait: true no corpo do pedido.

Exemplo:

"wait=25"

Parâmetros de caminho

id
string<uuid>
obrigatório

O id da ligação.

Corpo

application/json

Corpo opcional de uma atualização.

wait
boolean
padrão:false

true mantém a chamada em espera durante até 25 segundos e responde com 200 quando a sincronização estiver concluída, pelo que um único pedido devolve dados atualizados. Se o banco não tiver respondido nesse tempo, a chamada responde com 202: consulte a sincronização com get_sync_run, usando o sync_id, ou subscreva bank.sync.completed. bank.data.updated segue-se apenas quando a sincronização guarda alterações. O cabeçalho Prefer: wait=<seconds> (até 25) faz o mesmo.

Resposta

A sincronização terminou no prazo de 25 segundos.

Uma sincronização concluída devolvida por uma atualização com wait: a execução de sincronização com o 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

Motivo pelo qual a execução falhou no seu todo. null quando não falhou. Os erros de contas e recursos individuais estão em results.

outcome
enum<string>
obrigatório

Como terminou a sincronização.

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