Afiliação de Pagamento

1. Acessando o painel VTEX

Acesse o painel ADMIN VTEX (https://_nomedaloja_.myvtex.com/admin) e comece a navegação por Configurações da loja > Pagamentos > Configurações > Afiliações de gateways > +

Tela de configuração de Afiliaões de pagamento

2. Selecionando o conector

Apenas o conector CieloEcommerce receberá manutenção e atualização. Não será possível a configuração com outros conectores. Veja como migrar entre conectores.

⚠️

Atenção

O número do pedido que é exibido na tela do comprador é registrado na VTEX como informação orderId para o conector CieloEcommerce e como reference para o conector Braspag. Portanto, preste atenção ao migrar de um conector para o outro.

Selecione o conector CieloEcommerce e insira as informações conforme recebidas após a contratação da solução.

Tela de configuração para selecionar o conector CieloEcommerce

Veja as diferenças entre conectores legados e o novo conector CieloEcommerce.


3. Escolhendo o nome da afiliação

Insira o Nome da Afiliação:

É preciso configurar o mesmo conector com cada tipo de pagamento desejado, por isso preste atenção ao Nome da Afiliação utilizado. Sugerimos incluir no nome o provedor e meio de pagamento configurado, para facilitar o reconhecimento. Veja o exemplo:

Tela de configuração do Nome da Afiliação

Exemplos de Nome da Afiliação

ExemploDefinição
CieloEcommerce - AleloO título relembra que qualquer condição de pagamento que utilizar essa afiliação vai utilizar Alelo como o provider.
CieloEcommerce - Cielo30 c/ 3DS c/ SPLITO título relembra que qualquer condição de pagamento que utilizar essa afiliação vai utilizar Cielo30 como o provider, fazer a autenticação com 3DS (se compatível) e realizar SPLIT de pagamento (se compatível).

4. Preenchendo dados necessários

Preencha os campos com os dados requisitados. A imagem a seguir é um exemplo do preenchimento para o conector CieloEcommerce; consulte a tabela Dados da Afiliação para verificar quais são os campos correspondentes ao conector desejado.

Se o seu contrato é para vários provedores, sua integração será Gateway. Caso o seu contrato seja somente com a Cielo, sua integração é Cielo.

Tela de configuração do conector
Tela de configuração do conector
Tela de configuração do conector

Dados da Afiliação

CampoDescrição
Chave de aplicaçãoInsira o MerchantID.
Token de aplicaçãoInsira o MerchantKey.
NomeInsira nome identificador da afiliação.
IntegrationSelecione Adquirência se a sua integração atual é diretamente com a Cielo. Selecione Gateway se a sua integração atual é para utilização de outros provedores via Pagador (Gateway Braspag).
ProviderSelecione o provedor que deseja configurar a afiliação conforme o tipo de pagamento. Exemplo: Se o seu provedor de Boleto é o Bradesco e o seu provedor de Crédito, Débito e Pix é o Cielo será necessário adicionar duas afiliações.
O provedor Simulado deve ser utilizado para transações de teste.
O provedor Cielo deve ser configurado para Integração Adquirência.
O provedor Cielo30 deve ser configurado para Integração Gateway.
IsSplitInsira “Sim” ou “Não” se deseja utilizar o SPLIT de pagamentos. Disponível para os tipos de pagamento crédito, débito e boleto.
useCieloMDRSe usar o Split de Pagamentos, você pode optar por calcular a taxa de MDR com base no cadastro realizado na Cielo selecionando True, ou por zerar a taxa de MDR do seller selecionando False.
Se não usar o Split de Pagamentos, selecione Not Defined.
UseMPIInsira “Sim” ou “Não” se deseja utilizar a Autenticação 3DS 2.0. Este campo é obrigatório para o tipo de pagamento débito.
MpiClientIdID do MPI, disponibilizado para o cliente pela Cielo. Campo relacionado à autenticação 3DS *.
MpiClientSecretChave secreta do MPI, disponibilizada para o cliente pela Cielo. Campo relacionado à autenticação 3DS *.
MpiMerchantNameNome da loja, disponibilizado pela Cielo. Campo relacionado à autenticação 3DS *.
MpiMCCMerchant Category Code da loja, disponibilizado pela Cielo. Campo relacionado à autenticação 3DS *.
MpiEstablishmentCodeCódigo de estabelecimento da loja, disponibilizado pela Cielo. Campo relacionado à autenticação 3DS *.
SoftDescriptorValor que será concatenado com o valor de cadastro na adquirente para identificação na fatura. Permite no máximo 13 caracteres.
AntifraudProvider[Em homologação]
Selecionar o provedor de Antifraude escolhido, caso tenha contratado o serviço com o comercial do Gateway ou da Cielo.
Antifraud[Em homologação]
Selecionar o fluxo utilizado pelo serviço de antifraude, podendo optar pelo fluxo de análise antes da transação ser autorizada, AnalyseFirst, ou após a autorização, AuthorizeFirst.
AntifraudSequenceCriteria[Em homologação]
Selecionar a sequência do fluxo de antifraude de acordo com a escolha da análise:

- Caso o fluxo escolhido tenha sido AuthorizeFirst, o lojista pode optar por sequenciar sempre, Always ou somente em casos de sucesso, On Success.
- Caso o fluxo escolhido tenha sido AnalyseFirst, a sequência sempre será Always.
CaptureOnLowRiskCaso você não utilize o Antifraude integrado, selecione Not Defined.

Para selecionar captura automática da transação cuja análise de fraude determina que o risco é baixo/seguro, selecione True. Neste cenário, 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.
VoidOnHighRiskCaso você não utilize o Antifraude integrado, selecione Not Defined.

Para selecionar o cancelamento automático da transação cuja análise de fraude determina que o risco é alto/comprometida, selecione True. Neste cenário, o campo Antifraud obrigatoriamente deverá ser configurado como AuthorizeFirst.

*Nos casos de revisão manual, o cancelamento será feito automaticamente assim que recebermos a notificação de que ela foi rejeitada pelo provedor.
CapturaTempo em horas em que será enviada a solicitação de captura.
Em Padrão ou Desativado, a captura será realizada 4 dias após a autorização.
Em Imediatamente a captura será realizada imediatamente após a autorização.

*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.
UseVerifyCardSelecionar caso haja interesse em utilizar o serviço de VerifyCard.
Antes de configurar, confira se essa funcionalidade está habilitada em sua loja/EC.
AcceptInternationalCard[Exige VerifyCard]
Selecionar se a loja aceitará cartões internacionais via VerifyCard.
AcceptPrepaidCard[Exige VerifyCard]
Selecionar se a loja aceitará cartões pré-pagos via VerifyCard.
SaveCardSelecionar caso a loja queira disponibilizar a opção de salvar cartão para futuras compras. Antes de configurar, confira se a funcionalidade Cartão Protegido está habilitada em sua loja/EC.
CancelRefundTypePermite que o lojista 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 o lojista é notificado via e-mail.
CieloLIOClientIdCampo 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".

Após salvar, ele irá aparecer na lista Processar com afiliação da tela de configuração da Condição de Pagamento.

⚠️

Ao concluir as instruções, um alerta aparecerá na página para que o aplicativo seja baixado. É importante instalar o aplicativo na VTEX para o seu funcionamento adequado e para que futuras atualizações ocorram de forma transparente.