> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancelar uma ligação bancária na API: parar uma ligação não concluída

> O endpoint Cancel a Bank Link da Didit termina uma ligação que a pessoa não concluiu, para que o URL e o token deixem de funcionar.

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](https://docs.didit.me/pt/standalone-apis/bank-connection-revoke.md) em vez disso.


## OpenAPI

````yaml pt/openapi-25.json POST /v3/bank/links/{id}/cancel/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, ligações, contas, saldos, transações, instituições e cobertura.
      Os dados bancários estão disponíveis para aplicações sandbox. As chamadas
      de uma aplicação de produção respondem com `404` até ao acesso em produção
      ser anunciado. Nada é cobrado no sandbox. Uma chamada feita com uma chave
      de API precisa de uma chave que tenha a permissão de dados bancários
      (`bank-data`): leitura para as leituras, escrita para as operações que
      alteram algo. A verificação de conta é a exceção: precisa de acesso de
      escrita a sessões, ou de acesso total, e não da permissão de dados
      bancários. Os dados bancários não fazem parte do acesso total: uma chave
      de acesso total é recusada, e a chamada responde com `403
      bank_data_access_denied` até criar uma chave que tenha a permissão. Os
      dados bancários em bruto (contas, saldos, transações e o feed de
      alterações) também recusam um pedido que não traga uma chave de API.


      Todas as recusas em `/v3/bank/`, exceto as da verificação de conta, têm o
      mesmo corpo JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Um caminho que não é uma operação, um ID que não é um UUID
      ou um sub-recurso desconhecido responde com `404 not_found` em todos os
      métodos, e qualquer erro inesperado responde com `500 internal_error` com
      um `request_id`. Quando os dados bancários não estão disponíveis, todas as
      operações respondem com o `404` padrão da plataforma, exatamente como uma
      rota desconhecida.
paths:
  /v3/bank/links/{id}/cancel/:
    post:
      tags:
        - Bank Data
      summary: Cancelar uma ligação bancária
      description: >-
        Cancela uma ligação que ainda não foi concluída; o seu url e token
        deixam de funcionar. Cancelar uma ligação já cancelada, expirada,
        falhada ou concluída responde com `200` e devolve-a sem alterações, pelo
        que pode ser repetido em segurança. Uma ligação concluída mantém a
        conexão bancária associada.
      operationId: cancelBankLink
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O id da ligação.
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: >-
            A ligação, agora `cancelled`, ou sem alterações se já estava num
            estado final.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankLink'
              examples:
                Cancelled:
                  summary: Uma ligação cancelada
                  value:
                    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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: O recurso não existe nesta aplicação e neste ambiente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Não encontrado
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/bank/links/0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40/cancel/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.cancel_link(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            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);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.CancelLink(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankCancelLinkParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            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);
        - lang: php
          label: PHP
          source: >-
            <?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());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.bank.cancel_link("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using 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));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        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](/pt/integration/api-errors#novas-tentativas-e-idempotência).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankLink:
      type: object
      description: >-
        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.
      properties:
        id:
          type: string
          description: Identificador do link.
          format: uuid
        mode:
          type: string
          enum:
            - connect
            - renew
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - created
            - opened
            - connecting
            - completed
            - cancelled
            - expired
            - failed
          description: >-
            Estado do link. `completed`, `cancelled`, `expired` e `failed` são
            estados finais.
        url:
          type: string
          description: >-
            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.
          nullable: true
          format: uri
        client_token:
          type: string
          description: >-
            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.
          nullable: true
        expires_at:
          type: string
          description: Quando uma ligação não resgatada deixa de funcionar.
          format: date-time
        connection_id:
          type: string
          description: >-
            A ligação criada ou renovada por esta hiperligação, quando `status`
            é `completed`.
          format: uuid
          nullable: true
        check_id:
          type: string
          description: >-
            O resultado da verificação de propriedade desta ligação, quando foi
            pedido `ownership.compare` com valor diferente de `none`.
          format: uuid
          nullable: true
        reused:
          type: boolean
          description: >-
            `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:
          allOf:
            - $ref: '#/components/schemas/BankLinkError'
          nullable: true
          description: >-
            Motivo da falha da ligação, quando `status` é `failed`. Caso
            contrário, `null`.
        quote:
          $ref: '#/components/schemas/BankLinkQuote'
        vendor_data:
          type: string
          description: A sua referência do pedido.
          nullable: true
      required:
        - id
        - mode
        - access
        - status
        - url
        - client_token
        - expires_at
        - connection_id
        - check_id
        - reused
        - error
        - quote
        - vendor_data
    BankDataError:
      type: object
      description: >-
        Corpo de erro de todas as operações de Dados bancários. Todos os campos
        estão sempre presentes.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Código de erro legível por máquina. Baseie as decisões neste valor,
            nunca em `message`.
        message:
          type: string
          description: >-
            Explicação em linguagem simples para um programador. A redação pode
            mudar; não a analise.
        request_id:
          type: string
          description: Identificador deste pedido. Indique-o quando contactar o suporte.
        field:
          type: string
          description: >-
            O campo do pedido a corrigir, quando o erro diz respeito a um campo.
            Caso contrário, `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            O que fazer a seguir, para que um cliente possa agir sem adivinhar.
            `null` quando não há um passo seguinte padrão.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos a aguardar antes de tentar novamente. Definido em erros de
            limite de pedidos e erros temporários; caso contrário, `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankLinkError:
      type: object
      description: >-
        O motivo pelo qual a ligação terminou com `failed`. Nada foi publicado
        nem cobrado.
      properties:
        code:
          type: string
          enum:
            - duplicate_conflict
            - renewal_login_mismatch
            - reduced_grant
            - corporate_approval_not_supported
            - ongoing_access_not_available
            - bank_unavailable
            - bank_cancelled
            - consent_declined
            - read_limit
            - renewal_not_needed
            - renewal_window_expired
            - first_sync_failed
          description: >-
            Motivo da falha da ligação. Uma ligação com falha não é um erro
            HTTP: a ligação é devolvida com `status: failed` e este objeto. Uma
            ligação de renovação cuja conexão tenha entretanto mudado é
            devolvida com `renewal_not_needed` ou `renewal_window_expired`.
        message:
          type: string
          description: Explicação em linguagem simples para um programador.
        conflicts_with:
          type: array
          nullable: true
          items:
            type: string
            format: uuid
          description: >-
            Com `duplicate_conflict`: os ids das conexões ativas que se
            sobrepõem. Renove uma delas ou crie novamente a ligação com
            `duplicates: allow`.
      required:
        - code
        - message
        - conflicts_with
    BankLinkQuote:
      type: object
      description: >-
        O preço de uma ligação, fixado na criação. O valor cobrado é o da
        cotação. As leituras nunca são faturadas.
      properties:
        id:
          type: string
          description: Identificador da cotação.
          format: uuid
        lines:
          type: array
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            As linhas de preços cobradas por esta ligação, para os âmbitos
            solicitados.
        fallback_lines:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/BankLinkQuoteLine'
          description: >-
            O que uma alternativa de pagamento único custaria, apenas quando a
            ligação foi criada com `allow_one_time_fallback`. É apresentado na
            resposta de criação e é `null` caso contrário. Uma leitura pontual
            com dados pode custar mais do que um primeiro mês de acesso
            contínuo.
        total_usd:
          type: string
          description: >-
            Total de `lines` em USD. O total só pode descer: com uma concessão
            reduzida, ou quando a pessoa escolhe um país com um preço mais
            baixo.
          pattern: ^-?\d+(\.\d+)?$
        valid_until:
          type: string
          description: >-
            A cotação está fixada à ligação e é válida durante toda a vida útil
            da ligação, pelo que é igual a `expires_at`.
          format: date-time
        scopes:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Os dados definem o âmbito dos preços da cotação.
      required:
        - id
        - lines
        - fallback_lines
        - total_usd
        - valid_until
        - scopes
    RateLimitBudgetError:
      type: object
      description: >-
        Devolvido apenas numa recusa de orçamento de limite de pedidos do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de cada endpoint, não garantem estes campos de
        metadados.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensagem de recusa por orçamento já existente, legível por humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referência de suporte opaca: RL- seguido de 32 caracteres
            hexadecimais de UUID em minúsculas.
        limit:
          type: integer
          description: Orçamento do âmbito excedido; igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Orçamento restante, limitado a zero; igual a X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reposição da janela em segundos Unix; é igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duração da janela fixa em segundos, não o tempo de espera restante.
            Respeite Retry-After antes de tentar novamente.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankLinkQuoteLine:
      type: object
      description: Uma linha com preço de uma cotação.
      properties:
        meter:
          type: string
          description: >-
            O que é cobrado, por exemplo `bank_data_connection_month`,
            `bank_verification`.
          example: bank_data_connection_month
        unit:
          type: string
          description: >-
            O que é uma unidade, por exemplo `connection_month` ou
            `completed_sign_in`.
          example: connection_month
        price_usd:
          type: string
          description: >-
            Preço de uma unidade em USD, uma cadeia decimal com 4 casas
            decimais. Os montantes nos exemplos são ilustrativos; o preço de
            cada país é indicado na página de preços.
          pattern: ^-?\d+(\.\d+)?$
          example: '0.9000'
      required:
        - meter
        - unit
        - price_usd
  responses:
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Chave de API inválida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        A chave de API não tem a permissão Dados bancários (`bank-data`) ou, no
        caso de dados bancários em bruto numa aplicação em produção, a definição
        da aplicação "Bank data in the API" está desativada. Os dados bancários
        não fazem parte do acesso total: uma chave com acesso total, uma chave
        restrita a outros recursos e um pedido autenticado sem chave de API
        (credenciais de cliente, para dados em bruto) são todos recusados com
        este corpo de resposta. Crie uma chave e atribua-lhe a permissão
        explicitamente. A recusa acontece antes de qualquer pesquisa, por isso
        não indica se o objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Dados bancários não permitidos
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedWrite:
      description: >-
        Foi excedido o limite partilhado de escrita de 300 pedidos por minuto
        por chave de API. Respeite `Retry-After` antes de tentar novamente.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 300
            remaining: 0
            reset: 1794358860
            window_seconds: 60
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
    BankDataInternalError:
      description: >-
        Algo correu mal do lado da Didit. Qualquer erro inesperado em
        `/v3/bank/` responde no formato de erro do Bank, nunca com uma página
        HTML: indique o `request_id` ao suporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Um erro inesperado
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos a aguardar, arredondados por excesso para a janela seguinte.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O âmbito cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do âmbito excedido; igual ao limite do corpo. Presente nas
        recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining do corpo.
        Presente nas recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Hora de reposição em segundos Unix; é igual a reset no corpo. Presente
        nas recusas de orçamento do middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.