Configuração do conector CieloEcommerce
Configure o conector para transacionar online.
- Acesse o painel administrativo da sua loja VTEX:
https://nomedaloja.myvtex.com/admin
- Clique em Configurações da loja > Provedores;
- Clique em Novo provedor:
- Pesquise por "CieloEcommerce" e selecione o conector;

- Insira os dados da sua conta Cielo:
- Chave de Aplicação: seu
Merchant ID
; - Token de aplicação: seu
Access Token
.
Esses dados estão disponíveis no Portal de Desenvolvedores da Cielo. Veja como obter as credenciais em Criação das credenciais.
- Em Nome, insira um nome que faça referência à Cielo, para facilitar sua localização no futuro.
Exemplos de nome da afiliação
Exemplo | Definição |
---|---|
CieloEcommerce - Ticket | Afiliação que usa Ticket como provedor. |
CieloEcommerce - Cielo30 c/ 3DS c/ SPLIT | Afiliação que usa Cielo30 (Gateway de Pagamento) como o provedor, autentica com 3DS (se compatível) e realizar Split de Pagamento (se compatível). |
- Escolha se deseja ativar o modo teste;
- Ative o split de recebíveis se quiser dividir os valores entre diferentes partes. Depois, defina quem será responsável pelas tarifas e estornos:
Importante
A Cielo não permite pagamento com dois cartões diferentes na mesma compra.
- Preencha os campos conforme indicado na tabela abaixo:
Se o seu contrato é para vários provedores, sua integração será Gateway de Pagamento.
Caso o seu contrato seja somente com a Cielo, sua integração é Cielo.
Campo | Descrição |
---|---|
Chave de aplicação | Insira o MerchantID. |
Token de aplicação | Insira o MerchantKey. |
Nome | Insira o nome identificador da afiliação. |
Integration | Selecione Adquirência se a sua integração atual é com a API E-commerce Cielo. Selecione Gateway se a sua integração atual é para utilização de outros provedores via Gateway de Pagamento. |
Provider | Selecione o provedor que deseja configurar a afiliação conforme o tipo de pagamento. Exemplo: se você usa Bradesco para boletos e Cielo para cartões e Pix, crie uma afiliação para cada provedor. - Use o provedor Simulado para testar a integração antes de ir ao ar.; - O provedor Cielo deve ser configurado para Integração Adquirência; - O provedor Cielo30 deve ser configurado para Integração Gateway de Pagamento. |
DaysToInvoiceCancel | Para pagamentos via Boleto Bancário não pagos, selecione quantos dias corridos após o vencimento você gostaria que a transação seja cancelada. "Not defined" utiliza o padrão de tempo de 30 dias corridos. |
IsSplit | Insira “Sim” ou “Não” se deseja utilizar o Split de pagamentos. Disponível para os tipos de pagamento crédito, débito e boleto. |
useCieloMDR | Se usar Split, escolha: - True: usa a taxa cadastrada na Cielo; - False: zera a taxa para o seller. Se não usar o Split de Pagamentos, selecione Not Defined. |
UseMPI | Insira “Sim” ou “Não” se deseja utilizar a Autenticação 3DS 2.2. Este campo é obrigatório para o tipo de pagamento débito. |
MpiClientId | ID do MPI, disponibilizado para a loja pela Cielo. Campo obrigatório para transações com autenticação 3DS 2.2e DataOnly. |
MpiClientSecret | Chave secreta do MPI, disponibilizada para a loja pela Cielo. Campo obrigatório para transações com autenticação 3DS 2.2 e DataOnly |
MpiMerchantName | Nome da loja, disponibilizado pela Cielo. Campo obrigatório para transações com autenticação 3DS 2.2 e DataOnly |
MpiMCC | Merchant Category Code da loja, disponibilizado pela Cielo. Campo obrigatório para transações com autenticação 3DS 2.2 e DataOnly |
MpiEstablishmentCode | Código de estabelecimento da loja, disponibilizado pela Cielo. Campo obrigatório para transações com autenticação 3DS 2.2 e DataOnly |
DataOnly | Para transacionar com 3DS DataOnly, ou seja sem desafio de autenticação, com chargeback por conta da loja, selecione True. Para transacionar usando o 3DS para autenticação, selecione False. Se não utilizar o 3DS, selecione Not Defined Campo obrigatório para transações com autenticação 3DS 2.2 e DataOnly Para usar DataOnly, é necessário configurar todos os campos obrigatórios para autenticação 3DS. |
SoftDescriptor | Texto que aparecerá na fatura do comprador junto ao nome da loja. Permite no máximo 13 caracteres e não permite caracteres especiais. |
UseAntifraudSolution | Selecione qual opção de Antifraude será usada: Without Antifraud: para não usar Antifraude; Cielo: para usar Antifraude integrado a Cielo; VTEX: para usar Antifraude apartado pela VTEX. |
AntifraudProvider | Selecione o provedor de Antifraude escolhido, caso tenha contratado o serviço com o comercial do Gateway de Pagamento ou da Cielo. |
Antifraud | Selecione o fluxo utilizado pelo serviço de antifraude: podendo optar pelo fluxo de análise AnalyseFirst: análise de fraude antes da transação ser autorizada; AuthorizeFirst: análise de fraude depois da transação ser autorizada. |
AntifraudSequenceCriteria | Selecione a sequência do fluxo de antifraude de acordo com a escolha da análise: - Caso o fluxo escolhido tenha sido AuthorizeFirst, a loja pode optar por fazer a análise de fraude sempre (Always) ou somente quando a transação for autorizada (On Success). - Caso o fluxo escolhido tenha sido AnalyseFirst, a sequência sempre será Always. |
CaptureOnLowRisk | - Caso não utilize o Antifraude integrado, selecione Not Defined; - Caso utilize Split de Pagamentos, selecione False; - Selecione True para capturar automaticamente transações de baixo risco. Para isso, o campo Antifraud obrigatoriamente deverá ser configurado como AuthorizeFirst.Nos casos de revisão manual, a captura será feita automaticamente assim que recebermos a notificação de que ela foi aceita pelo provedor. |
VoidOnHighRisk | - Caso não utilize o Antifraude integrado, selecione Not Defined; - Caso utilize Split de Pagamentos, selecione False; - Selecione True para cancelar automaticamente transações de alto risco. Para isso, o campo Antifraud obrigatoriamente deverá ser configurado como AuthorizeFirst.Nos casos de revisão manual, a captura será feita automaticamente assim que recebermos a notificação de que ela foi aceita pelo provedor. |
CustomMdds | Este campo é destinado exclusivamente a lojas que utilizam nosso Antifraude Integrado através do provedor Cybersource. Ele deve ser usado para o envio de MDDs personalizados. Para configurá-lo, utilize a regra {Número}:{Valor}, onde {Número} deve ser substituído pelo número do MDD personalizado e {Valor} pelo nome do campo descritivo, conforme encontrado nesta documentação. Os valores devem ser separados por dois pontos ":", como no exemplo: 85:shopperinteraction Para enviar mais de um dado personalizado, siga o mesmo padrão, separando cada par {Número}:{Valor} por vírgula ",", como no exemplo: 85:shopperinteraction,86:currency *Importante: erros na grafia do campo não impedem a transação de ocorrer, mas também não serão enviados para a Cybersource. |
Captura | Tempo em horas em que será enviada a solicitação de captura. Se escolher Padrão ou Desativado, o pagamento será capturado automaticamente após quatro dias. Se escolher Imediatamente, a captura será feita logo após a autorização. O tempo máximo de captura é quatro dias (96 horas). Caso você utilize Antifraude para análises em compras de cartão de crédito, a captura respeitará o tempo da análise de fraude e somente será realizada após aprovação pelo provedor. |
UseVerifyCard | Selecione para utilizar o serviço de VerifyCard. Antes de configurar, confira se essa funcionalidade está habilitada em sua loja/EC. |
AcceptInternationalCard | Se usar VerifyCard, escolha se a loja aceitará cartões internacionais. |
AcceptPrepaidCard | Se usar VerifyCard, escolha se a loja aceitará cartões pré-pagos. |
SaveCard | O conector VTEX não possui a funcionalidade Cartão Protegido. Este campo está desabilitado. |
CancelRefundType | Permite que a loja escolha o fluxo de cancelamento/estorno de pedidos: - Automático sempre que possível: autoriza o cancelamento e estorno de forma automática (fluxo padrão); - Manual de acordo com a loja (notificação por e-mail): todos os pedidos de cancelamento e estorno não são autorizados de forma automática e a loja é notificado via e-mail. |
CieloLIOClientId | Campo configurado apenas para a utilização do SalesApp. Caso use o conector exclusivamente para e-commerce, esse campo deverá ficar em branco. |
*O preenchimento dos campos relacionados ao MPI é opcional; você pode escolher preencher os dados de MPI e deixar a opção UseMpi desativada ("No") e, mais tarde, caso deseje ativar o 3DS para esta afiliação, apenas altere a opção UseMpi para "Yes".
- Clique em Salvar.
Após salvar, um alerta será exibido para baixar o aplicativo. Instale-o para garantir que tudo funcione corretamente e que as atualizações sejam automáticas.
Updated about 17 hours ago