> ## 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.

# API para listar transações bancárias: intervalo de datas, lançadas e pendentes

> O endpoint Listar Transações da Didit lê as transações de uma conta por intervalo de datas, lançadas e pendentes, com paginação por page-token.

O endpoint List Transactions da Didit lê as transações de uma conta em um intervalo de datas, tanto lançadas quanto pendentes, com paginação por token de página.
Os valores são strings decimais, e os campos que um banco não envia vêm como `null`.
Para manter uma cópia sincronizada, use o [feed de mudanças](https://docs.didit.me/pt-br/standalone-apis/bank-transactions-sync.md) em vez de ler os intervalos novamente.


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/bank/accounts/{account_id}/transactions/
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, conexões, contas, saldos, transações, instituições e cobertura.
      Os dados bancários estão disponíveis para aplicações do sandbox. As
      chamadas de uma aplicação em produção respondem `404` até que o acesso em
      produção seja anunciado. Nada é cobrado no sandbox. Uma chamada feita com
      chave de API exige uma chave que tenha a permissão de dados bancários
      (`bank-data`): leitura para consultas e escrita para operações que alteram
      algo. A verificação de conta é a exceção: ela exige acesso de escrita a
      sessões, ou acesso total, e não a permissão de dados bancários.


      Os dados bancários não fazem parte do acesso total: uma chave com acesso
      total é recusada, e a chamada responde `403 bank_data_access_denied` até
      que você crie uma chave que tenha a permissão. Os dados brutos do banco
      (contas, saldos, transações e o feed de alterações) também recusam uma
      requisição sem chave de API.


      Toda recusa em `/v3/bank/`, exceto a da verificação de conta, tem 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 subrecurso desconhecido responde `404 not_found` para todos os
      métodos, e qualquer erro inesperado responde `500 internal_error` com um
      `request_id`. Quando os dados bancários não estão disponíveis, toda
      operação responde o `404` padrão da plataforma, exatamente como ocorre com
      uma rota desconhecida.
paths:
  /v3/bank/accounts/{account_id}/transactions/:
    get:
      tags:
        - Bank Data
      summary: Listar transações da conta
      description: >-
        Leitura por intervalo de datas das transações de uma conta, ordenadas
        por `effective_date` decrescente e, em seguida, por `id` decrescente, em
        páginas de até 500. `date_from` e `date_to` são datas do calendário,
        inclusivas, no fuso horário do próprio banco, sem nenhuma conversão.
        Elas se aplicam a `effective_date`: para uma transação lançada, sua data
        de lançamento; se não houver, sua data-valor; se não houver, a data em
        que foi vista pela primeira vez. Para uma transação pendente, sua data
        da transação; se não houver, a data em que foi vista pela primeira vez.
        Por padrão, `date_from` é o início do histórico armazenado e `date_to`
        não tem limite superior, e tanto as transações lançadas quanto as
        pendentes são retornadas.


        A primeira página define quais transações são incluídas, e cada uma é
        entregue em seu estado atual: uma transação removida durante a paginação
        deixa de aparecer nas páginas seguintes e é informada pelo feed de
        alterações (`sync_transactions`). `page_token` dá continuidade a uma
        leitura e vale por uma hora; um token expirado responde `410
        page_expired`, então reinicie a leitura a partir da consulta original.
        Para manter uma cópia atualizada, use o feed de alterações em vez de
        reler intervalos.


        Cabeçalhos de resposta: `X-Bank-Last-Synced-At` e `Cache-Control:
        no-store`.


        Requer uma chave de API com a permissão Dados bancários (`bank-data`):
        leitura para esta operação. Uma chave com acesso total não inclui essa
        permissão: conceda-a explicitamente ao criar a chave, ou a chamada
        responde `403 bank_data_access_denied`. Uma aplicação de sandbox lê os
        dados do seu Banco de teste somente com a chave. Uma requisição sem
        chave de API (credenciais de cliente) é recusada para dados brutos com o
        mesmo `403`.
      operationId: listBankTransactions
      parameters:
        - name: account_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O ID da conta.
        - name: date_from
          in: query
          required: false
          schema:
            type: string
            format: date
          description: Primeira data efetiva a incluir, inclusive.
        - name: date_to
          in: query
          required: false
          schema:
            type: string
            format: date
          description: >-
            Última data efetiva a incluir, inclusive. Sem limite superior quando
            você omitir este campo.
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - booked
              - pending
          description: >-
            Somente transações lançadas ou somente transações pendentes. Padrão:
            ambas.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: 'Tamanho da página, de 1 a 500. Padrão: 100.'
        - name: page_token
          in: query
          required: false
          schema:
            type: string
          description: O `next_page_token` da página anterior.
      responses:
        '200':
          description: Uma página de transações.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankTransactionPage'
              examples:
                Booked and pending:
                  summary: Duas transações efetivadas e uma pendente
                  value:
                    items:
                      - id: e5b1f8a3-0d47-4c92-a6e0-7f3c2d9b1845
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: pending
                        pending_id: null
                        reverses_id: null
                        booking_date: null
                        value_date: null
                        transaction_date: '2026-11-21'
                        effective_date: '2026-11-21'
                        amount: '-64.90'
                        currency: EUR
                        direction: debit
                        description: PAGO TARJETA PAPELERIA CENTRAL
                        counterparty:
                          name: PAPELERIA CENTRAL
                          iban: null
                          bic: null
                        remittance:
                          unstructured: []
                          structured: null
                          reference: null
                        bank_transaction_code: null
                        bank_reference: null
                        identity_quality: derived
                        end_to_end_id: null
                        mandate_id: null
                        creditor_id: null
                        merchant_category_code: '5943'
                        exchange: null
                        balance_after: null
                        category: office_supplies
                        first_seen_at: '2026-11-21T12:04:40Z'
                        updated_at: '2026-11-21T12:04:40Z'
                      - id: 8f2b6d41-9c3a-4e57-b0d8-1a7e5c4f2963
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-19'
                        value_date: '2026-11-20'
                        transaction_date: null
                        effective_date: '2026-11-19'
                        amount: '-1210.00'
                        currency: EUR
                        direction: debit
                        description: RECIBO SEGURIDAD SOCIAL
                        counterparty:
                          name: ENTIDAD PUBLICA DE EJEMPLO
                          iban: ES0000000000000000005766
                          bic: null
                        remittance:
                          unstructured:
                            - RECIBO SEGURIDAD SOCIAL 10/2026
                          structured: null
                          reference: '0028123456789'
                        bank_transaction_code: PMNT-RDDT-ESDD
                        bank_reference: '2026111900012345'
                        identity_quality: bank_reference
                        end_to_end_id: NOTPROVIDED
                        mandate_id: ES-SS-000123
                        creditor_id: ES00ZZZ00000000
                        merchant_category_code: null
                        exchange: null
                        balance_after: '18250.34'
                        category: taxes_and_social_security
                        first_seen_at: '2026-11-20T06:00:12Z'
                        updated_at: '2026-11-20T06:00:12Z'
                      - id: 2c9e7a05-6b14-4d38-8f2a-b3d51e0c9a67
                        account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        status: booked
                        pending_id: null
                        reverses_id: null
                        booking_date: '2026-11-18'
                        value_date: '2026-11-18'
                        transaction_date: null
                        effective_date: '2026-11-18'
                        amount: '3450.00'
                        currency: EUR
                        direction: credit
                        description: TRANSFERENCIA FACTURA 2026-0418
                        counterparty:
                          name: CLIENTE DE EJEMPLO SL
                          iban: ES0000000000000000007891
                          bic: null
                        remittance:
                          unstructured:
                            - FRA 2026-0418
                          structured: null
                          reference: null
                        bank_transaction_code: PMNT-RCDT-ESCT
                        bank_reference: '2026111800009876'
                        identity_quality: bank_reference
                        end_to_end_id: 2026-0418
                        mandate_id: null
                        creditor_id: null
                        merchant_category_code: null
                        exchange: null
                        balance_after: '19460.34'
                        category: income
                        first_seen_at: '2026-11-19T06:00:10Z'
                        updated_at: '2026-11-19T06:00:10Z'
                    next_page_token: null
                    has_more: false
          headers:
            X-Bank-Last-Synced-At:
              description: >-
                Quando os dados da conta foram buscados pela última vez no
                banco. Presente depois que a conta foi sincronizada.
              schema:
                type: string
                format: date-time
            Cache-Control:
              description: '`no-store`.'
              schema:
                type: string
        '400':
          description: >-
            O token de paginação não é válido, pertence a outra leitura ou um
            parâmetro está fora do intervalo permitido (incluindo `date_from`
            posterior a `date_to`). `field` indica qual é.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid token:
                  summary: Token inválido
                  value:
                    code: invalid_cursor
                    message: The cursor or page token is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: null
                    retry_after: null
                Token for another read:
                  summary: Token para outra leitura
                  value:
                    code: page_token_mismatch
                    message: >-
                      The page token belongs to a different read. Restart with
                      the same filters.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Requisição inválida
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: date_from
                    next_action: null
                    retry_after: null
        '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
        '409':
          description: >-
            A pessoa não compartilha mais esta conta (`access_removed`), ou a
            conexão foi excluída ou seus dados não são mais legíveis
            (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Access removed:
                  summary: Acesso removido
                  value:
                    code: access_removed
                    message: The person no longer shares this account.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '410':
          description: O page_token expirou.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Page expired:
                  summary: Página expirada
                  value:
                    code: page_expired
                    message: The page token expired. Restart the read.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: page_token
                    next_action: restart_read
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/accounts/a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10/transactions/?date_from=2026-01-01&date_to=2026-11-21&status=booked'
            \
              -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.list_transactions(
                "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.listTransactions("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.ListTransactions(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankListTransactionsParams{})\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().listTransactions("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->listTransactions('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.list_transactions("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.ListTransactionsAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankTransactionPage:
      type: object
      description: >-
        Uma página de uma leitura por intervalo de datas. A primeira página fixa
        quais transações são incluídas, e cada uma é entregue em seu estado
        atual; uma transação removida durante a paginação sai das páginas
        seguintes e é informada pelo feed de alterações.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankTransaction'
          description: Ordenado por `effective_date` decrescente e, depois, por `id`.
        next_page_token:
          type: string
          description: >-
            Continua esta leitura. Fixa o instantâneo da primeira página, vale
            por uma hora e fica vinculado à aplicação, ao ambiente, à conta e
            aos filtros da leitura.
          nullable: true
        has_more:
          type: boolean
      required:
        - items
        - next_page_token
        - has_more
    BankDataError:
      type: object
      description: >-
        Corpo de erro de toda operação 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. Decida o fluxo com base neste
            valor, nunca em `message`.
        message:
          type: string
          description: >-
            Explicação em linguagem simples para o desenvolvedor. O texto pode
            mudar; não o processe.
        request_id:
          type: string
          description: >-
            Identificador desta requisição. Informe-o ao entrar em contato com o
            suporte.
        field:
          type: string
          description: >-
            O campo da requisição a ser corrigido, quando o erro se refere a um
            único 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 em seguida, para que um cliente possa agir sem
            adivinhar. `null` quando não há uma próxima etapa padrão.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos a aguardar antes de tentar novamente. Definido em erros de
            limite de requisições 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
    BankTransaction:
      type: object
      description: >-
        Uma movimentação de uma conta. Todo campo que o banco não envia é
        `null`; as capacidades da instituição listam quais campos um banco é
        conhecido por enviar.
      properties:
        id:
          type: string
          description: >-
            Id da Didit, opaco e armazenado na primeira vez em que foi visto. O
            mesmo movimento mantém seu id entre leituras, sincronizações e
            renovações. `identity_quality` indica o quão forte é essa garantia.
          format: uuid
        account_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - booked
            - pending
          description: >-
            Uma transação pendente tem seu próprio ID. Quando o banco a lança, a
            transação lançada traz `pending_id` onde o banco as vincula, e a
            pendente aparece em `removed` com `reason: pending_booked`.
        pending_id:
          type: string
          description: >-
            A transação pendente que esta substituiu. Definida somente quando o
            banco as vincula, nunca por suposição.
          format: uuid
          nullable: true
        reverses_id:
          type: string
          description: >-
            A transação estornada por esta, quando o banco as vincula. Um
            estorno é uma nova transação.
          format: uuid
          nullable: true
        booking_date:
          type: string
          format: date
          nullable: true
        value_date:
          type: string
          format: date
          nullable: true
        transaction_date:
          type: string
          format: date
          nullable: true
        effective_date:
          type: string
          description: >-
            A data usada pelos filtros de data, conforme o banco a informa no
            próprio fuso horário, sem nenhuma conversão: para uma transação
            lançada, a data de lançamento; se ela não existir, a data-valor; se
            também não existir, a data em que foi vista pela primeira vez. Para
            uma transação pendente, a data da transação; se ela não existir, a
            data em que foi vista pela primeira vez.
          format: date
        amount:
          type: string
          description: >-
            Valor com sinal como string decimal. Negativo indica saída de
            dinheiro.
          pattern: ^-?\d+(\.\d+)?$
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Código de moeda ISO 4217.
        direction:
          type: string
          enum:
            - credit
            - debit
          description: Repete o sinal de `amount`.
        description:
          type: string
          nullable: true
        counterparty:
          $ref: '#/components/schemas/BankTransactionCounterparty'
        remittance:
          $ref: '#/components/schemas/BankTransactionRemittance'
        bank_transaction_code:
          type: string
          nullable: true
        bank_reference:
          type: string
          description: >-
            A referência imutável de lançamento do banco, quando ele a fornece.
            `null` caso contrário, nunca inventada.
          nullable: true
        identity_quality:
          type: string
          enum:
            - bank_reference
            - route_id
            - derived
          description: >-
            Como o `id` foi correspondido. `bank_reference` e `route_id` são
            estáveis. `derived` é correspondido pelo conteúdo: é estável
            enquanto o banco continuar informando o item sem alterações, e uma
            correção feita pelo banco pode então aparecer como um `removed` e um
            `added`.
        end_to_end_id:
          type: string
          nullable: true
        mandate_id:
          type: string
          nullable: true
        creditor_id:
          type: string
          nullable: true
        merchant_category_code:
          type: string
          nullable: true
        exchange:
          type: object
          nullable: true
          description: Detalhes da conversão de moeda, quando o banco os fornece.
          properties:
            source_amount:
              type: string
              pattern: ^-?\d+(\.\d+)?$
              nullable: true
            source_currency:
              type: string
              nullable: true
            rate:
              type: string
              pattern: ^-?\d+(\.\d+)?$
              nullable: true
        balance_after:
          type: string
          description: Saldo após a transação, quando o banco o informa.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        category:
          type: string
          description: Categoria própria da Didit, quando aplicável.
          nullable: true
        first_seen_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - account_id
        - status
        - pending_id
        - reverses_id
        - booking_date
        - value_date
        - transaction_date
        - effective_date
        - amount
        - currency
        - direction
        - description
        - counterparty
        - remittance
        - bank_transaction_code
        - bank_reference
        - identity_quality
        - end_to_end_id
        - mandate_id
        - creditor_id
        - merchant_category_code
        - exchange
        - balance_after
        - category
        - first_seen_at
        - updated_at
    RateLimitBudgetError:
      type: object
      description: >-
        Retornado somente em uma recusa de orçamento de limite de requisições do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de endpoint, não garantem esses 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 minúsculos de um UUID.
        limit:
          type: integer
          description: Orçamento do escopo 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: >-
            Horário de redefiniçã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 restante de espera.
            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
    BankTransactionCounterparty:
      type: object
      properties:
        name:
          type: string
          nullable: true
        iban:
          type: string
          nullable: true
        bic:
          type: string
          nullable: true
      required:
        - name
        - iban
        - bic
    BankTransactionRemittance:
      type: object
      properties:
        unstructured:
          type: array
          items:
            type: string
        structured:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
      required:
        - unstructured
        - structured
        - reference
  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,
        para dados brutos do banco em uma aplicação em produção, a configuração
        da aplicação "Bank data in the API" está desativada. Dados bancários não
        fazem parte do acesso total: uma chave com acesso total, uma chave
        restrita a outros recursos e uma requisição autenticada sem chave de API
        (credenciais de cliente, para dados brutos) são todas recusadas com este
        corpo, então crie uma chave e conceda a permissão explicitamente. A
        recusa acontece antes de qualquer busca, então ela não informa se um
        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
    RateLimitedRead:
      description: >-
        Limite de leitura do middleware excedido. Respeite o Retry-After antes
        de tentar novamente.
      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'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Algo deu errado do lado da Didit. Qualquer erro inesperado em
        `/v3/bank/` responde no formato de erro Bank, nunca com uma página HTML:
        informe 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 para cima até a próxima janela.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O escopo cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do escopo excedido; igual ao limite do corpo. Presente nas
        recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining no corpo.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Horário da redefinição em segundos Unix; igual à redefinição 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 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.

````

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