Esta operação permite que a automação comercial utilize o Pin Pad para realizar a captura estruturada e segura de informações necessárias ao fluxo da aplicação, por meio da exibição de interfaces interativas, como menus de seleção e telas de entrada de dados, possibilitando que o portador faça escolhas ou forneça informações de forma padronizada, orientada e adequada ao contexto operacional.

👍
Esta operação é utilizada exclusivamente para a comunicação entre a automação comercial e o Pin Pad com o objetivo de capturar e retornar dados informados pelo portador. Não há processamento transacional associado a essa funcionalidade.

Entre as principais capacidades da operação, destacam-se:

Criação e exibição de menus para navegação e seleção de opções pelo portador;
Captura de dados alfanuméricos ou numéricos diretamente no Pin Pad;
Coleta de informações específicas, como CPF, CNPJ, datas, número de telefone, entre outros;
Padronização da entrada de dados sensíveis, garantindo consistência e melhor experiência do usuário;
Suporte à construção de fluxos interativos customizados definidos pela automação.

❗️
Nem o Pin Pad nem a biblioteca Client Conecta realizam validações de conteúdo dos dados capturados como, por exemplo, verificação de dígitos de CPF ou CNPJ. Toda e qualquer validação, consistência ou tratamento das informações coletadas é de responsabilidade exclusiva da automação comercial.

Parâmetros de entrada

Campo	Tipo	Formato	Presença	Descrição
Oper	string	N..3	M	Código da operação a ser realizada: fixo `"9"` (`CFL_OPER_PPRECEIVE`).
PPOper	string	N2	M	Esse campo determina qual dado será capturado no pinpad. A operação do pinpad, definida na tabela PPOper, indica qual informação deverá ser coletada.
PPMenuTitle	string	A...63	O	Título do menu, obrigatório para PPOper igual a zero (`0`).
PPMenuItemsList	string	A24	O	Lista de strings (array) com no máximo 20 itens, obrigatório para PPOper igual a zero (`0`).
TimeOut	string	N02	M	TimeOut da operação.

Mensagem de notificação recebida na callback da operação

Não há.

Dados de resposta recebido na callback da operação

Campo	Tipo	Formato	Presença	Descrição
`Oper`	string	N..3	ME	Código da operação a ser realizada: fixo "9" (`CFL_OPER_PPRECEIVE`).
`Code`	string	N..2	M	Código de identificação do conteúdo do JSON enviado na função de callback: fixo "0", indicando que o JSON contém os dados de resposta da operação realizada.
`PPOper`	string	N02	ME	Para esta operação, consulte abaixo a tabela PPOper.
`PPDataOutput`	string	A..32	O	Para valores de `PPOper` maiores que zero, este campo retorna a informação coletada no Pin Pad.
`PPMenuItemSelect`	string	N02	O	Item de menu selecionado. Este campo é retornado quando o valor de `PPOper` é igual a zero.

Tabela PPOper

Cada valor do campo PPOper deve ser enviado por meio de uma string no formato JSON, contendo os campos descritos a seguir:

Valor	Mensagem do Campo
0	Menu (Campos específicos para essa operação)
1	DIGITE O DDD
2	REDIGITE O DDD
3	DIGITE O TELEFONE
4	REDIGITE O TELEFONE
5	DIGITE DDD+TELEFONE
6	REDIGITE DDD+TELEFONE
7	DIGITE O CPF
8	REDIGITE O CPF
9	DIGITE O RG
10	REDIGITE O RG
11	DIGITE OS 4 ÚLTIMOS DÍGITOS
12	DIGITE CÓDIGO DE SEGURANÇA
13	DIGITE O CNPJ
14	REDIGITE O CNPJ
15	DIGITE A DATA (DDMMAAAA)
16	DIGITE A DATA (DDMMAA)
17	DIGITE A DATA (DDMM)
18	DIGITE O DIA (DD)
19	DIGITE O MÊS (MM)
20	DIGITE O ANO (AA)
21	DIGITE O ANO (AAAA)
22	DATA DE NASCIMENTO (DDMMAAAA)
23	DATA DE NASCIMENTO (DDMMAA)
24	DATA DE NASCIMENTO (DDMM)
25	DIA DO NASCIMENTO (DD)
26	MÊS DO NASCIMENTO (MM)
27	ANO DO NASCIMENTO (AA)
28	ANO DO NASCIMENTO (AAAA)
29	DIGITE IDENTIFICAÇÃO
30	CÓDIGO DE FIDELIDADE
31	NÚMERO DA MESA
32	QUANTIDADE DE PESSOAS
33	DIGITE QUANTIDADE
34	NÚMERO DA BOMBA
35	NÚMERO DA VAGA
36	NÚMERO DO GUICHÊ/CAIXA
37	CÓDIGO DO VENDEDOR
38	CÓDIGO DO GARÇOM
39	NOTA DO ATENDIMENTO
40	NÚMERO DA NOTA FISCAL
41	NÚMERO DA COMANDA
42	PLACA DO VEÍCULO
43	DIGITE QUILOMETRAGEM
44	QUILOMETRAGEM INICIAL
45	QUILOMETRAGEM FINAL
46	DIGITE PORCENTAGEM
47	PESQUISA DE SATISFAÇÃO (0 a 10)
48	AVALIE ATENDIMENTO (0 a 10)
49	DIGITE O TOKEN
50	DIGITE NÚMERO DO CARTÃO
51	NÚMERO DE PARCELAS
52	CÓDIGO DO PLANO
53	CÓDIGO DO PRODUTO

Retornos

Código	Descrição
`CFL_OK`	Operação realizada com sucesso.
`CFL_ERROR_INVCALL`	Operação não permitida no momento.
`CFL_ERROR_INVPARAM`	Parâmetros informados inválidos.

Exemplos de requisição e resposta

Captura de informações específicas

Requisição

{ 
"TimeOutCaptura": "30", 
"PPOper": "13", 
"Oper": "009" 
}

Resposta

{ 
"Oper": "009", 
"Code": "00", 
"PPOper": "13", 
"PPDaraOutput": "A3YN381R000106", 
}

Menu personalizado

Requisição

{ 
"Oper": "009", 
"PPOper": "00", 
"Oper": "009" 
"PPMenuTitle": "Titulo Menu" 
"PPMenuItensList": ["Item1","Item2","Item3"] 
"TimeOut": "30" 
}

Resposta

{ 
"Oper": "009", 
"Code": "00", 
"PPOper": "00", 
"PPMenuItemSelec": "02", 
}