/integracao/iniciativas
Criar ou atualizar iniciativa
Idempotente em id_iniciativa_estadual. O CNPSA gera o código nacional CNPSA-AAAA-XXXXX.
CNPSA / Catálogo / Integração dos Estados
Este manual estabelece o padrão oficial de conexão de qualquer Unidade da Federação ao CNPSA. O cadastro nacional publica o formato; o Estado traduz a base que já opera e envia nesse layout. O programa estadual entra no inventário nacional sem ser redigitado no portal federal, e o provedor é avisado no Gov.br. O padrão é o mesmo para todos os Estados.
Este é o manual de integração do CNPSA. Não é o passo a passo de quem cadastra contrato na tela do site, e não é um acordo de cooperação.
A Lei nº 14.119, de 13 de janeiro de 2021, instituiu a Política Nacional de Pagamento por Serviços Ambientais e o CNPSA. Vários Estados já têm programa próprio, com centenas a milhares de contratos. Copiar cada contrato de novo no portal federal duplica esforço público e atrasa o inventário nacional — e, com ele, o acesso do provedor à isenção federal (art. 17).
Quem dita o formato é o CNPSA. Campos, listas e regras são nacionais. O Estado traduz a base que já tem para esse layout. Se a informação chegar nesse formato, entra. Se não chegar, não entra. Não se monta um formato novo a cada UF, nem se combina vocabulário na hora do envio.
A responsabilidade pelos dados, pela seleção dos provedores e pela atestação do serviço permanece no órgão estadual. O cadastro nacional não fiscaliza contrato por contrato.
O que viaja na conexão, nesta ordem:
Dois modos de envio, no mesmo formato nacional:
Estado sem sistema próprio não fica de fora: usa a remessa periódica e pode nascer já ligado ao formato nacional, em vez de criar uma base paralela para traduzir depois.
O que o Estado obtém, sem montar portal extra para o cidadão:
Este manual não ensina o cadastro na tela do CNPSA.
Também não cobre:
O cadastro nacional publica o formato. O Estado se encaixa nele.
Antes de qualquer envio, o cadastro nacional disponibiliza um layout único — o mesmo para envio contínuo e para remessa, o mesmo para todos os Estados. Esse layout está nos Anexos A a F deste manual: campos, obrigatoriedade, máscaras e listas oficiais, como o cadastro nacional já pede hoje.
O layout cobre:
Não basta o PDF. Sem os campos dos anexos — em especial o e-mail do provedor — o aviso ao cidadão e a isenção não andam. O Estado gera o pacote a partir da base que já opera, traduzido para esse layout. Não redigita no portal federal e não combina um formato novo na hora de conectar.
A homologação existe por um motivo simples: erro na tradução se multiplica.
O Estado não preenche o CNPSA na mão. Ele converte a base que já tem para o layout deste manual. Nessa conversão sempre aparece algum desvio — nome de serviço diferente da lista oficial, CPF incompleto, e-mail vazio, município que não bate, arquivo com nome diferente da planilha. Se o primeiro envio já for o acervo inteiro, o cadastro nacional ou recusa mil linhas de uma vez, ou grava dado errado e avisa mil provedores com informação torta. Os dois casos são piores do que testar pouco.
Por isso o lote de teste não define o formato (o formato já está nos anexos). Ele só mostra se a tradução está certa, antes de subir o acervo e antes de avisar qualquer cidadão.
Se a homologação falhar, o acervo não sobe. O formato permanece o publicado nos anexos.
Sempre que o programa andar, viaja só o que mudou, ainda no formato nacional:
O Estado não reenvia o acervo inteiro a cada vez. O identificador estadual é a âncora.
O MMA e o Estado marcam estes pontos, qualquer que seja a UF:
O mesmo roteiro se aplica a cada ente que aderir.
Estados que já têm sistema ligam o envio contínuo. Estados que ainda organizam a base em planilha ou banco legado usam a remessa no mesmo layout — e ficam prontos para um sistema futuro já alinhado ao cadastro nacional.
Este manual é o padrão. A adesão de cada Estado percorre os itens acima. O detalhe do que enviar está nos anexos.
O mesmo contrato técnico da especificação Swagger. O ambiente de teste ainda não está no ar: o endereço abaixo é o formato, não um servidor que já responda.
Homologação
Host a informar pela CGTI no credenciamento do órgão.
https://{host}/api/v1Autenticação
Token do órgão (OAuth 2.0, client credentials) e o CNPJ no cabeçalho X-Orgao-Integrador.
/integracao/iniciativas
Criar ou atualizar iniciativa
Idempotente em id_iniciativa_estadual. O CNPSA gera o código nacional CNPSA-AAAA-XXXXX.
/integracao/iniciativas/{id_iniciativa_estadual}
Consultar iniciativa pelo código estadual
/integracao/contratos
Criar ou atualizar um contrato
Idempotente em id_contrato_estadual. A iniciativa precisa já existir.
/integracao/contratos/lote
Enviar lote de contratos de um programa
Até 1.000 contratos por requisição, todos da mesma iniciativa. Processamento assíncrono. Se houver pendência de formato, o lote não grava os contratos. Consulte o resultado em GET /contratos/lote/{id_lote}.
/integracao/contratos/lote/{id_lote}
Resultado do processamento do lote
/integracao/pagamentos
Registrar pagamentos (um ou vários)
Cada item se liga a um id_contrato_estadual já enviado. Idempotente em id_pagamento_estadual.
/integracao/contratos/{id_contrato_estadual}/status-verificacao
Situação da conferência do provedor
Estes anexos são o layout que o CNPSA dita. Reproduzem o que o cadastro nacional já pede hoje no protótipo vigente: as mesmas colunas, listas e máscaras. O Estado traduz a base dele para este texto; não cria coluna nova nem lista paralela.
Arquivo tabular: CSV, codificação UTF-8, separador ponto e vírgula (;). Não enviar XLS ou XLSX. A primeira linha é o nome das colunas e não se altera. Uma linha = um registro. Datas em dd/mm/aaaa. Valores em reais no formato brasileiro (12000,00). Onde a célula admite várias opções, separe com | (sem espaço nas bordas). Não misture contrato individual, acordo coletivo e termo de adesão na mesma planilha.
Cada remessa de contratos é de um programa. O identificador que o Estado já usa viaja junto; se o mesmo código chegar de novo, o cadastro nacional atualiza, não duplica.
O órgão entra pelo CNPJ. Razão social, endereço e natureza jurídica vêm da base nacional de empresas; o Estado não os inventa.
| Campo | Obrigatório | Como enviar |
|---|---|---|
| CNPJ do órgão | Sim | 14 dígitos, com ou sem máscara |
| Identificador do órgão no Estado | Sim | Código que o Estado já usa para esse CNPJ (chave para atualizar sem duplicar) |
| E-mails de notificação | Sim | Um ou mais e-mails institucionais que recebem erro de processamento |
| Nome, CPF, cargo e e-mail do gestor indicado | Sim | Pessoa de contato do órgão no acordo de cooperação |
Sem vínculo de representante legal ou procuração digital no Gov.br, o órgão não se habilita na conexão. Coletividade sem CNPJ não entra.
O cadastro nacional gera o identificador visível CNPSA-AAAA-XXXXX. O Estado envia o código dele; não inventa o código nacional.
| Campo | Obrigatório | Como enviar |
|---|---|---|
| Identificador do programa no Estado | Sim | Chave do sistema ou da planilha estadual |
| Nome da iniciativa | Sim | Texto |
| Previsão de início | Sim | Ano (AAAA). Pode ser retroativo |
| Previsão de encerramento | Sim | Ano (AAAA), ou Data indeterminada, ou Não sei informar. Se for ano, não pode ser anterior ao início |
| UFs abrangidas | Sim | Siglas IBGE (duas letras). Pode ser mais de uma |
| Municípios | Sim | Nome do município + UF, no formato Município — UF |
| Biomas | Sim | Só as opções do Anexo F |
| Serviços ecossistêmicos | Sim | Lista oficial. Várias opções, separadas por |. Se Outros, descrever |
| Serviços ambientais | Sim | Lista oficial. Se incluir práticas sustentáveis, informar quais (Anexo F) |
| Tipos de provedor | Sim | Lista oficial. Outros exige texto. Em sociobiodiversidade, comunidade tradicional, povo indígena ou quilombo, informar o nome |
| Fontes de financiamento | Sim | Lista oficial |
| Formas de pagamento | Sim | Lista oficial. Outro exige texto |
| Periodicidade de pagamento | Sim | Uma opção da lista oficial. Outra exige texto |
| Orçamento anual exclusivo de PSA | Sim | Valor em reais |
| Orçamento total da iniciativa | Não | Valor em reais de todo o período |
| Parceiros | Não | Lista oficial. Outro exige texto |
| Memória de cálculo (texto) | Sim | Como o valor do serviço foi calculado |
| Arquivo da memória de cálculo | Sim | Nome do arquivo (PDF, DOC, DOCX, ODT, XLS ou XLSX) |
Não enviar pergunta de isenção fiscal nem legislação associada no programa. Isenção é do provedor, depois, no contrato.
Planilha modelo: modelo-cnpsa-contrato-individual.csv. Uma linha = um contrato. O arquivo do instrumento (PDF, JPG ou PNG, até 10 MB) tem o mesmo nome da última coluna.
| Coluna | Obrigatório | Regra |
|---|---|---|
| Tipo do contratado (PF ou PJ) | Sim | PF ou PJ |
| Nome do contratado | Sim | Texto |
| CPF ou CNPJ do contratado | Sim | CPF com 11 dígitos ou CNPJ com 14, com ou sem máscara |
| Sim | E-mail válido. É por ele que o provedor é avisado | |
| Telefone | Não | 10 ou 11 dígitos com DDD |
| Função da parte | Sim | Lista oficial. Se Outros, preencher a coluna seguinte |
| Outra função da parte | Condicional | Obrigatório se a função for Outros |
| CPF do representante avisado | Condicional | Obrigatório se PJ. 11 dígitos |
| Nome do representante avisado | Condicional | Obrigatório se PJ |
| Possui monitoramento (Sim ou Não) | Sim | Sim ou Não |
| Cláusula de rompimento (Sim, Não ou Não sei informar) | Sim | Uma dessas três |
| Razões da cláusula de rompimento | Não | Texto, se a cláusula for Sim |
| Tipo de local do serviço | Sim | Lista oficial |
| Número do CAR | Condicional | Obrigatório se o local for Terra privada |
| Município | Sim | Nome |
| UF | Sim | Duas letras |
| Data de assinatura (dd/mm/aaaa) | Sim | Máscara dd/mm/aaaa |
| Tempo de vigência | Sim | Lista oficial (Menos de 1 ano, 1 ano … 15 anos, Mais de 15 anos) |
| Serviços ambientais (separe com |) | Sim | Só a lista oficial |
| Serviços ecossistêmicos (separe com |) | Sim | Só a lista oficial |
| Valor global | Sim | Reais |
| Valor anual previsto | Não | Reais, se informado |
| Formas de pagamento (separe com |) | Sim | Só a lista oficial |
| Detalhe da forma de pagamento | Condicional | Obrigatório se a forma incluir Outro |
| Tipo de recebimento | Condicional | Se houver pagamento direto monetário: PIX, Conta corrente ou Conta poupança |
| Banco | Condicional | Lista oficial, se houver pagamento direto monetário |
| Tipo da chave PIX | Condicional | Se o recebimento for PIX |
| Chave PIX | Condicional | Máscara conforme o tipo da chave |
| Agência | Condicional | Se conta corrente ou poupança |
| Conta | Condicional | Se conta corrente ou poupança |
| Periodicidade do pagamento | Sim | Lista oficial |
| Nome do arquivo do contrato de PSA | Não* | Nome exato do PDF/foto anexado. Sem arquivo, a ficha fica sem documento |
*O envio do arquivo é opcional só se ainda não houver o instrumento. Sem e-mail do contratado o aviso ao provedor não anda.
Serviço ambiental, serviço ecossistêmico, forma e periodicidade de pagamento podem vir iguais aos do programa; o Estado pode alterar no contrato. Não copiar do programa: contratado, valor, município, CAR, monitoramento nem o arquivo.
O cadastro nacional já publica um modelo CSV para cada instrumento. O preenchimento um a um desses dois tipos permanece fechado; o lote usa só a planilha.
modelo-cnpsa-acordo-coletivo.csv)modelo-cnpsa-termo-adesao-individual.csv)Quem adere depois de um acordo entra em outro lote, no modelo de termo — não na mesma planilha do acordo.
Cada linha se liga a um contrato pelo identificador estadual. No cadastro vigente o registro é de previsão (não há comprovante nesta versão).
| Campo | Obrigatório | Como enviar |
|---|---|---|
| Identificador do pagamento no Estado | Sim | Chave única no órgão (ordem bancária, liquidação etc.) |
| Identificador do contrato no Estado | Sim | O mesmo código enviado no Anexo C, D ou equivalente |
| Ano da previsão | Sim | AAAA |
| Período de referência | Sim | Texto do período (ex.: 2026, 1º semestre de 2026) |
| Valor previsto | Sim | Reais |
| Observações | Não | Texto |
Não enviar comprovante nesta versão do layout.
O Estado escolhe somente estes textos. Item fora da lista é recusado na homologação.
Leitura no mesmo visualizador que o Catálogo do Conecta usa na página swagger_view. O botão Try it out mostra o formato da chamada. A chamada real depende do host e das credenciais que a CGTI ainda vai informar.