Glossário

Este glossário reúne os principais termos utilizados no ecossistema de desenvolvimento da API única de Cancelamento. Ele foi criado para facilitar a compreensão de conceitos técnicos e operacionais, promovendo uma integração mais eficiente com nossas soluções. Consulte-o sempre que tiver dúvidas sobre nomenclaturas ou funcionalidades.

Termo	Descrição
Cancelamento	Processo de estorno de uma venda já autorizada, podendo ser total ou parcial.
Carta de Cancelamento	Documento gerado após a efetivação do cancelamento da transação, disponível de forma unitária ou em lote.
POS (Point of Sale)	Terminal físico utilizado para capturar transações presenciais com cartão.
TEF (Transferência Eletrônica de Fundos)	Solução integrada ao sistema do varejista para captura de pagamentos no ponto de venda.
E-commerce	Canal de captura de pagamentos realizados em lojas virtuais e aplicativos.
Client ID	Identificador único do cliente utilizado para autenticação na API.
Client Secret	Chave confidencial associada ao Client ID, utilizada para obtenção do token de acesso.
Access Token	Token temporário utilizado para autenticar chamadas à API, obtido via OAuth 2.0.
OAuth 2.0	Protocolo de autenticação utilizado para controle de acesso à API.
Client Credentials Flow	Fluxo de autenticação OAuth 2.0 em que o sistema se autentica usando Client ID e Client Secret.
MTLS (Mutual TLS)	Mecanismo de segurança que exige certificado digital do cliente e do servidor para comunicação.
Certificado MTLS	Certificado digital assinado pela Cielo, obrigatório para consumo da API.
CSR (Certificate Signing Request)	Arquivo contendo a chave pública enviado para assinatura do certificado MTLS.
Ambiente de Homologação (HML)	Ambiente de testes utilizado para validação da integração.
Ambiente de Produção (PRD)	Ambiente oficial para processamento de transações reais.
Merchant ID (EC)	Identificador do Estabelecimento Comercial na Cielo.
Estabelecimento Comercial (EC)	Empresa cadastrada na Cielo responsável pela venda.
Raiz de CNPJ	Base do CNPJ que agrupa múltiplos estabelecimentos sob a mesma credencial.
Authorization Code	Código retornado na autorização da venda, usado para cancelamento e consultas.
NSU (Número Sequencial Único)	Identificador único da transação gerado no momento da captura.
Transaction ID	Identificador da transação, especialmente utilizado em vendas de e-commerce.
Refund	Termo utilizado pela API para representar um cancelamento de venda.
Refund ID	Identificador do lote de solicitações de cancelamento.
Control ID	Identificador único de um cancelamento dentro de um lote.
Refund Amount	Valor solicitado para cancelamento, podendo ser parcial ou total.
Sale Amount	Valor original da venda realizada.
Currency	Moeda utilizada na transação; aceita apenas BRL.
Endpoint	URL que representa um serviço disponível na API.
Request	Requisição enviada pelo cliente para a API.
Response	Retorno da API após o processamento da requisição.
Batch	Processamento em lote utilizado na efetivação dos cancelamentos.
Pending	Status que indica que a solicitação foi recebida e está aguardando processamento.
Rejected	Status que indica que o cancelamento foi recusado por regras de negócio.
Done	Status que indica que o cancelamento foi efetivado e liquidado com sucesso.
Failed	Status que indica falha de comunicação ou erro no processamento.
Detail	Objeto que detalha códigos e mensagens de erro em casos de rejeição ou falha.
Código de Rejeição	Código numérico que identifica o motivo da recusa do cancelamento.
Mensagem de Erro	Descrição textual do motivo da rejeição ou falha.
Cancelamento Unitário	Cancelamento realizado para uma única venda.
Cancelamento em Lote	Cancelamento realizado para múltiplas vendas em uma única requisição.
Consulta de Cancelamento	Operação para verificar o status e detalhes de cancelamentos solicitados.
Paginação	Mecanismo para dividir resultados de consulta em páginas.
Timeout	Falha de comunicação que pode exigir consulta posterior do cancelamento.