API Investimentos - Fundos de Investimentos

GET /baas/v1/open/dat/funds/investments

Obtém a lista de operações de Fundos de Investimento mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Permission necessária: funds

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "brandName": "Organização A",
      "companyCnpj": "21128159000166",
      "anbimaCategory": "RENDA_FIXA",
      "anbimaClass": "string",
      "anbimaSubclass": "string",
      "investmentId": "92792126019929200000000000000000000000000"
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data[].brandName: Nome da marca reportada pelo participante no Open Finance. Preferencialmente o mesmo nome atribuído no diretório Customer Friendly Server Name.
• data[].companyCnpj: CNPJ completo da instituição responsável pelo cadastro (sem máscara).
• data[].anbimaCategory: Categoria ANBIMA do fundo conforme Deliberação 77. Enum: RENDA_FIXA, ACOES, MULTIMERCADO, CAMBIAL.
• data[].anbimaClass: Classe ANBIMA do fundo. Campo necessário para aderência à Resolução CVM175 — definições de mercado aguardadas.
• data[].anbimaSubclass: Subclasse ANBIMA do fundo. Campo necessário para aderência à Resolução CVM175 — definições de mercado aguardadas.
• data[].investmentId: Identificador único e imutável da operação de fundo de investimento do cliente na instituição transmissora. Nos casos em que o cliente recompra o fundo após 12 meses sem movimentação e com quantidade zerada, o mesmo investmentId anterior deve ser reutilizado.
• links.self: URI completa que gerou a resposta atual.
• links.first: URI da primeira página. Obrigatório quando não for a primeira página.
• links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
• links.next: URI da próxima página. Obrigatório quando não for a última página.
• links.last: URI da última página. Obrigatório quando não for a última página.
• meta.totalRecords: Número total de registros no resultado.
• meta.totalPages: Número total de páginas no resultado.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/funds/investments/{investmentId}

Obtém os dados da operação de Fundos de Investimento identificada por investmentId.

Permission necessária: funds

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "name": "CONSTELLATION MASTER FIA",
    "cnpjNumber": "11225860000140",
    "isinCode": "BRCST4CTF001",
    "anbimaCategory": "ACOES",
    "anbimaClass": "string",
    "anbimaSubclass": "string"
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data.name: Nome oficial do fundo de investimento conforme exibido para os clientes nos canais eletrônicos. Máximo 250 caracteres.
• data.cnpjNumber: CNPJ do fundo de investimento (sem máscara). Diferente do companyCnpj da lista, que é o CNPJ da instituição custodiante/distribuidora.
• data.isinCode: Código ISIN do fundo conforme ISO 6166 — 12 caracteres alfanuméricos (ex: BRCST4CTF001). Campo opcional.
• data.anbimaCategory: Categoria ANBIMA do fundo conforme Deliberação 77. Enum: RENDA_FIXA, ACOES, MULTIMERCADO, CAMBIAL.
• data.anbimaClass: Classe ANBIMA. Campo para aderência à Resolução CVM175 — definições de mercado aguardadas.
• data.anbimaSubclass: Subclasse ANBIMA. Campo para aderência à Resolução CVM175 — definições de mercado aguardadas.
• links: Links de navegação entre páginas (ver descrição em GET /investments).
• meta.totalRecords: Número total de registros no resultado.
• meta.totalPages: Número total de páginas no resultado.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/funds/investments/{investmentId}/balances

Obtém a posição (saldo) da operação de Fundos de Investimento identificada por investmentId.

Quando não houver posição (quantidade e valores zerados), mas o investimento ainda estiver no prazo de exposição (até 12 meses após a última movimentação), deve-se retornar HTTP 200 com valores monetários 0.00, quantidade de cotas 0.00 e referenceDate igual à data do requestDateTime (sem o horário). Campos não obrigatórios não devem ser retornados.

