CRM Interface de Comunicação PDV

Objetivo

Permitir a comunicação entre PDV x retaguarda RMS para consultar o cadastro de clientes.

Descrição do processo

Padrões e Considerações

Todos os delimitadores devem ser o caracter "pipe" - |

Os comandos possíveis a serem enviados são:

"CC" – Consulta de cheques (autorização de venda).
"CS" – Consulta de saldos disponíveis (consulta de clientes).
"NV" – Notificação de Venda.
"CL" – Cadastro do Cliente.
"CN" – Cancelamento do cheque.
"CV" – Convênio.
"CT" – Carnê.
"FD" – Crédito Rotativo.
"FI" – Consulta Clientes Fidelidade.
"PL" – Private Label.
"CP" – Consulta parcela pagamento.
"PG" – Notificação do Pagamento.
"EO" – Estoque Online.
"AS" – Troca de Senha.
"HC" – Cancelamento de Cupom.
"DC" – Cancelamento de item do cupom.
"AC" - Autorização de cancelamento.

O número de autorização criado em uma consulta "CC", deve ser o mesmo número para a operação "NV" correspondente e o mesmo para o cancelamento.

O código de retorno "00" significa que a solicitação foi processada com sucesso. Qualquer outro código indica retorno com erro.

Cada transação é equivalente a uma parcela. Por exemplo, em uma compra em três parcelas o PDV deverá enviar uma transação "CC" com o valor total da compra e três transações "NV" com os dados de cada parcela.

A transação "NV" respeita a transação anterior a ela. Por exemplo, uma transação "CC" seguida de "NV" significa uma finalização em cheque. Uma transação "FD" seguida de "NV" significa uma finalização em crédito rotativo.

Para as finalizações que não sejam em cheque, deverá ser enviado no campo "CH-CHEQUE" o conteúdo do campo "CH-CUPOM" na transação "NV".

Para cancelar uma transação o PDV deverá enviar uma transação "CN" com o número de autorização, número de sequência e número do PDV da "NV" que será cancelada.

Para incluir um cliente através do PDV, deverá ser enviada uma transação "CL" e aguardar um retorno "00" para a confirmação da transação. Após isso, pode-se utilizar o sistema normal de autorização enviando uma transação "CC" seguida de "NV".

Para as consultas de fidelidade e private label, o código enviado de identificação do cliente deverá ser o "número do cartão". A mensagem terá como código de identificação "FI" (fidelidade) ou "PL" (private label) e o PDV deverá enviar à retaguarda:

Código de identificação da mensagem.
Código da Transação = "FI" ou "PL".
Tipo do código = 2.
Código informado no PDV = número do cartão.
Código da Loja.
Número do PDV.

A transação de pagamento "PG" deverá conter os campos código do cliente (Código, CPF ou Cartão), Loja, PDV, Fiscal, Usuário e Valor. Ela possui um retorno como todas as outras, porém não gera número de autorização e nem requer uma transação "NV" para sua confirmação.

Para a modalidade "Carnê", antes de enviar uma transação "PG", deverá ser enviada uma "CP". Esta informação "CP" será a solicitação da informação a ser paga pelo cliente. Deverá ser enviado os campos código do cliente (Código, CPF ou Cartão), Loja, PDV, Fiscal e Usuário. Para emissão do carnê pelo PDV, ao ser enviada uma mensagem "CC", será retornado o número do carnê a ser gerado. No entanto, a confirmação só será mesmo quando recebida a transação "NV" com as parcelas.
Para troca de senha "AS": Somente é necessário o PDV enviar para a retaguarda os campos abaixo:

Código de identificação da mensagem.
Código da Transação = "AS".
Tipo do código = 0- Código/ 1- CPF/ 2-Cartão.
Código informado no PDV = Documento.
Senha (Nova Senha).

Layout da Chamada ( PDV  Retaguarda )

