Retorno de consulta de pagamentos realizados

Top  Previous  Next

 

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

RetPgto_ddMMyyyyHHmmssfff.txt

 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.

 

0000

Pai: -

Retorno – Mensagem de retorno do pagamento.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

ResponseCode

Código de mensagem

N

S

3

 

 

2

ResponseCodeMessage

Mensagem de retorno

C

S

1-200

 

 

Exemplo:

0000;200;Processamento realizado com sucesso

 

0100

Pai: 0000

Mensagem – Dados da mensagem de retorno.

Ocorrência: 0 - N

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

categoria

Categoria da mensagem

N

S

3

 

 

2

codigo

Código da mensagem

N

S

3-4

 

 

3

mensagem

Descrição da mensagem

C

S

1-2000

 

 

4

observacao

Observação sobre a mensagem. Informações mais técnicas.

C

N

1-2000

 

 

Exemplo:

0100;100;386; CNPJ inválido.;

 

1000

Pai: -

Pagamento – Dados do pagamento da Operação de Transporte.

Ocorrência: 0 - N

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

dataHora

Data e hora do pagamento

D

S

 

 

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

Exemplo:

1000;2011-12-15 10:00:00

 

1100

Pai: 1000

Autorização CIOT – Operação de Transporte com CIOT.

           Ocorrência: 0 - 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

numero

Código Identificador da Operação de Transporte

N

S

12

 

 

2

ciotCodVerificador

Protocolo de autorização

C

S

4

 

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

Exemplo:

1100;556000000012;4567

 

1300

Pai: 1000

Autorização NDOP – Operação de Vale-Pedágio com NDOP

Ocorrência: 0 - 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

numero

Número do NDOP

N

S

12

 

 

2

ndopCodVerificador

Protocolo de autorização do NDOP

N

S

4

 

 

Exemplo:

1300;557895214785;7789

 

2000

Pai: -

Pedágio – Dados do pagamento de pedágio - Este registro não será exibido quando houver o registro 3000.

Ocorrência: 0 - 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

valorPago

Valor total do pagamento de pedágio

N

S

1-15

2

 

2

cpf

CPF do recebedor do pedágio

N

S

11

 

CPF do condutor ou colaborador que recebeu o pedágio

Exemplo:

2000;10.00;12345678901

 

2100

Pai: 2000

Estabelecimento – Dados sobre o estabelecimento que fez o pagamento.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

cnpj

CNPJ do estabelecimento

N

S

14

 

 

2

nome

Razão social do estabelecimento

C

S

1-150

 

 

Exemplo:

2100;12345678901234;Razao Social Exemplo Ltda.

 

2110

Pai: 2100

Endereço estabelecimento – Dados de endereço do estabelecimento.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

UF

Sigla UF

C

S

2

 

 

2

cidade

Cidade

C

S

1-100

 

 

3

bairro

Bairro

C

S

1-255

 

 

4

logradouro

Logradouro

C

S

1-255

 

 

5

numero

Número

N

N

1-8

 

 

6

CEP

CEP

N

N

8

 

 

7

complemento

Complemento do endereço

C

N

1-255

 

 

Exemplo:

2110;SP;1234567;Bairro Exemplo;Logradouro Exemplo;531;88500000;Complemento de endereço

Exemplo 2:

2110;PR;7654321;Bairro Exemplo2;Logradouro Exemplo2;4601;88500000;

 

3000

Pai: -

Frete – Dados do pagamento de frete - Este registro não será exibido quando houver o registro 2000.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

nome

Nome da parcela

C

S

1-50

 

 

2

valor

Valor de pagamento da parcela

N

S

1-15

2

 

3

comentario

Comentário

C

N

1-500

 

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

Exemplo:

3000;Parcela 2;500.00;

 

3100

Pai: 3000

Pagamento Automático – Dados do pagamento quando for do tipo automático - Este registro não será exibido quando houver algum dos seguintes registros: 3200, 3300, 3400, 3500.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

dataHora

Data e hora do agendamento

D

S

 

 

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

Exemplo:

3100;2011-12-15 10:00:00

 

3200

Pai: 3000

Pagamento Posto Credenciado – Dados do pagamento quando for efetivado no Posto Credenciado. Este registro não será exibido quando houver algum dos seguintes registros: 3100, 3300, 3400, 3500.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

cnpj

CNPJ do posto

N

S

14

 

 

2

nome

Razão social do posto

C

S

1-150

 

 

Exemplo:

3200;12345678901234;Posto Exemplo Ltda.

 

3210

Pai: 3200

Endereço do posto – Dados de endereço do posto.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

UF

Sigla UF

C

S

2

 

 

2

cidade

Cidade

C

S

1-100

 

 

3

bairro

Bairro

C

S

1-255

 

 

4

logradouro

Logradouro

C

S

1-255

 

 

5

numero

Número

N

N

1-8

 

 

6

CEP

CEP

N

N

8

 

 

7

complemento

Complemento do endereço

C

N

1-255

 

 

Exemplo:

3210;SP;1234567;Bairro Exemplo;Logradouro Exemplo;531;88500000;Complemento de endereço

Exemplo 2:

3210;PR;7654321;Bairro Exemplo2;Logradouro Exemplo2;4601;88500000;

 

3300

Pai: 3000

Pagamento Centro de Triagem – Dados do pagamento quando for efetivado no Centro de Triagem - Este registro não será exibido quando houver algum dos seguintes registros: 3100, 3200, 3400, 3500.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

cpf

