| Lista de Campos – Consulta Pagamentos | |||||||||
| Descrição | Parâmetro* | Tipo | Formato | Regra | Entrada | Saída | Ordenável | Exemplo – Entrada | Exemplo – Saída |
| ID do Pagamento (no SISGRU) | id | Numérico | 99999999999999 | Campo de uso exclusivo do sistema interno do Tesouro - SIGEFI | X | X | X | 1234567890 | 1234567890 |
| Código de Identificação do Pagamento | codigo | Alfanumérico | Varchar(50) | n/a | X | X | X | “WC9Xgf2HG51UcWd9QmNaS” | “WC9Xgf2HG51UcWd9QmNaS” |
| Unidade Gestora | ug | Alfanumérico | Campo obrigatório. | ||||||
| 999999 | Consulta por único item. | X | X | X | “170500” | XML representando a UG | |||
| 999999,999999,...,999999 | Consulta por lista de itens. | X | X | X | “170500,170501,170502” | XML representando a UG | |||
| 999999-999999 | Intervalo a ser pesquisado. | X | X | X | “170500-170502” | XML representando a UG | |||
| Tipo de Serviço | tipoServico | Alfanumérico | 9999 | n/a | X | X | X | "0001" | XML representando o Tipo de Serviço |
| Serviço | servico | Numérico | 999 | n/a | X | X | X | 123 | XML representando o Serviço |
| Data de Alteração da Situação no SISGRU | data | Data | DD/MM/YYYY-DD/MM/YYYY | Campo obrigatório caso o parâmetro dataAlteracaoSituacaoPagTesouro não tenha sido informado. Intervalo inferior ou igual a 30 dias. | X | X | X | “01/01/2016-30/01/2016” | “01/01/2016 04:34” |
| Data do Pagamento no PSP | dataPagamentoPSP | Data | DD/MM/YYYY HH:II | Pode ser retornado no resultado, porém não é filtro de entrada. | X | X | 01/01/2024 08:30 | ||
| Data de Vencimento | dataVencimento | Data | DD/MM/YYYY | Pode ser retornado no resultado, porém não é filtro de entrada. | X | X | 01/01/2024 | ||
| Competência | competencia | Alfanumérico | MMYYYY | Pode ser retornado no resultado, porém não é filtro de entrada. | X | X | "012024" | ||
| Nº da Transação na Instituição Financeira | numeroTransacaoPSP | Alfanumérico | Varchar(50) | n/a | X | X | X | "6757e3bc9054481db21684ff57b5f0e1" | “6757e3bc9054481db21684ff57b5f0e1” |
| Recolhimento | recolhimento | Alfanumérico | 99999 | Consulta por único item. | X | X | X | “10000” | XML representando o Recolhimento |
| 99999,99999,...,99999 | Consulta por lista de itens. | X | X | X | “10000,10001,10002” | XML representando o Recolhimento | |||
| 99999-99999 | Intervalo a ser pesquisado. | X | X | X | “10000-10002” | XML representando o Recolhimento | |||
| Contribuinte | codigoContribuinte | Alfanumérico | 99999999999999 | O contribuinte pode ser um CPF, CNPJ ou Unidade Gestora. | X | X | X | “00000000018” | “00000000018” |
| Nome do Contribuinte | nomeContribuinte | Alfanumérico | Varchar(255) | n/a | X | X | “nome do contribuinte” | ||
| Número de Referência | numeroReferencia | Alfanumérico | Varchar(20) | n/a | X | X | X | “10000” | “10000” |
| Forma de Pagamento | tipoPagamento | Alfanumérico | CC: Cartão de Crédito; SC: Saldo em Carteira Digital; DO: Débito em Conta; PX: PIX. |
n/a | X | X | X | “PX” | XML representando a Forma de Pagamento |
| Instituição Financeira | provedorPagamento | Numérico | 999 | n/a | X | X | X | 123 | XML representando a Instituição Financeira |
| Situação | situacao | Alfanumérico | CR: Criado; IN: Iniciado; SU: Submetido; CO: Concluído; ER: Erro; CA: Cancelado; RE: Rejeitado. |
n/a | X | X | X | “CR” | “CR” |
| Contabilização | contabilizacao | Numérico | 0: GRU não contabilizada; 1: GRU contabilizada. |
n/a | X | X | X | 0 | 0 |
| Valor Total | valorTotal | Numérico | 999999999.99 | Consulta por único valor. | X | X | X | “100.00” | “100.00” |
| <999999999.99 | Consulta por intervalo menor que valor. | X | X | X | “<100.00” | “99.00” | |||
| >999999999.99 | Consulta por intervalo maior que valor. | X | X | X | “>100.00” | “101.00” | |||
| 999999999.99-999999999.99 | Consulta por intervalo de valores. | X | X | X | “100.00-100.01” | “100.00” | |||
| Data de Pagamento | dataAlteracaoSituacaoPagTesouro | Data | DD/MM/YYYY-DD/MM/YYYY | Campo obrigatório caso o parâmetro data não tenha sido informado. Intervalo inferior ou igual a 30 dias. | X | X | X | “01/01/2016-30/01/2016” | “01/01/2016 04:34” |
| ISPB | ispb | Alfanumérico | 99999999 | Campo de uso exclusivo do sistema interno do Tesouro - SIGEFI | X | X | X | “12345678” | “12345678” |
| Forma de Utilização do PagTesouro | formaUtilizacaoPagTesouro | Numérico | 1: Sistema Próprio da UG; 2: Portal PagTesouro-GRU. |
Pode ser retornado no resultado, porém não é filtro de entrada. | X | X | 1 | ||
*O nome dos parâmetros é sensível a maiúsculas e minúsculas.