Campo	Descrição	Início	Final	Tipo	Tam.	Dec.
CH-FILLER	Código de identificação da mensagem	1	4	Num	4
PIPE-00	Delimitador	5	5	Alfa	1
CH-TRANSACAO	Código da Transação: CS, CC, NV, FI...	6	7	Alfa	2
PIPE-00	Delimitador	8	8	Alfa	1
CH-TIPCOD	Tipo do código: 0 – Código de Cliente 1 – C.P.F. / C.G.C. 2 – Número Cartão	9	9	Num	1
PIPE-01	Delimitador	10	10	Alfa	1
CH-CODIGO	Código informado no PDV	11	26	Num	16
PIPE-02	Delimitador	27	27	Alfa	1
CH-LOJA	Código da Loja	28	30	Num	3
PIPE-03	Delimitador	31	31	Alfa	1
CH-PDV	Número do PDV	32	34	Num	3
PIPE-04	Delimitador	35	35	Alfa	1
CH-CUPOM	Número do cupom	36	41	Num	6
PIPE-05	Delimitador	42	42	Alfa	1
CH-FINAL	Número da finalizadora	43	45	Num	3
PIPE-06	Delimitador	46	46	Alfa	1
CH-DATA-VENC	Data para vencimento	47	54	Num	8
PIPE-07	Delimitador	55	55	Alfa	1
CH-DIAS-VENC	Número de dias para vencimento	56	59	Num	4
PIPE-08	Delimitador	60	60	Alfa	1
CH-VALOR	Valor do cheque	61	77	Num	17	2
PIPE-09	Delimitador	78	78	Alfa	1
CH-BANCO	Número do banco do cheque	79	81	Num	3
PIPE-10	Delimitador	82	82	Alfa	1
CH-AGENCIA	Código da agência do cheque	83	87	Num	5
PIPE-11	Delimitador	88	88	Alfa	1
CH-CONTA	Número da conta corrente do cheque	89	99	Num	11
PIPE-12	Delimitador	100	100	Alfa	1
CH-CHEQUE	Número do cheque	101	107	Num	7
PIPE-13	Delimitador	108	108	Alfa	1
CH-CPF	C.P.F. do cheque	109	122	Num	14
PIPE-14	Delimitador	123	123	Alfa	1
CH-USUARIO	Identificação do caixa	124	131	Alfa	8
PIPE-15	Delimitador	132	132	Alfa	1
CH-FISCAL	Identificação do fiscal	133	140	Alfa	8
PIPE-16	Delimitador	141	141	Alfa	1
CH-AUTORIZACAO	Número de autorização da venda	142	150	Num	9
PIPE-17	Delimitador	151	151	Alfa	1
CH-SEQUENCIA	Número de sequência do PDV	152	156	Num	5
PIPE-18	Delimitador	157	157	Alfa	1
CH-CMC7	CMC7 DO CHEQUE	158	192	Alfa	35
PIPE-19	Delimitador	193	193	Alfa	1
CH-CMC7-LIDA	CMC7 DO CHEQUE - LIDA (1) OU DIGITADA (0)	194	194	Num	1
PIPE-20	Delimitador	195	195	Alfa	1
CH-PEDIDO	Nrº do Pedido do Vendas Assistidas	196	102	Num	7
PIPE-21	Delimitador	103	103	Alfa	1
CH-SENHA	Nova senha	104	109	Alfa	6
PIPE-22	Delimitador	110	110	Alfa	1
CH-DT-LANC	Data de lançamento vale	111	118	Alfa	8
PIPE-22	Delimitador	119	119	Alfa	1
CH-SEQ-VALE	Nrº Sequencia vale	120	127	Num	7
PIPE-22	Delimitador	128	128	Alfa	1
PIPE-23	Delimitador	129	129	Alfa	1

Layout do Retorno com Erro ( Retaguarda  PDV )

Campo	Descrição	Início	Final	Tipo	Tam.	Dec.
RE-CODIGO	Código do Erro	1	2	Num	2
PIPE-E01	Delimitador	3	3	Alfa	1
RE-MENS	Mensagem para PDV	4	23	Alfa	20
PIPE-E02	Delimitador	24	24	Alfa	1
RE-MENS-ERRO	Mensagem de Erro	25	74	Alfa	50
PIPE-E03	Delimitador	75	75	Alfa	1
RE-NOME	Nome do Cliente	76	115	Alfa	40
PIPE-E04	Delimitador	116	116	Alfa	1
RE-SEQUENCIA	Número da Sequência	117	121	Alfa	5
PIPE-E05	Delimitador	122	122	Alfa	1
PIPE-E06	Delimitador	123	123	Alfa	1

Layout do Retorno de Aprovação ( Retaguarda  PDV )

