Pular para o conteúdo principal

Checkout Transparente via API

O Checkout Transparente do PicPay oferece uma solução de pagamento integrada, permitindo que os clientes realizem transações diretamente no site do lojista, com maior personalização e controle sobre o processo de checkout.

Fluxo do Processo de Pagamento Transparente​

O processo de pagamento com o Checkout Transparente envolve as seguintes etapas:

  1. Início do Checkout pelo Consumidor: O consumidor inicia o processo de checkout no site do lojista.
  2. Exibição da Página de Checkout Personalizada: O lojista exibe uma página de checkout personalizada, permitindo que o consumidor insira suas informações de pagamento diretamente no seu próprio site.
  3. Escolha do Método de Pagamento pelo Consumidor:
    • Pagamento com Cartão: O consumidor insere os dados do cartão na página de checkout.
    • Pagamento com Wallet PicPay: O consumidor opta por usar a Wallet PicPay como forma de pagamento.
    • Pagamento com PIX: O consumidor opta por usar o PIX como forma de pagamento.
  4. Processamento do Pagamento pelo Lojista:
    • Pagamento com Cartão: O lojista envia uma requisição de autorização de pagamento ao PicPay com os dados do cartão fornecidos pelo consumidor. Após o processamento bem-sucedido, o PicPay confirma o pagamento ao lojista, que, por sua vez, confirma a conclusão do pedido ao consumidor.
    • Pagamento com Wallet PicPay: O lojista solicita a criação de um QRCode ao PicPay. Uma vez recebido, o lojista exibe este QRCode ao consumidor, que realiza o pagamento via app PicPay. Após o pagamento, o PicPay confirma a transação tanto para o consumidor quanto para o lojista.
    • Pagamento com PIX: O lojista solicita a criação de um QRCode PIX ao PicPay. Uma vez recebido, o lojista exibe este QRCode ao consumidor, que realiza o pagamento escaneando o QRCode ou utilizando a função "Pix Copia e Cola". Após o pagamento, o PicPay confirma a transação para o lojista, que, por sua vez, confirma a conclusão do pedido ao consumidor.
  5. Notificação de Pagamento ao Lojista: Independentemente do método de pagamento escolhido, o PicPay envia uma notificação ao lojista confirmando o pagamento.
  6. Confirmação do Pedido ao Consumidor: O lojista, após receber a confirmação de pagamento, notifica o consumidor sobre a conclusão bem-sucedida do pedido.

Este fluxo permite que os lojistas ofereçam uma experiência de checkout mais fluída e integrada, mantendo altos padrões de segurança e facilitando uma variedade de opções de pagamento para os consumidores.

Integração com a API do Checkout Transparente​

Requisições Server-to-Server São Cruciais

É fundamental que todas as requisições para a API do E-commerce PicPay sejam realizadas a partir do backend do lojista, nunca através do frontend do site. Esta abordagem assegura a integridade e a confidencialidade das credenciais do PicPay, protegendo contra exposições de dados sensíveis e possíveis vulnerabilidades de segurança.

Transação autenticada com 3DS

No momento da criação de um checkout, o lojista pode solicitar o uso da autenticação 3DS. Saiba mais.

O Checkout Transparente do PicPay oferece flexibilidade e controle na integração de pagamentos, através de uma série de recursos disponíveis na nossa API. Aqui estão os detalhes importantes para a integração bem-sucedida com a nossa API.

Autorização de Pagamentos com Cartão​

Para transações com cartão de crédito, a seção Cobrar da nossa API Reference contém todas as informações necessárias para processar autorizações. Essa parte da API permite que você integre de forma segura o processamento de pagamentos com cartão no seu site.

Campo paymentSource

Ao fazer a requisição de autorização para o Checkout Transparente, certifique-se de preencher o campo paymentSource com o valor GATEWAY. Isso garante que a transação seja processada corretamente dentro do contexto deste tipo de checkout.

Pagamentos com Carteira PicPay no Checkout Transparente​

O Checkout Transparente não se limita a transações com cartão de crédito, ele também suporta pagamentos realizados através da carteira PicPay dos clientes. Uma característica distintiva deste método de pagamento é sua natureza assíncrona, ou seja, ele ocorre em duas etapas fundamentais:

  1. Geração e Exibição do QrCode: Primeiramente, você gera um QrCode PicPay usando o endpoint da sessão Wallet na nossa API Reference. Esse QrCode é então exibido no seu frontend. Diferentemente dos pagamentos com cartão, onde a autorização é quase instantânea, o QrCode aguarda a ação do cliente.

  2. Pagamento e Confirmação pelo Cliente: O cliente escaneia o QrCode usando o aplicativo PicPay para realizar o pagamento. Diferente dos pagamentos com cartão, que são processados e confirmados em tempo real, os pagamentos via carteira PicPay exigem que o cliente complete ativamente a transação. Uma vez que o pagamento é feito, o PicPay notifica o lojista via webhook, permitindo que ele prossiga com as etapas subsequentes do pedido.

