Histórico da Página

...

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico	prgfin/acr/acr540za

Considerações Gerais

Objetivo

...

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

...

pi_envia_cnf_ncn_vda_tef
Requisito	REQ 1376 - Controle de caixa - Integração com leitora de cartão
Sintaxe	run pi_envia_cnf_ncn_vda_tef in h-handle (input param p_cod_empresa_tef , input param p_cod_operac_admdra , input param p_cdd_trans_seq, input param p_cod_usuar, output param p_nom_mensagem_tef, output param table for tt_log_erro).
Descrição	Confirmação ou desfazimento de transação realizada via leitora de cartão.
Parâmetros	Descrição
p_cod_empresa_tef	Código da empresa corrente.
p_cod_operac_admdra	Tipo de operação, de acordo com manual do Aplicativo. Ex.: (CNF,NCN).
p_cod_usuar	Código do usuário do módulo.
p_cdd_trans_seq	Número sequencial gerado para a transação.
p_nom_mensagem_tef	Mensagem para o Operador.
table for tt_log_erro	Tabela temporária com retorno de erros da API.
Retorno		A API irá retornar o campo “p_nom_mensagem_tef” preenchido apenas quando o tipo de operação for desfazimento para que o Operador possa saber que a transação teve sucesso; Para o tipo confirmação não haverá retorno de informações.Os motivos para a rejeição da solicitação de confirmação ou desfazimento da venda são especificados na temp-table tt_erro_log. As mensagens possíveis para esse método são:
		21.368 - Transações TEF não autorizadas.
		21.369 - Usuário(a) sem permissão para transações TEF.
		21.372 - Diretório de integração não foi localizado.
		21.376 - Falta parâmetros para este procedimento.
		21.379 - Arquivo de transação não foi gerado.
		21.380 - Houve erro no tratamento do arquivo gerado.
		21.381 - Sistema não respondeu a solicitação de transação TEF.
		21.382 - Arquivo de Confirmação foi gerado com erro.
		21.383 - Arquivo de resposta foi gerado com erro.
		21.384 - Mensagem TEF: &1 = ex: Cartão não autorizado.
		21.396 - Parâmetros do TEF não foi localizado.
		21.397 - Usuário do Controle de Caixa não localizado.
		21.400 - Registro &1 = (nome da tabela) não foi localizado.

pi_envia_req_cnc_vda_tef
Requisito	REQ 1376 - Controle de caixa - Integração com leitora de cartão
Sintaxe	run pi_envia_req_cnc_vda_tef in h-handle (input param p_cod_empresa_tef , input param p_cod_operac_admdra , input param p_cod_usuar, Input param p_rec_cancel_vda_tef, output param p_cdd_trans_seq, output param p_nom_mensagem_tef, output param p_nom_arquivo_retorno, output param table for tt_log_erro).
Descrição	Estorno de transações confirmadas no mesmo dia do pedido de cancelamento, via leitora de cartão.
Parâmetros	Descrição
p_cod_empresa_tef	Código da empresa corrente.
p_cod_operac_admdra	Tipo de operação, de acordo com manual do Aplicativo. Ex.: (CNC).
p_cod_usuar	Código do usuário do módulo.
p_rec_cancel_vda_tef	Recid do regisro que será cancelado. (tabela: process_negoc_cx_cart).
p_cdd_trans_seq	Número sequencial gerado para a transação.
p_nom_mensagem_tef	Mensagem para o Operador.
p_nom_arquivo_retorno	Caminho e nome do arquivo gerado com a imagem do cupom.
table for tt_log_erro	Tabela temporária com retorno de erros da API.
Retorno		A API irá retornar o número da transação, que será gerado no parâmetro “p_cdd_trans_tef”, o qual pode vir a ser utilizado na chamada do método “pi_envia_cnf_ncn_vda_tef” para confirmação do cancelamento da venda; Atualmente o processo de cancelamento não exige a geração de confirmação do cancelamento; O campo “p_nom_mensagem_tef” é somente orientativo, para que o Operador possa saber que a transação teve sucesso; Está API gera o recibo de transação em diretório específico, portanto devolve o caminho e o nome do arquivo gerado no parâmetro “p_nom_arquivo_retorno”; Os motivos para a rejeição da solicitação de cancelamento da venda são especificados na temp-table tt_erro_log. As mensagens possíveis para esse método são:
		21.368 - Transações TEF não autorizadas.
		21.369 - Usuário(a) sem permissão para transações TEF.
		21.372 - Diretório de integração não foi localizado.
		21.376 - Falta parâmetros para este procedimento.
		21.379 - Arquivo de transação não foi gerado.
		21.380 - Houve erro no tratamento do arquivo gerado.
		21.381 - Sistema não respondeu a solicitação de transação TEF.
		21.382 - Arquivo de Confirmação foi gerado com erro.
		21.383 - Arquivo de resposta foi gerado com erro.
		21.384 - Mensagem TEF: &1 = ex: Cartão não autorizado.
		21.387 - Operação TEF não pode ser cancelada por &1 = ex.: nome do usuário.
		21.395 - Cancelamento não permitido.
		21.396 - Parâmetros do TEF não foi localizado.
		21.397 - Usuário do Controle de Caixa não localizado.
		21.400 - Registro &1 = (nome da tabela) não foi localizado.

