API Investimentos - Renda Fixa Crédito

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

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

Permission necessária: credit-fixed-incomes

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "brandName": "Organização A",
      "companyCnpj": "21128159000166",
      "investmentType": "CRI",
      "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 crédito. Enum: DEBENTURES (Debêntures), CRI (Certificado de Recebíveis Imobiliários), CRA (Certificado de Recebíveis do Agronegócio).
• data[].investmentId: Identificador único e imutável da operação de renda fixa crédito do cliente na instituição transmissora.
• links.self: URL completa que gerou a resposta atual.
• links.first: URL da primeira página. Obrigatório quando não for a primeira página.
• links.prev: URL da página anterior. Obrigatório quando não for a primeira página.
• links.next: URL da próxima página. Obrigatório quando não for a última página.
• links.last: URL 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/credit-fixed-incomes/investments/{investmentId}

Obtém os dados da operação de Renda Fixa Crédito identificada por investmentId.

Permission necessária: credit-fixed-incomes

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "issuerInstitutionCnpjNumber": "11225860000140",
    "isinCode": "BRCST4CTF001",
    "investmentType": "CRI",
    "debtorCnpjNumber": "11225860000140",
    "debtorName": "Roberto Marino",
    "taxExemptProduct": "SIM",
    "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"
    },
    "issueDate": "2018-02-16",
    "dueDate": "2018-02-15",
    "voucherPaymentIndicator": "SIM",
    "voucherPaymentPeriodicity": "MENSAL",
    "voucherPaymentPeriodicityAdditionalInfo": "Diária",
    "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 (sem máscara). Obrigatório quando a instituição possuir a informação.
