API Hub Cobrança — Catálogo de APIs governamentais

Outros Temas / APIS em Destaque

API Hub Cobrança

PGFN/PGDAU

Versão 1.0 - 28/04/2025

Base / Sistema: HUB PGFN

Disponível via Conecta

Federal

A API HUB COBRANÇA tem por objetivo viabilizar a integração dos sistemas dos credores públicos conveniados à solução desenvolvida pela Procuradoria-Geral da Fazenda Nacional (PGFN), possibilitando a utilização de estratégias e instrumentos voltados à cobrança administrativa de créditos inscritos em dívida ativa. Dessa forma, a integração permite ampliar a eficiência dos processos de recuperação de créditos, por meio do acesso a serviços e funcionalidades disponibilizados pela PGFN.

Público Alvo:

Entidades Credoras que compõem a Administração Pública Federal.

Legislação associada:

Artigo 2o., incisos III e IV e parágrafo 9o. da Lei 10.522/2002 c/c Lei 6.830/1980.

"§ 9º Convênio entre a União, representada pela Procuradoria-Geral da Fazenda Nacional, e os titulares dos créditos previstos nos incisos III e IV do caput deste artigo poderá estabelecer regras de cooperação que favoreçam a recuperação desses ativos."

Principais Operações

Detalhar registro de proteção ao crédito referentes a um CPF ou CNPJ

GET https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca/apirest/registroProtecaoCredito/{cpfCnpj}/{tipoCpfCnpj}

Parâmetros de Entrada x-cpf-usuario

Cpf do usuário responsável pela operação

cpfCnpj

CPF ou CNPJ para consulta

tipoCpfCnpj

Tipo do NI pra consulta: 1-CPF, 2-CNPJ

Parâmetros de Saída id

Identificador do registro

dataDebito

Data do débito do registro

referencia

Número de referência do registro

valorDebitoCentavos

Valor do débito em centavos cadastrado no registro

situacao

Código da situação do registro

situacaoMotivo

Motivo para o tratamento da situação do registro

dataUltimaSituacao

Data da última situação do registro

dataRegistro

Data do registro

nomeCredor

Nome do credor associado ao registro

situacaoDescricao

Descrição da situação do registro

codigoMunicipio

Código do município do devedor

tipo

Tipo CPF/CNPJ do devedor (1=CPF, 2=CNPJ)

cpfCnpj

NI do devedor do registro de acordo com o tipoCpfCnpj

nome

Nome do devedor do registro

endereco

Endereço do devedor do registro

numero

Número do endereço do devedor do registro

complemento

Complemento do endereço do devedor do registro

bairro

Bairro do endereço do devedor do registro

cep

CEP do endereço do devedor do registro

municipio

Município do endereço do devedor do registro

estado

Estado do endereço do devedor do registro

telefone

Telefone do devedor do registro

Email do devedor do registro

ddd

DDD do telefone do devedor do registro

credorId

Identificador do credor do registro

tipoEnvioArquivo

Tipo de envio do arquivo

templateId

ID do template

templateNome

Nome do template

tipoDevedor

Tipo do devedor

cnpjCredor

CNPJ do credor

Excluir logicamente registro de proteção ao crédito

PUT https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca/apirest/registroProtecaoCredito/{cpfCnpj}/{tipoCpfCnpj}/{referencia}/excluir

Parâmetros de Entrada cpf

Cpf do usuário responsável pela operação

cpfCnpj

CPF ou CNPJ do contribuinte a ser excluído

tipoCpfCnp

Tipo do contribuinte a ser excluído: CPF, CNPJ

referencia

Número de referência/contrato do registro a ser excluído

Parâmetros de Saída id

Identificador interno do registro

dataDebito

Data do débito do registro

referencia

Número de referência do registro

valorDebitoCentavos

Valor do débito em centavos cadastrado no registro

situacao

Código da situação do registro

situacaoMotivo

Motivo para o tratamento da situação do registro

dataUltimaSituacao

Data da última situação do registro

dataRegistro

Data do registro

nomeCredor

Nome do credor associado ao registro

situacaoDescricao

Descrição da situação do registro

codigoMunicipio

Código do município do devedor

tipo

Tipo CPF/CNPJ do devedor (1=CPF, 2=CNPJ)

cpfCnpj

CPF ou CNPJ do devedor

nome

Nome do devedor

endereco

Endereço do devedor

numero

Número do endereço do devedor

complemento

Complemento do endereço

bairro

Bairro do devedor

cep

CEP do devedor

municipio

Município do devedor

estado

Estado do devedor

telefone

Telefone do devedor

E-mail do devedor

ddd

DDD do telefone do devedor

credorId

ID do credor

tipoEnvioArquivo

Tipo de envio do arquivo

templateId

ID do template

templateNome

Nome do template

tipoDevedor

Tipo do devedor (PRINCIPAL, CORRESPONSAVEL)

cnpjCredor

CNPJ do credor

Reenviar registro de proteção ao crédito

PUT https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca/apirest/registroProtecaoCredito/{cpfCnpj}/{tipoCpfCnpj}/{referencia}/reenviar

Parâmetros de Entrada cpf

Cpf do usuário responsável pela operação

cpfCnpj

CPF ou CNPJ do contribuinte a ser reenviado

tipoCpfCnpj

Tipo do contribuinte a ser reenviado: CPF, CNPJ

referencia

Número de referência/contrato do registro a ser reenviado

Parâmetros de Saída id

Identificador interno do registro

dataDebito

Data do débito do registro

referencia

Número de referência do registro

valorDebitoCentavos

Valor do débito em centavos cadastrado no registro

