Envio de Operação de Pagamento

Top  Previous  Next

 

O arquivo de envio de Operação de Pagamento deve possuir a seguinte nomenclatura:

EnvOpag_nomeQualquer.xml        

A parte inicial da nomenclatura do arquivo (EnvOpag) é determinante para o funcionamento do processo. Se não seguir este padrão, o arquivo não será processado. O restante do nome do arquivo fica a encargo do sistema que gerar o arquivo e não tem impacto no processo.

 Abaixo, segue a especificação de registros e campos que devem/podem ser informados em um arquivo de envio de Operação de Pagamento.

 

Campo

Elem.

Pai

Tipo

Ocor.

Tam.

Dec.

Observação

operacaoPagamento_envio

Raiz

 

 

1

 

 

 

versao

A

operacaoPagamento_envio

S

1

7

 

Versão da integração que está sendo realizada.

token

A

operacaoPagamento_envio

S

1

24

 

O token será usado para determinar quais os níveis de permissionamento podem ser aceitos. Por exemplo: determinar um valor limite de operações de transporte por token.

infOperacaoPagamento

Raiz

operacaoPagamento_envio

 

1

 

 

 

ID

A

infOperacaoPagamento

S

0-1

 

 

GUID único para assinatura da mensagem. Utilizar este formato ou o formato abaixo.

Id

A

infOperacaoPagamento

S

0-1

 

 

GUID único para assinatura da mensagem. Utilizar este formato ou o formato acima.

impAuto

A

infOperacaoPagamento

N

0-1

1

 

Indica se ocorrerá impressão automática.

1 = Sim

2 = Não

Caso não seja informada será tomada por padrão o valor 1.

Este atributo não tem validade para integrações que não utilizam o módulo agente.

ide

Raiz

infOperacaoPagamento

 

1

 

 

Informações sobre a Operação de Pagamento

cnpj

E

ide

N

1

14

 

CNPJ da Contratante

ptEmissor

E

ide

S

1

1-30

 

Nome do ponto de emissão de Operação de Pagamento, dentro da Contratante. Os pontos emissores são configurados no cadastro da Contratante, no portal nddCargo.

numero

E

ide

N

1

1-9

 

Número da Operação de Pagamento

serie

E

ide

N

1

1-4

 

Série da Operação de Pagamento

colaborador

Raiz

infOperacaoPagamento

 

1

 

 

Dados do colaborador que receberá o pagamento

cpf

E

colaborador

N

1

11

 

CPF do colaborador

informacoes

Raiz

colaborador

 

0-1

 

 

Dados para cadastro do colaborador

nomeCompleto

E

informacoes

S

1

1-150

 

Nome do colaborador.

nomeMae

E

informacoes

S

1

1-150

 

Nome da mãe do colaborador.

nomePai

E

informacoes

S

0-1

1-150

 

Nome do pai do colaborador.

dataNascimento

E

informacoes

D

1

 

 

Data de nascimento do colaborador.

Formato: AAAA-MM-DD

identidade

E

informacoes

S

1

1-20

 

Identidade do colaborador.

endereco

Raiz

informacoes

 

1

 

 

Dados de endereço do colaborador.

UF

E

endereco

S

1

2

 

Sigla UF do colaborador.

cidade

E

endereco

S

1

1-100

 

Nome do Município do colaborador.

bairro

E

endereco

S

1

1-255

 

Bairro do colaborador.

logradouro

E

endereco

S

1

1-255

 

Logradouro do colaborador.

numero

E

endereco

N

0-1

1-8

 

Número do colaborador.

CEP

E

endereco

N

0-1

8

 

CEP do colaborador.

complemento

E

endereco

S

0-1

1-255

 

Complemento do endereço do colaborador.

telefone

E

informacoes

N

1

10-11

 

Informar o número do celular do colaborador, juntamente com o DDD. Caso não haja um número válido, informar 9999999999 ou 99999999999.

cartao

Raiz

colaborador

 

0-1

 

 

Dados do cartão para realizar o vínculo com o colaborador, quando necessário

cartaoId

E

cartao

N

1

1-15

 

Identificador do cartão entregue ao colaborador.

gestoraCartao

E

cartao

N

1

3

 

Gestora do cartão entregue ao colaborador.

rota

Raiz

infOperacaoPagamento

 

0-1

 

 

Informações da rota

rotaERP

E

rota

S

1

1-30

 

Nome da rota no ERP para a integração.

informacoes

Raiz

rota

 

0-1

 

 

Dados para inserção de uma rota no sistema ou atualização de uma já existente.

nome

E

informacoes

S

1

1-50

 

Nome de apresentação da rota dentro do sistema.

tipoRotaPadrao

E

informacoes

N

0-1

1

 

Define o tipo de rota padrão a ser utilizado nos pontos de parada.

1 = Rápida

2 = Curta

pontosParada

Raiz

informacoes

 

1

 

 

Dados dos pontos da parada da rota.

pontoParada

Raiz

pontosParada

 

2-N

 

 

Dados do ponto de parada.

codigoIBGE

E

pontoParada

N

1

7

 

Código IBGE do ponto de parada.

Deverá ser informada esta tag ou a tag cep

cep

E

pontoParada

N

1

8

 

CEP do ponto de parada.

Deverá ser informada esta tag ou a tag codigoIBGE

tipoRotaEspecifico

E

pontoParada

N

0-1

1

 

Tipo de rota específico para o ponto de parada em relação ao ponto anterior.

1 = Rápida

2 = Curta

responsaveis

Raiz

informacoes

 

0-1

 

 

Dados dos responsáveis pela rota.

responsavel

Raiz

responsaveis

 

1-N

 

 

Dados do responsável.

nome

E

responsavel

S

1

1-50

 

Nome do responsável pela rota na Contratante.

email

E

responsavel

S

1

1-255

 

E-mail do responsável pela rota na Contratante. Em caso de alterações na rota, o aviso será encaminhado para este e-mail.

utilizarRoteirizador

E

informacoes

N

0-1

1

 

Possibilita a utilização do roteirizador para calcular a distância e valores de pedágio.

1 = Sim

2 = Não

totalKm

E

informacoes

N

0-1

1-15

2

Total de quilômetros da rota.

notificarRespContratante

E

informacoes

N

0-1

1

 

Define a notificação para os responsáveis na Contratante, caso o roteirizador identifique alterações na rota.

1 = Sim

2 = Não

pagamento

Raiz

infOperacaoPagamento

 

1

 

 

Informações sobre o pagamento

gestoraCartao

E

pagamento

N

1

3

 

Gestora do cartão.

valor

E

pagamento

N

0-1

1-15

2

Valor a ser pago.

valorPedagio

E

pagamento

N

0-1

1-15

2

Valor de pedágio a ser pago.

categoriaPedagio

E

pagamento

N

0-1

1-2

 

Categoria de pedágio.

Valores possíveis disponíveis nos anexos.

Signature

Raiz

operacaoPagamento_envio

 

1

 

 

Tag de assinatura