Criar Checkout
Pagamentos
Criar Checkout
Cria um checkout para pagamento de débitos veiculares
POST
Criar Checkout
Descrição
Cria um checkout para pagamento de débitos veiculares. O checkout agrupa os débitos selecionados e gera um identificador único que será usado no processamento do pagamento.Validade: O checkout é válido por 24 horas após a criação. Após este período, será necessário criar um novo checkout.
Fluxo de Uso
Seleção de Débitos
Débitos Obrigatórios
Alguns débitos são obrigatórios e devem ser pagos em conjunto:- IPVA: Deve ser pago junto com o licenciamento
- Licenciamento: Pode ter débitos dependentes
- Multas: Algumas multas são pré-requisitos para o licenciamento
Validação de Débitos
A API valida automaticamente:- Se todos os débitos obrigatórios estão incluídos
- Se os débitos pertencem ao mesmo veículo
- Se os débitos ainda estão válidos e não foram pagos
- Se os valores correspondem aos débitos consultados
Campo externalId
Dados do Cliente
Os dados do cliente são necessários para:- Emissão de nota fiscal
- Envio de comprovantes por e-mail
- Validação antifraude
- Comunicação sobre o status do pagamento
Campos Obrigatórios
- name: Nome completo do cliente
- email: E-mail válido para envio de comprovantes
- cpfCnpj: CPF ou CNPJ (apenas números)
O CPF/CNPJ informado deve corresponder ao proprietário do veículo ou pessoa autorizada a pagar os débitos.
Estrutura do Checkout
Débitos
Cada débito deve conter:- id: Identificador do débito retornado na consulta
- amount: Valor do débito (para validação)
Cliente
Exemplo de Uso Completo
Resposta do Checkout
A resposta contém:- checkoutId: ID único do checkout para usar no pagamento
- totalAmount: Valor total de todos os débitos selecionados
- expiresAt: Data/hora de expiração do checkout (24 horas)
Expiração do Checkout
Renovar Checkout
Se o checkout expirar antes do pagamento:Códigos de Resposta HTTP
200 - Sucesso
Checkout criado com sucesso. Use ocheckoutId para processar o pagamento.
400 - Bad Request
Dados inválidos na requisição. Possíveis motivos:- Débitos inválidos ou não encontrados
- Valores não correspondem aos débitos
- Dados do cliente inválidos (CPF/CNPJ, e-mail)
- Débitos obrigatórios faltando
422 - Unprocessable Entity
Dados válidos mas não podem ser processados:- Débitos já foram pagos
- Débitos de veículos diferentes
- Dependências de débitos não satisfeitas
- Checkout duplicado (mesmo externalId)
Validação de Dependências
Antes de criar o checkout, valide as dependências:Interface de Usuário
Boas Práticas
Mostre o Total Claramente
Mostre o Total Claramente
Exiba o valor total antes de criar o checkout:
Indique Débitos Obrigatórios
Indique Débitos Obrigatórios
Marque visualmente débitos que devem ser pagos juntos:
Valide Antes de Enviar
Valide Antes de Enviar
Valide no frontend antes de criar o checkout:
Mostre Tempo de Expiração
Mostre Tempo de Expiração
Informe ao cliente sobre a validade do checkout:
Próximos Passos
Após criar o checkout:Tokenizar Cartão
Tokenize o cartão do cliente de forma segura
Simular Parcelas
Simule opções de parcelamento para o valor total
Processar Pagamento
Efetue o pagamento usando o checkoutId
Débitos Dependentes
Entenda as regras de dependência entre débitos
Suporte
Dúvidas sobre Checkout?
Entre em contato para esclarecer dúvidas sobre criação de checkout e validação de débitos.
Authorizations
API Key fornecida no painel administrativo da Uvvipague
Body
application/json