Pular para o conteúdo principal
GET
curl
O endpoint de sincronização de transações da Didit retorna o que mudou nas transações de uma conexão desde um cursor: added, modified e removed. Um cursor vazio retorna tudo, com reset: true. Armazene next_cursor somente após uma resposta com has_more: false. Veja Feed bancário contínuo para contabilidade.

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.

Parâmetros de caminho

id
string<uuid>
obrigatório

O ID da conexão.

Parâmetros de consulta

cursor
string

O next_cursor que você armazenou. Vazio ou omitido começa do início.

limit
integer
padrão:100

Tamanho da página, de 1 a 500. Padrão: 100.

Intervalo obrigatório: 1 <= x <= 500
page_token
string

Continua a mesma leitura enquanto has_more for true.

Resposta

Uma página de alterações.

Alterações nas transações de uma conexão desde um cursor. Um cursor vazio retorna todas as transações atuais como added. Todas as páginas de uma mesma leitura refletem o mesmo instantâneo; alterações que ocorrerem nesse meio tempo aparecem na leitura seguinte.

added
object[]
obrigatório

Transações a adicionar. Em uma primeira leitura (sem cursor, ou após reset), esta lista contém todas as transações que a conexão tinha quando a leitura começou, cada uma exatamente uma vez e em seu estado atual, mesmo que uma sincronização ocorra enquanto você pagina. Nas leituras seguintes, contém as transações novas desde o seu cursor e a transação efetivada que substitui uma pendente.

modified
object[]
obrigatório

Transações que mudaram desde o seu cursor, em seu estado atual. Aplique cada uma como upsert, pelo id: uma transação que você já recebeu ao paginar a primeira leitura volta aqui se tiver mudado nesse meio-tempo, e uma correção do banco também chega aqui.

removed
object[]
obrigatório

Transações que não existem mais, com um reason. Ignore um id que você não tenha: uma transação removida enquanto você paginava uma primeira leitura foi entregue uma vez como added e chega na leitura seguinte.

has_more
boolean
obrigatório

true enquanto houver mais páginas. Armazene next_cursor somente após uma resposta com has_more: false; se a paginação falhar no meio do caminho, reinicie a partir do cursor que você havia armazenado.

next_page_token
string | null
obrigatório

Continua esta leitura enquanto has_more for true.

next_cursor
string | null
obrigatório

O checkpoint durável do feed, retornado somente na última página. É opaco e vinculado à aplicação, ao ambiente e à conexão. Pode ser reproduzido por 90 dias. Em uma primeira leitura, marca o momento em que a leitura começou, de modo que o que mudou nesse intervalo chega na leitura seguinte.

reset
boolean
obrigatório

true em toda carga inicial, ou seja, em toda leitura a partir de um cursor vazio: substitua sua cópia pelo resultado em vez de acrescentá-lo a ela.

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