Processo de integração

Instalação:

📘

Atenção

Recomendamos que seja feito backup da sua loja Magento antes de realizar qualquer instalação ou atualização do módulo.

Certifique-se de que não há instalação de outros módulos para o PagSeguro em seu sistema.

Caso utilize a compilação do Magento, deixe a mesma desativada e limpa (System -> Tools -> Compilation).

Baixe a última versão do módulo através deste link ou então baixe o repositório como arquivo zip através do botão do GitHub:

Na área administrativa do seu painel Magento, acesse o menu System -> Magento Connect -> Magento Connect Manager. Caso tenha uma versão anterior do módulo instalada, faça a remoção agora.

No Magento Connect Manager, dentro da seção Direct package file upload, clique em Escolher arquivo/Choose file, selecione o arquivo UOL_PagSeguro-x.x.x.tgz (baixado anteriormente) e clique no botão de upload.

No console da página, será exibido a mensagem Package installed: community UOL_Pagseguro x.x.x, confirmando que a instalação do módulo foi realizada com sucesso.

Ao clicar em Refresh, o módulo do pagseguro aparecerá na tabela de pacotes. Caso utilize a compilação, volte para a área administrativa do Magento, ative e execute novamente.

Pronto, ao finalizar o processo o módulo do PagSeguro estará instalando em seu Magento.

Configurações gerais:

Aqui você encontrará os seguintes itens:

Configurações do Módulo
Configurações de Checkout
Configurações de Status
Consultar Meios de Pagamento
Transações
Lista de Pedidos do Magento

Configurações do Módulo

Para acessar e configurar o módulo acesse o menu PagSeguro -> Configurações. As opções disponíveis estão descritas abaixo.

ambiente: especifica em que ambiente as transações serão feitas (produção/sandbox).

e-mail: e-mail cadastrado no PagSeguro. O preenchimento é obrigatório.

token: token gerado pelo PagSeguro. O preenchimento é obrigatório.

url de redirecionamento: ao final do fluxo de pagamento no PagSeguro, seu cliente será redirecionado automaticamente para a página de confirmação em sua loja ou então para a URL que você informar neste campo. Para ativar o redirecionamento ao final do pagamento é preciso ativar o serviço de [Pagamentos via API].
Observação.: Esta URL é informada automaticamente e você só deve alterá-la caso deseje que seus clientes sejam redirecionados para outro local.

url de notificação: sempre que uma transação mudar de status, o PagSeguro envia uma notificação para sua loja.
Observação: Esta URL só deve ser alterada caso você deseje receber as notificações em outro local. Deve ser uma url válida, e não o endereço local, como http://127.0.0.1/
charset: codificação do seu sistema (ISO-8859-1 ou UTF-8).

ativar log: ativa/desativa a geração de logs.

diretório: informe o local e nome do arquivo a partir da raíz de instalação do Magento, onde se deseja criar o arquivo de log. Ex.: /pagseguro.log.

• Caso não seja informado, os logs não serão registrados no arquivo.
• O campo só é exibido se ativar log no campo "ativar log".
• Por padrão o módulo virá configurado para salvar o arquivo de log em /var/pagseguro.log.

listar transações abandonadas?: ativa/desativa a pesquisa de transações que foram abandonadas no checkout do PagSeguro.

template de e-mail: define qual o template de email sua loja usará para o envio do email de recuperação de venda. Esse campo só é exibido se ativar a listagem de transações abandonadas no campo acima.

oferecer desconto para ...: ativa/desativa desconto para checkouts utilizando este meio de pagamento.

percentual de desconto: define o percentual de desconto a ser concedido para o meio de pagamento escolhido. Esse campo só é exibido se ativar desconto para meio de pagamento, e é de preenchimento é obrigatório.

habilitar recuperação de carrinho: Habilita a recuperação de carrinho do PagSeguro. (por padrão está desabilitada)

listar parcelamento: Habilita a exibição de uma listagem de parcelas na tela de visualização do produto. (Irá exibir o maior parcelamento disponível para o produto na tela de exibição do mesmo)

habilitar retentativa de pagamento: habilita efetuar a retentativa de pagamento para cartões de crédito que falharam no momento da cobrança. Essa ação só funciona no checkout transparente.

Configurações de Checkout

Ativa/Desativa os tipos de meio de pagamento que serão exibidos na tela de checkout.

PagSeguro (Padrão ou Lightbox - Usando a Tela do PagSeguro)

ativar: ativa/desativa o meio de pagamento PagSeguro (padrão ou lightbox).

