Retorno de busca de pagamentos realizados

Top  Previous  Next

 

O arquivo de retorno de consulta de pagamentos possui a seguinte nomenclatura:

RetPgto_ddMMyyyyHHmmssfff.xml

 Abaixo segue a especificação do arquivo que será gravado no diretório de integração de pagamentos. Este arquivo serve para sinalizar que houve o pagamento de alguma parcela de alguma das Operações de Transporte feitas pela Contratante.

 

Campo

Elem.

Pai

Tipo

Ocor.

Tam.

Dec.

Observação

retornoConsultaPgtos

Raiz

 

 

1

 

 

 

mensagens

Raiz

retornoConsultaPgtos

 

0-1

 

 

 

mensagem

Raiz

mensagens

 

1-N

 

 

Dados da mensagem de retorno.

categoria

E

mensagem

N

1

3

 

Categoria da mensagem

codigo

E

mensagem

N

1

1-3

 

Código de mensagem de retorno

mensagem

E

mensagem

S

1

1-2000

 

Descrição da mensagem

observacao

E

mensagem

S

0-1

1-2000

 

Observação sobre a mensagem.

Neste campo poderão ser apresentadas informações mais técnicas sobre o que ocorreu no processo.

pgtos

Raiz

retornoConsultaPgtos

 

0-1

 

 

 

pgto

Raiz

pgtos

 

1-N

 

 

 

autorizacao

Raiz

pgto

 

0-1

 

 

Tipo de operação

ciot

Raiz

autorizacao

 

1

 

 

Será retornado este elemento ou o ndop

numero

E

ciot

N

1

12

 

Código Identificador da Operação de Transporte

ciotCodVerificador

E

ciot

S

1

4

 

Protocolo de autorização da Operação de Transporte, disponibilizado pela ANTT.

ndop

Raiz

autorizacao

 

1

 

 

Será retornado este elemento ou o ciot

numero

E

ndop

N

1

12

 

Número do NDOP

ndopCodVerificador

E

ndop

N

1

4

 

Protocolo de autorização do NDOP

dataHora

E

ndop

D

1

 

 

Data e hora do retorno das informações

pedagio

Raiz

pgto

 

1

 

 

Será retornado este elemento ou o frete

valorPago

E

pedagio

N

1

1-15

2

Valor total do pagamento de pedágio

estabelecimento

Raiz

pedagio

 

1

 

 

Dados do estabelecimento que realizou a carga do pedágio.

cnpj

E

estabelecimento

N

1

14

 

CNPJ do estabelecimento

nome

E

estabelecimento

S

1

1-150

 

Razão social do estabelecimento

endereco

Raiz

estabelecimento

 

1

 

 

Dados de endereço do estabelecimento.

UF

E

endereco

S

1

2

 

Sigla UF

cidade

E

enderecoendereco

S

1

1-100

 

Nome do Município

bairro

E

endereco

S

1

1-255

 

Bairro

logradouro

E

endereco

S

1

1-255

 

Logradouro

numero

E

endereco

N

0-1

1-8

 

Número

CEP

E

endereco

N

0-1

8

 

CEP

complemento

E

endereco

S

0-1

1-255

 

Complemento do endereço

cpfRecebedor

E

pedagio

N

1

11

 

CPF do condutor ou colaborador que recebeu o pedágio

frete

Raiz

pgto

 

1

 

 

Será retornado este elemento ou o pedagio

parcelas

Raiz

frete

 

1

 

 

Dados das parcelas pertencentes a operação de transporte.

parcela

Raiz

parcelas

 

1-N

 

 

Dados da parcela

nome

E

parcela

S

1

1-50

 

Nome da parcela

valorPago

E

parcela

N

1

1-15

2

Valor de pagamento da parcela

efetivacao

Raiz

parcela

 

1

 

 

Tipo da efetivação de pagamento da parcela

postoCredenciado

Raiz

efetivacao

 

1

 

 

Efetivação no posto credenciado.

Será retornado este elemento ou o centroTriagem ou o contratante ou oconfirmacaoEletronica ou o automatica

cnpj

E

postoCredenciado

N

1

14

 

CNPJ

nome

E

postoCredenciado

S

1

1-150

 

Razão social

endereco

Raiz

postoCredenciado

 

1

 

 

Dados de endereço do posto credenciado.

UF

E

endereco

S

1

2

 

Sigla UF

cidade

E

endereco

S

1

1-100

 

Nome do Município

bairro

E

endereco

S

1

1-255

 

Bairro

logradouro

E

endereco

S

1

1-255

 

Logradouro

numero

E

endereco

N

0-1

1-8

 

Número

CEP

E

endereco

N

0-1

8

 

CEP

complemento

E

endereco

S

0-1

1-255

 

Complemento do endereço

centroTriagem

Raiz

