Guias de Pagamento de Cobranças

A API de Guias de Pagamento de Cobranças permite listar e obter detalhes das guias de pagamento associadas às cobranças da 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
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
status_reason
Type
string
Description
Motivo do status (quando aplicável, ex: motivo de rejeição ou falha).
Name
last_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
charge
Type
object
Description
Informações da cobrança relacionada à guia de pagamento.
- Name
  id
  Type
  number
  Description
  ID único da cobrança.
- Name
  external_uid
  Type
  string
  Description
  Identificador externo no órgão.
- Name
  code
  Type
  string
  Description
  Código da cobrança no órgão.
- Name
  description
  Type
  string
  Description
  Descrição da cobrança.
- Name
  due_date
  Type
  string
  Description
  Data de vencimento da cobrança.
- Name
  amount
  Type
  number
  Description
  Valor da cobrança em reais.
- Name
  company
  Type
  object
  Description
  Informações da empresa associada à cobrança.
  Name
  id
  Type
  number
  Description
  ID da empresa.
  Name
  external_uid
  Type
  string
  Description
  Identificador externo da empresa.
  Name
  name
  Type
  string
  Description
  Nome da empresa.

GET/v1/charges/payment-slips

Listar Guias de Pagamento

Retorna uma lista paginada de todas as guias de pagamento de cobranças 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[agency]
Type
object
Description
Filtra por órgão autuador da cobrança associada.
- Name
  $eq
  Type
  string
  Description
  Igual ao valor especificado.
- Name
  $ne
  Type
  string
  Description
  Diferente do valor especificado.

Request

GET

/v1/charges/payment-slips

curl -G https://api.habilitar.me/v1/charges/payment-slips \
  -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",
      "due_date": "2026-01-19",
      "status_reason": null,
      "last_synced_at": "2025-01-10T10:00:00.000Z",
      "created_at": "2026-01-06T19:06:41.609Z",
      "updated_at": "2026-01-14T11:59:25.865Z",
      "charge": {
        "id": 1,
        "external_uid": "FRMEV02298932025",
        "code": "606-82",
        "description": "Pagamento Eletrônico de Frete (PEF)",
        "due_date": "2026-01-19",
        "amount": 293.47,
        "company": {
          "id": 1,
          "external_uid": "EXT_COMPANY_123",
          "name": "Empresa Exemplo Ltda"
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "size": 10,
    "total": 1
  },
  "total": 1
}

Eventos de Webhook

Name
charge.payment-slip.created
Description
Uma nova guia de pagamento de cobrança foi criada.
Name
charge.payment-slip.updated
Description
Uma guia de pagamento de cobrança foi atualizada.

Exemplo de payload

{
  "type": "charge.payment-slip.created",
  "data": {
    "id": 1,
    "status": "issued",
    "amount": 293.47,
    "barcode": "23793381286000000000300000000402184340000029347",
    "due_date": "2026-01-19",
    "status_reason": null,
    "last_synced_at": "2025-01-10T10:00:00.000Z",
    "created_at": "2026-01-06T19:06:41.609Z",
    "updated_at": "2026-01-14T11:59:25.865Z",
    "charge": {
      "id": 1,
      "external_uid": "FRMEV02298932025",
      "code": "606-82",
      "description": "Pagamento Eletrônico de Frete (PEF)",
      "due_date": "2026-01-19",
      "amount": 293.47,
      "company": {
        "id": 1,
        "tax_id": "12345678000190",
        "external_uid": "EXT_COMPANY_123",
        "name": "Empresa Exemplo Ltda"
      }
    }
  }
}