API Investimentos - Renda Fixa Bancária

GET /baas/v1/open/dat/bank-fixed-incomes/investments

Obtém a lista de operações de Renda Fixa Bancária mantidas pelo cliente na instituição transmissora e para as quais ele tenha fornecido consentimento.

Permission necessária: bank-fixed-incomes

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "brandName": "Organização A",
      "companyCnpj": "21281590001660",
      "investmentType": "CDB",
      "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[].investmentType: Tipo do ativo de renda fixa bancária. Enum: CDB (Certificado de Depósito Bancário), RDB (Recibo de Depósito Bancário), LCI (Letra de Crédito Imobiliário), LCA (Letra de Crédito do Agronegócio).
• data[].investmentId: Identificador único e imutável da operação de renda fixa do cliente na instituição transmissora.
• 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/bank-fixed-incomes/investments/{investmentId}

Obtém os dados da operação de Renda Fixa Bancária identificada por investmentId.

Permission necessária: bank-fixed-incomes

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "issuerInstitutionCnpjNumber": "11225860000140",
    "isinCode": "BRCST4CTF001",
    "investmentType": "CDB",
    "remuneration": {
      "preFixedRate": "0.300000",
      "postFixedIndexerPercentage": "1.100000",
      "rateType": "LINEAR",
      "ratePeriodicity": "MENSAL",
      "calculation": "DIAS_CORRIDOS",
      "indexer": "CDI",
      "indexerAdditionalInfo": "Dólar"
    },
    "issueUnitPrice": {
      "amount": "1000.000004",
      "currency": "BRL"
    },
    "dueDate": "2018-02-15",
    "issueDate": "2018-02-16",
    "clearingCode": "CDB421GPXXX",
    "purchaseDate": "2018-02-15",
    "gracePeriodDate": "2018-02-16"
  },
  "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.issuerInstitutionCnpjNumber: CNPJ da instituição emissora do título (sem máscara).
• data.isinCode: Código ISIN do título — código universal que identifica cada valor mobiliário ou instrumento financeiro, conforme ISO 6166. 12 caracteres alfanuméricos (ex: BRCST4CTF001).
• data.investmentType: Tipo do ativo. Enum: CDB, RDB, LCI, LCA.
• data.remuneration.preFixedRate: Taxa de remuneração pré-fixada de emissão do título (6 casas decimais, ex: 0.300000 = 30%). Obrigatório quando indexer for PRE_FIXADO ou para produtos com remuneração híbrida.
• data.remuneration.postFixedIndexerPercentage: Percentual do indexador pós-fixado de emissão do título (6 casas decimais, ex: 1.100000 = 110%). Valor negativo indica que o indexador está sendo deduzido da rentabilidade. Obrigatório quando indexer for diferente de PRE_FIXADO ou para produtos híbridos.
• data.remuneration.rateType: Tipo da taxa de remuneração. Enum: LINEAR, EXPONENCIAL.
• data.remuneration.ratePeriodicity: Periodicidade da taxa de remuneração. Enum: MENSAL, ANUAL, DIARIO, SEMESTRAL.
• data.remuneration.calculation: Base de cálculo. Enum: DIAS_UTEIS, DIAS_CORRIDOS.
• data.remuneration.indexer: Índice de referência para correção da rentabilidade. Enum: CDI, DI, TR, IPCA, IGP_M, IGP_DI, INPC, BCP, TLC, SELIC, PRE_FIXADO, OUTROS.
• data.remuneration.indexerAdditionalInfo: Informações adicionais do indexador. Obrigatório quando indexer for OUTROS.
• data.issueUnitPrice.amount: Preço unitário de emissão do título. Com 2 a 8 casas decimais.
• data.issueUnitPrice.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data.dueDate: Data de vencimento do título (YYYY-MM-DD).
• data.issueDate: Data de emissão do título (YYYY-MM-DD).
• data.clearingCode: Código de registro do ativo na clearing.
• data.purchaseDate: Data de aquisição pelo cliente (YYYY-MM-DD).
• data.gracePeriodDate: Data até a qual o cliente não poderá resgatar antecipadamente seu investimento (YYYY-MM-DD).
• 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/bank-fixed-incomes/investments/{investmentId}/balances

Obtém a posição (saldo) da operação de Renda Fixa Bancária 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 zerados (0.00), quantidade 0.00 e referenceDateTime igual ao requestDateTime. Campos não obrigatórios não devem ser retornados.

Permission necessária: bank-fixed-incomes

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "referenceDateTime": "2022-07-21T17:32:00Z",
    "quantity": "1000.0004",
    "updatedUnitPrice": {
      "amount": "1000.000004",
      "currency": "BRL"
    },
    "grossAmount": {
      "amount": "1000.0004",
      "currency": "BRL"
    },
    "netAmount": {
      "amount": "1000.0004",
      "currency": "BRL"
    },
    "incomeTax": {
      "amount": "1000.0004",
      "currency": "BRL"
    },
    "financialTransactionTax": {
      "amount": "1000.0004",
      "currency": "BRL"
    },
    "blockedBalance": {
      "amount": "1000.0004",
      "currency": "BRL"
    },
    "purchaseUnitPrice": {
      "amount": "1000.000004",
      "currency": "BRL"
    },
    "preFixedRate": "0.300000",
    "postFixedIndexerPercentage": "1.000000"
  },
  "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.referenceDateTime: Data e hora da última posição consolidada disponível nos canais eletrônicos, no formato RFC-3339 UTC. Os minutos e segundos devem ser representados como zero (00:00:00Z). Pode refletir captura síncrona (até uma hora atrás) ou assíncrona (horas ou dias atrás). Quando a posição for zerada, deve ser igual ao requestDateTime.
