Enviar Solicitações
Este endpoint permite o envio externo, via API, de um lote de informações de PL/Cota para processamento.
- Método:
POST - Caminho:
/api/v1/pl-cota/envio
Headers da Requisição
| Header | Valor | Obrigatório | Descrição |
|---|---|---|---|
| Authorization | Bearer <token> | Sim | Token de autenticação JWT |
| Content-Type | application/json | Sim | Formato do payload |
| X-Correlation-ID | <uuid> | Não | ID para rastreabilidade |
Regras de Acesso
Para envio via API, o usuário precisa atender às regras abaixo:
| Regra | Valor esperado |
|---|---|
| Perfil | supervisor ou operator |
| Papel | Administrador, Gestor ou Controladoria |
| Serviço | PLCOTA |
| Funcionalidade | PL_COTA_ENVIO |
Usuário sysadmin não realiza envio de PL/Cota. O acesso de sysadmin é restrito à consulta e download de recibos.
Corpo da Requisição
O corpo da requisição deve conter o campo informacoes, com uma lista de 1 até 3.000 informações.
{
"informacoes": [
{
"identificacao": {
"tipoIdentificador": "1",
"idRegistro": "CODIGO123",
"cnpjAdministrador": "11222333000199",
"cnpjProvedor": "11222333000199",
"tipoInforme": "1",
"moeda": "BRL",
"dataInformacao": "2026-04-17",
"reenvio": "N"
},
"informeSimples": {
"valorCota": "1000000,123456789",
"valorPatrimLiq": "1000000,12345"
}
}
]
}
Exemplo cURL
curl -X POST "https://<host>/api/v1/pl-cota/envio" \
-H "Authorization: Bearer <seu_token>" \
-H "Content-Type: application/json" \
-d '{
"informacoes": [
{
"identificacao": {
"tipoIdentificador": "1",
"idRegistro": "CODIGO123",
"cnpjAdministrador": "11222333000199",
"cnpjProvedor": "11222333000199",
"tipoInforme": "1",
"moeda": "BRL",
"dataInformacao": "2026-04-17",
"reenvio": "N"
},
"informeSimples": {
"valorCota": "1000000,123456789",
"valorPatrimLiq": "1000000,12345"
}
}
]
}'
Blocos do Payload
identificacao
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| tipoIdentificador | String | Sim | Identificador da classe ou subclasse. Domínio: 1=Código STI, 2=Código ANBIMA, 3=CNPJ, 4=Identificador CVM da Subclasse |
| idRegistro | String | Sim | Código de identificação da classe ou subclasse |
| cnpjAdministrador | String | Sim | CNPJ do administrador |
| cnpjProvedor | String | Sim | CNPJ do provedor/controlador de ativos |
| tipoInforme | String | Sim | Domínio: 1=PL/Cota, 2=Informe Diário, 3=Integração CVM, 4=Cota Bruta |
| moeda | String | Sim | Código da moeda, exemplo: BRL |
| dataInformacao | String | Sim | Data base no formato AAAA-MM-DD |
| reenvio | String | Sim | Domínio: S ou N |
| observacoes | String | Condicional | Obrigatório em cenários de reenvio com diferença. Mínimo 10 e máximo 500 caracteres |
informeSimples
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| valorCota | String | Condicional | Valor da cota líquida |
| valorPatrimLiq | String | Condicional | Valor do patrimônio líquido |
| valorCotaBruta | String | Condicional | Valor da cota bruta |
| valorCotaPreEvento | String | Condicional | Valor da cota antes do evento |
| rentabilidadeCota | String | Condicional | Variação da cota |
informeCompleto
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| valorTotalAplic | String | Condicional | Valor total das aplicações |
| valorTotalResg | String | Condicional | Valor total dos resgates |
| valorTotalComeCotas | String | Condicional | Valor total do come-cotas |
| numeroCotistas | String | Condicional | Número total de cotistas |
informeCvm
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dataProxInfoPl | String | Condicional | Data do próximo informe CVM no formato AAAA-MM-DD |
| valorTotalCartFundo | String | Condicional | Valor total dos ativos da carteira do fundo |
| valorTotalAtivos | String | Condicional | Valor total dos ativos |
| valorTotalSaidas | String | Condicional | Valor total das saídas de caixa |
| cotistasSignificativos | Array | Condicional | Lista de até 5 cotistas significativos |
Formato dos Valores
| Tipo de campo | Formato |
|---|---|
| Datas da API | AAAA-MM-DD |
| Valores monetários/decimais | String com vírgula como separador decimal. Exemplo: 1000000,12345 |
| CPF/CNPJ | Somente números |
Campos decimais com ponto (.) são rejeitados com erro de separador decimal inválido.
Respostas
Sucesso - 201 Created
Em caso de recebimento com sucesso, o lote é gravado para processamento assíncrono e a API retorna o recibo da solicitação.
{
"recibo": "FSH5AUI2DNS7AJJ",
"idRequest": "b4b8f3fd-86c2-49b0-a8a5-0f5b4a6cb700",
"instituicao": "11222333000199",
"usuario": "usuario@empresa.com.br",
"dataHoraEnvio": "20260417T143000",
"statusProc": "1",
"totalInformacoes": 1,
"msgErro": []
}
Leiaute Inválido - 400 Bad Request
Quando a validação síncrona identifica erro de leiaute, a API retorna status 400 com o recibo gerado para consulta posterior.
{
"recibo": "HON9D49BLMVNRX4",
"idRequest": "b4b8f3fd-86c2-49b0-a8a5-0f5b4a6cb700",
"instituicao": "11222333000199",
"usuario": "usuario@empresa.com.br",
"dataHoraEnvio": "20260417T143000",
"dataHoraProc": "20260417T143001",
"statusProc": "5",
"totalInformacoes": 1,
"msgErro": [
{
"erro": "Separador de decimais inválido"
}
]
}
Sem Autenticação - 401 Unauthorized
Retornado quando o token não é enviado ou é inválido.
Sem Permissão - 403 Forbidden
Retornado quando o token é válido, mas não atende às regras de perfil, papel, serviço ou funcionalidade do PL/Cota.