Enums

Endpoints para consulta de valores válidos (enums) utilizados na API. Estes endpoints são úteis para preencher campos de seleção (selects) no frontend e validar dados antes do envio.

---

Métodos de Pagamento

[GET] /enums/payment-method

Retorna a lista completa de métodos de pagamento suportados pelo sistema.

Headers

Nome	Tipo	Obrigatório	Descrição
Accept	string	Sim	application/json

---

Request (Sem parâmetros)

GET /enums/payment-method

---

Response (200 OK)

{
  "PIX": "Pix",
  "BOLETO": "Boleto",
  "BOLEPIX": "Boleto + Pix",
  "CREDIT_CARD": "Cartão de Crédito",
  "DEBIT_CARD": "Cartão de Débito"
}

---

Status de Usuário

[GET] /enums/user-status

Retorna os possíveis estados em que um usuário do sistema pode se encontrar.

---

Response (200 OK)

{
  "ACTIVE": "Ativo",
  "INACTIVE": "Inativo",
  "PENDING_VERIFICATION": "Pendente de Verificação",
  "BLOCKED": "Bloqueado"
}

---

Status de Boleto

[GET] /enums/boleto-status

Retorna os status específicos para o ciclo de vida de um boleto bancário.

---

Response (200 OK)

{
  "PENDING": "Pendente",
  "PAID": "Pago",
  "OVERDUE": "Atrasado",
  "CANCELED": "Cancelado",
  "DELETED": "Excluído"
}

---

Status de Pix

[GET] /enums/pix-status

Retorna os status específicos para cobranças via Pix.

---

Response (200 OK)

{
  "PENDING": "Pendente",
  "PAID": "Pago",
  "EXPIRED": "Expirado",
  "CANCELED": "Cancelado"
}

---

Tipos de Webhook

[GET] /enums/webhook-type

Retorna os tipos de eventos que podem disparar um webhook.

---

Response (200 OK)

{
  "PAYMENT_RECEIVED": "Pagamento Recebido",
  "CHARGE_CREATED": "Cobrança Criada",
  "CHARGE_EXPIRED": "Cobrança Expirada",
  "WITHDRAW_COMPLETED": "Saque Concluído"
}

---

Tipos de Transação

[GET] /enums/type-transactions

Retorna os tipos de transações financeiras registradas no extrato.

---

Response (200 OK)

[
  {
    "id": 1,
    "name": "PIX IN",
    "description": "Recebimento via Pix",
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  },
  {
    "id": 2,
    "name": "BOLETO IN",
    "description": "Recebimento via Boleto",
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  },
  {
    "id": 3,
    "name": "PIX OUT",
    "description": "Transferência via Pix",
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  },
  {
    "id": 4,
    "name": "TAXA",
    "description": "Taxa de serviço",
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
]

---

Status de Clientes

[GET] /enums/status-clients

Retorna os status de cadastro de clientes/alunos.

---

Response (200 OK)

[
  {
    "id": 1,
    "title": "ACTIVE",
    "label": "Ativo",
    "created_at": "2024-01-01T10:00:00.000000Z",
    "updated_at": "2024-01-01T10:00:00.000000Z"
  },
  {
    "id": 2,
    "title": "INACTIVE",
    "label": "Inativo",
    "created_at": "2024-01-01T10:00:00.000000Z",
    "updated_at": "2024-01-01T10:00:00.000000Z"
  }
]

---

Status de Cobrança

[GET] /enums/charge-status

Retorna os status globais de uma cobrança (Invoice).

---

Response (200 OK)

[
  {
    "id": 1,
    "title": "pending",
    "label": "Pendente",
    "created_at": "2024-01-18T18:41:25.000000Z",
    "updated_at": "2024-01-18T18:41:25.000000Z"
  },
  {
    "id": 2,
    "title": "paid",
    "label": "Pago",
    "created_at": "2024-01-18T18:41:25.000000Z",
    "updated_at": "2024-01-18T18:41:25.000000Z"
  },
  {
    "id": 3,
    "title": "overdue",
    "label": "Vencido",
    "created_at": "2024-01-18T18:41:25.000000Z",
    "updated_at": "2024-01-18T18:41:25.000000Z"
  },
  {
    "id": 4,
    "title": "failed",
    "label": "Falhou",
    "created_at": "2024-01-18T18:41:25.000000Z",
    "updated_at": "2024-01-18T18:41:25.000000Z"
  },
  {
    "id": 5,
    "title": "deleted",
    "label": "Excluído",
    "created_at": "2024-01-18T18:41:25.000000Z",
    "updated_at": "2024-01-18T18:41:25.000000Z"
  }
]

---

Lista de Bancos

[GET] /enums/banks

Retorna uma lista extensa de bancos brasileiros para transferências e configurações de conta.

---

Response (200 OK)

[
  {
    "ispb": "00000000",
    "name": "BCO DO BRASIL S.A.",
    "code": 1,
    "fullName": "Banco do Brasil S.A."
  },
  {
    "ispb": "00000208",
    "name": "BRB - BCO DE BRASILIA S.A.",
    "code": 70,
    "fullName": "BRB - BANCO DE BRASILIA S.A."
  },
  {
    "ispb": "00360305",
    "name": "CAIXA ECONOMICA FEDERAL",
    "code": 104,
    "fullName": "CAIXA ECONOMICA FEDERAL"
  },
  {
    "ispb": "00416968",
    "name": "BANCO INTER",
    "code": 77,
    "fullName": "Banco Inter S.A."
  },
  {
    "ispb": "01181521",
    "name": "BCO COOPERATIVO SICREDI S.A.",
    "code": 748,
    "fullName": "BANCO COOPERATIVO SICREDI S.A."
  },
  {
    "ispb": "02038232",
    "name": "BANCO SICOOB S.A.",
    "code": 756,
    "fullName": "BANCO COOPERATIVO SICOOB S.A. - BANCO SICOOB"
  }
]

(A resposta real contém centenas de bancos brasileiros)