Permission necessária: funds

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "referenceDate": "2023-01-07",
    "grossAmount": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "netAmount": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "incomeTaxProvision": {
      "amount": "50.02",
      "currency": "BRL"
    },
    "financialTransactionTaxProvision": {
      "amount": "50.02",
      "currency": "BRL"
    },
    "blockedAmount": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "quotaQuantity": "42.25",
    "quotaGrossPriceValue": {
      "amount": "1000.04",
      "currency": "BRL"
    }
  },
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource",
    "last": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data.referenceDate: Data da última posição consolidada disponível nos canais eletrônicos (YYYY-MM-DD). Quando a posição for zerada, deve ser igual à data do requestDateTime.
• data.grossAmount.amount: Valor bruto do investimento (quantidade de cotas × valor da cota), atualizado na data de referência. Com 2 a 4 casas decimais. Pode ser negativo.
• data.grossAmount.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data.netAmount.amount: Valor líquido do investimento atualizado na data de referência, após dedução de IR, IOF e taxa de saída (quando a instituição considera esses valores na composição do saldo líquido). Inclui o valor bloqueado (blockedAmount). Com 2 a 4 casas decimais. Pode ser negativo.
• data.netAmount.currency: Moeda no padrão ISO-4217.
• data.incomeTaxProvision.amount: Valor do IR provisionado com a alíquota vigente na data de referência. Com 2 a 4 casas decimais.
• data.incomeTaxProvision.currency: Moeda no padrão ISO-4217.
• data.financialTransactionTaxProvision.amount: Valor do IOF provisionado com a alíquota vigente na data de referência. Com 2 a 4 casas decimais.
• data.financialTransactionTaxProvision.currency: Moeda no padrão ISO-4217.
• data.blockedAmount.amount: Valor não disponível para movimentação (bloqueio judicial, bloqueio em garantia etc.). Prazo de carência não é considerado bloqueio. Com 2 a 4 casas decimais. Pode ser negativo.
• data.blockedAmount.currency: Moeda no padrão ISO-4217.
• data.quotaQuantity: Quantidade de cotas detidas em posição pelo cliente na data de referência. Com 2 a 8 casas decimais.
• data.quotaGrossPriceValue.amount: Valor bruto da cota atualizado na data de referência. Com 2 a 8 casas decimais. Pode ser negativo.
• data.quotaGrossPriceValue.currency: Moeda no padrão ISO-4217.
• links: Links de navegação entre páginas (ver descrição em GET /investments).
• meta.totalRecords: Número total de registros no resultado.
• meta.totalPages: Número total de páginas no resultado.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/funds/investments/{investmentId}/transactions

Obtém as movimentações históricas (últimos 12 meses) da operação de Fundos de Investimento identificada por investmentId.

Permission necessária: funds

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "transactionId": "ABCD2126019929279212650822221989319253344",
      "type": "ENTRADA",
      "transactionType": "APLICACAO",
      "transactionTypeAdditionalInfo": "string",
      "transactionConversionDate": "2023-01-07",
      "transactionQuotaPrice": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionQuotaQuantity": "42.25",
      "transactionValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionGrossValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "incomeTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "financialTransactionTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionExitFee": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionNetValue": {
        "amount": "1000.04",
        "currency": "BRL"
      }
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

