Banco B3 APIs

{"id":"0527a5eb-79aa-4a70-b85e-7e1f2407fd8f","description":"<details>\n<summary><b>Vis\u00e3o Geral<\/b><\/summary><br>\n\nA API de Cust\u00f3dia do Banco B3 age como facilitador nos processos operacionais di\u00e1rios, possibilitando ganho de escala, mitiga\u00e7\u00e3o de risco operacional, e serve como uma ponte entre diferentes plataformas e sistemas, garantindo a integridade, seguran\u00e7a e efici\u00eancia na troca e informa\u00e7\u00f5es e dados transacionados.\n\nAs fun\u00e7\u00f5es gerais da API s\u00e3o detalhadas abaixo:\n1. **Consulta e Valida\u00e7\u00e3o de Cota Di\u00e1ria de Fundos**: Atrav\u00e9s da API, os usu\u00e1rios podem consultar informa\u00e7\u00f5es atualizadas sobre as cotas di\u00e1rias calculadas para cada fundo de investimento e dar instru\u00e7\u00e3o de valida\u00e7\u00e3o do valor calculado para divulga\u00e7\u00e3o ao mercado.\n\n2. **Consulta de Saldo e Extrato de Conta Corrente Online**: Atrav\u00e9s da API, os usu\u00e1rios podem consultar as movimenta\u00e7\u00f5es financeiras online e o saldo atualizado em suas contas correntes. Isso inclui entradas e sa\u00eddas de recursos, permitindo um acompanhamento efetivo do fluxo de caixa associado \u00e0s opera\u00e7\u00f5es nos diversos mercados.\n\n3. **Carteira em formato XML ANBIMA 4.01**: A API fornece acesso as informa\u00e7\u00f5es da carteira di\u00e1ria no padr\u00e3o ANBIMA 4.0.1, nos formatos XML e JSON. \n\n4. **Consulta de Posi\u00e7\u00e3o de Cotistas por Certificado de Aplica\u00e7\u00e3o**: Atrav\u00e9s da API, os usu\u00e1rios podem consultar a posi\u00e7\u00e3o di\u00e1ria por certificado\/nota de aplica\u00e7\u00e3o de cotistas para um determinado fundo de investimento.\n\n5. **Consultas de Movimenta\u00e7\u00e3o de Cotistas**: A API fornece, em formato JSON, dados baseados na movimenta\u00e7\u00e3o de cotistas (aplica\u00e7\u00f5es, resgates e amortiza\u00e7\u00f5es) a partir de um determinado fundo de investimento.\n\n6. **Integra\u00e7\u00e3o de Boletas de Renda Vari\u00e1vel**: A API permite a boletagem de opera\u00e7\u00f5es de clientes realizadas no mercado de a\u00e7\u00f5es e op\u00e7\u00f5es da B3.\n\n7. **Integra\u00e7\u00e3o de Boletas de Renda Fixa**: A API permite a boletagem de opera\u00e7\u00f5es de renda fixa de clientes realizadas no mercado, tanto para t\u00edtulos p\u00fablicos quanto para opera\u00e7\u00f5es de cr\u00e9dito privado.\n\n8. **Integra\u00e7\u00e3o de Opera\u00e7\u00f5es de Cotas de Fundos**: A API permite a boletagem de opera\u00e7\u00f5es (aplica\u00e7\u00f5es e resgates) em cotas de fundos externos (ativo do fundo).\n\nPara maiores informa\u00e7\u00f5es, por gentileza entrar em contato com o time do Banco B3 atrav\u00e9s dos contatos abaixo:\n\natendimento_banco@b3.com.br\n+55 11 2565-4176\nou \nbancob3sales@b3.com.br\n\nwww.bancob3.com.br\n\n<\/p><\/details><br\/>\n\n<details><summary><b>Regras e Boas Pr\u00e1ticas<\/b><\/summary><br\/><p>\n\nComo boas praticas seguimos com alguns padr\u00f5es de dados:\n- **Datas**: no formato AAAA-DD-MM. Ex.: 2024-01-01.\n- **N\u00fameros**: formato double com at\u00e9 12 casas decimais antes e 12 depois do ponto. Ex. 999999999999.9, 0.999999999999.\n- **Identificadores internos**: sempre em formato UUID\/GUID com h\u00edfen. Ex. e79e3c5e-a3bd-4175-a230-ab69c92711db, D6CD9E9C-2A08-4360-8979-90DD6186ADC9.\n\n<\/p><\/details><br\/>\n\n<details>\n<summary><b>Exemplos de Payload<\/b><\/summary><br>\n<details style=\"margin-left: 20px;\">\n<summary><b>Consulta Boletas<\/b><\/summary><br>\n\nConsulta status de um lote de opera\u00e7\u00f5es de compra e venda nos mercados de renda vari\u00e1vel \u00e0 vista e de op\u00e7\u00f5es.\n\n```json\nGET \/api\/custodias\/v1\/public\/boletas\/renda-variavel?idLoteBoletas=D6CD9E9C-2A08-4360-8979-90DD6186ADC9`\n```\n<\/details><br>\n<details style=\"margin-left: 20px;\">\n<summary><b>Insere Boletas<\/b><\/summary><br>\n\nInsere opera\u00e7\u00f5es realizadas de compra e venda nos mercados de renda vari\u00e1vel a ser processada no portf\u00f3lio do cliente.\n\n```json\nPOST \/v1\/public\/boletagem\/renda-variavel\n[\n  {\n    \"idExterno\": \"105D0E75-1B42-4038-9287-712EA451D457\",\n    \"codigoCarteira\": \"FUNDO_TESTE_LIQUIDEZ\",\n    \"codigoCorretora\": \"CORRETORA_TESTE\",\n    \"codigoPapel\": \"PETR4\",\n    \"dataMovimento\": \"2024-02-01\",\n    \"indicadorCompraVenda\": \"C\",\n    \"quantidadeNegociada\": 10,\n    \"precoNegociado\": 29.78,\n  },\n  {\n    \"idExterno\": \"30B7D5DD-5B27-4341-8022-110E501D63CA\",\n    \"codigoCarteira\": \"FUNDO_TESTE_LIQUIDEZ\",\n    \"codigoCorretora\": \"CORRETORA_TESTE\",\n    \"codigoPapel\": \"B3SA3\",\n    \"dataMovimento\": \"2024-02-01\",\n    \"indicadorCompraVenda\": \"C\",\n    \"quantidadeNegociada\": \"1000\",\n    \"precoNegociado\": \"12.52\",\n  }\n] \n```\n\n<\/details><br>\n<details style=\"margin-left: 20px;\">\n<summary><b>Relat\u00f3rio de posi\u00e7\u00e3o do fundo<\/b><\/summary><br>\n\nRetorna a posi\u00e7\u00e3o da carteira do fundo em formato JSON ou XML, baseados no padr\u00e3o XML ANBIMA 4.01\n\n```json\nGET api\/custodias\/v1\/public\/relat\u00f3rios\/posi\u00e7\u00e3o-fundo\/fundos\/7FAE021D-ABDE-4484-8E0F-398B3C13F8D5?dataCarteira=2024-01-01\n```\n<\/details><br>\n<details style=\"margin-left: 20px;\">\n<summary><b>Relat\u00f3rio de caixa online<\/b><\/summary><br>\n\nRetorna dados online dos lan\u00e7amentos da conta corrente do fundo no Banco B3.\n\n```json\nGET \/api\/custodias\/v1\/public\/relatorios\/caixa-on-line\/fundos\/7FAE021D-ABDE-4484-8E0F-398B3C13F8D5?dataInicial=2024-01-01&dataFinal=2024-01-01\n```\n<\/details><br>\n<details style=\"margin-left: 20px;\">\n<summary><b>Consulta para valida\u00e7\u00e3o de cotas<\/b><\/summary><br>\n\nRetorna um grupo com valores de cotas de um fundo\n\n```json\nGET \/api\/custodias\/v1\/public\/validacao-cotas?dataInicio=2024-01-02?dataFim=2024-01-02?cotaLiberada=N\n```\n\n<\/details><br>\n<details style=\"margin-left: 20px;\">\n<summary><b>Valida ou invalida uma cota<\/b><\/summary><br>\n\nAlterar o status de valida\u00e7\u00e3o da cota de fundo\n\n```json\nPATCH \/api\/custodias\/v1\/public\/validacao-cotas?idCota=F037DA0F-CAF4-4D99-BD7C-9F11029913F8\n{\n    \"data\":{\n        \"status\": \"COTA_VALIDA\",\n        \"motivo\": \"OK\"\n    }\n}\n```\n\n<\/details><br>\n<\/details><br>\n \n<details><summary><b>Host<\/b><\/summary><br\/><p>\n\n**Acesso por meio da Internet:**\n\n- Certifica\u00e7\u00e3o: https:\/\/api-custodia-h.bancob3.com.br\n- Produ\u00e7\u00e3o: https:\/\/api-custodia.bancob3.com.br\n\n<\/p><\/details><br\/>\n\n<details><summary><b>Modelo de Autentica\u00e7\u00e3o<\/b><\/summary><br\/><p>\n\nSegue o [Modelo de Autentica\u00e7\u00e3o](\/index.php?option=com_content&view=article&id=62) utilizado.\n\n<\/p><\/details><br\/>\n\n","deprecated":false,"apiVersion":"1.1.0-rc3","swaggerVersion":"1.1","basePath":"https:\/\/developers.b3.com.br:8065","resourcePath":"\/api\/custodias\/v1","models":{"FundoDaMovimentacao":{"type":"object","properties":{"codigoDoFundo":{"maxLength":50,"type":"string","description":"Codigo do Fundo","nullable":true,"example":"eum","exampleSetFlag":true},"documento":{"maxLength":14,"type":"string","description":"Documento Fundo","nullable":true,"example":"dolore","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false},"CaixaOnlineRespostaOk":{"required":["data","links"],"type":"object","properties":{"data":{"type":"object","properties":{"idRequisicao":{"type":"string","description":"Identificador \u00fanico da requisi\u00e7\u00e3o","format":"uuid","nullable":true,"example":"7ddd1795-0d6a-4579-a4af-cad6607745a6","exampleSetFlag":true},"conta":{"type":"object","properties":{"ispb":{"maxLength":8,"type":"string","description":"ISPB do banco","nullable":true,"example":"voluptas","exampleSetFlag":true},"agencia":{"maxLength":5,"type":"string","description":"C\u00f3digo da ag\u00eancia","nullable":true,"example":"unde","exampleSetFlag":true},"numero":{"maxLength":20,"type":"string","description":"N\u00famero da conta","nullable":true,"example":"vel","exampleSetFlag":true},"saldo":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Saldo atualizado total da conta na data","format":"double","exampleSetFlag":false}},"additionalProperties":false,"exampleSetFlag":false},"movimentos":{"type":"array","description":"Lista da movimenta\u00e7\u00e3o de conta","nullable":true,"exampleSetFlag":false,"items":{"type":"object","properties":{"numeroMovimento":{"maxLength":20,"type":"string","description":"N\u00famero do movimento","nullable":true,"example":"repudiandae","exampleSetFlag":true},"dataMovimentoCaixa":{"maxLength":10,"type":"string","description":"Data do movimento","nullable":true,"example":"veritatis","exampleSetFlag":true},"indicadorDebitoCredito":{"maxLength":1,"type":"string","description":"Valores poss\u00edveis: D = D\u00e9bito; C = Cr\u00e9dito","nullable":true,"example":"a","exampleSetFlag":true},"valorMovimento":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor monet\u00e1rio do movimento","format":"double","exampleSetFlag":false},"saldoInicial":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Saldo inicial ap\u00f3s o \u00faltimo lan\u00e7amento","format":"double","example":3,"exampleSetFlag":true},"saldoFinal":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Saldo final ap\u00f3s a soma do lan\u00e7amento atual","format":"double","exampleSetFlag":false},"historicoMovimento":{"type":"object","properties":{"codigo":{"maxLength":10,"type":"string","description":"C\u00f3digo do hist\u00f3rico do movimento","nullable":true,"example":"quos","exampleSetFlag":true},"descricao":{"maxLength":50,"type":"string","description":"Descri\u00e7\u00e3o do hist\u00f3rico do movimento","nullable":true,"example":"quas","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false},"contraParte":{"type":"object","properties":{"titular":{"type":"object","properties":{"cpfCnpj":{"maxLength":14,"type":"string","description":"CPF ou CNPJ da contraparte do movimento","nullable":true,"example":"ipsam","exampleSetFlag":true},"nome":{"maxLength":50,"type":"string","description":"Nome da contraparte do movimento","nullable":true,"example":"nisi","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false},"conta":{"type":"object","properties":{"ispb":{"maxLength":8,"type":"string","description":"ISPB do banco contraparte do movimento","nullable":true,"example":"nisi","exampleSetFlag":true},"agencia":{"maxLength":5,"type":"string","description":"C\u00f3digo da ag\u00eancia contraparte do movimento","nullable":true,"example":"dicta","exampleSetFlag":true},"numero":{"maxLength":20,"type":"string","description":"N\u00famero da conta contraparte do movimento","nullable":true,"example":"voluptas","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false}},"additionalProperties":false,"exampleSetFlag":false}},"additionalProperties":false,"exampleSetFlag":false}}},"additionalProperties":false,"exampleSetFlag":false},"links":{"required":["atual"],"type":"object","properties":{"atual":{"maxLength":2000,"minLength":0,"type":"string","description":"Link para a p\u00e1gina atual.","example":"","exampleSetFlag":true},"primeira":{"maxLength":2000,"minLength":0,"type":"string","description":"Link para a primeira p\u00e1gina.","nullable":true,"example":"","exampleSetFlag":true},"anterior":{"maxLength":2000,"minLength":0,"type":"string","description":"Link para a p\u00e1gina anterior.","nullable":true,"example":"","exampleSetFlag":true},"proxima":{"maxLength":2000,"minLength":0,"type":"string","description":"Link para a pr\u00f3xima p\u00e1gina.","nullable":true,"example":"","exampleSetFlag":true},"ultima":{"maxLength":2000,"minLength":0,"type":"string","description":"Link para a \u00faltima p\u00e1gina.","nullable":true,"example":"","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false}},"additionalProperties":false,"exampleSetFlag":false},"ArquivoPosicao":{"type":"object","properties":{"fundo":{"type":"object","properties":{"header":{"required":["dataPosicao"],"type":"object","properties":{"codigoIsin":{"maxLength":12,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do fundo, fornecido pela BVMF.","nullable":true,"example":"suscipit","exampleSetFlag":true},"cnpjFundo":{"maxLength":14,"type":"string","description":"CNPJ do fundo conforme cadastro na Receita Federal","nullable":true,"example":"enim","exampleSetFlag":true},"nomeFundo":{"maxLength":255,"type":"string","description":"Nome do Fundo cadastrado na Receita Federal","nullable":true,"example":"commodi","exampleSetFlag":true},"dataPosicao":{"maxLength":8,"minLength":1,"type":"string","description":"Data de apura\u00e7\u00e3o do valor da cota do fundo","format":"date","example":"2014-06-02T00:00:00.000+00:00","exampleSetFlag":true},"nomeAdministrador":{"maxLength":255,"type":"string","description":"Nome do administrador do fundo na Data Posi\u00e7\u00e3o","nullable":true,"example":"doloremque","exampleSetFlag":true},"cnpjAdministrador":{"maxLength":255,"type":"string","description":"CNPJ do administrador do fundo na Data Posi\u00e7\u00e3o","nullable":true,"example":"animi","exampleSetFlag":true},"nomeGestor":{"maxLength":255,"type":"string","description":"Nome do gestor do fundo na Data Posi\u00e7\u00e3o","nullable":true,"example":"laudantium","exampleSetFlag":true},"cnpjGestor":{"maxLength":14,"type":"string","description":"CNPJ do gestor do fundo na Data Posi\u00e7\u00e3o","nullable":true,"example":"praesentium","exampleSetFlag":true},"nomeCustodiante":{"maxLength":255,"type":"string","description":"Nome do custodiante do fundo na Data Posi\u00e7\u00e3o","nullable":true,"example":"quasi","exampleSetFlag":true},"cnpjCustodiante":{"maxLength":14,"type":"string","description":"CNPJ do custodiante do fundo na Data Posi\u00e7\u00e3o","nullable":true,"example":"pariatur","exampleSetFlag":true},"valorCota":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor da cota do fundo apurado na Data Posi\u00e7\u00e3o","format":"double","example":6240,"exampleSetFlag":true},"quantidadeCota":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor num\u00e9rico com o estoque de cotas na Data Posi\u00e7\u00e3o.","format":"double","example":572,"exampleSetFlag":true},"patrimonioLiquidoFundo":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor financeiro do PL (Patrim\u00f4nio L\u00edquido) de fechamento do fundo na Data Posi\u00e7\u00e3o","format":"double","exampleSetFlag":false},"valorAtivos":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor dos ativos acrescidos dos ajustes Mercado Futuro","format":"double","exampleSetFlag":false},"valorReceber":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valores a receber exceto os ajustes Mercado Futuro","format":"double","exampleSetFlag":false},"valorPagar":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valores a pagar exceto os ajustes Mercado Futuro","format":"double","example":63136692095,"exampleSetFlag":true},"valorCotasEmitir":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valores em aberto referentes \u00e0s aplica\u00e7\u00f5es no fundo","format":"double","example":869330,"exampleSetFlag":true},"valorCotasResgatar":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valores em aberto referentes aos resgates de cotistas do fundo","format":"double","exampleSetFlag":false},"codigoAmbima":{"maxLength":50,"type":"string","description":"C\u00f3digo do fundo cadastrado na ANBIMA","nullable":true,"example":"repudiandae","exampleSetFlag":true},"tipoFundo":{"maxLength":50,"type":"string","description":"C\u00f3digo de classifica\u00e7\u00e3o do Tipo de Fundo da ANBIMA","nullable":true,"example":"quod","exampleSetFlag":true},"nivelRisco":{"maxLength":2,"type":"string","description":"N\u00edvel de risco segundo estabelecido na RES CMN 3121 de 25\/09\/2003","nullable":true,"example":"a","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false},"tituloPublico":{"type":"array","description":"T\u00edtulos P\u00fablicos que comp\u00f5em o Patrim\u00f4nio L\u00edquido do Fundo \/ Carteira na Data Posi\u00e7\u00e3o","nullable":true,"exampleSetFlag":false,"items":{"type":"object","properties":{"codigoIsinTitulo":{"maxLength":12,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do Ativo","nullable":true,"example":"praesentium","exampleSetFlag":true},"codigoAtivoTitulo":{"maxLength":50,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do tipo de t\u00edtulo p\u00fablico","nullable":true,"example":"repellat","exampleSetFlag":true},"codigoAtivoCusip":{"maxLength":9,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do ativo. \u00c9 fornecido pelo CUSIP","nullable":true,"example":"quo","exampleSetFlag":true},"dataEmissaoAtivo":{"maxLength":8,"type":"string","description":"Data da emiss\u00e3o do ativo conforme cadastro no SELIC","nullable":true,"example":"voluptas","exampleSetFlag":true},"dataOperacaoCompraAtivo":{"maxLength":8,"type":"string","description":"Data em que foi realizada a compra definitiva do papel pelo fundo","nullable":true,"example":"quam","exampleSetFlag":true},"dataVencimentoLiquidacaoAtivo":{"maxLength":8,"type":"string","description":"Data do vencimento do ativo","nullable":true,"example":"maiores","exampleSetFlag":true},"quantidadeDisponivel":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade dispon\u00edvel para negocia\u00e7\u00e3o na Data Posi\u00e7\u00e3o","format":"double","exampleSetFlag":false},"quantidadeGarantia":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade bloqueada para negocia\u00e7\u00e3o em margem de garantia de opera\u00e7\u00f5es (BVMF) na Data Posi\u00e7\u00e3o","format":"double","exampleSetFlag":false},"depositoGanrantias":{"maxLength":10,"type":"string","description":"Identifica a c\u00e2mara de liquida\u00e7\u00e3o em favor da qual a garantia est\u00e1 depositada","nullable":true,"example":"molestias","exampleSetFlag":true},"puCompra":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor Financeiro pago na aquisi\u00e7\u00e3o do ativo dividido pela quantidade comprada","format":"double","example":813,"exampleSetFlag":true},"puVencimento":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Conforme cadastro no SELIC ou no ambiente de negocia\u00e7\u00e3o","format":"double","example":3934727,"exampleSetFlag":true},"puPosicao":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"\u00c9 o valor que est\u00e1 sendo contabilizado no Fundo\/Carteira na Data Posi\u00e7\u00e3o","format":"double","example":25,"exampleSetFlag":true},"puEmissao":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor presente do PU de Vencimento na data de emiss\u00e3o do papel","format":"double","example":579334163,"exampleSetFlag":true},"principal":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"PU de Compra X Quantidade Total","format":"double","example":91428823782,"exampleSetFlag":true},"tributos":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor total dos tributos provisionados (IR + IOF)","format":"double","example":0,"exampleSetFlag":true},"valorFinanceiroDisponivel":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"PU de Posi\u00e7\u00e3o X Quantidade Dispon\u00edvel","format":"double","exampleSetFlag":false},"valorFinanceiroGarantias":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"PU de Posi\u00e7\u00e3o X Quantidade em Garantia","format":"double","example":748199910260,"exampleSetFlag":true},"cupomTaxaNegociada":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Taxa de compra negociada.","format":"double","example":640634,"exampleSetFlag":true},"indexadorBvmf":{"maxLength":50,"type":"string","description":"C\u00f3digo do indexador conforme cadastro na Tabela da BVMF","nullable":true,"example":"fugiat","exampleSetFlag":true},"percentualIndexador":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Este percentual refere-se ao indexador da opera\u00e7\u00e3o","format":"double","example":40,"exampleSetFlag":true},"caracteristicaDoTitulo":{"maxLength":255,"type":"string","description":"Identificar se o t\u00edtulo poder\u00e1 ser negociado a qualquer momento","nullable":true,"example":"non","exampleSetFlag":true},"percentualProvisaoCredito":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Provis\u00e3o de perda percentual sobre o valor financeiro bruto dispon\u00edvel na Data Posi\u00e7\u00e3o.","format":"double","example":268765334,"exampleSetFlag":true},"compromissoRevenda":{"type":"object","properties":{"dataRetornoOperacao":{"maxLength":8,"type":"string","description":"Data do retorno da opera\u00e7\u00e3o compromissada","nullable":true,"example":"quas","exampleSetFlag":true},"puRetorno":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor corrigido da opera\u00e7\u00e3o compromissada dividido pela Quantidade Dispon\u00edvel","format":"double","example":66,"exampleSetFlag":true},"indexadorBvmf":{"maxLength":50,"type":"string","description":"C\u00f3digo do indexador conforme cadastro na Tabela da BVMF","nullable":true,"example":"quisquam","exampleSetFlag":true},"percentualIndexador":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Este percentual refere-se ao indexador da opera\u00e7\u00e3o compromissada","format":"double","example":90500912,"exampleSetFlag":true},"taxaOperacao":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Taxa da Opera\u00e7\u00e3o Compromissada, ao ano","format":"double","example":78891979419,"exampleSetFlag":true},"classeOperacao":{"maxLength":1,"type":"string","description":"Identificar a classe da opera\u00e7\u00e3o compromissada","nullable":true,"example":"a","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false},"classeOperacao":{"maxLength":1,"type":"string","description":"Identificar a classe da opera\u00e7\u00e3o","nullable":true,"example":"a","exampleSetFlag":true},"identificadorInternoAtivo":{"maxLength":255,"type":"string","description":"C\u00f3digo interno do ativo conforme cadastro no sistema de origem","nullable":true,"example":"debitis","exampleSetFlag":true},"nivelRisco":{"maxLength":2,"description":"N\u00edvel de risco segundo estabelecido na RES CMN 3121 de 25\/09\/2003","nullable":true,"exampleSetFlag":false}},"additionalProperties":false,"exampleSetFlag":false}},"acoes":{"type":"array","description":"A\u00e7\u00f5es que constam no fundo ou na carteira na data","nullable":true,"exampleSetFlag":false,"items":{"type":"object","properties":{"codigoIsinAcoes":{"maxLength":12,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do Ativo","nullable":true,"example":"sequi","exampleSetFlag":true},"codigoAtivoCusip":{"maxLength":9,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do Ativo. \u00c9 fornecido pelo CUSIP","nullable":true,"example":"ratione","exampleSetFlag":true},"codigoAtivo":{"maxLength":50,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do tipo de Ativo","nullable":true,"example":"blanditiis","exampleSetFlag":true},"quantidadeDisponivel":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade dispon\u00edvel para negocia\u00e7\u00e3o na Data Posi\u00e7\u00e3o","format":"double","example":54653303301,"exampleSetFlag":true},"lotePadraoAtivo":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade padr\u00e3o do ativo definido pelo ambiente de negocia\u00e7\u00e3o","format":"double","exampleSetFlag":false},"quantidadeGarantiaBloqueada":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade bloqueada para negocia\u00e7\u00e3o","format":"double","example":9858539932,"exampleSetFlag":true},"valorFinanceiroDisponivel":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"PU de Posi\u00e7\u00e3o X Quantidade Dispon\u00edvel \/ Lote","format":"double","example":528669066179,"exampleSetFlag":true},"valorFinanceiroGarantia":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"PU de Posi\u00e7\u00e3o X Quantidade em Garantia \/ Lote","format":"double","exampleSetFlag":false},"valorTributos":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor total dos tributos provisionados (IR)","format":"double","exampleSetFlag":false},"puPosicao":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"\u00c9 o valor, expresso em lote, que est\u00e1 sendo contabilizado no Fundo\/Carteira na Data Posi\u00e7\u00e3o","format":"double","example":9465,"exampleSetFlag":true},"porcentagemProvisaoCredito":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Provis\u00e3o de perda percentual sobre o valor financeiro bruto dispon\u00edvel","format":"double","exampleSetFlag":false},"tipoContaCorrente":{"maximum":2,"minimum":1,"type":"integer","description":"Identificar se o ativo est\u00e1 atrelado a uma conta investimento","format":"int32","example":1,"exampleSetFlag":true},"classeOperacao":{"maxLength":1,"type":"string","description":"Identificar a classe da opera\u00e7\u00e3o: C \u2013 Comprado| D \u2013 Doado | T \u2013 Tomado | V - Vendido","nullable":true,"example":"a","exampleSetFlag":true},"dataVencimentoAluguel":{"maxLength":8,"type":"string","description":"Data registrada no deposit\u00e1rio como t\u00e9rmino do aluguel do ativo","nullable":true,"example":"cum","exampleSetFlag":true},"taxaAluguel":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Custo, em valor percentual ao ano, a ser pago pelo Tomador e Doador do ativo","format":"double","exampleSetFlag":false},"cnpjIntermediarioAluguel":{"maxLength":14,"type":"string","description":"CNPJ do intermedi\u00e1rio do aluguel na Data Posi\u00e7\u00e3o","nullable":true,"example":"id","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false}},"futuros":{"type":"array","description":"Ativos futuros que constam no fundo ou na carteira na data","nullable":true,"exampleSetFlag":false,"items":{"type":"object","properties":{"codigoIsinPapel":{"maxLength":12,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do Ativo, fornecido pela BVMF","nullable":true,"example":"ipsa","exampleSetFlag":true},"codigoAtivo":{"maxLength":50,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do tipo de Ativo, conforme cadastro no ambiente de negocia\u00e7\u00e3o","nullable":true,"example":"itaque","exampleSetFlag":true},"cnpjCorretora":{"maxLength":14,"type":"string","description":"CNPJ da Corretora onde a posi\u00e7\u00e3o est\u00e1 registrada","nullable":true,"example":"enim","exampleSetFlag":true},"serieContrato":{"maxLength":50,"type":"string","description":"S\u00e9rie do contrato conforme cadastro no ambiente de negocia\u00e7\u00e3o","nullable":true,"example":"vero","exampleSetFlag":true},"quantidadeAtivo":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade na Data Posi\u00e7\u00e3o","format":"double","exampleSetFlag":false},"valorTotalPosicao":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor total atualizado dos contratos na Data Posi\u00e7\u00e3o (Quantidade X PU X Tamanho do Contrato)","format":"double","exampleSetFlag":false},"valorTributos":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor total dos tributos provisionados (IR)","format":"double","example":87810544,"exampleSetFlag":true},"dataVencimentoContrato":{"maxLength":8,"type":"string","description":"Data de vencimento do contrato conforme cadastro no ambiente","nullable":true,"example":"quae","exampleSetFlag":true},"valorAjusteDiario":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor de Ajuste di\u00e1rio total a pagar ou a receber por posi\u00e7\u00e3o","format":"double","exampleSetFlag":false},"classeOperacao":{"maxLength":1,"type":"string","description":"Identificar a classe da opera\u00e7\u00e3o: C \u2013 Comprado | V  \u2013 Vendido","nullable":true,"example":"a","exampleSetFlag":true},"hedge":{"maxLength":1,"type":"string","description":"Identificar se esta posi\u00e7\u00e3o faz parte de uma estrat\u00e9gia de hedge: S - Sim | N - N\u00e3o","nullable":true,"example":"a","exampleSetFlag":true},"tipoHedge":{"maximum":2,"minimum":0,"type":"integer","description":"Identifica o tipo de Hedge da opera\u00e7\u00e3o: \r\n0 \u2013 se a opera\u00e7\u00e3o n\u00e3o for parte integrante de um hedge |\r\n1 \u2013 se a op\u00e7\u00e3o for parte integrante de um hedge de Renda Fixa |\r\n2 \u2013 se a op\u00e7\u00e3o for parte integrante de um hedge de Renda Vari\u00e1vel","format":"int32","example":1,"exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false}},"caixa":{"type":"array","description":"Conta caixa do fundo ou da carteira com o saldo na data","nullable":true,"exampleSetFlag":false,"items":{"type":"object","properties":{"isinInstituicao":{"maxLength":6,"type":"string","description":"C\u00f3digo ISIN reduzido (6 caracteres) dentificando o pa\u00eds (Ex: BR \u2013 Brasil) e a Institui\u00e7\u00e3o deposit\u00e1ria dos valores","nullable":true,"example":"rerum","exampleSetFlag":true},"tipoConta":{"maxLength":1,"type":"string","description":"Identifica o tipo de conta: D \u2013 Dep\u00f3sito | P \u2013 Poupan\u00e7a | N \u2013 Numer\u00e1rio | I \u2013 Investimento | J \u2013 Judicial","nullable":true,"example":"a","exampleSetFlag":true},"saldo":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Valor do saldo na Data Posi\u00e7\u00e3o","format":"double","example":6689,"exampleSetFlag":true},"nivelRisco":{"maxLength":2,"type":"string","description":"N\u00edvel de risco segundo estabelecido na RES CMN 3121 de 25\/09\/2003","nullable":true,"example":"ex","exampleSetFlag":true}},"additionalProperties":false,"exampleSetFlag":false}},"cotas":{"type":"object","properties":{"isinFundo":{"maxLength":12,"type":"string","description":"C\u00f3digo para identifica\u00e7\u00e3o do fundo objeto do investimento","nullable":true,"example":"eos","exampleSetFlag":true},"cnpjFundo":{"maxLength":14,"type":"string","description":"CNPJ do fundo objeto do investimento","nullable":true,"example":"eum","exampleSetFlag":true},"quantidadeDisponivel":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade dispon\u00edvel em estoque na Data Posi\u00e7\u00e3o","format":"double","exampleSetFlag":false},"quantidadeGarantiaBloqueada":{"maximum":1000000000000,"minimum":0,"pattern":"(\\d{1,12})(\\,\\d{1,12})?$","type":"number","description":"Quantidade bloqueada 

# --- truncated at 32 KB (235 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/b3-exchange/refs/heads/main/openapi/b3-exchange-banco-b3-custody-openapi.json