nome de exibição: define o nome que será utilizado para o meio de pagamento na tela de checkout. O preenchimento é obrigatório.
checkout: especifica o modelo de checkout que será utilizado. É possível escolher entre checkout padrão ou checkout lightbox.

Checkout Transparente - Cartão de Crédito

ativar: ativa/desativa o meio de pagamento Checkout Transparente - Cartão de Crédito.

nome de exibição: define o nome que será utilizado para esse meio de pagamento na tela de checkout. O preenchimento é obrigatório.

Url de sucesso: o comprador será redirecionado para a URL informada se o pagamento for efetuado com sucesso.

Checkout Transparente - Boleto Bancário

ativar: ativa/desativa o meio de pagamento Checkout Transparente - Boleto Bancário.

nome de exibição: define o nome que será utilizado para esse meio de pagamento na tela de checkout. O preenchimento é obrigatório.

Checkout Transparente - Débito Online

ativar: ativa/desativa o meio de pagamento Checkout Transparente - Débito Online.

nome de exibição: define o nome que será utilizado para esse meio de pagamento na tela de checkout. O preenchimento é obrigatório.

Configurações de Status

Não é necessário alterar essa configuração. O módulo já vem com uma configuração padrão de status mas, caso deseje personalizar, esta seção permite configurar para cada status do Pagseguro o respectivo status do Magento (opcional).

Pendente: define qual state do Magento será associado ao status Pendente do PagSeguro.

Aguardando pagamento: define qual state do Magento será associado ao status Aguardando pagamento do PagSeguro.

Em análise: define qual state do Magento será associado ao status Em análise do PagSeguro.

Paga: define qual state do Magento será associado ao status Paga do PagSeguro.

Disponível: define qual state do Magento será associado ao status Disponível do PagSeguro.

Em disputa: define qual state do Magento será associado ao status Em disputa do PagSeguro.

Devolvida: define qual state do Magento será associado ao status Devolvida do PagSeguro.

Cancelada: define qual state do Magento será associado ao status Cancelada do PagSeguro.

Chargeback Debitado: define qual state do Magento será associado ao status Chargeback Debitado do PagSeguro.

Em Contestação: define qual state do Magento será associado ao status Em Contestação do PagSeguro.

Documentação oficial do Magento sobre os status:

Order Workflow: http://docs.magento.com/m1/ce/user_guide/order-processing/order-workflow.html
Order Status: http://docs.magento.com/m1/ce/user_guide/order-processing/order-status.html

Consultar Meios de Pagamento

A opção Consultar meios de pagamentos ativos na conta PagSeguro exibe todos os meios de pagamento ativos na conta do vendedor no PagSeguro.

Todos os meios de pagamento disponíveis para o vendedor podem ser visualizados no site do PagSeguro, e serem habilitados/desabilitados.

Transações

Para acessar essa funcionalidade acesse o menu PagSeguro -> Transações

Cancelamento

Com esta funcionalidade você poderá listar e cancelar transações que ainda estão nos status “Em análise” e “Aguardando Pagamento”. É aconselhável que antes de usar esta funcionalidade você faça a conciliação de suas transações para obter os status mais atuais.

Na lista são exibidas 10 transações por página, ordenadas por data de criação mais recente.

Filtro:

• Quantidade de dias para o intervalo de pesquisa.
• Por padrão vem selecionado os 5 últimos dias.

Resultado:

• Na coluna AÇÃO, o link Cancelar abre uma popup com a confirmação do cancelamento.

Se selecionar a opção Não, o sistema fecha a popup. Se selecionar a opção Sim, o sistema realiza o cancelamento da transação, exibe uma mensagem de sucesso e retira a transação da lista de resultados da consulta.

Conciliação

Com esta funcionalidade você poderá listar as transações realizadas em um determinado intervalo de datas. Ela pode ser usada periodicamente para verificar se o seu sistema recebeu todas as notificações enviadas pelo PagSeguro e, consequentemente, manter o status de suas transações sempre atualizados.

São exibidas todas as transações que estão com os status divergentes entre o Magento e o PagSeguro.

Na lista são exibidas 10 transações por página, ordenadas por data de criação mais recente.

Filtro:

• Quantidade de dias para o intervalo de pesquisa.
• Por padrão vem selecionado os 5 últimos dias.

Resultado:

• Na coluna AÇÃO, o link Ver detalhes redireciona para os detalhes da ordem do pedido no Magento.
• Na primeira coluna, com o checkbox, o usuário seleciona as transações na qual deseja realizar a conciliação. O botão Conciliar permanece desabilitado até que uma transação seja selecionada.

Ao clicar em Conciliar, o sistema atualiza o status do pedido no Magento para ficar igual ao do PagSeguro.

