{
  "aid": "openfinancebrasil.org.br:main-2.5.0-beta.2",
  "name": "API Accounts - Open Finance Brasil",
  "type": "Index",
  "description": "API de contas de depósito à vista, contas de poupança e contas pré-pagas do Open Finance Brasil – Fase 2.\nAPI que retorna informações de contas de depósito à vista, contas de poupança e contas de pagamento pré-pagas mantidas nas instituições transmissoras por seus clientes,\nincluindo dados de identificação da conta, saldos, limites e transações.\\\nNão possui segregação entre pessoa natural e pessoa jurídica.\\\nRequer consentimento do cliente para todos os `endpoints`.\n\n# Orientações\nA `Role`  do diretório de participantes relacionada à presente API é a `DADOS`.\\\nPara todos os `endpoints` desta API é previsto o envio de um `token` através do header `Authorization`.\\\nEste token deverá estar relacionado ao consentimento (`consentId`) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos \ndados relacionados ao `consentId` específico relacionado.\\\nOs dados serão devolvidos na consulta desde que o `consentId` relacionado corresponda a um consentimento válido e com o status `AUTHORISED`.\\\nÉ também necessário que o recurso em questão (conta, contrato, etc) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).\\\nAlém disso as `permissions` necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado (`consentId`).\\\nRelacionamos a seguir as `permissions` necessárias para a consulta de dados em cada `endpoint` da presente API.\n\n## Permissions necessárias para a API Accounts\n\nPara cada um dos paths desta API, além dos escopos (`scopes`) indicados existem `permissions` que deverão ser observadas:\n\n### `/accounts`\n  - permissions:\n    - GET: **ACCOUNTS_READ**\n### `/accounts/{accountId}`\n  - permissions:\n    - GET: **ACCOUNTS_READ**\n### `/accounts/{accountId}/balances`\n  - permissions:\n    - GET: **ACCOUNTS_BALANCES_READ**\n### `/accounts/{accountId}/transactions`\n  - permissions:\n    - GET: **ACCOUNTS_TRANSACTIONS_READ**\n### `/accounts/{accountId}/transactions-current`\n  - permissions:\n    - GET: **ACCOUNTS_TRANSACTIONS_READ**\n### `/accounts/{accountId}/overdraft-limits`\n  - permissions:\n    - GET: **ACCOUNTS_OVERDRAFT_LIMITS_READ**\n### `/accounts/{accountId}/reserved-balances`\n  - permissions:\n    - GET: **ACCOUNTS_BALANCES_READ**\n\n## Data de imutabilidade por tipo de transação​\nO identificador de transações de contas é de envio obrigatório no Open Finance Brasil. De acordo com o tipo da transação deve haver o envio de um identificador único, estável e imutável em D0 ou D+1, conforme tabela abaixo\n```\n|---------------------------------------|-------------------------|-----------------------|\n| Tipo de Transação                     | Data da Obrigatoriedade | Data da Imutabilidade |\n|---------------------------------------|-------------------------|-----------------------|\n| TED                                   | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| PIX                                   | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| TRANSFERENCIA MESMA INSTITUIÇÃO (TEF) | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| TARIFA SERVIÇOS AVULSOS               | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| FOLHA DE PAGAMENTO                    | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| DOC                                   | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| BOLETO                                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| CONVÊNIO ARRECADAÇÃO                  | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| PACOTE TARIFA SERVIÇOS                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| DEPÓSITO                              | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| SAQUE                                 | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| CARTÃO                                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| ENCARGOS JUROS CHEQUE ESPECIAL        | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| RENDIMENTO APLICAÇÃO FINANCEIRA       | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| PORTABILIDADE SALÁRIO                 | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| RESGATE APLICAÇÃO FINANCEIRA          | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| OPERAÇÃO DE CRÉDITO                   | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| OUTROS                                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n```\n\nPara consultar as regras aplicáveis ao comportamento do transacionID de acordo com o status da transação, consultar a página [Orientações - Contas](https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/193658890)\n",
  "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/openfinancebrasil.org.br/main/2.5.0-beta.2/apis.json",
  "tags": [
    "openfinancebrasil.org.br",
    "main"
  ],
  "created": "2026-04-11",
  "modified": "2026-04-11",
  "specificationVersion": "0.19",
  "access": "3rd-Party",
  "maintainers": [
    {
      "FN": "Jentic",
      "X-github": "jentic",
      "url": "https://github.com/jentic"
    }
  ],
  "apis": [
    {
      "aid": "openfinancebrasil.org.br:main-2.5.0-beta.2",
      "name": "API Accounts - Open Finance Brasil",
      "description": "API de contas de depósito à vista, contas de poupança e contas pré-pagas do Open Finance Brasil – Fase 2.\nAPI que retorna informações de contas de depósito à vista, contas de poupança e contas de pagamento pré-pagas mantidas nas instituições transmissoras por seus clientes,\nincluindo dados de identificação da conta, saldos, limites e transações.\\\nNão possui segregação entre pessoa natural e pessoa jurídica.\\\nRequer consentimento do cliente para todos os `endpoints`.\n\n# Orientações\nA `Role`  do diretório de participantes relacionada à presente API é a `DADOS`.\\\nPara todos os `endpoints` desta API é previsto o envio de um `token` através do header `Authorization`.\\\nEste token deverá estar relacionado ao consentimento (`consentId`) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos \ndados relacionados ao `consentId` específico relacionado.\\\nOs dados serão devolvidos na consulta desde que o `consentId` relacionado corresponda a um consentimento válido e com o status `AUTHORISED`.\\\nÉ também necessário que o recurso em questão (conta, contrato, etc) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).\\\nAlém disso as `permissions` necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado (`consentId`).\\\nRelacionamos a seguir as `permissions` necessárias para a consulta de dados em cada `endpoint` da presente API.\n\n## Permissions necessárias para a API Accounts\n\nPara cada um dos paths desta API, além dos escopos (`scopes`) indicados existem `permissions` que deverão ser observadas:\n\n### `/accounts`\n  - permissions:\n    - GET: **ACCOUNTS_READ**\n### `/accounts/{accountId}`\n  - permissions:\n    - GET: **ACCOUNTS_READ**\n### `/accounts/{accountId}/balances`\n  - permissions:\n    - GET: **ACCOUNTS_BALANCES_READ**\n### `/accounts/{accountId}/transactions`\n  - permissions:\n    - GET: **ACCOUNTS_TRANSACTIONS_READ**\n### `/accounts/{accountId}/transactions-current`\n  - permissions:\n    - GET: **ACCOUNTS_TRANSACTIONS_READ**\n### `/accounts/{accountId}/overdraft-limits`\n  - permissions:\n    - GET: **ACCOUNTS_OVERDRAFT_LIMITS_READ**\n### `/accounts/{accountId}/reserved-balances`\n  - permissions:\n    - GET: **ACCOUNTS_BALANCES_READ**\n\n## Data de imutabilidade por tipo de transação​\nO identificador de transações de contas é de envio obrigatório no Open Finance Brasil. De acordo com o tipo da transação deve haver o envio de um identificador único, estável e imutável em D0 ou D+1, conforme tabela abaixo\n```\n|---------------------------------------|-------------------------|-----------------------|\n| Tipo de Transação                     | Data da Obrigatoriedade | Data da Imutabilidade |\n|---------------------------------------|-------------------------|-----------------------|\n| TED                                   | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| PIX                                   | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| TRANSFERENCIA MESMA INSTITUIÇÃO (TEF) | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| TARIFA SERVIÇOS AVULSOS               | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| FOLHA DE PAGAMENTO                    | DO                      | DO                    |\n|---------------------------------------|-------------------------|-----------------------|\n| DOC                                   | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| BOLETO                                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| CONVÊNIO ARRECADAÇÃO                  | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| PACOTE TARIFA SERVIÇOS                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| DEPÓSITO                              | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| SAQUE                                 | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| CARTÃO                                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| ENCARGOS JUROS CHEQUE ESPECIAL        | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| RENDIMENTO APLICAÇÃO FINANCEIRA       | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| PORTABILIDADE SALÁRIO                 | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| RESGATE APLICAÇÃO FINANCEIRA          | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| OPERAÇÃO DE CRÉDITO                   | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n| OUTROS                                | DO                      | D+1                   |\n|---------------------------------------|-------------------------|-----------------------|\n```\n\nPara consultar as regras aplicáveis ao comportamento do transacionID de acordo com o status da transação, consultar a página [Orientações - Contas](https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/193658890)\n",
      "image": "",
      "baseURL": "https://api.banco.com.br/open-banking/accounts/v2",
      "humanURL": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/openfinancebrasil.org.br/main/2.5.0-beta.2",
      "version": "2.5.0-beta.2",
      "tags": [
        "openfinancebrasil.org.br",
        "main"
      ],
      "properties": [
        {
          "type": "OpenAPI",
          "name": "OpenAPI definition",
          "url": "https://raw.githubusercontent.com/jentic/jentic-public-apis/refs/heads/main/apis/openapi/openfinancebrasil.org.br/main/2.5.0-beta.2/openapi.json",
          "mediaType": "application/openapi+json"
        },
        {
          "type": "GitHubRepo",
          "url": "https://github.com/jentic/jentic-public-apis/tree/main/apis/openapi/openfinancebrasil.org.br/main/2.5.0-beta.2"
        }
      ],
      "contact": [
        {
          "FN": "Governança do Open Finance Brasil – Especificações",
          "email": "gt-interfaces@openbankingbr.org",
          "url": "https://openbanking-brasil.github.io/areadesenvolvedor/"
        }
      ]
    }
  ]
}