🛒 APIs de Venda
Bem-vindo à documentação de Venda! Esta seção reúne os guias completos para integração com as APIs de vendas em estabelecimentos lojistas e e-commerce, além de recursos auxiliares como geração de PIN Block e autenticação biométrica.
📚 Documentos Disponíveis
🛒 Venda Loja
API REST para vendas em estabelecimentos físicos (PDV). Permite realizar o ciclo completo de uma venda com cartão ou biometria.
| Funcionalidade | Descrição |
|---|---|
| Consultar Limite | Verifica limite disponível e situação do cartão |
| Working Key | Obtém chave para criptografia da senha |
| Pré-Autorização | Cria reserva de valor com senha, CVV2 ou biometria |
| Sonda | Consulta o status de uma pré-autorização |
| Captura | Efetiva a venda e gera o contrato |
| Desfazimento | Estorna uma venda no mesmo dia |
| Cancelamento | Cancela um contrato já efetivado |
Integradores de PDV, sistemas de caixa e aplicativos de loja física.
🌐 Venda E-commerce
API REST para vendas em canais digitais. Suporte a transações online com cartão e voucher.
| Funcionalidade | Descrição |
|---|---|
| Pré-Autorização | Cria reserva de valor para compras online |
| Captura | Efetiva a venda após aprovação |
| Desfazimento | Estorna uma transação |
| Consulta de Status | Verifica o andamento de um pedido |
Plataformas de e-commerce, marketplaces e aplicativos de compra online.
🔐 Geração de PIN Block
Guia técnico para criptografar a senha do cliente com a working key antes do envio na pré-autorização.
- Como obter a working key
- Algoritmo e padrão de criptografia (ISO 9564)
- Exemplos em múltiplas linguagens
- Boas práticas de segurança
Fluxo de venda com senha do cartão. Leia este guia antes de implementar a pré-autorização com senhaCriptografada.
CredFace - Integração Biométrica
Guia para integrar a validação biométrica facial no fluxo de venda.
- Exibir a URL de biometria em WebView ou QR Code
- Gerenciar tokens de sessão
- Validar o resultado da autenticação
- Implementar callbacks e retornos de confirmação
Fluxo de venda com biometria. Leia este guia para tratar o retorno da pré-autorização biométrica.
🔧 Troubleshooting
Guia de resolução de problemas para todos os endpoints de venda.
- Erros comuns e suas causas
- Ações recomendadas por endpoint
- Códigos de retorno e mensagens de erro
🔄 Fluxos de Venda
- 🔐 Com Senha
- 💳 Sem Senha
- Biometria
Venda com Senha do Cartão
Utiliza criptografia de senha via PIN Block e working key.
Venda com Dados do Cartão sem Senha
Utiliza tarja magnética + CVV2, sem necessidade de criptografia de senha.
Venda com Biometria
Sem necessidade de senha — o cliente valida a identidade por reconhecimento facial.
🛡️ Segurança
| Recurso | Descrição |
|---|---|
| 🔑 Bearer Token (JWT) | Obrigatório em todos os endpoints |
| 🔒 PIN Block (ISO 9564) | Criptografia da senha com working key rotativa |
| CredFace | Validação biométrica facial em tempo real |
| 🔢 NSU | Número Sequencial Único para rastreabilidade de transações |
| 🆔 msgId (UUID) | Identificador para rastreamento de log por requisição |