Skip to main content

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:

Liquidation Status

Status de liquidação dos débitos junto aos Detrans:

Tipos de Débito

Debt Type

Tipos de débitos veiculares disponíveis:

Métodos de Pagamento

Payment Method

Métodos de pagamento aceitos:

Tipos de Resposta de Consulta

Search Response Type

Tipos de resposta ao consultar débitos:

Estados (UF)

Brazilian States

Siglas dos estados brasileiros suportados:
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:

Códigos de Erro

Error Codes

Códigos de erro específicos da API:

HTTP Status Codes

Status Codes Comuns

Códigos HTTP utilizados pela API:

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

Exemplos de Uso

Validação de Enum

Switch Case com ENUMs

Próximos Passos

Fluxo Completo

Veja como usar estes ENUMs no fluxo completo de integração

Consulta de Débitos

Entenda os tipos de débito e status de resposta

Autenticação

Configure sua API Key para começar

Tratamento de Erros

Aprenda a lidar com códigos de erro