• data.isinCode: Código ISIN do título — identificador universal conforme ISO 6166. 12 caracteres alfanuméricos (ex: BRCST4CTF001). Obrigatório quando a transmissora possuir a informação. Deve ser preenchido quando clearingCode não for informado.
• data.investmentType: Tipo do ativo. Enum: DEBENTURES, CRI, CRA.
• data.debtorCnpjNumber: CNPJ do devedor (sem máscara). Obrigatório para CRI e CRA quando a transmissora possuir a informação.
• data.debtorName: Nome do devedor. Obrigatório para CRI e CRA quando a transmissora possuir a informação.
• data.taxExemptProduct: Indica se é um produto incentivado (isento de IR). Enum: SIM, NAO.
• data.remuneration.preFixedRate: Taxa pré-fixada de emissão do contrato (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 contrato (6 casas decimais, ex: 1.100000 = 110%). 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. Obrigatório quando a instituição possuir a informação.
• data.remuneration.ratePeriodicity: Periodicidade da taxa. Enum: MENSAL, ANUAL, DIARIO, SEMESTRAL. Obrigatório quando a instituição possuir a informação.
• data.remuneration.calculation: Base de cálculo. Enum: DIAS_UTEIS, DIAS_CORRIDOS. Obrigatório quando a instituição possuir a informação.
• 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.issueDate: Data de emissão do título (YYYY-MM-DD).
• data.dueDate: Data de vencimento do título (YYYY-MM-DD).
• data.voucherPaymentIndicator: Indica se há pagamento de cupom. Enum: SIM, NAO.
• data.voucherPaymentPeriodicity: Periodicidade do pagamento de cupom. Obrigatório quando voucherPaymentIndicator for SIM. Enum: MENSAL, TRIMESTRAL, SEMESTRAL, ANUAL, IRREGULAR, OUTROS.
• data.voucherPaymentPeriodicityAdditionalInfo: Informações adicionais da periodicidade. Obrigatório quando voucherPaymentPeriodicity for OUTROS.
• data.clearingCode: Código de registro do ativo na clearing. Obrigatório quando a transmissora possuir a informação. Deve ser preenchido quando isinCode não for informado.
• data.purchaseDate: Data de aquisição pelo cliente (YYYY-MM-DD).
• data.gracePeriodDate: Data até a qual o cliente não poderá resgatar antecipadamente (YYYY-MM-DD). Obrigatório quando a instituição possuir a informação.
• 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/credit-fixed-incomes/investments/{investmentId}/balances

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

Permission necessária: credit-fixed-incomes

Parâmetros de path

Exemplo de resposta (200 OK)

{
  "data": {
    "referenceDateTime": "2022-07-21T17:32:00Z",
    "updatedUnitPrice": {
      "amount": "1000.0400",
      "currency": "BRL"
    },
    "quantity": "15.00",
    "grossAmount": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "netAmount": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "incomeTax": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "financialTransactionTax": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "blockedBalance": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "purchaseUnitPrice": {
      "amount": "1000.000004",
      "currency": "BRL"
    },
    "preFixedRate": "0.300000",
    "postFixedIndexerPercentage": "1.100000",
    "fine": {
      "amount": "1000.04",
      "currency": "BRL"
    },
    "latePayment": {
      "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.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). Quando a posição for zerada, deve ser igual ao requestDateTime.
• data.updatedUnitPrice.amount: Valor bruto unitário atualizado na data de referência. Com 2 a 8 casas decimais.
• data.updatedUnitPrice.currency: Moeda no padrão ISO-4217 (ex: BRL).
• data.quantity: Quantidade de títulos detidos na data de posição do cliente. Com 2 a 8 casas decimais.
• 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 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.
• data.fine.amount: Valor de multa por atraso do pagamento acordado em contrato. Com 2 a 4 casas decimais. Obrigatório quando a transmissora possuir a informação.
• data.fine.currency: Moeda no padrão ISO-4217.
• data.latePayment.amount: Valor de mora por atraso do pagamento acordado em contrato. Com 2 a 4 casas decimais. Obrigatório quando a transmissora possuir a informação.
• data.latePayment.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/credit-fixed-incomes/investments/{investmentId}/transactions

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

Permission necessária: credit-fixed-incomes

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "type": "ENTRADA",
      "transactionType": "COMPRA",
      "transactionTypeAdditionalInfo": "string",
      "transactionDate": "2018-02-15",
      "transactionUnitPrice": {
        "amount": "1000.000004",
        "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 (compra, cancelamento de venda, transferências recebidas), SAIDA (venda, cancelamento de compra, vencimento, pagamento de juros, amortização, prêmio, transferências enviadas, multa, mora). Para CANCELAMENTO, o type é o contrário do evento originário.
• data[].transactionType: Natureza da movimentação. Enum: COMPRA, VENDA, CANCELAMENTO, VENCIMENTO, PAGAMENTO_JUROS, AMORTIZACAO, PREMIO, TRANSFERENCIA_TITULARIDADE, TRANSFERENCIA_CUSTODIA, MULTA, MORA, OUTROS. Para transferências, usar 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: Valor unitário negociado na data de aquisição. Em transferências de custódia, quando o PU original não estiver disponível, informar o PU marcado pela instituição na data de transferência. Com 2 a 8 casas decimais. Obrigatório para transactionType igual a COMPRA, VENDA ou VENCIMENTO.
• data[].transactionUnitPrice.currency: Moeda no padrão ISO-4217.
• data[].transactionQuantity: Quantidade de títulos envolvidos na movimentação. Com 2 a 8 casas decimais. Obrigatório para transactionType igual a COMPRA, VENDA, VENCIMENTO, TRANSFERENCIA_TITULARIDADE ou TRANSFERENCIA_CUSTODIA.
• 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 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 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 acordada na contratação (6 casas decimais, ex: 0.300000 = 30%). Obrigatório quando type for ENTRADA e o produto for prefixado ou híbrido.
• data[].indexerPercentage: Percentual máximo do indexador na transação (6 casas decimais, ex: 1.100000 = 110%). 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: URL completa que gerou a resposta atual.
• links.first: URL da primeira página. Obrigatório quando não for a primeira página.
• links.prev: URL da página anterior. Obrigatório quando não for a primeira página.
• links.next: URL 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/credit-fixed-incomes/investments/{investmentId}/transactions-current

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

Permission necessária: credit-fixed-incomes

Parâmetros de path

Parâmetros de query

Exemplo de resposta (200 OK)

{
  "data": [
    {
      "type": "ENTRADA",
      "transactionType": "COMPRA",
      "transactionTypeAdditionalInfo": "string",
      "transactionDate": "2018-02-15",
      "transactionUnitPrice": {
        "amount": "1000.000004",
        "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 /baas/v1/open/dat/credit-fixed-incomes/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.