> For the complete documentation index, see [llms.txt](https://docs.iopay.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iopay.com.br/products/modulos-para-ecommerce/modulos-para-opencart/checkout-transparente-para-opencart.md). # Checkout Transparente ## Introdução Aceite pagamentos através de cartões de crédito de várias bandeiras, boleto registrado e PIX (de qualquer banco). Através do módulo checkout transparente da IO, você obtém uma forma rápida e prática de integrar seu ecommerce com as APIs e tecnologias da IOPAY para processamento de transações on-line. A IOPAY conta ainda com duas opções em antifraude para que as suas vendas tenham a segurança adequada ao seu mercado. O checkout transparente da IO possui UX e UI aprimoradas para garantir maiores taxas de conversão além de permitir que o seu cliente faça pagamentos sem sair da sua loja ou fazer login em plataformas externas. ## Compatibilidade O módulo de checkout transparente para OpenCart, é homologado para instalações do OpenCart cuja versão: **`OpenCart 3.x.x`** ## Recursos * Análise antifraude com seguro contra fraude (plano opcional, consulte) * Análise antifraude com análise de comportamento de navegação * Processe pagamentos dentro do seu ecommerce de forma 100% transparente * Checkout otimizado para maior conversão de vendas * Receba Atualização do status das transações de forma automática (via webhooks) * Otimizado para OpenCart 3.x * Extensão segura e de acordo com o compliance PCI (Payment Card Industry) * Permita pagamentos com cartão de crédito em até 12x com as menores taxas do mercado * Aceite as 9 principais bandeiras de cartão do mundo * Aceite PIX com QRCode ou Copia e Cola em seu e-commerce e converta mais vendas ainda! * Gere boletos dentro da sua loja sem enviar o seu cliente para outro site * Processe cartões de crédito dentro da sua loja. Gere mais conversões ao não exigir que o cliente saia da sua loja para fazer login ou se cadastrar em alguma de pagamentos. * Módulo 100% responsivo e adequado à qualquer tela: smartphones, tablets e desktops * Módulo totalmente gratuito * Time de especialistas pronto e disponível sem custo para auxiliar nas suas integrações * Instalação simples e rápida * Suporte Premium #### Modalidades de pagamentos aceitas ![](/files/-MVwoA5eSMcouxzlYXeO) {% hint style="info" %} O tempo estimado para implementação desse tutorial é inferior a 10 minutos {% endhint %} ## Download & Instalação {% hint style="success" %} **Para baixar a última versão \[1.5.1]** do módulo "Checkout Transparente para OpenCart 3.x" , acesse\ \ {% endhint %} Após download, siga os passos: ### 1. Faça login na interface de administração do OpenCart Faça login na administração do OpenCart acessando /admin ### 2. Instalação do módulo **2.1** Dentro da plataforma administrativa do OpenCart, navegue no menu principal e clique na opção: "**Extensions > Installer**", conforme ilustrado abaixo: ![Menu principal da administração do OpenCart 3.x](/files/-MVwMZHyHltYBOfjQyep) **2.2** Clique em 'Upload' e selecione o arquivo compactado baixado para o seu computador no passo **1**\ ***Arquivo zip:** io-checkout-transparente.opencart.3.x.zip* ![](/files/-MVwNC_ljg2Xu_JGF0NH) \ **2.3** Aguarde o processo de instalação (alguns segundos) e verifique se o módulo foi instalado corretamente e é listado em 'Install History', conforme demonstrado na imagem abaixo: ![Instalação bem sucedida](/files/-MVwT7zhkzFAhxTqaRp4) ### 3. Custom Fields As transações processadas com IOPAY contam com sistema antifraude e para que a integração funcione corretamente precisamos inserir 4 campos customizados no OpenCart, pois o OpenCart não possui estes campos em sua instalação nativa. 1. CPF (*Customer*) 2. Telefone de Entrega (*Shipping*) 3. CPF (*Shipping*) 4. Número do endereço (Shipping) Antes de partirmos para as configurações do módulo checkout transparente certifique-se que a sua instalação do OpenCart contenha os 4 campos citados acima. Caso a sua instalação atual contenha campos similares aos citados acima, pule para o passe 4. Se a sua instalação não contém este campos, será necessário inseri-los e este é um processo simplificado e facilitado pelo recurso *Custom Fields* do OpenCart. Para adicionar os 4 Custom Fields necessários para o funcionamento do módulo checkout transparente, siga os passos descritos abaixo na seção 3.1 Custom Fields #### 3.1 Adicionando Custom Fields {% hint style="info" %} Caso o seu commerce já possua campos similares à: \ \ CPF (cliente), \ Telefone de entrega\ CPF (de quem receberá a entrega) \ Número do endereço pule para o passo 4 {% endhint %} Para a inserção de custom fields, acesse a opção 'Customers > Custom Fields' no menu principal da administração do OpenCart
![Menu principal da administração do OpenCart](/files/-MVwZ8kAD7lZ-iC4HgWy) \ Clique em "+" para inserir cada Custom Field. ![](/files/-MW0FUGqCAQ5pc8YGi-5) \ Confira abaixo como proceder para cada um dos três CustomFields: **1. CPF (Customer)** | **Opção** | Valor | | --------------------: | --------------------------------------------------------------------------------------------------------- | | **Custom Field Name** | CPF | | **Location** | account | | **Type** | Text | | **Value** | 000.000.000-00 | | **Validation** | /^(\[0-9]{3}.?\[0-9]{3}.?\[0-9]{3}-?\[0-9]{2}\|\[0-9]{2}.?\[0-9]{3}.?\[0-9]{3}\\/?\[0-9]{4}-?\[0-9]{2})$/ | | **Customer Group** | default (selecione os demais grupos de clientes, caso possua) | | **Required** | true | | **Status** | Enabled | | **Sort Order** | 3 | ![Demonstração da inserção para o Campo CPF (Customer)](/files/-MVw_5IbPJ7wsofIN6uU) Clique no botão salvar para efetivar a adição desse Custom Field. \ Agora, precisamos repetir o processo para a adição do segundo custom field exigido. Portanto, novamente clique na opção + Add New disponível na página principal da seção Customers > Custom Field para adicionar um novo campo. ![](/files/-MW0FUGqCAQ5pc8YGi-5) **2. Telefone de Entrega (Address)** | **Opção** | **Valor** | | --------------------- | ------------------------------------------------------------- | | **Custom Field Name** | Telefone de Entrega | | **Location** | Address | | **Type** | Text | | **Value** | (00)0000-0000 | | **Validation** | /(\\(?\d{2}\\)?\s)?(\d{4,5}\\-\d{4})$/ | | **Customer Group** | default (selecione os demais grupos de clientes, caso possua) | | **Required** | true (selecione os demais grupos de clientes, caso possua) | | **Status** | Enabled | | **Sort Order** | 10 | ![Demonstração para inserção do campo Telefone (endereço de entrega)](/files/-MVwdYKm0HLeMWki9UK6) Clique em Save para salvar esse campo.\ \ \ Agora partiremos para inserção o último custom field, para isso, clique novamente em + Add New, para adicionar um novo campo.
**3. CPF (Address)** | **Opção** | Valor | | --------------------- | --------------------------------------------------------------------------------------------------------- | | **Custom Field Name** | CPF (de quem receberá a entrega) | | **Location** | Address | | **Type** | Text | | **Value** | 000.000.000-00 | | **Validation** | /^(\[0-9]{3}.?\[0-9]{3}.?\[0-9]{3}-?\[0-9]{2}\|\[0-9]{2}.?\[0-9]{3}.?\[0-9]{3}\\/?\[0-9]{4}-?\[0-9]{2})$/ | | **Customer Group** | default (selecione os demais grupos de clientes, caso possua) | | **Required** | true (selecione os demais grupos de clientes, caso possua) | | **Status** | Enabled | | **Sort Order** | 1 | ![Inserção do campo customizado CPF (de quem receberá a entrega) localizado em "Address"' ](/files/-MW07qY35VQfb3nl20uN) **4. Número (Shipping)** * Por padrão, instalações do OpenCart não contam com campo separado para número do endereço. Dessa forma, precisamos adicionar o CustomField 'Numero' para que o cliente possa utilizá-lo para preenchimento correto do endereço e para que a integração com a IOPAY possa receber as informações necessárias. {% hint style="info" %} Caso, não deseje adicionar esse CustomField, selecione a opção: "Não usar campo separado para Número". Ao marcar essa opção, o módulo vai extrair automaticamente o número a partir da string informada no campo padrão de endereço. {% endhint %} | **Opção** | Valor | | --------------------: | ------------------------------------------------------------- | | **Custom Field Name** | Número | | **Location** | address | | **Type** | Text | | **Value** | | | **Validation** | | | **Customer Group** | default (selecione os demais grupos de clientes, caso possua) | | **Required** | true (selecione os demais grupos de clientes, caso possua) | | **Status** | Enabled | | **Sort Order** | 3 | #### #### 4. Confirme se os 4 campos acima foram inseridos com o "Location" correto ![](/files/-M_SDWCBFBaDyaRLvHHH) ### 4. Configurando o Módulo ### 4.1 Ativação Agora que já temos o módulo de checkout instalado, campos custom inseridos, precisaremos realizar algumas configurações no módulo.\ \ Para isso, ainda na interface de administração do OpenCart, navegue até a opção **Extensions > Extensions** no menu principal, conforme imagem abaixo: ![](/files/-MW0Hfs5gwZybBvyjf7l) \ Selecione a opção **Payments** na listagem, conforme demonstrado abaixo: ![](/files/-MW0IRaskxPlNR4q8DH0) \ O OpenCart exibirá uma listagem dos módulos de pagamentos disponíveis para o seu ecommerce, localize "**IOPAY Checkout**" e clique em + Install *(botão verde) para adicionar IOPAY ao seu ecommerce.*
![](/files/-MW0Jk33Lik7j5V7XavN) \ Depois de clicar em Install, o módulo deve aparecer na listagem conforme imagem abaixo.\ Clique na opção Edit para abrir as configurações do módulo. ![](/files/-MW0KtGc_qf-4N6vXi1p) ### 4.2 Configurações Gerais A página de configurações do módulo tem o seguinte formato: ![](/files/-MWQKtChUrKWFgD8Afft) Primeiro, na aba General, forneça as configurações básicas de acordo com a sua loja: | **Campo** | **Descrição** | | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **E-MAIL** | Email credenciado na conta IOPAY | | **IO SELLER ID** | ID da sua loja na IOPAY *(você recebe esse dado no seu processo de onboard e credenciamento ou pode gerá-lo a qualquer momento através da sua Conta Digital)* | | **API SECRET** | Token de acesso à API *(você recebe esse dado no seu processo de onboard e credenciamento ou pode gerá-lo à qualquer momento através da sua Conta Digital)* | | **IO ANTIFRAUDE TYPE** |

Selecione a opção de acordo com o seu plano na IOPAY. As opções disponíveis são:

without\_antifraud --> sem antifraude

with\_antifraud --> antifraude convencional

with\_antifraud\_insurrance --> antifraude com seguro

| | **IO ANTIFRAUD\_ID** |

Chave pública do antifraude. Insira de acordo com o seu plano na IO.

(você obtém essa informação na sua Conta Digital em Vendas > Pagamentos Online)

| | **Sandbox Mode** |

O 'sandbox' setado como Yes conecta na API de testes da IO, ou seja, nenhuma transação de pagamentos é efetivada no mundo real e nenhum debito é processado. Esse modo é útil para realizar testes de integração.

No modo sandbox 'No', as transações passam pelas APIs de produção e efetivam o processamento dos pagamentos junto a cadeia do sistema de pagamentos brasileiro (SPB).

| | **Debug Mode** | Habilitando este modo, informações adicionais serão incluídas nos logs em caso de falhas | | **Transaction Method** | Configure para 'Autorização' caso o seu plano possua antifraude. | | **Total** | Valor mínimo de um pedido para que o módulo de pagamento da IO seja habilitado. Recomenda-se deixar esse campo vazio. | | **GeoZone** | Caso o seu ecommerce possua varias zonas geográficas, selecione a zona em que o módulo IO será ativado. Ou selecione 'All Zones' para ativar em todas as zonas geográficas. | | **Status** | Define se o módulo de pagamentos está habilitado ou não. Selecione Enabled para ativar | | **SortOrder** |

Ordem de exibição dos módulos.

Caso seu ecommerce possua diversos meios de pagamentos configurados, esse campo é utilizado para ordenar a exibição.

Quanto maior for esse número, mais para baixo na lista de opções aparecerá.

Valor recomendado: 1

| #### 4.3 Configurando Status Quando uma transação é gerada ou é atualizada, o modulo da IO atribui automaticamente a identificação de status mais apropriada.\ \ Acesse a aba 'Order Status' para configurar os status das transações com os status disponíveis na sua instalação do OpenCart. ![](/files/-MWQM11CZl82_bxAF4gZ) {% hint style="warning" %} **Atenção:** para o correto funcionamento, o seu OpenCart deve possuir status cadastrados para os diferentes estágios de uma transação e você deve vinculá-los de acordo com a imagem acima.\ \ Para confirmar que a sua instalação do OpenCart possui "Order Status" cadastrados, acessando a seção:\ **System > Localization > Order Status**
{% endhint %} | **Status** | **Cartão de Crédito** | **Boleto** | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Cancelado** | O pagamento foi cancelado | O boleto foi cancelado | | **Pagamento Processado** |

O pagamento foi processado e aprovado na análise antifraude, O débito foi realizado junto ao banco emissor e bandeira do cartão.

O valor da venda já se encontra como recebível na sua conta IO de acordo com o seu plano de recebimento.

| Boleto compensado com sucesso. O valor estará disponível na sua conta IO em até 48h. | | **Negado** | O pagamento foi negado pelo banco emissor o cartão ou negado pela análise antifraude | N/D | | **Expirado** | N/D | Pagamentos do tipo boleto cujo prazo limite de pagamento não foram atingidos | | **Falhado** |

Houve falha na captura do pagamento.


Dados de pagamento incorretos ou inválidos.

Também pode indicar problema temporário de conectividade entre o datacenter do ecommerce e o datacenter da IOPAY, ou problema temporário de comunicação entre IOPAY e demais participantes da cadeia de pagamentos.

|

Houve falha ao gerar o boleto.


Dados de pagamento incorretos ou inválidos.

Também pode indicar problema temporário de conectividade entre o datacenter do ecommerce e o datacenter da IOPAY, ou problema temporário de comunicação entre IOPAY e demais participantes da cadeia de pagamentos.

| | **Pendente** |

Uma transação com cartão de crédito com status Pendente simboliza que a transação foi pré autorizada pelo banco emissor e se encontra atualmente em análise antifraude.

Obs: Após a análise antifraude, o status da transação pode mudar para Pagamento Processado ou Negado.

| Aguardando pagamento do boleto | | **Pagamento Estornado** |

Indica que o pagamento foi cancelado pela loja ou pelo cliente consumidor (chargeback).

Quando um pagamento é estornado o valor da compra é devolvido para o cliente seguindo critérios estabelecidos pelas bandeiras e bancos emissores.

| N/D | #### 4.4 Mapeando os Campos O último passo para configurar o módulo de checkout transparente é mapear os custom fields disponíveis no seu OpenCart com os 4 tipos especiais necessários para correta integração com a IO.\ \ Se você seguiu os passo 3.1 dessa documentação, basta selecionar conforme a imagem abaixo ![](/files/-M_SGd59slpVcg5qhY9T) Se você pulou o passo 3.1, pois já possui campos similares em sua instalação, basta escolher para quais campos personalizados o módulo IO vai estar vinculado. Clique em salvar alterações.\ \ **Pronto**, o módulo de checkout transparente já está disponível para uso.\ Preview da interface de pagamentos: ### 4.3 Final #### Interface para pagamento por cartão de crédito à vista ou em até 12x ![](/files/jHhp4Xdaf2uTeWtYXrpl) #### #### Gere boletos com facilidade Permita que o seu cliente gere boletos sem deixar sua loja e acessar plataformas externas. \ Aumente a sua conversão de vendas com essa simplificação de processos.
![](/files/QQ7fOp2GxnwIs0KrybfB) #### PIX: VENDA POR PIX VIA CÓDIGO QR OU PIX COPIA E COLA ![Interface de escolha para pagamento via PIX](/files/Ks9fVlThaOq0ykLPvEFy) ![Transação PIX gerada. A interface possibilita pagamentos por PIX via Código QR ou pagamentos PIX Copia e Cola](/files/GFFtmClVMsrPrf36GhY0) \
#### Interface responsiva Os módulos de pagamento da IO contam com interface responsiva, permitindo que seus clientes possam pagar acessando e qualquer dispositivo: smartphones, tablets e desktops. ## Webhooks / Callbacks Após a instalação e configuração do módulo Checkout Transparente para OpenCart, segundo o tutorial acima, você deve especificar a URL na qual a IOPAY realizará requisições para informar sobre mudança de status em transações de pagamento ocorridas para a sua conta. Através dos webhooks, notificamos o seu ecommerce toda vez que uma nova transação for gerada, paga, cancelada ou sofrer qualquer outra mudança de status, mantendo assim todas as informações referentes à pagamentos sempre atualizadas na sua loja. O módulo para opencart fornecido pela IOPAY já conta com este recurso (webhook client) e você precisará apenas informar a URL da sua loja na sua conta digital IOPAY, conforme o padrão abaixo: ``` https://domain.com/index.php?route=extension/payment/iopay_checkout_transparente/callback ``` Para inserir a URL acima, acesse a sua conta digital da IOPAY, navegue até a opção **Vendas > Pagamentos Online > Configurações de Integração com Checkout** Conforme exemplificado abaixo: ![Troque https://domain.com/ pelo endereço correto da sua instalação OpenCart](/files/57yvgbjHQDUAlhGvWnqw) ## Segurança & Compliance O módulo checkout transparente para OpenCart utiliza a API oficial de pagamentos da IOPAY, que conta com compliance PCI-DSS para garantir segurança máxima em todo seu pool tecnológico para transações de pagamento. ![](/files/-MVqkR-9OidFdlMjTUGP) {% embed url="" %} Abra a sua conta hoje mesmo e comece a lucrar mais\
{% endembed %} {% content-ref url="/pages/-MVxmrTniMZ75cL\_pCHr" %} [Checkout Transparente](/products/modulos-para-ecommerce/modulos-para-opencart/checkout-transparente-para-opencart.md) {% endcontent-ref %}