Operação responsável pelo cadastro ou atualização cadastral de estabelecimentos na plataforma Cielo Conecta.

Sua finalidade é registrar, configurar ou atualizar as informações do estabelecimento, permitindo a realização de transações de pagamento e demais funcionalidades da solução.

O Client Conecta identifica automaticamente se a operação corresponde a um novo cadastro ou a uma atualização cadastral, não sendo necessário implementar lógica adicional para essa distinção.

Para a execução dessa operação, todos os parâmetros mandatórios devem ser informados, garantindo a consistência das informações processadas.

Em operações de atualização cadastral, os campos LogicalNumber e MerchantAcquirerId não são obrigatórios quando não houver necessidade de alteração. Caso seja necessário atualizar, ambos devem ser explicitamente informados na requisição.

Durante a operação de inicialização da biblioteca, caso o Cnpj informado não seja localizado ou o estabelecimento não esteja cadastrado, será retornado o erro CFL_ERROR_MCH_NFOUND. Esse retorno indica a necessidade de executar previamente esta operação antes de qualquer operação transacional.

Somente após a conclusão bem sucedida do cadastro do estabelecimento é que a biblioteca estará apta a prosseguir com a inicialização e demais funcionalidades.

⚠️
Atenção
Recomenda se que, antes de realizar o cadastro ou atualização de um estabelecimento, o cliente entre em contato com o time de Integração da Cielo para validação das informações cadastrais.
Pontos críticos:

LogicalNumber: deve ser solicitado previamente. É um identificador único por CNPJ, definido mediante validação e direcionamento da Cielo.;

Mcc (Merchant Category Code): deve ser corretamente configurado;

MerchantAcquirerId: deve ser informado conforme orientação da Cielo . Este identificador vincula o estabelecimento à plataforma de aquirencia e é indispensável para a atualização correta das informações cadastrais.

Regras e comportamentos da operação

Atualização cadastral

Quando a operação for utilizada exclusivamente para atualização de dados cadastrais, como endereço, CNPJ, razão social ou contatos, não é obrigatória a informação dos parâmetros LogicalNumber e MerchantAcquirerId.

Caso seja necessário atualizar esses identificadores, ambos devem ser informados para garantir a correta atualização do vínculo com a plataforma Cielo Conecta.

Cadastro e validação de endereço

O Cielo Conecta realiza validações rigorosas sobre os dados de endereço, especialmente o campo CEP (ZipCode), que é a principal referência para validação.

O ZipCode é obrigatório e deve ser válido;
Caso o ZipCode seja inválido, a operação é recusada;
O campo Street não é utilizado como critério de validação;
O logradouro é definido automaticamente com base no CEP;
Caso o valor informado em Street não corresponda ao CEP, ele será ignorado.

Na prática, o campo Street torna se opcional.

ℹ️
Importante
Sempre informar um ZipCode válido e consistente para garantir a correta definição do endereço.

Sincronização após cadastro

Após o cadastro do estabelecimento utilizando LogicalNumber, ocorre um processo de sincronização com a aquirencia, necessário para configurar corretamente o ambiente operacional.

Esse processo inclui:

Configuração de produtos e meios de pagamento;
Parâmetros operacionais do estabelecimento;
Comunicação com o Pin Pad.

⚠️
Atenção
Após o cadastro, é necessário aguardar aproximadamente um minuto antes de executar a inicialização da biblioteca.
A não observância pode resultar em falhas operacionais, indisponibilidade de pagamentos e inconsistências na primeira execução.

Parâmetros de entrada

Campo	Tipo	Formato	Obrigatório	Descrição
`Oper`	string	N..3	M	Código da operação: fixo "2" (`CFL_OPER_MERCHANT`).
`Address`	object			Endereço do estabelecimento.
`ZipCode`	string	N8	M	CEP do estabelecimento.
`Street`	string	A..120	O	Logradouro.
`Number`	string	A..9	M	Número do endereço.
`Complement`	string	A..120	O	Complemento.
`TradeName`	string	A..35	M	Nome fantasia.
`CompanyName`	string	A..35	M	Razão social.
`Email`	string	A..45	M	E mail do estabelecimento cadastrado no Cielo Conecta.
`PhoneNumber`	string	A..14	M	Telefone do estabelecimento.
`Mcc`	string	N4	M	Código MCC.
`SoftDescriptor`	string	A..13	O	Identificação de venda.
`DocumentNumber`	string	A..20	M	Número do documento.
`DocumentType`	string	A..4	M	Tipo do documento. Valor aceito: CNPJ.
`TefConfig`	object
`LogicalNumber`	string	N9	M	Número lógico do estabelecimento.
`MerchantAcquirerId`	string	N15	O	Código na adquirência. Quando o conteúdo for menor que quinze (15) caracteres, deve ter preenchimento de zeros (0) a esquerda. Ex.: "MerchantAcquirerId": "000000789012345"

Exemplo de requisição

{ 
    "Address": { 
        "ZipCode": "58015260", 
        "Street": "Alameda Xingu", 
        "Number": "512", 
        "Complement": "Comercial" 
    }, 
    "TradeName": "Client Conecta Teste11", 
    "CompanyName": "Client Conecta Teste11", 
    "Email": "[email protected]", 
    "PhoneNumber": "11900000000", 
    "Mcc": 5999,    //numero especifico por tipo de estabelicimento (tabela ABECs) 
    "SoftDescriptor": "Pentest",//identificação de venda no estabelicimento- notificação da venda (campo de 13 char) 
    "DocumentNumber": "81752158000110", 
    "DocumentType": "Cnpj" 
    , 
    "TefConfig": { 
        "LogicalNumber": "42001001-X"//clietne deve receber esta informação do comercial Cielo.  
    } 
}

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

Não há.

Dados de resposta recebido na callback da operação

Não há.

Retornos

Código	Descrição
`CFL_OK`	Cadastro realizado com sucesso.
`CFL_ERROR_INVCALL`	Operação não permitida no momento.
`CFL_ERROR_INVOPER`	Operação inválida ou não reconhecida.
`CFL_ERROR_MCH_NFOUND`	Estabelecimento não cadastrado.
`CFL_ERROR_NETWORK`	Erro na comunicação com Cielo Conecta.
`CFL_ERROR_MCH_UPDATE`	Erro na atualização cadastral.
`CFL_ERROR_TEFCONFIG`	Erro na atualização de `LogicalNumber` e `MerchantAcquirerId`.