Visão Geral
O objetivo desta documentação é orientar sobre a integração da API Checkout Vempag Pay, descrevendo as funcionalidades e os métodos HTTP, listando informações a serem enviadas e recebidas e provendo exemplos.
Processo de Integração
Para se integrar na API VEMPAG, você precisa passar por três etapas:
- Integração
Nessa fase ainda não é necessário ser cliente cadastrado para enviar requisições. Possuímos um ambiente de testes, onde é possível testar todas as situações que ocorrem em produção, como transações aprovadas e negadas. Para receber uma credencial de integração é necessário se cadastrar. Cadastre-se aqui. - Homologação
Após finalizar o desenvolvimento, você deverá preencher um roteiro de testes para que possamos validar sua integração. Esse é um processo de teste, que tem como objetivo validar se todos os casos transacionais estão sendo executados com sucesso para que você não tenha problemas ao colocar sua solução em produção. - Produção
Ao final da homologação, você receberá o nosso OK para ir para produção.
Certificados e Segurança
O que é Certificado SSL?
O Certificado SSL para servidor web oferece autenticidade e integridade dos dados de um web site, proporcionando aos clientes das lojas virtuais a garantia de que estão realmente acessando o site que desejam, e não uma um site fraudador.
Empresas especializadas são responsáveis por fazer a validação do domínio e, dependendo do tipo de certificado, também da entidade detentora do domínio.
O que é o selo PCI?
O selo PCI foi criado pela American Express, Visa, Mastercard e outros, a fim de disseminar os padrões de segurança de dados de pagamentos com cartão.
Os dados do seu cartão sempre protegidos.
A certificação PCI DSS (Payment Card Industry Data Security Standard) é composta por um conjunto de regras e requisitos rígidos que visam proteger os dados e informações dos seus cartões em todas as suas transações online.
Atendemos aos requisitos de segurança exigidos pelo PCI
Vantagens
- Implementa medidas rigorosas de controle de dados de cartões e transações, protegendo as informações do titular do cartão.
- Possui um programa de gerenciamento de vulnerabilidades, monitorando sites suspensos e novas ameaças.
- Monitora e testa redes rigorosamentes, para detectar falhas e fraudes.
- Mantém uma política de segurança de informações.
Changelog
Versão – V1.1
Data – 17/11/2022
Alteração – Versão inicial
Produto – N.A.
Checkout
Checkout na loja virtual é a etapa final do processo de compra online. Na página de checkout, antes de finalizar o pedido, o cliente digita seus dados pessoais e efetua o pagamento. Mantê-la otimizada é importante para melhorar a experiência de compra e evitar o abandono de carrinho.
💡 Imagine que você entra em um supermercado, escolhe seus produtos e, quando termina as compras, não sabe onde ficam os caixas. Quando, finalmente, você encontra esse lugar e chega a sua vez, o atendente solicita uma infinidade de dados pessoais e pede que você vá até uma outra sala para passar seu cartão de crédito.
Como você se sentiria para fazer esse pagamento? No mínimo, um pouco inseguro, certo?
O que é checkout na loja virtual?
Checkout é a etapa final para a concretização de uma compra, ou seja, é o momento em que o cliente vai até o carrinho de compras e:
- Confere os itens que vai levar;
- Digita suas informações pessoais, como nome, e-mail e CEP;
- Checa preço, promoções e cupons;
- Escolhe o meio de pagamento e, de fato, efetua a compra;
- Recebe a confirmação de processamento do pedido.
Funcionalidades
| Chamadas | Descrição |
|---|---|
| Seleciona Chave | Utiliza KEY (chave) Barcode como pedido para transação. |
| Autenticar Credenciais | Autentica Credencial para ser utilizado na chamada Checkout Redirect. |
| Checkout Redirec | Redireciona comprador para Checkout Vempag Pay |
| Pré-captura transação | Realiza custodia do saldo referente a transação junto a adquirente. |
Prevenção a Fraude/td> | Audita a transação antes da captura. |
| Captura transação | Captura final posterior as validações do portador do cartão que está executando a transação. |
| Cancelar transação | Cancelar compras que ainda não estão com status “Paga”. |
| Estornar transação | Estornar compras que estão com status “Paga”. |
| Fluxo de Pagamento | Etapa final do checkout, contendo informações dos produtos/serviços e meios de pagamento. |
| Consulta de Transações | Consulta os dados das transações, possuindo 3 tipos: Detalhe da transação, por referência e intervalo de data. |
| Notificação (webhook) | Envia uma notificação contendo os detalhes da transação, sempre que ela sofrer alguma transação de status. |
Aplicação
Apresentarmos um exemplo prático de aplicação da API Checkout.
1º Passo: Gerar Token do ambiente de teste:
- Para obter as credenciais para o ambiente, clique em solicitar token.
- Você receberá as chaves necessárias para acessar os ambientes via e-mail.
2º Passo: Integrando o checkout Vempag:
- Nesta documentação estão descritas todas as funcionalidades da integração da API Checkout Vempag, os parâmetros técnicos e principalmente os códigos de exemplos para facilitar o seu desenvolvimento.
💡 É utilizada uma Integração via API que permite o parceiro enviar o “Pedido” do seu domínio com todos os dados que ele deseja apresentar no checkout.
Autenticação
A autenticação do estabelecimento deverá ser feita através do envio dos campos ilustrados abaixo.
| Parâmetro | Descrição |
|---|---|
| Document | Documento do estabelecimento credenciado gerado pela Vempag (credencial). |
| AcessKey | Chave de acesso enviada após o cadastro na aplicação (senha da credencial). |
Auth
Todas as requisições enviadas para a Vempag deverão ser autenticadas pelo estabelecimento. A autenticação consiste no envio do Document e AcessKey, que é o identificador e chave única do estabelecimento fornecido pela Vempag.
Endpoint: https://vp-checkout-backend-hml.vamosparcelar.com.br/api/public/v1/auth
Exemplo de uma requisição:
Montando pedido
Na integração via API, a tela transacional é “montada” com bases em dados enviados que formam um pedido com itens. Esses dados são separados nos seguintes parâmetros.
| Parâmetro | Descrição |
|---|---|
| Type | “Key” – Essa chamada determina o tipo de requisição necessária para processamento das informações. |
| Key | “Key” – Tipo de chave recebida pelo módulo para busca da guia que será transacionada. Ex: código de barras do boleto (obrigatório caso o type seja “Key”). |
| Amount | Valor total a ser transacionado (campo não obrigatório para “Type Key”). |
| ShortDescription | Descrição curta do item que será transacionado. |
| Description | Descrições adicionais. |
| ExternalId | Id externo utilizado para referenciar a aplicação. Isso possibilita a conciliação entre o que é enviado ou transacionado. |
| ExpirationDate | Data de expiração da guia. |
| PayerDocumentType | Tipo do documento do pagador, podendo ser CPF ou CNPJ. |
| PayerDocument | Documento do responsável pelo pagamento. |
| ReceiverDocumentType | Tipo do documento do recebedor, podendo ser CPF ou CNPJ. |
| ReceiverDocument | Documento do responsável pelo recebimento. |
Após o envio dos dados do pedido, o Checkout enviará um Response contendo um LINK para a tela de pagamento.
IMPORTANTE: A chamada a API Checkout CRIA UMA TRANSAÇÃO. O Link retornado é uma “order” indicando que uma tela transacional está pronta para ser utilizada.
Request - Create Order
Endpoint é a URL para onde as requisições com os dados do pedido serão enviadas. Todas as requisições deverão ser enviadas utilizando o método HTTP POST, para o endpoint:
Endpoint: https://vp-checkout-backend-hml.vamosparcelar.com.br/api/public/v1/create-order
Exemplo de uma requisição:
Responses
Devido ao seu fluxo ser dividido em duas etapas, sendo a primeira, a autenticação e a segunda, a realização do pagamento; O Checkout possui duas respostas para uma transação:
Response – Auth – É o response retornado com o token de acesso e sua liberação.
Response – CreateOrder – Retorna o link que redirecionará o usuário à tela de pedidos.
Existem apenas duas opções de resposta na integração da API: Sucesso / Erro
Sucesso – Em caso de sucesso, o response será o conteúdo do Request mais o Link que direciona a tela transacional.
Importante – O Checkout Vempag não possui erros numerados, apenas uma mensagem genérica. Veja a sessão “Identificando erros de Integração” para maiores informações.