Guias de Pagamento

A API de Guias de Pagamento permite listar e obter detalhes das guias de pagamento de infrações conectadas à sua organização.

Propriedades

Name
id
Type
number
Description
ID único da guia de pagamento.

Name

status

Type

enum

Description

Status da guia de pagamento. Valores possíveis:

Valor	Descrição
`pending`	Solicitação recebida internamente e ainda não processada.
`requested`	Solicitação processada e aguardando emissão por parte do órgão.
`issued`	Guia de pagamento emitida pelo órgão.
`rejected`	Emissão rejeitada pelo órgão.
`failed`	Falha ao gerar guia de pagamento.

Name
discount
Type
enum
Description
Tipo de desconto aplicado. Valores possíveis:
Valor Descrição
full 40% de desconto.
partial 20% de desconto.
none Sem desconto.
Name
amount
Type
number
Description
Valor da guia de pagamento (quando disponível).
Name
barcode
Type
string
Description
Código de barras da guia de pagamento (quando disponível).
Name
due_date
Type
string
Description
Data de vencimento da guia de pagamento no formato "YYYY-MM-DD".
Name
created_at
Type
string
Description
Data e hora de criação da guia de pagamento no formato ISO 8601.
Name
updated_at
Type
string
Description
Data e hora da última atualização da guia de pagamento no formato ISO 8601.
Name
traffic_violation
Type
object
Description
Informações da infração relacionada à guia de pagamento.
- Name
  id
  Type
  number
  Description
  ID único da infração.
- Name
  ait
  Type
  string
  Description
  Número do AIT da infração.
- Name
  code
  Type
  string
  Description
  Código da infração.
- Name
  description
  Type
  string
  Description
  Descrição da infração.

Valor	Descrição
`full`	40% de desconto.
`partial`	20% de desconto.
`none`	Sem desconto.

GET/v1/traffic-violations/tickets/

Listar Guias de Pagamento

Retorna uma lista paginada de todas as guias de pagamento de infrações.

Parâmetros de Paginação

Name
pagination[page]
Type
integer
Description
Número da página (começando em 1). Use junto com pagination[size].
Name
pagination[size]
Type
integer
Description
Tamanho da página (número de itens por página, máximo 100). Use junto com pagination[page].

Parâmetros de Filtro

Name
filters[status]
Type
object
Description
Filtra por status da guia de pagamento.
- Name
  $eq
  Type
  string
  Description
  Igual ao valor especificado. Valores possíveis: pending, requested, issued, rejected, failed.
Name
filters[discount]
Type
object
Description
Filtra por tipo de desconto.
- Name
  $eq
  Type
  string
  Description
  Igual ao valor especificado. Valores possíveis: full, partial, none.
Name
filters[due_date]
Type
object
Description
Filtra por data de vencimento. Formato: YYYY-MM-DD.
- Name
  $eq
  Type
  string
  Description
  Igual ao valor especificado.
- Name
  $ne
  Type
  string
  Description
  Diferente do valor especificado.
- Name
  $lt
  Type
  string
  Description
  Menor que o valor especificado.
- Name
  $lte
  Type
  string
  Description
  Menor ou igual ao valor especificado.
- Name
  $gt
  Type
  string
  Description
  Maior que o valor especificado.
- Name
  $gte
  Type
  string
  Description
  Maior ou igual ao valor especificado.

Request

GET

/v1/traffic-violations/tickets/

curl -G https://api.habilitar.me/v1/traffic-violations/tickets/ \
  -H "x-api-key: {token}" \
  -d "pagination[page]=1" \
  -d "pagination[size]=10"

Response - 200

{
  "data": [
    {
      "id": 1,
      "status": "issued",
      "amount": 130.16,
      "barcode": "23791234560000012345678901234567890123456789012",
      "discount": "partial",
      "due_date": "2026-01-28",
      "traffic_violation": {
        "id": 123,
        "ait": "AIT123456789",
        "code": "7455",
        "description": "Transitar em velocidade superior à máxima permitida em até 20%"
      },
      "created_at": "2026-01-06T19:06:41.609Z",
      "updated_at": "2026-01-14T11:59:25.865Z"
    }
  ],
  "pagination": {
    "page": 1,
    "size": 25,
    "total": 1
  },
  "total": 1
}

GET/v1/traffic-violations/tickets/{id}

Detalhar Guia de Pagamento

Retorna os detalhes de uma guia de pagamento específica.

Parâmetros de Rota

Name
id
Type
number
Required
obrigatório
Description
ID da guia de pagamento que deseja consultar.

Request

GET

/v1/traffic-violations/tickets/{id}

curl https://api.habilitar.me/v1/traffic-violations/tickets/1 \
  -H "x-api-key: {token}"

Response - 200

{
  "data": {
    "id": 1,
    "status": "issued",
    "amount": 130.16,
    "barcode": "23791234560000012345678901234567890123456789012",
    "discount": "partial",
    "due_date": "2026-01-28",
    "traffic_violation": {
      "id": 123,
      "ait": "AIT123456789",
      "code": "7455",
      "description": "Transitar em velocidade superior à máxima permitida em até 20%"
    },
    "created_at": "2026-01-06T19:06:41.609Z",
    "updated_at": "2026-01-14T11:59:25.865Z"
  }
}

Response - 404

{
  "error": "Not Found",
  "message": "Ticket with id 123 not found"
}

GET/v1/traffic-violations/tickets/{id}/file

Arquivo da Guia de Pagamento

Retorna o arquivo PDF da guia de pagamento.

Parâmetros de Rota

Name
id
Type
number
Required
obrigatório
Description
ID da guia de pagamento.

Request

GET

/v1/traffic-violations/tickets/{id}/file

curl https://api.habilitar.me/v1/traffic-violations/tickets/1/file \
  -H "x-api-key: {token}"

Response - 200

{
  "data": "data:application/pdf;base64,JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2..."
}

Response - 404

{
  "error": "Not Found",
  "message": "Ticket with id 123 not found"
}

Eventos de Webhook

Name
traffic-violation.ticket.created
Description
Uma nova guia de pagamento foi criada.
Name
traffic-violation.ticket.updated
Description
Uma guia de pagamento foi atualizada.

Exemplo de payload

{
  "type": "traffic-violation.ticket.created",
  "data": {
    "id": 1,
    "status": "issued",
    "amount": 130.16,
    "barcode": "23791234560000012345678901234567890123456789012",
    "discount": "partial",
    "due_date": "2026-01-28",
    "traffic_violation": {
      "id": 123,
      "ait": "AIT123456789",
      "code": "7455",
      "description": "Transitar em velocidade superior à máxima permitida em até 20%"
    },
    "created_at": "2026-01-06T19:06:41.609Z",
    "updated_at": "2026-01-14T11:59:25.865Z"
  }
}