Segregação de taxas - v1.0.0

Cadastro de segregação de taxas

POST <hub-anbima>:/v1/segregacao-taxas/solicitacoes

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de Segregação de taxas.

Método utilizado para criar uma solicitação de segregação de taxas. Por se tratar de uma solicitação, ela passará por uma série de validações e processos assíncronos.

Se as validações básicas passarem com sucesso (processos síncronos), a solicitação é aceita para processamento(segue de forma assíncrona).

Limites de Taxa (Rate Limit)

Para garantir a estabilidade e o uso justo de nossas APIs para todos os desenvolvedores, aplicamos limites na quantidade de requisições que podem ser feitas em determinados intervalos de tempo. O desrespeito a esses limites resultará em respostas de erro.

Nossos Limites Existem dois níveis de controle de taxa em vigor: um limite geral para cada endpoint e um limite específico por clienteID para as APIs externas.

Tipo de Limite	Requisições por segundo	Endpoints Afetados
Limite Geral por Endpoint	200	Todos os endpoints do nosso serviço de borda.
Limite por Cliente	10	Cadastro de Segregação de taxas.

Header

Authorization: Bearer {access_token}

Body

Limite máximo de 10MB

{
  "cnpjGestor": "string",
  "cnpjFundo": "string",
  "nomeComercialFundo": "string",
  "cnpjAdministrador": "string",
  "cnpjClasse": "string",
  "nomeComercialClasse": "string",
  "taxaNaSubClasse": "string",
  "codigoCvmSubClasse": "string",
  "nomeComercialSubClasse": "string",
  "taxaGlobal": {
    "cobraTaxaGlobal": "string",
    "taxaComposicaoGlobal": [
      "string"
    ],
    "estruturacaoPrevidenciaCompoeTaxaGlobal": "string",
    "perfilTaxaGlobal": "string",
    "unidadeTaxaGlobal": "string",
    "valorTaxaGlobal": number,
    "valorPisoTaxaGlobal": number,
    "valorFixoTaxaGlobal": number,
    "informacoesAdicionaisTaxaGlobal": "string",
    "taxasEscalonadas": [
      {
        "inicial": number,
        "final": number,
        "unidadeTaxa": "string",
        "taxa": number,
        "faixaEfetiva": boolean
      }
    ]
  },
  "taxaPerformance": {
    "cobraTaxaPerformance": "string",
    "perfilTaxaPerformance": "string",
    "periodicidadeTaxaPerformance":boolean,
    "informacoesAdicionaisTaxaPerformance": "string",
    "indicesTaxaPerformance": [
      {
        "inicial": number,
        "final": number,
        "percentual": number,
        "percentualIndiceReferencia": number,
        "indice": "string",
        "taxaFixa": number,
      }
    ]
  },
  "taxaAdministracao": {
    "cobraTaxaAdministracao": "string",
    "perfilTaxaAdministracao": "string",
    "unidadeTaxaAdministracao": "string",
    "valorTaxaAdministracao": number,
    "valorPisoTaxaAdministracao": number,
    "valorFixoTaxaAdministracao": number,
    "informacoesAdicionaisTaxaAdministracao": "string",
    "descricaoFaixaRemuneracaoAdministracao": "string",
    "taxasEscalonadas": [
      {
        "inicial": number,
        "final": number,
        "unidadeTaxa": "string",
        "taxa": number,
        "faixaEfetiva": boolean
      }
    ]
  },
  "taxaEstruturacaoPrevidencia": {
    "cobraTaxaEstruturacaoPrevidencia": "string",
    "perfilTaxaEstruturacaoPrevidencia": "string",
    "unidadeTaxaEstruturacaoPrevidencia": "string",
    "valorTaxaEstruturacaoPrevidencia": number,
    "valorPisoTaxaEstruturacaoPrevidencia": number,
    "valorFixoTaxaEstruturacaoPrevidencia": number,
    "informacoesAdicionaisTaxaEstruturacaoPrevidencia": "string",
    "descricaoFaixaRemuneracaoEstruturacaoPrevidencia": "string",    
    "estruturadorRecebeParcelaTaxaPerformance": "string",
    "parcelaTaxaPerformanceEstruturador": number,
    "parcelaTaxaPerformanceGestor": number,
    "taxasEscalonadas": [
      {
        "inicial": number,
        "final": number,
        "unidadeTaxa": "string",
        "taxa": number,
        "faixaEfetiva": boolean
      }
    ],
    "listaEstruturadores": [
      {
        "cnpjEstruturador": "string",
        "nomeEstruturador": "string"
      }
    ]
  },
  "acordosComerciais": [
    {
      "nomeAcordoComercial": "string",
      "cobraTaxaGestao": "string",
      "perfilTaxaGestao": "string",
      "unidadeTaxaGestao": "string",
      "valorTaxaGestao": number,
      "valorPisoTaxaGestao": number,
      "valorFixoTaxaGestao": number,
      "informacoesAdicionaisTaxaGestao": "string",
      "descricaoFaixaRemuneracaoGestao": "string",
      "taxaEscalonadaGestao": [
        {
          "inicial": number,
          "final": number,
          "unidadeTaxa": "string",
          "taxa": number,
          "faixaEfetiva": boolean
        }
      ],
      "cobraTaxaCoGestao": "string",
      "perfilTaxaCoGestao": "string",
      "unidadeTaxaCoGestao": "string",
      "valorTaxaCoGestao": number,
      "valorPisoTaxaCoGestao": number,
      "valorFixoTaxaCoGestao": number,
      "informacoesAdicionaisTaxaCoGestao": "string",
      "descricaoFaixaRemuneracaoCoGestao": "string"
      "taxaEscalonadaCoGestao": [
        {
          "inicial": number,
          "final": number,
          "unidadeTaxa": "string",
          "taxa": number,
          "faixaEfetiva": boolean
        }
      ],
      "listaCoGestor": [
        {
          "cnpjCoGestor": "string",
          "nomeCoGestor": "string"
        }
      ],
      "cobraTaxaDistribuicao": "string",
      "perfilTaxaDistribuicao": "string",
      "unidadeTaxaDistribuicao": "string",
      "valorTaxaDistribuicao": number,
      "valorPisoTaxaDistribuicao": number,
      "valorFixoTaxaDistribuicao": number,
      "outrasReceitasEssenciaisTaxaDistribuicao": "string",      
      "informacoesAdicionaisRemuneracaoTaxaDistribuicao": "string",
      "descricaoFaixaRemuneracaoDistribuicao": "string",
      "taxaEscalonadaDistribuicao": [
        {
          "inicial": number,
          "final": number,
          "unidadeTaxa": "string",
          "taxa": number,
          "faixaEfetiva": boolean
        }
      ],
      "listaDistribuidoresDistribuicao": [
        {
          "cnpjDistribuidor": "string",
          "nomeDistribuidor": "string"
        }
      ],
      "distribuidorRecebeParcelaTaxaPerformance": "string",
      "valorParcelaTaxaPerformanceDistribuidor": number,
      "valorParcelaTaxaPerformanceGestor": number,
      "valorRemuneracaoTaxaPerformanceDistribuidor": number,
      "valorRemuneracaoTaxaPerformanceGestor": number,
    }
  ],
}

