Visão Geral
Esta página documenta todos os ENUMs (enumeradores) e tipos de dados utilizados na API Uvvipague. Use esta referência para garantir que está enviando os valores corretos nas requisições.Status de Pagamento
Payment Status
Status possíveis para transações de pagamento com cartão de crédito:| Status | Descrição | Ação Recomendada |
|---|---|---|
paid | Pagamento aprovado e processado com sucesso | Liberar produto/serviço |
in_analysis | Transação em análise pelo antifraude | Aguardar atualização via webhook |
refused | Transação recusada pela operadora ou antifraude | Informar cliente e oferecer nova tentativa |
processing | Transação sendo processada | Aguardar atualização |
awaiting_payment | Aguardando confirmação de pagamento (comum em PIX) | Aguardar pagamento do cliente |
cancelled | Pagamento cancelado | Transação encerrada |
refunded | Pagamento estornado | Valor devolvido ao cliente |
chargeback | Contestação de pagamento | Analisar disputa |
Liquidation Status
Status de liquidação dos débitos junto aos Detrans:| Status | Descrição |
|---|---|
pending | Liquidação pendente |
processing | Liquidação em processamento |
settled | Débito liquidado com sucesso |
failed | Falha na liquidação |
cancelled | Liquidação cancelada |
Tipos de Débito
Debt Type
Tipos de débitos veiculares disponíveis:| Tipo | Descrição | Exemplo |
|---|---|---|
ticket | Multa de trânsito | Multas de velocidade, estacionamento, etc. |
ipva | IPVA (Imposto sobre Propriedade de Veículos Automotores) | IPVA anual, cota única ou parcelada |
licensing | Taxa de licenciamento | Taxa anual de licenciamento |
service | Taxa de serviço | Multa de pátio, taxas diversas |
Métodos de Pagamento
Payment Method
Métodos de pagamento aceitos:| Método | Descrição | Características |
|---|---|---|
credit_card | Cartão de crédito | Parcelamento disponível (1x a 12x) |
pix | PIX | Pagamento instantâneo, aguarda confirmação |
Tipos de Resposta de Consulta
Search Response Type
Tipos de resposta ao consultar débitos:| Tipo | Descrição |
|---|---|
debts | Veículo possui débitos pendentes |
VehicleWithoutDebts | Veículo sem débitos |
VehicleNotFound | Veículo não encontrado nos sistemas do Detran |
search-error-event | Erro na consulta (indisponibilidade do Detran, etc.) |
Estados (UF)
Brazilian States
Siglas dos estados brasileiros suportados:- Lista Completa
- Código
| UF | Estado |
|---|---|
AC | Acre |
AL | Alagoas |
AP | Amapá |
AM | Amazonas |
BA | Bahia |
CE | Ceará |
DF | Distrito Federal |
ES | Espírito Santo |
GO | Goiás |
MA | Maranhão |
MT | Mato Grosso |
MS | Mato Grosso do Sul |
MG | Minas Gerais |
PA | Pará |
PB | Paraíba |
PR | Paraná |
PE | Pernambuco |
PI | Piauí |
RJ | Rio de Janeiro |
RN | Rio Grande do Norte |
RS | Rio Grande do Sul |
RO | Rondônia |
RR | Roraima |
SC | Santa Catarina |
SP | São Paulo |
SE | Sergipe |
TO | Tocantins |
Limitações por Estado: Alguns estados (GO, MA, MS, RS) retornam apenas IPVA em cota única. Consulte a documentação de consulta de débitos para mais detalhes.
Bandeiras de Cartão
Card Brand
Bandeiras de cartão de crédito aceitas:| Bandeira | Código |
|---|---|
| Visa | visa |
| Mastercard | mastercard |
| American Express | amex |
| Elo | elo |
| Hipercard | hipercard |
| Diners Club | diners |
Códigos de Erro
Error Codes
Códigos de erro específicos da API:| Código | Descrição | Solução |
|---|---|---|
900 | Serviço indisponível | Aguardar e tentar novamente |
901 | Timeout na consulta ao Detran | Tentar novamente após alguns minutos |
902 | Dados inconsistentes retornados pelo Detran | Verificar dados do veículo |
903 | Manutenção programada do Detran | Aguardar fim da manutenção |
HTTP Status Codes
Status Codes Comuns
Códigos HTTP utilizados pela API:2xx - Sucesso
2xx - Sucesso
| Código | Descrição |
|---|---|
200 | OK - Requisição bem-sucedida |
201 | Created - Recurso criado com sucesso |
4xx - Erro do Cliente
4xx - Erro do Cliente
| Código | Descrição |
|---|---|
400 | Bad Request - Dados inválidos na requisição |
401 | Unauthorized - API Key inválida ou ausente |
404 | Not Found - Recurso não encontrado |
422 | Unprocessable Entity - Dados não podem ser processados |
429 | Too Many Requests - Limite de requisições excedido |
5xx - Erro do Servidor
5xx - Erro do Servidor
| Código | Descrição |
|---|---|
500 | Internal Server Error - Erro interno do servidor |
503 | Service Unavailable - Serviço temporariamente indisponível |
Validações e Regras
Formatos de Dados
Formatos esperados para diferentes tipos de dados:Placa de Veículo
Formato:
ABC1234 ou ABC1D23 (Mercosul)- 7 caracteres
- Com ou sem hífen
- Letras maiúsculas
RENAVAM
Formato:
12345678901- 11 dígitos numéricos
- Validação de dígito verificador
CPF
Formato:
12345678900- 11 dígitos numéricos
- Apenas números, sem pontos ou hífen
CNPJ
Formato:
12345678000100- 14 dígitos numéricos
- Apenas números, sem pontos, barra ou hífen
Limites e Restrições
| Campo | Limite | Descrição |
|---|---|---|
| Parcelas | 1 a 12 | Número de parcelas permitido |
| Valor mínimo por parcela | R$ 5,00 | Valor mínimo de cada parcela |
| Timeout de checkout | 24 horas | Tempo de validade do checkout |
| Timeout de PIX | 30 minutos | Tempo para pagamento via PIX |