CPF do centro de triagem

N

N

11

 

Este campo deve ser obrigatório se o campo abaixo não for informado.

2

cnpj

CNPJ do centro de triagem

N

N

14

 

Este campo deve ser obrigatório se o campo acima não for informado.

3

nome

Razão social do centro de triagem

C

S

1-150

 

 

Exemplo:

3300;;12345678901234;Centro de Triagem Exemplo Ltda.

 

3310

Pai: 3300

Endereço do Centro de Triagem – Dados de endereço do Centro de Triagem.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

UF

Sigla UF

C

S

2

 

 

2

cidade

Cidade

C

S

1-100

 

 

3

bairro

Bairro

C

S

1-255

 

 

4

logradouro

Logradouro

C

S

1-255

 

 

5

numero

Número

N

N

1-8

 

 

6

CEP

CEP

N

N

8

 

 

7

complemento

Complemento do endereço

C

N

1-255

 

 

Exemplo:

3310;SP;1234567;Bairro Exemplo;Logradouro Exemplo;531;88500000;Complemento de endereço

Exemplo 2:

3310;PR;7654321;Bairro Exemplo2;Logradouro Exemplo2;4601;88500000;

 

3400

Pai: 3000

Pagamento Contratante – Dados do pagamento quando for efetivado na Contratante, ou quando houver pagamento imediato - Este registro não será exibido quando houver algum dos seguintes registros: 3100, 3200, 3300, 3500.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

cnpj

CNPJ da contratante

N

S

14

 

 

2

nome

Razão social da contratante

C

S

1-150

 

 

Exemplo:

3400;12345678901234;Contratante Exemplo Ltda.

 

3410

Pai: 3400

Endereço da Contratante – Dados de endereço da Contratante.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

UF

Sigla UF

C

S

2

 

 

2

cidade

Cidade

C

S

1-100

 

 

3

bairro

Bairro

C

S

1-255

 

 

4

logradouro

Logradouro

C

S

1-255

 

 

5

numero

Número

N

N

1-8

 

 

6

CEP

CEP

N

N

8

 

 

7

complemento

Complemento do endereço

C

N

1-255

 

 

Exemplo:

3410;SP;1234567;Bairro Exemplo;Logradouro Exemplo;531;88500000;Complemento de endereço

Exemplo 2:

3410;PR;7654321;Bairro Exemplo2;Logradouro Exemplo2;4601;88500000;

 

3500

Pai: 3000

Pagamento Confirmador – Dados do pagamento quando for efetivado na Contratante - Este registro não será exibido quando houver algum dos seguintes registros: 3100, 3200, 3300, 3400.

Ocorrência: 1 - N

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

cpf|cnpj

CPF|CNPJ do confirmador

N

S

11|14

 

 

2

nome

Nome do confirmador ou Razão social

C

S

1-150

 

 

Exemplo:

3500;12345678901;José da Silva.

Exemplo 2:

3500;12345678901234;Confirmador Exemplo Ltda.

 

3510

Pai: 3500

Endereço do Confirmador – Dados de endereço do Confirmador.

Ocorrência: 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

UF

Sigla UF

C

S

2

 

 

2

cidade

Cidade

C

S

1-100

 

 

3

bairro

Bairro

C

S

1-255

 

 

4

logradouro

Logradouro

C

S

1-255

 

 

5

numero

Número

N

N

1-8

 

 

6

CEP

CEP

N

N

8

 

 

7

complemento

Complemento do endereço

C

N

1-255

 

 

Exemplo:

3510;SP;1234567;Bairro Exemplo;Logradouro Exemplo;531;88500000;Complemento de endereço

Exemplo 2:

3510;PR;7654321;Bairro Exemplo2;Logradouro Exemplo2;4601;88500000;

 

3600

Pai: 3000

Carga – Campos contendo os dados da carga da parcela

Ocorrência: 0 - 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

quantidade

Quantidade da carga

N

S

1-5

 

Quantidade da carga.

2

unidadeMedida

Unidade de medida

C

S

1-20

 

Unidade de medida.

3

dataPrevisaoEntrega

Data prevista para entrega da carga

D

S

 

 

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

Exemplo:

3600;1.00;T;2013-10-10

 

3610

Pai: 3600

Entrega carga – Campos contendo os dados de entrega da carga da parcela

Ocorrência: 0 - 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

quantidade

Quantidade da carga

N

S

1-7

2

Quantidade da carga que foi entregue.

2

unidadeMedida

Unidade de medida

C

S

1-20

 

Unidade de medida.

3

dataEntrega

Data de entrega da carga

D

S

 

 

Data que a carga foi entregue.

Padrão: AAAA-MM-DD

4

dataHoraRegistroPassagem

Data em que foi realizado o registro de passagem

D

S

 

 

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

5

cnpjPostoCredenciado

CNPJ do posto credenciado onde foi realizado o registro de passagem

N

1

14

 

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

Exemplo:

3610;1.00;T;2013-10-25;2013-10-25;12345678901234

 

3700

Pai: 3000

Confirmação de Pagamento – Campos contendo os dados da confirmação de pagamento

Ocorrência: 0 - 1

#

Campo

Descrição

Tipo

Obr.

Tam.

Dec.

Observação

1

dataHoraConfirmacao

Data e hora em que foi realizada a confirmação do pagamento

D

S

 

 

Data e hora em que foi realizada a confirmação do pagamento:

2

observacao

Observação

C

N

1-500

 

Observação

Exemplo:

3700;2013-10-10;