Exemplos de preenchimento

• COBRA-TAXA-NAO.json
• TODOS-OS-CAMPOS-PREENCHIDOS.json
• PERFIL-TAXA-ESCALONADA-PL-FUNDO.json
• PERFIL-TAXA-ESCALONADA-OUTROS.json
• PERFIL-TAXA-FIXA.json
• UNIDADE-TAXA-PORCENTAGEM-ACRESCIDO.json
• UNIDADE-TAXA-OUTROS.json

Sucesso

Status code - 201 (Created)

{
  "numeroSolicitacao": "string",
  "mensagem": "string",
  "status": "string",
  "dataSubmissao": date(YYYY-MM-DD)
}

Falhas

Status code 400 - Bad Request

{
  "statusCode": number,
  "message": [
    "string",
  ],
  "error": "string"
}

Status code 401 - Unauthorized

{
  "statusCode": number,
  "message": "string",
  "error": "string"
 }

Status code 403 - Not found

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 429 - Too Many Requests

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 500 - Internal Server Error

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Acompanhamento de uma segregação de taxas

GET <hub-anbima>:/v1/segregacao-taxas/solicitacoes/{numeroSolicitacao}/status

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de Segregação de taxas.

Header

Authorization: Bearer {access_token}

Parâmetros

numeroSolicitacao: string

Response

Status Code Ok - 200

{
  "numeroSolicitacao": "string",
  "numeroLote": "string",
  "status": "string",
  "dataAtualizacao": date(YYYY-MM-DD),
  "inconsistencias": [
    {
      "contexto": "string",
      "campo": "string",
      "mensagem": [
          "string"
      ]
    }
  ]
}

Falhas

Status code 204 - No Content

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 400 - BadRequest

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 401 - Unauthorized

{
  "statusCode": number,
  "message": "string",
  "error": "string"
 }

Status code 403 - Forbidden

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 500 - Internal Server Error

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Lista de Segregações de taxas