Estorno total e Parcial

Com esta funcionalidade você poderá estornar os valores de transações que estejam nos status “Paga”, “Disponível” e “Em disputa”. É aconselhável que antes de usar esta funcionalidade você faça a conciliação de suas transações para obter os status mais atuais.

Atenção: Ao realizar um Estorno total a transação será estornada e terá seu status alterado no PagSeguro para "Devolvida". Ao realizar um Estorno parcial será estornado o valor inserido, contudo, o status da transação no PagSeguro não será alterado (a transação manterá o seu último status).

Na lista são exibidas 10 transações por página, ordenadas por data de criação mais recente.

Na coluna AÇÃO existem duas opções: Estorno total e Estorno parcial

Estorno Total

Ao clicar em Estorno total, o sistema solicita confirmação da operação. Ao confirmar, o estorno é realizado, alterando o status da transação para Devolvida e a mesma é retirada da lista de resultados.

Estorno Parcial

O estorno parcial só pode ser realizado uma vez.

Ao clicar em Estorno parcial, o sistema exibe uma popup para informar o valor que deseja ser estornado. Esse campo possui algumas validações:

• O preenchimento é obrigatório.
• O valor informado não pode ser 0.
• O valor informado não pode ser negativo.
• O valor informado não pode ser maior do que o valor total da venda.

Após passar por todas as validações, o sistema realiza o estorno parcial e a transação é retirada da lista de resultado.

É importante lembrar que no estorno parcial, o status da transação no PagSeguro não será alterado (a transação manterá o seu último status). Porém, na lista de transações, em parênteses ao lado do status, há a informação de que foi realizado o estorno, como assinalado a seguir:

Na tela da ordem do pedido, no painel do Magento, também é possível ver nas notificações, a informação do estorno parcial e o valor, como assinalado a seguir:

Listar transações

Com esta funcionalidade você poderá listar as suas transações. Caso não encontre uma transação ou se o status de uma transação estiver desatualizado é aconselhável que você use a conciliação de transações.

São exibidas apenas as transações que estão com os status conciliados entre PagSeguro e Magento.

Na lista são exibidas 10 transações por página, ordenadas por data de criação mais recente.

Filtros:

• Nenhum filtro é obrigatório.
• Se a data inicial ou final for preenchida, a outra se torna obrigatória.
• O sistema busca exatamente o que é informado no filtro. Por isso, os IDs do Magento e PagSeguro precisam ser informados corretamente.
• Toda transação estornada de forma parcial não tem seu status alterado. Por isso, ao filtrar por "Estornada Parcialmente" o pedido exibirá o seu status original, e a informação de estorno parcial entre parênteses.

Resultado:

• Na coluna ID MAGENTO, o id é um link que redireciona para os detalhes da ordem do pedido no Magento.
• Na coluna AÇÃO, o link Ver detalhes do pagamento abre uma popup com os detalhes da transação no PagSeguro. A opção Exibir todos os itens mostra detalhes dos itens do carrinho.

Em Exibir todos os dados de custos cobrados são exibidos todos os custos e valores cobrados na transação:

Lista de Pedidos do Magento

Nessa funcionalidade, entre os dados de todos os pedidos realizados, é exibido o ambiente do PagSeguro em que a transação foi realizada e o status atual da mesma.

Coluna Ambiente: Sandbox ou Produção

Front-end:

Checkout Padrão (Usando a tela do PagSeguro)

Para finalizar uma requisição de pagamento com o Checkout Padrão você precisa ter configurado nas Configurações do Tipos de Checkout as opções Ativar = "Yes", Tipo de Checkout = "Padrão" e Nome de Exibição = "Pagseguro" (ou o que desejar).

No Checkout > 4 Informações de Pagamento escolha a opção "Pagseguro" e acione o botão "Continuar".

No Checkout > 5 Rever Pedido, revise seu pedido e acione o botão "Place Order".

Ao finalizar a compra com sucesso, será exibido a página Finalizando sua compra com Pagseguro e o comprador será direcionado para a página de pagamento do PagSeguro, se a página de pagamento não abrir automaticamente, clique na opção clique aqui que ela abrirá.

Na página de pagamento do pagseguro, informe o usuário e senha ou cadastre-se para realizar o pagamento com sucesso.

Checkout Lightbox (Usando a tela do Pagseguro)

O Pagamento Lightbox ou Checkout Lightbox permite que todo o processo de pagamento seja feito em uma janela que se sobrepõe ao site do vendedor. Dessa forma o comprador não é redirecionado para outra janela ou pop-up para realizar o pagamento.