• data.quantity: Quantidade de títulos detidos na data de posição do cliente. Com 2 a 10 casas decimais.
• data.updatedUnitPrice.amount: Valor bruto unitário atualizado na data de referência. Com 2 a 10 casas decimais.
• data.updatedUnitPrice.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data.grossAmount.amount: Valor bruto do investimento (quantidade × preço unitário atualizado). Com 2 a 4 casas decimais.
• data.grossAmount.currency: Moeda no padrão ISO-4217.
• data.netAmount.amount: Valor líquido do investimento na data de referência, após dedução de IR e IOF. Com 2 a 4 casas decimais.
• data.netAmount.currency: Moeda no padrão ISO-4217.
• data.incomeTax.amount: Valor do Imposto de Renda (IR) provisionado com a alíquota vigente na data de referência. Com 2 a 4 casas decimais.
• data.incomeTax.currency: Moeda no padrão ISO-4217.
• data.financialTransactionTax.amount: Valor do IOF provisionado com a alíquota vigente na data de referência. Com 2 a 4 casas decimais.
• data.financialTransactionTax.currency: Moeda no padrão ISO-4217.
• data.blockedBalance.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.
• data.blockedBalance.currency: Moeda no padrão ISO-4217.
• data.purchaseUnitPrice.amount: Valor unitário negociado com o cliente na data de aquisição. Com 2 a 8 casas decimais.
• data.purchaseUnitPrice.currency: Moeda no padrão ISO-4217.
• data.preFixedRate: Taxa de remuneração acordada na contratação (6 casas decimais). Para produtos progressivos, considerar a taxa máxima contratada.
• data.postFixedIndexerPercentage: Percentual do indexador acordado na contratação (6 casas decimais). Para produtos progressivos, considerar a taxa máxima contratada.
• 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/bank-fixed-incomes/investments/{investmentId}/transactions

Obtém as movimentações históricas (últimos 12 meses) da operação de Renda Fixa Bancária identificada por investmentId.

Permission necessária: bank-fixed-incomes

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "type": "ENTRADA",
      "transactionType": "APLICACAO",
      "transactionTypeAdditionalInfo": "string",
      "transactionDate": "2018-02-15",
      "transactionUnitPrice": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionQuantity": "42.25",
      "transactionGrossValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "incomeTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "financialTransactionTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionNetValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "remunerationTransactionRate": "0.300000",
      "indexerPercentage": "1.100000",
      "transactionId": "ABCD2126019929279212650822221989319253344"
    }
  ],
  "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[].type: Tipo de movimentação na visão do investimento. Enum: ENTRADA (aplicação, cancelamento de resgate, transferência recebida), SAIDA (resgate, cancelamento de aplicação, vencimento, pagamento de juros, amortização, transferência enviada).
• data[].transactionType: Natureza da movimentação. Enum: APLICACAO, RESGATE, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, OUTROS. Para transferências, o transactionUnitPrice deve ser o PU da aquisição original (ou PU da data de transferência quando o original não estiver disponível).
• data[].transactionTypeAdditionalInfo: Informação adicional do tipo de movimentação. Obrigatório quando transactionType for OUTROS.
• data[].transactionDate: Data da movimentação (YYYY-MM-DD).
• data[].transactionUnitPrice.amount: Preço unitário bruto negociado na transação. Com 2 a 8 casas decimais.
• data[].transactionUnitPrice.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data[].transactionQuantity: Quantidade de títulos envolvidos na movimentação. Com 2 a 8 casas decimais.
• data[].transactionGrossValue.amount: Valor bruto da transação (preço unitário × quantidade). Com 2 a 4 casas decimais.
• data[].transactionGrossValue.currency: Moeda no padrão ISO-4217.
• data[].incomeTax.amount: Valor do IR recolhido na transação. Com 2 a 4 casas decimais. Obrigatório para produtos sujeitos a IR quando type for SAIDA.
• data[].incomeTax.currency: Moeda no padrão ISO-4217.
• data[].financialTransactionTax.amount: Valor do IOF recolhido na transação. Com 2 a 4 casas decimais. Obrigatório para produtos sujeitos a IOF quando type for SAIDA.
• data[].financialTransactionTax.currency: Moeda no padrão ISO-4217.
• data[].transactionNetValue.amount: Valor líquido da transação. Com 2 a 4 casas decimais.
• data[].transactionNetValue.currency: Moeda no padrão ISO-4217.
• data[].remunerationTransactionRate: Taxa de remuneração da transação (6 casas decimais). Obrigatório quando type for ENTRADA e o produto for prefixado ou híbrido.
• data[].indexerPercentage: Percentual máximo do indexador acordado na contratação (6 casas decimais). Obrigatório quando type for ENTRADA e o produto for pós-fixado ou híbrido.
• data[].transactionId: Código ou identificador único da movimentação individual prestado pela instituição.
• 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/bank-fixed-incomes/investments/{investmentId}/transactions-current

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

Permission necessária: bank-fixed-incomes

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "type": "ENTRADA",
      "transactionType": "APLICACAO",
      "transactionTypeAdditionalInfo": "string",
      "transactionDate": "2018-02-15",
      "transactionUnitPrice": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionQuantity": "42.25",
      "transactionGrossValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "incomeTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "financialTransactionTax": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "transactionNetValue": {
        "amount": "1000.04",
        "currency": "BRL"
      },
      "remunerationTransactionRate": "0.300000",
      "indexerPercentage": "1.100000",
      "transactionId": "ABCD2126019929279212650822221989319253344"
    }
  ],
  "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 /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.