GET <hub-anbima>:/v1/segregacao-taxas/solicitacoes?numeroSolicitacao={numeroSolicitacao}&page={page}&limit={limit}&dataInicioAtualizacao={dataInicioAtualizacao}&dataFimAtualizacao={dataFimAtualizacao}&numeroSolicitacao={numeroSolicitacao}&numeroLote={numeroLote}&cnpjClasse={cnpjClasse}&codigoCvmSubClasse={codigoCvmSubClasse}&cnpjGestor={cnpjGestor}&cnpjAdministrador={cnpjAdministrador}&statusSolicitacao={statusSolicitacao}

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de Segregação de taxas.

Endpoint utilizado para recuperar todas as segregações de taxas.

Header

Authorization: Bearer {access_token}

Pagination Query

numeroSolicitacao: string

page: number

limit: number

dataInicioAtualizacao: date(YYYY-MM-DD)

dataFimAtualizacao: date(YYYY-MM-DD)

numeroLote: string

cnpjClasse: string

codigoCvmSubClasse: string

cnpjGestor: string

cnpjAdministrador: string

statusSolicitacao: string

Response

Status Ok - 200

{
  "data": [
    {
      "nomeAdministrador": "string",
      "cnpjAdministrador": "string",
      "cnpjClasse": "string",
      "cnpjFundo": "string",
      "cnpjGestor": "string",
      "codigoCvmSubClasse": "string",
      "dataAtualizacao": date(YYYY-MM-DD),
      "nomeComercialFundo": "string",
      "nomeComercialClasse": "string",
      "nomeComercialSubClasse": "string",
      "nomeGestor": "string",
      "numeroSolicitacao": "string",
      "numeroLote": "string",
      "status": "string",
      "taxaNaSubClasse": "string",
      "origemCadastro": "string"
    }
  ],
  "pagination": {
    "page": number,
    "limit": number,
    "totalRecords": number,
    "totalPages": number,
    "hasNext": boolean,
    "hasPrevious": boolean
  }
}

Falhas

Status code 400 - BadRequest

{
  "statusCode": number,
  "message": [
    "string"
  ],
  "error": "string"
}

Status code 401 - Unauthorized

{
  "statusCode": number,
  "message": "string",
  "error": "string"
 }

Status code 403 - Forbidden

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 500 - Internal Server Error

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Consulta de uma segregação de taxas

GET <hub-anbima>:/v1/segregacao-taxas/solicitacoes/{numeroSolicitacao}

Tipo de rota: Síncrona

Para acessar os tipos e formatos dos campos, consultar a lista de campos de Segregação de taxas.

Header

Authorization: Bearer {access_token}

Parâmetros

numeroSolicitacao: string

Response

Status Code Ok - 200

