Habilitar.me

Guias de Pagamento de Infrações ANTT

A API de Guias de Pagamento de Infrações ANTT permite listar e obter detalhes das guias de pagamento associadas às infrações ANTT.

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:

    ValorDescrição
    pendingSolicitação recebida internamente e ainda não processada.
    requestedSolicitação processada e aguardando emissão por parte do órgão.
    issuedGuia de pagamento emitida pelo órgão.
    rejectedEmissão rejeitada pelo órgão.
    failedFalha ao gerar guia de pagamento.
  • 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
    payment_method
    Type
    enum
    Description

    Forma de pagamento da guia. Valores possíveis:

    ValorDescrição
    bank_slipBoleto bancário.
    pixPagamento via PIX.
  • Name
    pix
    Type
    string | null
    Description

    Código PIX copia-e-cola da guia de pagamento. Preenchido apenas quando payment_method for pix; caso contrário, retorna null.

  • Name
    due_date
    Type
    string
    Description

    Data de vencimento da guia de pagamento no formato "YYYY-MM-DD".

  • Name
    status_reason
    Type
    string | null
    Description

    Motivo do status (quando aplicável, ex: motivo de rejeição ou falha).

  • Name
    synced_at
    Type
    string
    Description

    Data e hora da última sincronização no formato ISO 8601.

  • 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
    antt_violation
    Type
    object
    Description

    Informações da infração ANTT relacionada à guia de pagamento.

    • Name
      id
      Type
      number
      Description

      ID único da infração ANTT.

    • Name
      external_uid
      Type
      string
      Description

      Identificador da infração no órgão.

    • Name
      code
      Type
      string
      Description

      Código da infração no órgão.

    • Name
      description
      Type
      string
      Description

      Descrição da infração.

    • Name
      due_date
      Type
      string
      Description

      Data de vencimento da infração.

GET/v1/antt/violations/tickets

Listar Guias de Pagamento

Retorna uma lista paginada de todas as guias de pagamento de infrações ANTT da organização.

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
      $ne
      Type
      string
      Description

      Diferente do valor especificado.

  • 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.

  • Name
    filters[company][external_uid]
    Type
    object
    Description

    Filtra por identificador externo da empresa da infração associada.

    • Name
      $eq
      Type
      string
      Description

      Igual ao valor especificado.

    • Name
      $ne
      Type
      string
      Description

      Diferente do valor especificado.

Request

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

Response - 200

{
  "data": [
    {
      "id": 1,
      "status": "issued",
      "amount": 293.47,
      "barcode": "23793381286000000000300000000402184340000029347",
      "payment_method": "bank_slip",
      "pix": null,
      "due_date": "2026-01-19",
      "status_reason": null,
      "synced_at": "2025-01-10T10:00:00.000Z",
      "created_at": "2026-01-06T19:06:41.609Z",
      "updated_at": "2026-01-14T11:59:25.865Z",
      "antt_violation": {
        "id": 1,
        "external_uid": "FRMEV02298932025",
        "code": "606-82",
        "description": "Transitar com excesso de peso bruto total",
        "due_date": "2026-01-19"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "total": 1
  },
  "total": 1
}
GET/v1/antt/violations/tickets/{id}

Detalhar Guia de Pagamento

Retorna os detalhes de uma guia de pagamento de infração ANTT 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/antt/violations/tickets/{id}
curl https://api.habilitar.me/v1/antt/violations/tickets/1 \
  -H "x-api-key: {token}"

Response - 200

{
  "data": {
    "id": 1,
    "status": "issued",
    "amount": 293.47,
    "barcode": "23793381286000000000300000000402184340000029347",
    "payment_method": "bank_slip",
    "pix": null,
    "due_date": "2026-01-19",
    "status_reason": null,
    "synced_at": "2025-01-10T10:00:00.000Z",
    "created_at": "2026-01-06T19:06:41.609Z",
    "updated_at": "2026-01-14T11:59:25.865Z",
    "antt_violation": {
      "id": 1,
      "external_uid": "FRMEV02298932025",
      "code": "606-82",
      "description": "Transitar com excesso de peso bruto total",
      "due_date": "2026-01-19"
    }
  }
}

Response - 404

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

Eventos de Webhook

  • Name
    antt-violation.ticket.created
    Description

    Uma nova guia de pagamento de infração ANTT foi criada.

  • Name
    antt-violation.ticket.updated
    Description

    Uma guia de pagamento de infração ANTT foi atualizada.

Exemplo de payload

{
  "type": "antt-violation.ticket.created",
  "data": {
    "id": 1,
    "status": "issued",
    "amount": 293.47,
    "barcode": "23793381286000000000300000000402184340000029347",
    "payment_method": "bank_slip",
    "pix": null,
    "due_date": "2026-01-19",
    "status_reason": null,
    "synced_at": "2025-01-10T10:00:00.000Z",
    "created_at": "2026-01-06T19:06:41.609Z",
    "updated_at": "2026-01-14T11:59:25.865Z",
    "antt_violation": {
      "id": 1,
      "external_uid": "FRMEV02298932025",
      "code": "606-82",
      "description": "Transitar com excesso de peso bruto total",
      "due_date": "2026-01-19"
    }
  }
}

Essa página foi útil?