Integração VTEX
A Cielo desenvolveu um conector na plataforma de e-commerce VTEX para realização do pagamento através das APIs de pagamento online da Cielo. A usabilidade da plataforma deve ser consultada no tutorial da VTEX. Abaixo reforçaremos as informações necessárias para utilização do conector.
Configuração
Para a configuração estar completa é preciso cadastrar Afiliação de pagamento para posteriormente vincular a uma Condição de pagamento.
Para mais informações, visite os artigos de suporte da VTEX: Cadastrar afiliações de gateway e Configurar condições de pagamento.
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 Transações > Pagamentos > Configurações > Afiliações de gateways > +
2. Selecionando o Conector
Apenas o conector CieloEcommerce receberá manutenção e atualização. Veja como migrar entre conectores.
Selecione o conector desejado e insira as informações conforme recebidas após a contratação da solução. Os conectores disponíveis são:
- Braspag;
- BraspagV2;
- CieloV3;
- CieloV4;
- CieloEcommerce.
Veja as diferenças entre conectores:
| Meios de Pagamento | Braspag | Braspag V2 | Cielo V3 | Cielo V4 | CieloEcommerce |
|---|---|---|---|---|---|
| Boleto | Gateway: - BancoDoBrasil2 - Bradesco2 |
Não se aplica | Adquirência: - BancoDoBrasil2 - Bradesco2 |
Não se aplica | Não se aplica |
| Boleto Registrado | Gateway: - BancoDoBrasil2 - Bradesco2 |
Não se aplica | Adquirência: - BancoDoBrasil2 - Bradesco2 |
Não se aplica | Adquirência: - Bradesco2 - BancoDoBrasil2 - BancoDoBrasil3 Gateway: - Bradesco2 - BancoDoBrasil2 - BancoDoBrasil3 - ItauShopline - Caixa2 - CitiBank2 - Santander2 |
| Crédito | Gateway: - Banorte - Redecard - Ditef - Amex 2P - PagosOnLine - PayVision - Sitef - GetNet - Sub1 - Credibanco - E-rede2 - E-rede - SafraPay |
Gateway: - Cielo30 - Rede2 |
Adquirência: - Cielo |
Adquirência: - Cielo |
Adquirência: - Cielo Gateway: - Cielo30 - Getnet - Rede2 - Safra2 - Sub1 - Banorte - Credibanco2 - Carrefour* - CredSystem* - Credz* - Dmcard* |
| Débito | Gateway: - Cielo3.0 - GetNet - Rede2 |
Gateway: - Cielo3.0 - Rede2 |
Gateway: - Cielo |
Gateway: - Cielo |
Adquirência: - Cielo Gateway: - Cielo30 - Getnet - Rede2 - Safra2 |
| Pix | Não se aplica | Não se aplica | Não se aplica | Não se aplica | Adquirência: - Bradesco2 - Cielo Gateway: - Cielo30 - Bradesco2 |
| Voucher | Não se aplica | Gateway: - Ticket |
Adquirência: - Alelo |
Não se aplica | Adquirência: - Alelo Gateway: - Ticket - Alelo |
*Bandeira própria
- A solução Antifraude Braspag é oferecida por todos os conectores.
- As soluções 3DS 2.0 e Split de Pagamentos são oferecidas apenas pelos conectores Braspag V2, Cielo V4 e 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:
Exemplos de Nome da Afiliação
| Exemplo | Definição |
|---|---|
| CieloEcommerce - Ticket | Nesse exemplo o título relembra que qualquer condição de pagamento que utilizar essa afiliação vai utilizar Ticket como o provider. |
| CieloEcommerce - Cielo30 c/ 3DS c/ SPLIT | Nesse exemplo o 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.
Dados da Afiliação
| Campo | Descrição | Conector |
|---|---|---|
| Nome da Afiliação | Insira nome identificador da afiliação. | Todos. |
| Application Key | Insira o MerchantID. | Todos. |
| Application Token | Insira o MerchantKey. | Todos. |
| Integration | Selecione Adquirência se o seu contrato é somente com a adquirência Cielo. Selecione Gateway se o seu contrato é para utilização de outros provedores. |
CieloEcommerce |
| Provider | Selecione 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çãoes de teste. O provedor Cielo deve ser configurado para Integração Adquirência. O provedor Cielo30 deve ser configurado para Integração Gateway. |
Todos. Obs. 1: Braspag e CieloV3 possuem o provedor listado em cada tipo de pagamento. Obs. 2: Cada conector possui uma lista de provedores aptos para seleção. |
| UseSPLIT | 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. | BraspagV2, CieloEcommerce e CieloV4. |
| UseMPI | Insira “Sim” ou “Não” se deseja utilizar a Autenticação 3DS 2.0. Este campo é obrigatório para o tipo de pagamento débito. | BraspagV2, CieloEcommerce e CieloV4. |
| MpiClientId | ID do MPI, disponibilizado para o cliente pela Cielo. Campo relacionado à autenticação 3DS**. | BraspagV2, CieloEcommerce e CieloV4. |
| MpiClientSecret | Chave secreta do MPI, disponibilizada para o cliente pela Cielo. Campo relacionado à autenticação 3DS**. | BraspagV2, CieloEcommerce e CieloV4. |
| MpiMerchantName | Nome da loja, disponibilizado pela Cielo. Campo relacionado à autenticação 3DS**. | BraspagV2, CieloEcommerce e CieloV4. |
| MpiMCC | Merchant Category Code da loja, disponibilizado pela Cielo. Campo relacionado à autenticação 3DS**. | BraspagV2, CieloEcommerce e CieloV4. |
| MpiEstablishmentCode | Código de estabelecimento da loja, disponibilizado pela Cielo. Campo relacionado à autenticação 3DS**. | BraspagV2, CieloEcommerce e CieloV4. |
| SoftDescriptor | Valor que será concatenado com o valor de cadastro na adquirente para identificação na fatura. Permite no máximo 13 caracteres. | CieloEcommerce. |
| Captura | Tempo em horas em que será enviada a solicitação de captura. Em Padrão ou Desativado, a captura será será realizada 4 dias após a autorização. Em Imediatamente a captura será realizada imeadiatamente após a autorização. Não configura Capture = ‘True’. | Braspag, CieloV3 e CieloEcommerce. |
| Alterar tempo máximo para captura automática | Tempo (em dias) em que a capatura deve ser solicitada. | Braspag e CieloV3. |
| Ativar Divisão e tempos de captura | Selecione Sim se for ativar divisão entre Marketplace e Seller. Selecione Não se não possuir divisão entre Marketplace e Seller. | BraspagV2, CieloEcommerce e CieloV4 |
| Responsabilidade pelas tarifas de pagamento. Essa configuração será enviada para o seu processador de pagamentos | Selecione Marketplace, Marketplace + Sellers ou Sellers. Só será exibido se Ativar Divisão estiver preenchido com “Sim”. | BraspagV2, CieloEcommerce e CieloV4 |
| Responsabilidade pelos estornos. Essa configuração será enviada para o seu processador de pagamentos | Selecione Marketplace ou Marketplace + Sellers ou Sellers. Só será exibido se Ativar Divisão estiver preenchido com “Sim”. | BraspagV2, CieloEcommerce e CieloV4 |
- 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 o conector, ele irá aparecer na lista Processar com afiliação da tela de configuração da Condição de Pagamento.
Condição de Pagamento
1. Adicionando Nova Condição de Pagamento
Acesse Transações > Configurações > Condições de Pagamento > +
2. Configurando o Tipo de Pagamento
Selecione o tipo de pagamento que deseja configurar e insira as informações necessárias:
| Campo | Descrição |
|---|---|
| Nome da Condição | Insira nome identificador da condição de pagamento. |
| Processar com a afiliação | Selecione a afiliação existente na lista conforme previamente cadastrada na seção Afiliação de Pagamento. |
| Usar solução antifraude | Esta opção apenas será exibida se houver Antifraude previamente cadastrado Afiliação de Pagamento. |
Da mesma forma que a Afiliação de Pagamento, é preciso configurar a condição de pagamento quantas vezes necessárias de acordo com o tipo de pagamento desejado, por isso fique atento ao Nome da Condição utilizada. O nome do conector é exibido e o tipo de pagamento também. Então sugerimos inserir somente as soluções que foram configuradas na afiliação selecionada.
Exemplos de Nome da Condição
| Exemplo | Definição |
|---|---|
| Ticket | Nesse exemplo o título relembra que a condição de pagamento vai utilizar a afiliação configurada com Ticket como provider. |
| Cielo30 c/ 3DS c/ SPLIT | Nesse exemplo o título relembra que qualquer condição de pagamento vai utilizar a afiliação configurada com Cielo30 como provider, fazer a autenticação com 3DS (se compatível) e realizará SPLIT de Pagamento (se compatível) |
Após essas duas etapas concluídas com todas as condições de pagamento criadas, as opções de pagamento serão exibidas na tela de checkout da loja.
Meios de Pagamento
Boleto
Selecione a Condição de Pagamento desejada e configure conforme o passo a passo em Condição de Pagamento.
Crédito
Selecione a Condição de Pagamento desejada e configure conforme o passo a passo em Condição de Pagamento.
Débito
Selecione a Condição de Pagamento desejada e configure conforme o passo a passo em Condição de Pagamento.
Pix
Selecione a Condição de Pagamento desejada e configure conforme o passo a passo em Condição de Pagamento.
Voucher
Este meio de pagamento deve seguir a seção de Pagamentos Customizados para que a opção seja exibida na Condição de Pagamento. Posteriormente, selecione a Condição de Pagamento desejada e configure conforme o passo a passo em Condição de Pagamento.
Pagamentos Customizados
Para configurar pagamentos customizados, acesse Transações > Configurações > Pagamentos Customizados > Cartão da Loja – Bandeira Própria > Configurar
Nesta seção configure os dados para Private Label, Ticket e Alelo:
| Campo | Descrição |
|---|---|
| Name | Valores Possíveis: Carrefour Credz CredSystem DMCard Ticket |
| Descrição | Valores Possíveis: Carrefour Credz CredSystem DMCard Ticket |
| Intervalos de BIN | 100000-999999 |
| Código de pagamento do adquirente | Valores Possíveis: 580 565 550 564 634 |
| Usar nome do titular do cartão | Sim |
| Quantidade de dígitos do CVV | [1]999 |
| Usar data de validade do cartão? | Não |
| Usar endereço de cobrança? | Não |
| Máscara do cartão | 9999 9999 9999 9999 |
| Validade do pagamento | Não |
| Autorizar automaticamente | Não |
| Ativar divisão de pagamento | Não |
3DS
As credenciais recebidas para utilização da solução devem ser inseridas conforme o tópico Afiliação de Pagamento. Caso não use a solução 3DS, selecione o campo UseMpi como “No” em Preenchendo os Dados Necessário.
Split de Pagamentos
Para que o Split seja utilizado corretamente, os sellers de um marketplace devem estar previamente cadastrados na plataforma VTEX e deve ser informado ao time de implantação os dados de cadastro da VTEX juntamente com o CNPJ. Caso essa informação seja editada na VTEX, o time Cielo deve ser informado dos novos dados.
Para ativação do recurso Split abra um chamado no suporte Cielo e informe ao time de implantação os dados de seller cadastrados na plataforma VTEX.
Para fazer o cadastro de um seller, acesse Marketplace > Sellers > Gerenciamento:
Antifraude
Para que as transações sejam validadas pelo Antifraude é necessário que o conector de Antifraude Braspag esteja configurado previamente em Afiliação de Pagamento antes da etapa de Condição de Pagamento.
Para configurar, acesse Transações > Configurações > Afiliações de gateways > +
Selecione o conector Braspag (Soluções Antifraude) e insira as informações conforme recebidas após a contratação das soluções desejadas.
| Campo | Descrição |
|---|---|
| Id do Merchant | Merchant ID do antifraude, disponibilizado pela Cielo. |
| FingerPrint_OrgId | Fingerprint Org ID, disponibilizado pela Cielo para validação na Cybersource. Indica o ambiente na Threatmetrix: Sandbox ou Produção. |
| FingerPrint_MerchantId | Fingerprint Merchant ID, disponibilizado pela Cielo para validação na Cybersource. Identificador da sua loja ou operação. É diferente do MerchantId. |
| Moeda | Selecionar a moeda da transação Brasil Real (BRL) |
| Versão de dados definidos da loja | Utilizar sempre Retail_V4 |
| Enviar transações autenticadas | Sim |