{
  "cnpjFundo": "string",
  "nomeComercialFundo": "string",
  "cnpjAdministrador": "string",
  "cnpjGestor": "string",
  "cnpjClasse": "string",
  "nomeComercialClasse": "string",
  "taxaNaSubClasse": "string",
  "nomeComercialSubClasse": "string",
  "codigoCvmSubClasse": "string",
  "taxaGlobal": {
    "cobraTaxaGlobal": "string",
    "taxaComposicaoGlobal": [
      "string"
    ],
    "perfilTaxaGlobal": "string",
    "unidadeTaxaGlobal": "string",
    "valorTaxaGlobal": number,
    "valorPisoTaxaGlobal": number,
    "valorFixoTaxaGlobal": number,
    "informacoesAdicionaisTaxaGlobal": "string",
    "estruturacaoPrevidenciaCompoeTaxaGlobal": "string",
    "taxasEscalonadas": [
      {
        "inicial": number,
        "final": number,
        "unidadeTaxa": "string",
        "taxa": number,
        "faixaEfetiva": boolean
      }
    ]
  },
  "taxaPerformance": {
    "cobraTaxaPerformance": "string",
    "perfilTaxaPerformance": "string",
    "periodicidadeTaxaPerformance":boolean,
    "informacoesAdicionaisTaxaPerformance": "string",
    "indicesTaxaPerformance": [
      {
        "inicial": number,
        "final": number,
        "string": number,
        "percentualIndiceReferencia": number,
        "indice": "string",
        "taxaFixa": number,
        "faixaEfetiva": boolean
      }
    ]
  },
  "acordosComerciais": [
    {
      "nomeAcordoComercial": "string",
      "cobraTaxaGestao": "string",
      "perfilTaxaGestao": "string",
      "unidadeTaxaGestao": "string",
      "valorTaxaGestao": number,
      "valorPisoTaxaGestao": number,
      "valorFixoTaxaGestao": number,
      "descricaoFaixaRemuneracaoGestao": "string",
      "informacoesAdicionaisTaxaGestao": "string",
      "taxaEscalonadaGestao": [
        {
          "inicial": number,
          "final": number,
          "unidadeTaxa": "string",
          "taxa": number,
          "faixaEfetiva": boolean
        }
      ],
      "cobraTaxaDistribuicao": "string",
      "perfilTaxaDistribuicao": "string",
      "unidadeTaxaDistribuicao": "string",
      "valorTaxaDistribuicao": number,
      "valorPisoTaxaDistribuicao": number,
      "valorFixoTaxaDistribuicao": number,
      "taxaEscalonadaDistribuicao": [
        {
          "inicial": number,
          "final": number,
          "unidadeTaxa": "string",
          "taxa": number,
          "faixaEfetiva": boolean
        }
      ],
      "descricaoFaixaRemuneracaoDistribuicao": "string",
      "listaDistribuidoresDistribuicao": [
        {
          "cnpjDistribuidor": "string",
          "nomeDistribuidor": "string"
        }
      ],
      "informacoesAdicionaisRemuneracaoTaxaDistribuicao": "string",
      "outrasReceitasEssenciaisTaxaDistribuicao": "string",
      "distribuidorRecebeParcelaTaxaPerformance": "string",
      "valorParcelaTaxaPerformanceDistribuidor": number,
      "valorParcelaTaxaPerformanceGestor": number,
      "valorRemuneracaoTaxaPerformanceDistribuidor": number,
      "valorRemuneracaoTaxaPerformanceGestor": number,
      "cobraTaxaCoGestao": "string",
      "perfilTaxaCoGestao": "string",
      "unidadeTaxaCoGestao": "string",
      "valorTaxaCoGestao": number,
      "valorPisoTaxaCoGestao": number,
      "valorFixoTaxaCoGestao": number,
      "informacoesAdicionaisTaxaCoGestao": "string",
      "taxaEscalonadaCoGestao": [
        {
          "inicial": number,
          "final": number,
          "unidadeTaxa": "string",
          "taxa": number,
          "faixaEfetiva": boolean
        }
      ],
      "listaCoGestor": [
        {
          "cnpjCoGestor": "string",
          "nomeCoGestor": "string"
        }
      ],
      "descricaoFaixaRemuneracaoCoGestao": "string"
    }
  ],
  "taxaAdministracao": {
    "cobraTaxaAdministracao": "string",
    "perfilTaxaAdministracao": "string",
    "unidadeTaxaAdministracao": "string",
    "valorTaxaAdministracao": number,
    "valorPisoTaxaAdministracao": number,
    "valorFixoTaxaAdministracao": number,
    "informacoesAdicionaisTaxaAdministracao": "string",
    "descricaoFaixaRemuneracaoAdministracao": "string",
    "taxasEscalonadas": [
      {
        "inicial": number,
        "final": number,
        "unidadeTaxa": "string",
        "taxa": number,
        "faixaEfetiva": boolean
      }
    ]
  },
  "taxaEstruturacaoPrevidencia": {
    "cobraTaxaEstruturacaoPrevidencia": "string",
    "perfilTaxaEstruturacaoPrevidencia": "string",
    "unidadeTaxaEstruturacaoPrevidencia": "string",
    "valorTaxaEstruturacaoPrevidencia": number,
    "valorPisoTaxaEstruturacaoPrevidencia": number,
    "valorFixoTaxaEstruturacaoPrevidencia": number,
    "informacoesAdicionaisTaxaEstruturacaoPrevidencia": "string",
    "estruturadorRecebeParcelaTaxaPerformance": "string",
    "unidadeParcelaTaxaPerformanceEstruturador": "string",
    "parcelaTaxaPerformanceEstruturador": number,
    "unidadeParcelaTaxaPerformanceGestor": "string",
    "parcelaTaxaPerformanceGestor": number,
    "listaEstruturadores": [
      {
        "cnpjEstruturador": "string",
        "nomeEstruturador": "string"
      }
    ],
    "descricaoFaixaRemuneracaoEstruturacaoPrevidencia": "string",
    "taxasEscalonadas": [
      {
        "inicial": number,
        "final": number,
        "unidadeTaxa": "string",
        "taxa": number,
        "faixaEfetiva": boolean
      }
    ]
  }
}

Falhas

Status code 204 - No Content

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 400 - BadRequest

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 401 - Unauthorized

{
  "statusCode": number,
  "message": "string",
  "error": "string"
 }

Status code 403 - Forbidden

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}

Status code 500 - Internal Server Error

{
  "statusCode": number,
  "message": "string",
  "error": "string"
}