curl -X POST 'https://verification.didit.me/v3/bank/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/cancel/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.cancel_link(
"11111111-2222-3333-4444-555555555555",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.cancelLink("11111111-2222-3333-4444-555555555555");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.CancelLink(ctx, "11111111-2222-3333-4444-555555555555", didit.BankCancelLinkParams{})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().cancelLink("11111111-2222-3333-4444-555555555555");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->cancelLink('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.cancel_link("11111111-2222-3333-4444-555555555555")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.CancelLinkAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));{
"id": "0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40",
"mode": "connect",
"access": "ongoing",
"status": "cancelled",
"url": null,
"client_token": null,
"expires_at": "2026-11-21T13:00:00Z",
"connection_id": null,
"check_id": null,
"reused": false,
"error": null,
"quote": {
"id": "7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43",
"lines": [
{
"meter": "bank_data_connection_month",
"unit": "connection_month",
"price_usd": "0.9000"
}
],
"fallback_lines": null,
"total_usd": "0.9000",
"valid_until": "2026-11-21T13:00:00Z",
"scopes": [
"accounts",
"balances",
"transactions"
]
},
"vendor_data": "client-7731"
}Cancelar vínculo bancário na API: encerrar um vínculo pendente
O endpoint Cancel a Bank Link da Didit encerra um vínculo que a pessoa não concluiu, para que a URL e o token deixem de funcionar.
curl -X POST 'https://verification.didit.me/v3/bank/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/cancel/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.cancel_link(
"11111111-2222-3333-4444-555555555555",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.cancelLink("11111111-2222-3333-4444-555555555555");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.CancelLink(ctx, "11111111-2222-3333-4444-555555555555", didit.BankCancelLinkParams{})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().cancelLink("11111111-2222-3333-4444-555555555555");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->cancelLink('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.cancel_link("11111111-2222-3333-4444-555555555555")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.CancelLinkAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));{
"id": "0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40",
"mode": "connect",
"access": "ongoing",
"status": "cancelled",
"url": null,
"client_token": null,
"expires_at": "2026-11-21T13:00:00Z",
"connection_id": null,
"check_id": null,
"reused": false,
"error": null,
"quote": {
"id": "7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43",
"lines": [
{
"meter": "bank_data_connection_month",
"unit": "connection_month",
"price_usd": "0.9000"
}
],
"fallback_lines": null,
"total_usd": "0.9000",
"valid_until": "2026-11-21T13:00:00Z",
"scopes": [
"accounts",
"balances",
"transactions"
]
},
"vendor_data": "client-7731"
}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
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
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.
1 - 255Resposta
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.