Web service Concentrador: Consulta de Pagamentos Realizados
Serviço web que retorna uma lista de solicitações de certificado com pagamento via PagTesouro que tiveram sua situação alterada. A consulta pode ser realizada tanto através da informação de um período quanto através da informação do Número do DUV.
Atores que podem utilizar o Serviço:
- ANVISA
Endpoint do Serviço:
POST url_base/psp-cdp-rest/api/certificado-anvisa/status-solicitacoes/v1.00
Autenticação:
- Mútua por certificado digital
Finalidade:
- Retornar uma lista de solicitações de certificado com pagamento via PagTesouro que tiveram sua situação alterada no intervalo informado ou no DUV informado.
Content-Type:
application/json
Parâmetros da Requisição da Consulta de Pagamentos Realizados:
| Nome | Descrição | Tipo | Tamanho | Local | Observação |
|---|---|---|---|---|---|
| dataInicial | Data de Início da Pesquisa | String (Opcional) | 10 | url query string | Formato: yyyy-mm-dd. (*) Campo obrigatório caso o campo "numeroDuv" não esteja preenchido. |
| dataFinal | Data de Fim da Pesquisa | String (Opcional) | 10 | url query string | Formato: yyyy-mm-dd. (*) Caso esse campo não seja preenchido será assumido o mesmo valor do campo "dataInicial". |
| cnpj | CNPJ da Empresa | Long (Opcional) | 14 | url query string | |
| numeroDuv | Número do DUV | Long (Opcional) | 9 | url query string | (*) Campo obrigatório caso o campo "dataInicial" não esteja preenchido. |
Resposta da Requisição:
| Nome | Descrição | Tipo | Observação |
|---|---|---|---|
| versão | String | Valor padrão: 1.00 | |
| arqueacaoLiquida | Arqueação Líquida | String | Informações Gerais > Dados da embarcação > Arqueação Líquida |
| codigoAssunto | Código do Assunto do Peticionamento ANVISA | Integer | Código do Assunto da seção Informações de Pagamento, da Solicitação de Certificado |
| fatoGerador | Fator Gerador | Integer | Código do Fato Gerador da Taxa da ANVISA |
| descricaoAssunto | Assunto do Peticionamento ANVISA | String | Descrição do Assunto na Solicitação de Certificado |
| idSetorAnuente | Identificador do Setor Anuente | String | Código da unidade local no senha-rede |
| descricaoPortoOrigem | Porto de Origem | String | Nome do Porto do DUV |
| estado | Estado | String | UF do Porto do DUV |
| numeroDuv | Número do Documento Único Virtual (DUV) | Long | Número do DUV (sem zeros à esquerda) |
| numeroSolicitacao | N. Solicitação | Long | Relação de Peticionamentos/Solicitações > Nº da Solicitação |
| dataHoraSolicitacao | Data/Hora da Solicitação | String | Relação de Peticionamentos/Solicitações > Data do Peticionamento |
| classeEmbarcacao | Código correspondente a classe da embarcação | String | Mesmo que DATAVISA. Domínio: - 25: Classe I - 26: Classe II - 27: Classe III - 28: Classe IV - 31: Classe V Fluvial I - 32: Classe V Maritimo I - 33: Classe V Fluvial II - 34: Classe V Maritimo II |
| numeroEmbarcacao | Número da Embarcação | String | Número IMO ou Número da Inscrição da Embarcação |
| nomeEmbarcacao | Nome da Embarcação | String | Nome da Embarcação |
| codigoPaisBandeira | Código do país/bandeira | String | De-para do valor da Bandeira da embarcação com domínio DATAVISA. |
| tipoTransito | Tipo do Trânsito | String | Mesmo que DATAVISA. Domínio: - Internacional - Nacional - Interestadual - Municipal |
| finalidadeEmbarcacaoAnvisa | Finalidade Embarcação ANVISA | String | De-para do valor da Finalidade da Embarcação, do cadastro da embarcação com domínio DATAVISA |
| finalidadeEmbarcacaoPSP | Finalidade Embarcação PSP | String | Finalidade da Embarcação do Cadastro da Embarcação |
| tipoNavegacaoAnvisa | Tipo navegação ANVISA | String | De-para do valor do Tipo de Viagem Chegada nas ‘Características da Estadia’ com domínio DATAVISA |
| tipoNavegacaoPSP | Tipo navegação PSP | String | Valor do Tipo de Viagem Chegada nas ‘Características da Estadia’ Gerais |
| responsavelTransacaoCpfCnpj | Responsável Transação CPF/CNPJ | String | Número do documento do Requerente da solicitação de certificado |
| dataUltimaAtualizacao | Data da Última Atualização | String | Data da ultima atualização da solicitação de certificado |
| solicitacaoPagTesouroCancelada | Solicitação do Pag Tesouro Cancelada | String | Valor 'true' se o Peticionamento for Cancelado |
| requisicoesPagTesouro | Requisições Pag Tesouro | String | Deve retornar apenas 1, a não ser que por alguma exceção não prevista o usuário consiga realizar dois pagamentos para a mesma solicitação |
| statusPagamentoPagTesouro | Status Pagamento Pag Tesouro | String | Domínio: - CONCLUIDO - ISENTO (quando o certificado é isento e não é criada requisição no PagTesouro). - Demais situações não serão enviadas, conforme combinado. |
| dataPagamentoPagTesouro | Data do Pagamento Pag Tesouro | String | Data retornada pelo Pagtesouro de quando o ultimo status foi alterado, no caso quando o pagamento foi recebido |
| idPagamento | Id do Pagamento | String | ID Pagamento fornecido pelo PagTesouro |
| valorRetornado | Valor Retornado | String | Valor retornado na consulta de situação no PagTesouro |
| codigoServico | Código de Serviço | String | Código do Serviço Informado no PagTesouro |
| numeroReferencia | Número de Referência | String | Máscara [000000 00 000000 00 0000]. Onde: - Os primeiros 6 dígitos são referentes ao 'Número do DUV'. - Os 2 próximos dígitos são referentes ao 'Ano do DUV'. - Os 6 próximos dígitos são referentes ao 'Número da Solicitação'. - Os 2 próximos dígitos são referentes ao 'Ano da Solicitação'. - Os 4 últimos são ZERO para evitar colisão com outros Números de Referência ANVISA. |
| numeroCompetencia | Número de Competência | String | Mês e ano – Formato: “mmaaaa”. |
| dataVencimento | Data de Vencimento | String | 05 (cinco) dias após a data de solicitação |
| cnpjCpfContribuinte | CNPJ/CPF Contribuinte | String | CNPJ agência que criou o DUV |
| nomeContribuinte | Nome do Contribuinte | String | Nome da agência que criou o DUV |
| valorPrincipal | Valor Principal | String | Valor da Taxa ANVISA, de acordo com a Classe e assunto escolhidos |
| valorDescontos | Valor dos Descontos | String | Conforme especificação do Pagtesouro, deve ser vazio se o valor for 0 |
| valorOutrasDeducoes | Valor de Outras Deduções | String | Conforme especificação do Pagtesouro, deve ser vazio se o valor for 0 |
| valorMulta | Valor da Multa | String | Conforme especificação do Pagtesouro, deve ser vazio se o valor for 0 |
| valorJuros | Valor dos Juros | String | Conforme especificação do Pagtesouro, deve ser vazio se o valor for 0 |
| valorOutrosAcrescimos | Valor Outros Acréscimos | String | Conforme especificação do Pagtesouro, deve ser vazio se o valor for 0 |
| dadosCadastro | Dados da empresa Solicitante | String | Agrupamento com os dados da empresa que solicitou o certificado |
| representanteLegalCpf | Representante Legal CPF | String | CPF do representante da seção 'Informações de Identificação do Requerente' da solicitação de certificado |
| representanteLegalCodCidade | Código da cidade do representante Legal | Integer | Código do município do representante legal, seção 'Informações de Identificação do Requerente' da solicitação de certificado |
| representanteLegalNomeCidade | Nome da cidade do representante Legal | Integer | Nome do município do representante legal, seção 'Informações de Identificação do Requerente' da solicitação de certificado |
| representanteLegalPais | Código do país do representante Legal | Integer | Código do país Brasil (padrão) - mesmo que bandeira |
| representanteLegalNome | Nome do representante legal | String | Nome do representante legal da seção 'Informações de Identificação do Requerente' da solicitação de certificado |
| agenciaCnpj | Cnpj da agência | String | CNPJ da agência dona do DUV |
| agenciaRazaoSocial | Razão social da agência | String | Razão Social da agência dona do DUV |
| agenciaLogradouro | Logradouro da agência | String | Logradouro da agência dona do DUV |
| agenciaCep | Cep da agência | String | CEP da agência dona do DUV |
| agenciaPais | Código do país da agência | String | Código do país Brasil (padrão) - mesmo que bandeira |
| agenciaCodCidade | Código da cidade da agência | String | Código do município da agência dona do DUV |
| agenciaNomeCidade | Nome da cidade da agência | String | Nome do município da agência dona do DUV |
| agenciaUF | Código da uf da agência | String | Razão Social da agência dona do DUV |
Exemplos de Requisições/Resposta da Requisição:
Exemplo da Requisição da Consulta de Pagamentos Realizados por Período:
POST https://integracoes.portosempapel.gov.br/psp-cdp-rest/api/certificado-anvisa/status-solicitacoes/v1.00?dataInicial=2020-01-15&dataFinal=2020-01-17&cnpj=82951351000142
Exemplo da Requisição da Consulta de Pagamentos Realizados por DUV:
POST https://integracoes.portosempapel.gov.br/psp-cdp-rest/api/certificado-anvisa/status-solicitacoes/v1.00?numeroDuv=12020
Exemplo de JSON com a resposta da requisição:
{
"versao": "1.00",
"arqueacaoLiquida": "2",
"codigoAssunto": 9959,
"fatorGerador": 9999,
"descricaoAssunto": "Emissão de certificado de livre prática de embarcações que realizam navegação de : Interior em trânsito internacional - com deslocamento fluvial - desenvolvem atividades de esporte e recreio com fins comerciais",
"idSetorAnuente": "2530280001",
"descricaoPortoOrigem": "SANTOS",
"estado": "SP",
"numeroDuv": 12020,
"numeroSolicitacao": "0025182020",
"dataHoraSolicitacao": "2016-02-02T07:41:00",
"classeEmbarcacao": "33",
"numeroEmbarcacao": "3333331",
"nomeEmbarcacao": "NO WOMAN, NO CRY",
"codigoPaisBandeira": "105",
"tipoTransito": "Internacional",
"finalidadeEmbarcacaoAnvisa": "Transporte de Carga",
"finalidadeEmbarcacaoPSP": "Dragagem",
"tipoNavegacaoAnvisa": "",
"tipoNavegacaoPSP": "INTERIOR",
"responsavelTransacaoCpfCnpj": "11111111111",
"dataUltimaAtualizacao": "2020-01-09T13:38:13",
"solicitacaoPagTesouroCancelada": "false",
"requisicoesPagTesouro" : [
{
"statusPagamentoPagTesouro": "CONCLUIDO",
"dataPagamentoPagTesouro": "2020-01-09T14:18:38",
"idPagamento": "00001",
"valorRetornado": "10.00",
"codigoServico": "9999",
"numeroReferencia": "00222220000444020000",
"numeroCompetencia": "012020",
"dataVencimento": "2020-01-10",
"cnpjCpfContribuinte": "1111111111",
"nomeContribuinte": "Agência X",
"valorPrincipal" : "509,00",
"valorDescontos" : "0,00",
"valorOutrasDeducoes" : "0,00",
"valorMulta" : "0,00",
"valorJuros" : "0,00",
"valorOutrosAcrescimos" : "0,00"
}
],
"dadosCadastro" : [
{
"representanteLegalCpf": "11111111111",
"representanteLegalCodCidade": "25",
"representanteLegalpais": "231",
"representanteNome": "João da Silva",
"agenciaCnpj": "11111111111111",
"agenciaRazaoSocial": "Agencia X",
"agenciaLogradouro": "Rua das Acácias",
"agenciaCep": "88000111",
"agenciaPais": "231",
"agenciaCidade": "25",
"agenciaUF": "22"
}
]
}
Atenção:
Os campos de data/hora são retornados com o fuso horário de brasília (para manter o padrão com o arquivo enviado ao datavisa)