Saltar para o conteúdo principal
POST
curl
O endpoint Cancel a Bank Link da Didit termina uma ligação que a pessoa não concluiu, pelo que o url e o token deixam de funcionar. Use-o quando o seu utilizador abandona o fluxo ou quando cria uma nova ligação para o mesmo utilizador. Cancelar uma ligação concluída não altera nada e responde com 200, deixando a ligação inalterada: para cortar 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 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

Parâmetros de caminho

id
string<uuid>
obrigatório

O id da ligação.

Resposta

A ligação, agora cancelled, ou sem alterações se já estava num estado final.

Uma execução do Bank Link para uma pessoa: ligar um banco ou renovar uma ligação. Confirme pessoalmente a ligação com get_link: nunca confie num 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 estados finais.

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

A página alojada para onde enviar a pessoa. Devolvida apenas quando a ligação é criada; null nas leituras seguintes, porque o token não é guardado.

client_token
string | null
obrigatório

O token do Bank Link incorporado da Didit, que ainda não foi disponibilizado: abra url hoje. Devolvido apenas quando a ligação é criada; null nas leituras seguintes. Tem uma única finalidade e uma duração curta. Não contém dados pessoais. Nunca o registe.

expires_at
string<date-time>
obrigatório

Quando uma ligação não resgatada deixa de funcionar.

connection_id
string<uuid> | null
obrigatório

A ligação criada ou renovada por esta hiperligação, quando status é completed.

check_id
string<uuid> | null
obrigatório

O resultado da verificação de propriedade desta ligação, quando foi pedido ownership.compare com valor diferente de none.

reused
boolean
obrigatório

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

error
object | null
obrigatório

Motivo da falha da ligação, quando status é failed. Caso contrário, null.

quote
object
obrigatório

O preço de uma ligação, fixado na criação. O valor cobrado é o da cotação. As leituras nunca são faturadas.

vendor_data
string | null
obrigatório

A sua referência do pedido.

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