efetivacao

 

1

 

 

Efetivação no centro de triagem.

Será retornado este elemento ou o postoCredenciado ou o contratante ou o confirmacaoEletronica ou o automatica

cnpj

E

centroTriagem

N

1

14

 

CNPJ

nome

E

centroTriagem

S

1

1-150

 

Razão social

endereco

Raiz

centroTriagem

 

1

 

 

Dados de endereço do centro de triagem

UF

E

endereco

S

1

2

 

Sigla UF

cidade

E

endereco

S

1

1-100

 

Nome do Município

bairro

E

endereco

S

1

1-255

 

Bairro

logradouro

E

endereco

S

1

1-255

 

Logradouro

numero

E

endereco

N

0-1

1-8

 

Número

CEP

E

endereco

N

0-1

8

 

CEP

complemento

E

endereco

S

0-1

1-255

 

Complemento do endereço

contratante

Raiz

efetivacao

 

1

 

 

Efetivação na contratante.

Será retornado este elemento ou o postoCredenciado ou o centroTriagem ou o confirmacaoEletronica ou o automatica

cnpj

E

contratante

N

1

14

 

CNPJ

nome

E

contratante

S

1

1-150

 

Razão social

endereco

Raiz

contratante

 

1

 

 

Dados de endereço da contratante

UF

E

endereco

S

1

2

 

Sigla UF

cidade

E

endereco

S

1

1-100

 

Nome do Município

bairro

E

endereco

S

1

1-255

 

Bairro

logradouro

E

endereco

S

1

1-255

 

Logradouro

numero

E

endereco

N

0-1

1-8

 

Número

CEP

E

endereco

N

0-1

8

 

CEP

complemento

E

endereco

S

0-1

1-255

 

Complemento do endereço

confirmacaoEletronica

Raiz

efetivacao

 

1

 

 

Efetivação na confirmação eletrônica.

Será retornado este elemento ou o postoCredenciado ou o centroTriagem ou o contratante ou o automatica

cpf

E

confirmacaoEletronica

N

1

11

 

CPF

Será retornado este elemento ou o cnpj

cnpj

E

confirmacaoEletronica

N

1

14

 

CNPJ

Será retornado este elemento ou o cpf

nome

E

confirmacaoEletronica

S

1

1-150

 

Razão social

endereco

Raiz

confirmacaoEletronica

 

1

 

 

Dados de endereço do confirmador

UF

E

endereco

S

1

2

 

Sigla UF

cidade

E

endereco

S

1

1-100

 

Nome do Município

bairro

E

endereco

S

1

1-255

 

Bairro

logradouro

E

endereco

S

1

1-255

 

Logradouro

numero

E

endereco

N

0-1

1-8

 

Número

CEP

E

endereco

N

0-1

8

 

CEP

complemento

E

endereco

S

0-1

1-255

 

Complemento do endereço

automatica

Raiz

efetivacao

 

1

 

 

Efetivação automática.

Será retornado este elemento ou o postoCredenciado ou o centroTriagem ou o contratante ou o confirmacaoEletronica

dataHora

E

automatica

D

1

 

 

Data e hora do agendamento.

Formato: AAAA-MM-DD HH:MM:SS

comentario

E

parcela

S

0-1

1-500

 

Comentário realizado durante a ação que deu origem ao pagamento

carga

Raiz

parcela

 

0-1

 

 


saida

Raiz

carga

 

1

 

 


quantidade

E

saida

N

1

1-7

2

Quantidade da carga.

unidadeMedida

E

saida

S

1

1-20

 

Unidade de medida.

dataPrevisaoEntrega

E

saida

D

1

 

 

Data prevista para a entrega da carga. Padrão: AAAA-MM-DD

entrega

Raiz

carga

 

0-1

 

 


quantidade

E

entrega

N

1

1-7

2

Quantidade da carga que foi entregue.

unidadeMedida

E

entrega

S

1

1-20

 

Unidade de medida.

dataEntrega

E

entrega

D

1

 

 

Data que a carga foi entregue. Padrão: AAAA-MM-DD

dataHoraRegistroPassagem

E

entrega

D

1

 

 

Data em que foi realizado o registro de passagem. Padrão: AAAA-MM--DD HH:MM:SS

cnpjPostoCredenciado

E

entrega

N

1

14

 

Número do CNPJ do posto credenciado onde foi realizado o registro de passagem.

confirmacaoPgto

Raiz

parcela

 

0-1

 

 

Campos contendo os dados da confirmação de pagamento

dataHoraConfirmacao

E

confirmacaoPgto

D

1

 

 

Data e hora em que foi realizada a confirmação do pagamento pela contratante. Padrão: AAAA-MM-DD HH:MM:SS

observacao

E

confirmacaoPgto

S

0-1

1-500

 

Observação