Para finalizar uma requisição de pagamento com o Checkout Lightbox você precisa ter configurado nas Configurações do Tipos de Checkout as opções Ativar = "Yes", Tipo de Checkout = "Lightbox" e Nome de Exibição = "Pagseguro".

No Checkout > 4 Informações de Pagamento escolher a opção "PagSeguro" e acione o botão "Continuar".

No Checkout > 5 Rever Pedido, revise seu pedido e acione o botão "Place Order".

Ao finalizar sua compra com sucesso, irá exibir a página Finalizando sua compra com Pagseguro e uma janela do PagSeguro será aberta dentro do seu site para o cliente logar ou criar uma conta. Após a identificação do comprador, será permitido realizar o pagamento de acordo com as opções habilitadas pelo vendedor.

Pagamento Transparente (Usando sua tela)

Boleto

O Pagamento Transparente ou Checkout Transparente oferece maior controle e flexibilidade sobre o processo de pagamento. Com essa integração o cliente fica no ambiente do seu e-commerce ou site durante todo o processo de compra, sem necessidade de cadastro ou páginas intermediárias de pagamento. Com esta opção ativa, fica disponível em seu site a forma de pagamento Boleto Bancário. O Checkout Transparente está disponível para contas do tipo Vendedor e Empresarial. As seções seguintes indicarão como finalizar o pagamento pelo Checkout Transparente do PagSeguro.

Para finalizar uma requisição de pagamento com o Checkout Transparente - Boleto Bancário você precisa ter configurado nas Configurações as opções Ativar = "Yes" e o Nome de Exibição a sua Escolha = Ex: "Transparente - Boleto Bancário".

No Checkout > 4 Informações de Pagamento, escolher a opção "Transparente - Boleto Bancário", preencha o campo "CPF" com um CPF válido e acione o botão "Continuar"

CPF ou CNPJ: inserir um CPF ou CNPJ válido.
No Checkout > 5 Rever Pedido, revise seu pedido e acione o botão "Place Order".

Ao finalizar sua compra com sucesso irá exibir a página Pedido Efetuado e direcionar o comprador para impressão do Boleto ou pagamento direto no seu internet banking.

Cartão de Crédito

Com esta opção ativa, fica disponível em seu site a forma de pagamento Cartão de Crédito. O Checkout Transparente está disponível para contas do tipo Vendedor e Empresarial. As seções seguintes indicarão como finalizar o pagamento pelo Checkout Transparente do PagSeguro.

Para finalizar uma requisição de pagamento com o Transparente - Cartão de Crédito você precisa ter configurado nas Configurações as opções Ativar = "Yes", Nome de Exibição a sua Escolha = Ex: "Transparente - Cartão de Crédito" e a Url de sucesso = Ex: "/checkout/onepage/sucess".

No Checkout > 4 Informações de Pagamento escolher a opção "Transparente - Cartão de Crédito", preencha os campos abaixo com informações válidas e acione o botão "Continuar"

• Número do cartão: inserir um número de cartão válido.
• Nome impresso no cartão: inserir as informações do titular do cartão de crédito.
• Validade: inserir mês e ano da data de validade do seu cartão de crédito.
• Código de segurança: inserir código de segurança do seu cartão de crédito.
• Data de Nascimento: inserir a data de nascimento do titular do cartão.
• Parcelas: escolher a quantidade e o valor da prestação
• Total: informa o Total de Pagamento.

No Checkout > 5 Rever Pedido, revise seu pedido e acione o botão "Place Order".

Ao finalizar sua compra com sucesso irá exibir a página Pedido Efetuado.

Débito Online

Com esta opção ativa, fica disponível em seu site a forma de pagamento Débito Online. O Checkout Transparente está disponível para contas do tipo Vendedor e Empresarial. As seções seguintes indicarão como finalizar o pagamento pelo Checkout Transparente do PagSeguro.

Para finalizar uma requisição de pagamento com o Transparente - Débito Online você precisa ter configurado nas Configurações as opções Ativar = "Yes" e o Nome de Exibição a sua Escolha = Ex: "Transparente - Débito Online".

No Checkout > 4 Informações de Pagamento escolher a opção "Transparente - Débito Online", escolha o banco desejado e acione o botão "Continuar".

• CPF ou CNPJ: inserir um CPF ou CNPJ válido.
• Banco: escolher o banco para débito.

No Checkout > 5 Rever Pedido, revise seu pedido e acione o botão "Place Order".

Ao finalizar sua compra com sucesso irá exibir a página Pedido Efetuado e direciona o comprador para o internet banking escolhido.

🚧

Dúvidas

Caso tenha dúvidas ou precise de suporte, acesse nosso