situacao

Código da situação do registro

situacaoMotivo

Motivo para o tratamento da situação do registro

dataUltimaSituacao

Data da última situação do registro

dataRegistro

Data do registro

nomeCredor

Nome do credor associado ao registro

situacaoDescricao

Descrição da situação do registro

codigoMunicipio

Código do município do devedor

tipo

Tipo CPF/CNPJ do devedor (1=CPF, 2=CNPJ)

cpfCnpj

CPF ou CNPJ do devedor

nome

Nome do devedor

endereco

Endereço do devedor

numero

Número do endereço do devedor

complemento

Complemento do endereço

bairro

Bairro do devedor

cep

CEP do devedor

municipio

Município do devedor

estado

Estado do devedor

telefone

Telefone do devedor

E-mail do devedor

ddd

DDD do telefone do devedor

credorId

ID do credor

tipoEnvioArquivo

Tipo de envio do arquivo

templateId

ID do template

templateNome

Nome do template

tipoDevedor

Tipo do devedor

cnpjCredor

CNPJ do credor

Consultar registro de protesto por idTransacao

GET https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca/apirest/protesto/{idTransacao}

Parâmetros de Entrada cpf

Cpf do usuário responsável pela operação

idTransacao

ID de transação (UUID) do registro de protesto

Parâmetros de Saída idTransacao

string

dataEmissao

string

titulo

string

valorTituloCentavos

integer

credorId

integer

cnpjCredor

string

nomeCredor

string

situacao

integer

situacaoDescricao

string

situacaoMotivo

string

tipoEnvioArquivo

integer

dataUltimaSituacao

string

dataRegistro

string

templateId

integer

templateNome

string

numeroProtesto

string

motivoCancelamento

string

tipoMotivoCancelamento

string

devedores

array

integer

tipoCpfCnpj

integer

tipoDevedor

string

cpfCnpj

string

nome

string

endereco

string

numero

string

complemento

string

bairro

string

cep

string

municipio

string

municipioCodigo

string

estado

string

telefone

string

ocorrencias

array

numeroProtesto

string

numeroProtocolo

string

status

string

motivo

string

dataOcorrenciaPuma

string, format: date-time

dataOcorrenciaCra

string, format: date-time

Detalhar registro de proteção ao crédito com situação SISPAC

GET https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca/apirest/registroProtecaoCredito/{cpfCnpj}/{tipoCpfCnpj}/{referencia}

Parâmetros de Entrada cpf

Cpf do usuário responsável pela operação

cpfCnpj

CPF ou CNPJ do contribuinte para consulta

tipoCpfCnpj

Tipo do contribuinte para consulta: CPF, CNPJ

referencia

Número de referência/contrato do registro

Parâmetros de Saída id

Identificador interno do registro

dataDebito

Data do débito do registro

referencia

Número de referência do registro

valorDebitoCentavos

Valor do débito em centavos cadastrado no registro

situacao

Código da situação do registro

situacaoMotivo

Motivo para o tratamento da situação do registro

dataUltimaSituacao

Data da última situação do registro

dataRegistro

Data do registro

nomeCredor

Nome do credor associado ao registro

situacaoDescricao

Descrição da situação do registro

codigoMunicipio

Código do município do devedor

tipo

Tipo CPF/CNPJ do devedor (1=CPF, 2=CNPJ)

cpfCnpj

CPF ou CNPJ do devedor

nome

Nome do devedor

endereco

Endereço do devedor

numero

Número do endereço do devedor

complemento

Complemento do endereço

bairro

Bairro do devedor

cep

CEP do devedor

municipio

Município do devedor

estado

Estado do devedor

telefone

Telefone do devedor

E-mail do devedor

ddd

DDD do telefone do devedor

credorId

ID do credor

tipoEnvioArquivo

Tipo de envio do arquivo

templateId

ID do template

templateNome

Nome do template

tipoDevedor

Tipo do devedor

cnpjCredor

CNPJ do credor

Detalhes SISPAC

idRegistro

integer

documento

string

tipoDocumento

string

tipoOcorrencia

string

referencia

string

documentoCredor

string

sistemaOrigem

string

sistemaDestino

string

situacaoAtual

string

dataNegativacao

string, format: data-time

dataUltimaAtualizacao

string, format: data-time

historicoProcessamento

array

historicoProcessamento: situacao

string

historicoProcessamento: dataAtualizacao

string, format: data-time

negativacaoAtiva

boolean

Endpoints

Produção

https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca https://apigateway.conectagov.estaleiro.serpro.gov.br/oauth2/jwt-token

Homologação

https://apigateway.conectagov.estaleiro.serpro.gov.br/api-hub-cobranca-hom https://apigateway.conectagov.estaleiro.serpro.gov.br/oauth2/jwt-token

FAQ - Acesse o link abaixo se está com problema para acessar a API:

Quero acessar os serviços do Conecta — Governo Digital

Como Acessar

Para órgão Público Federal, siga as instruções de adesão ao Conecta gov.br

Quero acessar

Swagger

Documentação técnica

Manual

Contato do Responsável

PGFN/PGDAU (Autorizações e Dúvidas) (Área de Negócio)

cadin.pgdau@pgfn.gov.br

(61) 2025-5100

Horário comercial

PGFN/CDA (Autorizações) (Área de Negócio)

cda.pgfn@pgfn.gov.br

(61) 2025-5100

Horário comercial

PGFN/CGTI (Área Técnica)

cgti.pgfn@pgfn.gov.br cgti.sistemas@pgfn.gov.br

(61) 2025-4804

Horário comercial