Campo	Descrição	Início	Final	Tipo	Tam.	Dec.
RT-CODIGO	Código de retorno	1	2	Num	2
PIPE-R01	Delimitador	3	3	Alfa	1
RT-AUTORIZ	Número da autorização	4	12	Num	9
PIPE-R02	Delimitador	13	13	Alfa	1
RT-SALDO	Saldo disponível	14	30	Num	17	2
PIPE-R03	Delimitador	31	31	Alfa	1
RT-SINAL	Sinal do saldo disponível	32	32	Alfa	1
PIPE-R04	Delimitador	33	33	Alfa	1
RT-NOME	Nome do cliente	34	73	Alfa	40
PIPE-R05	Delimitador	74	74	Alfa	1
RT-CPF	C.P.F. do cliente	75	88	Num	14
PIPE-R06	Delimitador	89	89	Alfa	1
RT-RG	R.G. do cliente	90	104	Alfa	15
PIPE-R07	Delimitador	105	105	Alfa	1
RT-FONE	Telefone do cliente	106	116	Alfa	11
PIPE-R08	Delimitador	117	117	Alfa	1
RT-ENDERECO	Endereço do cliente	118	157	Alfa	40
PIPE-R09	Delimitador	158	158	Alfa	1
RT-NUM	Número do endereço do cliente	159	163	Num	5
PIPE-R10	Delimitador	164	164	Alfa	1
RT-COMPLE	Complemento do endereço do cliente	165	184	Alfa	20
PIPE-R11	Delimitador	185	185	Alfa	1
RT-SEQUENCIA	Número de sequência do PDV	186	190	Num	5
PIPE-R12	Delimitador	191	191	Alfa	1
RT-SITU-CLIE	Situação do Cliente	192	193	Num	2
PIPE-R13	Delimitador	194	194	Alfa	1
RT-TIPO-CLIE	Tipo de Cliente	195	196	Num	2
PIPE-R14	Delimitador	197	197	Alfa	1
RT-PONTOS-DISP	Pontos disponíveis dos clientes	198	204	Num	7
PIPE-R15	Delimitador	205	205	Alfa	1
RT-EVENTO-01	Se a data de nascimento do cliente estiver na semana gravar 01 se não gravar 00	206	207	Num	2
PIPE-R16	Delimitador	208	208	Alfa	1
RT-EVENTO-02	Se a data de nascimento do cônjuge do cliente estiver na semana gravar 01, se a data de nascimento de qualquer dependente do cliente estiver na semana gravar 02 se não gravar 00	209	210	Num	2
PIPE-R17	Delimitador	211	211	Alfa	1
RT-EVENTO-03	Premiação	212	213	Num	2
PIPE-R18	Delimitador	214	214	Alfa	1
RT-PONTO-EXTRA-1	Ponto Extra – Por período de compra	215	221	Num	7
PIPE-R19	Delimitador	222	222	Alfa	1
RT-PONTO-EXTRA-2	Ponto Extra – Por estabelecimento de compra	223	229	Num	7
PIPE-R20	Delimitador	230	230	Alfa	1
RT-MENSAGEM	Espaço para qualquer tipo de mensagem que a retaguarda deseje enviar para PDV sobre o cliente	231	260	Alfa	30
PIPE-R21	Delimitador	261	261	Alfa	1
RT-CATEGORIA	Categoria do Cliente – Informa o tipo de cliente. Se for funcionário será = 1.	262	263	Num	2
PIPE-R22	Delimitador	264	264	Alfa	1
RT-DIAS-CHEQUE	Número Dias Cheque Pré	265	267	Num	3
PIPE-R23	Delimitador	268	268	Alfa	1
RT-NOME-EMPR	Nome Empresa Conveniada	269	298	Alfa	30
PIPE-R24	Delimitador	299	299	Alfa	1
RT- COD CONVENIO	Código do convênio	300	303	Num	3
PIPE-R25	Delimitador	304	304	Alfa	1
RT-SENHA	Senha	305	315	Alfa	10
PIPE-R26	Delimitador	317	317	Alfa	1
RT-CARNET	Número do carnê	318	319	Num	1
PIPE-R27	Delimitador	321	321	Alfa	1
RT-PARCELA	Número da parcela do carnê	323	324	Num	2
PIPE-R28	Delimitador	325	325	Alfa	1
RT-VALOR	Valor parcela	326	343	Num	17	2
PIPE-R29	Delimitador	344	344	Alfa	1
RT-VENCIMENTO	Data vencimento parcela	345	353	Num	8
PIPE-R30	Delimitador	354	354	Num	1
RT-CH-DEVOL	Ocorrência de Cheques Devolvidos	355	355	Alfa	1	S/N
PIPE-R31	Delimitador	356	356	Alfa	1
RT-CH-QT-COMP	Quantidade de Cheques Compensados	357	363	Num	6
PIPE-R31	Delimitador	364	364	Alfa	1
PIPE-R32	Delimitador	365	365	Alfa	1

Árvore de páginas

Manual de Interface de Comunicação PDV / Listener