Pular para o conteúdo principal
POST
curl
O endpoint Cancel a Bank Link do Didit encerra um link bancário que o usuário ainda não concluiu, de modo que a url dele e o token deixam de funcionar. Use-o quando o seu usuário abandonar o fluxo ou quando você criar um novo link para o mesmo usuário. Cancelar um link concluído não altera nada e responde com 200 e o link sem alterações: para interromper o acesso, use revogar em vez disso.

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

Parâmetros de caminho

id
string<uuid>
obrigatório

O ID do link.

Resposta

O link, agora cancelled, ou inalterado, caso já estivesse em estado final.

Uma execução do Bank Link para uma pessoa: conectar um banco ou renovar uma conexão. Confirme um link por conta própria com get_link: nunca confie em um id enviado pelo navegador.

id
string<uuid>
obrigatório

Identificador do link.

mode
enum<string>
obrigatório
Opções disponíveis:
connect,
renew
access
enum<string>
obrigatório
Opções disponíveis:
one_time,
ongoing
status
enum<string>
obrigatório

Estado do link. completed, cancelled, expired e failed são finais.

Opções disponíveis:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
obrigatório

A página hospedada para onde a pessoa deve ser enviada. Retornado somente quando o link é criado; null em leituras posteriores, pois o token não é armazenado.

client_token
string | null
obrigatório

O token do Bank Link incorporado da Didit, que ainda não foi liberado: abra url hoje. Retornado apenas quando o link é criado; null em leituras posteriores. Tem finalidade única e curta duração. Não contém dados pessoais. Nunca o registre em logs.

expires_at
string<date-time>
obrigatório

Quando um link não resgatado deixa de funcionar.

connection_id
string<uuid> | null
obrigatório

A conexão criada ou renovada por este link, quando status é completed.

check_id
string<uuid> | null
obrigatório

O resultado de propriedade deste link, quando foi solicitado um valor de ownership.compare diferente de none.

reused
boolean
obrigatório

true quando o link foi concluído como renovação de uma conexão existente, porque a pessoa já compartilha exatamente estas contas (duplicates: reuse). Nada é cobrado duas vezes.

error
object | null
obrigatório

Por que o link falhou, quando status é failed. Caso contrário, null.

quote
object
obrigatório

O preço de um link, fixado no momento em que ele é criado. O valor cobrado é o da cotação. Leituras nunca geram cobrança.

vendor_data
string | null
obrigatório

Sua referência da requisição.

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