pi_envia_req_md_adm_tef
Requisito	REQ 1376 - Controle de caixa - Integração com leitora de cartão
Sintaxe	run pi_envia_req_md_adm_tef in h-handle (input param p_cod_empresa_tef , input param p_cod_operac_admdra , input param p_cod_usuar, output param p_nom_mensagem_tef, output param p_nom_arquivo_retorno).
Descrição	Requisição acesso ao administrador SITEF – Tecnologia TEF (Transferência Eletrônica de Fundos)
	Parâmetros	Descrição
	p_cod_empresa_tef	Código da empresa corrente.
	p_cod_operac_admdra	Tipo de operação, de acordo com manual do Aplicativo. Ex.: (CRT).
	p_cod_usuar	Código do usuário do módulo.
	p_nom_mensagem_tef	Mensagem para o Operador.
	p_nom_arquivo_retorno	Caminho e nome do arquivo gerado com a imagem do cupom.
Retorno	A API irá retornar o campo “p_nom_mensagem_tef” o qual retornará a última ação executado no administrador. Serve também para informar ao operador do caixa que o retorno do controle voltou para a Automação (Controle de Caixa); Se o operador solicitar reimpressão ou fazer algum cancelamento pelo administrador, a API fará a geração do cupom o qual será impresso automaticamente pelo Controle de Caixa, através do parâmetro p_nom_arquivo_retorno que retorna com o caminho completo onde foi gerado o arquivo que contem a imagem do cupom; Caso esteja em branco, houve erro ou o acesso ao administrador não gerou nenhuma saída de impressão. As mensagens possíveis para esse método são:
	21.368 - Transações TEF não autorizadas.
	21.369 - Usuário(a) sem permissão para transações TEF.
	21.372 - Diretório de integração não foi localizado.
	21.376 - Falta parâmetros para este procedimento.
	21.379 - Arquivo de transação não foi gerado.
	21.380 - Houve erro no tratamento do arquivo gerado.
	21.381 - Sistema não respondeu a solicitação de transação TEF.
	21.382 - Arquivo de Confirmação foi gerado com erro.
	21.383 - Arquivo de resposta foi gerado com erro.
	21.384 - Mensagem TEF: &1 = ex: Cartão não autorizado.
	21.396 - Parâmetros do TEF não foi localizado.
	21.397 - Usuário do Controle de Caixa não localizado.
	21.400 - Registro &1 = (nome da tabela) não foi localizado.

...

Método Negócio

pi_valid_amb_tef
Requisito	REQ 1376 - Controle de caixa - Integração com leitora de cartão
Sintaxe	run pi_valid_amb_tef (input p_cod_empresa_tef, input p_cod_usuar)
Descrição	Faz a verificação dos parâmetros do TEF e carrega as variáveis de diretórios e arquivos que serão utilizados durante o processamento. Em caso de erro grava-o em tt_log_erro.
	Parâmetros	Descrição
	p_cod_empresa_tef	Código da empresa corrente.
	p_cod_usuar	Código do usuário do módulo.
Retorno	Não há retorno de informações. Em caso de erro, apenas grava o mesmo na tabela de erros. Os erros são tratados na procedure ‘pai”.

...

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão 5

Chave

Considerações Gerais

Tabelas Temporárias

Método Negócio