Essa abordagem assíncrona oferece uma camada adicional de flexibilidade para os clientes, enquanto mantêm o lojista informado sobre o status do pagamento em tempo real.

Habilitação do Método de Pagamento via Wallet

Lembre-se, para aceitar pagamentos via carteira PicPay, é necessário habilitar esse método na seção Meu Checkout no Painel Lojista.

Verificação do Status de Pagamento

Para acompanhar e confirmar o status do pagamento realizado via QrCode, os lojistas têm à disposição um endpoint específico. Este endpoint, dedicado à consulta do status de cobranças, pode ser encontrado detalhadamente na seção Search da nossa API Reference.

Com a integração do método de pagamento via carteira PicPay no Checkout Transparente, os lojistas podem oferecer uma experiência de pagamento ainda mais diversificada e adaptável às preferências dos clientes.

Autorização de Pagamentos com Cartão e autenticação 3DS habilitada​

Para transações com cartão de crédito autenticadas com 3DS, a seção Autenticação 3DS da nossa API Reference contém todas as informações necessárias para processar a autenticação. Essa parte da API permite que você integre de forma segura o processamento de pagamentos com cartão utilizando a autenticação 3DS.

Script de Coleta de Dados​

Utilizado durante a etapa de Setup. A URL e o Access Token recebidos na resposta do Setup, serão utilizados para inicializar o iframe de Device Data Collection. Iniciar um form POST em um "hidden" iframe. OBS: O form action e o parâmetro JWT devem ser alterados com o valor recebido na URL e AccessToken do Setup.

<iframe name="ddc-iframe" height="1" width="1" style="display: none;"> </iframe>
<form id="ddc-form" target="ddc-iframe" method="POST" action="https://centinelapistag.cardinalcommerce.com/V1/Cruise/ Collect">
   <input type="hidden" name="JWT" value=" eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI1YWZiNGRkY2ZmNjI2YjIzNzA2OWZhM2QiLCJ pYXQiOjE1OTExMTgyNzIsImV4cCI6MTU5MTEyNTQ3MiwianRpIjoiNWU4MDg5MG EtN2UyNi00ZmI3LThiYTUtNjQ2ZDU0NjJiMzBkIiwiUGF5bG9hZCI6eyJBY3Rpb25Db 2RlIjoiU1VDQ0VTUyIsIlNlc3Npb25JZCI6IjY0ZTY2NjQ4LTFkYzYtNDZjMS1hNGYzLT BkYzE2MzQwZmFmMTAiLCJFcnJvck51bWJlciI6MCwiRXJyb3JEZXNjcmlwdGlvbiI6I lN1Y2Nlc3MifX0.j8EPWEEDf85hYQcxFzXxmHqHFTlptSQITJgfBGtLLjA" />
</form>

Script de Processamento de um Desafio​

Utilizado durante a etapa de Enrollment. Quando o retorno da solicitação de autenticação indicar a necessidade de processar um desafio, deverá ser efetuada a operação no front end, através da função abaixo: Iniciar um form POST em um "hidden" iframe. OBS: O form action e o parâmetro JWT devem ser alterados com o valor recebido na URL e AccessToken.

<iframe name="step-up-iframe" height="250" width="400"> </iframe>
<form id=""step-up-form" target=" "step-up-iframe" method="POST" Action="https://centinelapistag.cardinalcommerce.com/V2/Cruise/StepUp">
    <input type="hidden" name="JWT" value="eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiI1YWZiNGRkY2ZmNjI2YjIzNzA2OWZhM 2QiLCJpYXQiOjE1OTExMTgyNzIsImV4cCI6MTU5MTEyNTQ3MiwianRpIjoiNWU4M Dg5MGEtN2UyNi00ZmI3LThiYTUtNjQ2ZDU0NjJiMzBkIiwiUGF5bG9hZCI6eyJBY3R pb25Db2RlIjoiU1VDQ0VTUyIsIlNlc3Npb25JZCI6IjY0ZTY2NjQ4LTFkYzYtNDZjMS1h NGYzLTBkYzE2MzQwZmFmMTAiLCJFcnJvck51bWJlciI6MCwiRXJyb3JEZXNjcmlw dGlvbiI6IlN1Y2Nlc3MifX0.j8EPWEEDf85hYQcxFzXxmHqHFTlptSQITJgfBGtLLjA" />
</form>

Importância da Certificação PCI​

Certificação PCI Necessária

Para usar o Checkout Transparente, é essencial que o lojista seja credenciado com a certificação PCI DSS (Payment Card Industry Data Security Standard). Esta certificação garante que os dados dos cartões de crédito sejam manuseados de acordo com os padrões de segurança da indústria, protegendo as informações sensíveis dos clientes e minimizando os riscos de fraude.

O Checkout Transparente é ideal para lojistas que buscam oferecer uma experiência de pagamento mais personalizada e integrada, mantendo ao mesmo tempo altos padrões de segurança e conformidade.