• data[].transactionId: Código ou identificador único da movimentação individual na posição do fundo, prestado pela instituição.
• data[].type: Tipo de movimentação na visão do investimento. ENTRADA cobre: APLICACAO, TRANSFERENCIA_COTAS, OUTROS. SAIDA cobre: RESGATE, COME_COTAS, TRANSFERENCIA_COTAS, AMORTIZACAO, OUTROS. Enum: ENTRADA, SAIDA.
• data[].transactionType: Natureza da movimentação. Enum: AMORTIZACAO, TRANSFERENCIA_COTAS, APLICACAO, RESGATE, COME_COTAS, OUTROS. A opção OUTROS deve ser usada apenas quando a movimentação não se enquadrar em nenhum dos demais itens.
• data[].transactionTypeAdditionalInfo: Informação adicional do tipo de movimentação. Obrigatório quando transactionType for OUTROS.
• data[].transactionConversionDate: Data da conversão da transação de movimentação do fundo (YYYY-MM-DD). É a data efetiva de processamento da ordem, conforme as regras do regulamento do fundo.
• data[].transactionQuotaPrice.amount: Valor da cota utilizada na conversão da movimentação, conforme regra prevista no regulamento. Pode ser negativo. Com 2 a 8 casas decimais.
• data[].transactionQuotaPrice.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data[].transactionQuotaQuantity: Número de cotas convertidas na data da movimentação. Com 2 a 8 casas decimais.
• data[].transactionValue.amount: Valor solicitado pelo cliente na ordem. Pode ser negativo. Com 2 a 4 casas decimais.
• data[].transactionValue.currency: Moeda no padrão ISO-4217.
• data[].transactionGrossValue.amount: Valor bruto da movimentação (quantidade de cotas × valor da cota). Para movimentações sem cotas (ex: amortização), esta regra não se aplica. Pode ser negativo. Com 2 a 4 casas decimais.
• data[].transactionGrossValue.currency: Moeda no padrão ISO-4217.
• data[].incomeTax.amount: Valor do IR retido na fonte com a alíquota vigente na data da movimentação. Pode ser negativo. Com 2 a 4 casas decimais. Obrigatório quando type for SAIDA.
• data[].incomeTax.currency: Moeda no padrão ISO-4217.
• data[].financialTransactionTax.amount: Valor do IOF retido na fonte com a alíquota vigente na data da movimentação. Pode ser negativo. Com 2 a 4 casas decimais. Obrigatório quando type for SAIDA.
• data[].financialTransactionTax.currency: Moeda no padrão ISO-4217.
• data[].transactionExitFee.amount: Valor da taxa de saída considerado na movimentação. Com 2 a 4 casas decimais. Obrigatório quando type for SAIDA.
• data[].transactionExitFee.currency: Moeda no padrão ISO-4217.
• data[].transactionNetValue.amount: Valor líquido da movimentação após dedução de IR, IOF e taxa de saída. Pode ser negativo. Com 2 a 4 casas decimais. Obrigatório quando type for SAIDA.
• data[].transactionNetValue.currency: Moeda no padrão ISO-4217.
• links.self: URI completa que gerou a resposta atual.
• links.first: URI da primeira página. Obrigatório quando não for a primeira página.
• links.prev: URI da página anterior. Obrigatório quando não for a primeira página.
• links.next: URI da próxima página. Obrigatório quando não for a última página.
• meta.requestDateTime: Data e hora da consulta no formato RFC-3339 UTC.

GET /baas/v1/open/dat/funds/investments/{investmentId}/transactions-current

Obtém as movimentações recentes da operação de Fundos de Investimento identificada por investmentId. O período considerado é de até 7 dias anteriores à consulta, incluindo o dia da consulta (D-6).

Permission necessária: funds

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "transactionId": "ABCD2126019929279212650822221989319253344",
      "type": "SAIDA",
      "transactionType": "RESGATE",
      "transactionTypeAdditionalInfo": "string",
      "transactionConversionDate": "2023-01-07",
      "transactionQuotaPrice": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionQuotaQuantity": "42.25",
      "transactionValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionGrossValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "incomeTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "financialTransactionTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionExitFee": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionNetValue": {
        "amount": "1000.04",
        "currency": "BRL"
      }
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v1/resource",
    "first": "https://api.banco.com.br/open-banking/api/v1/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v1/resource",
    "next": "https://api.banco.com.br/open-banking/api/v1/resource"
  },
  "meta": {
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}

Descrição dos campos

Este endpoint retorna a mesma estrutura de resposta que GET /baas/v1/open/dat/funds/investments/{investmentId}/transactions. A diferença está no limite de período de consulta: máximo de 7 dias anteriores à data de consulta, inclusive (D-6), em vez dos 12 meses do endpoint histórico.

O objeto meta contém apenas requestDateTime (sem totalRecords e totalPages), e o objeto links não possui o campo last. Consulte a descrição completa dos campos na seção anterior.