Rotas Públicas & Enums

Esta seção documenta as rotas acessíveis de forma pública (como links de pagamento e consultas rápidas) e os endpoints auxiliares de Enums para obter as listas e domínios de valores válidos no sistema.

---

🌎 Rotas Públicas (routes/api.php)

1. Status Base do Servidor

Retorna a confirmação de que a API está online e respondendo.

• Método: GET
• Rota: /
• Resposta (200 OK):

  "ok"

2. Disparo de Job de Teste (Sandbox)

Dispara um job assíncrono básico para testar a fila de processamento da aplicação.

• Método: GET
• Rota: /jobTeste
• Resposta (200 OK):

  "disparado!"

3. Consultas Públicas de Cobranças (Public Charges)

Esses endpoints fornecem informações simplificadas de cobranças para exibição externa ou integração sem autenticação de cliente.

• GET /api/public/charges: Lista cobranças públicas.
• GET /api/public/charge: Exibe detalhes básicos de uma cobrança.
• GET /api/public/charge/pix: Retorna os dados Pix de uma cobrança específica.
• GET /api/public/charge/boleto: Retorna os dados do boleto de uma cobrança.
• GET /api/public/pix/{txid}: Consulta o status de um pagamento Pix específico pelo txid.

4. Busca Pública de Boleto por Dados

Permite buscar um boleto ativo utilizando critérios gerais.

• Método: POST
• Rota: /api/public/boletos/search
• Payload JSON:

  {
    "document": "12345678909",
    "nosso_numero": "12345678"
  }

5. Links de Pagamento Públicos (Payment Link)

Módulo que serve a página e os dados de checkout do link de pagamento gerado pelo faturamento.

• GET /api/public/paymentLink/{id}: Retorna as informações do link de pagamento (valores, descrição, métodos aceitos).
• POST /api/public/paymentLink/{id}/pay: Envia os dados de pagamento (Pix/Cartão/Boleto) digitados pelo comprador no checkout.
• GET /api/public/payment-status/{chargeId}/charge: Consulta o status atual de pagamento de uma cobrança gerada a partir do link.

---

🗂️ Rotas de Enums (/enums)

Esses endpoints fornecem as listas padronizadas utilizadas em payloads e filtros no sistema.

1. Métodos de Pagamento

Retorna um mapa associativo com os métodos válidos.

• GET /api/enums/payment-method
• Retorno (200 OK):

  {
    "pix": "PIX",
    "credit_card": "Cartão de Crédito",
    "boleto": "Boleto Bancário",
    "bolepix": "Boleto + Pix"
  }

2. Status do Usuário

• GET /api/enums/user-status
• Retorno (200 OK):

  {
    "1": "Ativo",
    "2": "Inativo",
    "3": "Bloqueado"
  }

3. Status de Boletos

Retorna um mapa de ID do status para o seu respectivo rótulo de exibição.

• GET /api/enums/boleto-status
• Retorno (200 OK):

  {
    "1": "Emitido",
    "2": "Pago",
    "3": "Cancelado",
    "4": "Recusado",
    "5": "Rejeitado"
  }

4. Status de PIX

• GET /api/enums/pix-status
• Retorno (200 OK):

  {
    "1": "Pendente",
    "2": "Pago",
    "3": "Cancelado"
  }

5. Tipos de Webhooks

• GET /api/enums/webhook-type
• Retorno (200 OK):

  [
    {
      "value": "charge.created",
      "title": "Cobrança Criada"
    },
    {
      "value": "charge.paid",
      "title": "Cobrança Paga"
    }
  ]

6. Status de Envio do Webhook

• GET /api/enums/webhook-status
• Retorno (200 OK):

  [
    {
      "value": "pending",
      "title": "Pendente"
    },
    {
      "value": "delivered",
      "title": "Entregue"
    },
    {
      "value": "failed",
      "title": "Falhou"
    }
  ]

7. Tipos de Transações no Livro Razão (Ledger)

Retorna os modelos de tipos de transações direto do banco.

• GET /api/enums/type-transactions
• Retorno (200 OK):

  [
    {
      "id": 1,
      "name": "PIX IN",
      "title": "Recebimento via PIX",
      "created_at": "2024-02-20T12:00:00.000000Z",
      "updated_at": "2024-02-20T12:00:00.000000Z"
    },
    {
      "id": 2,
      "name": "PIX OUT",
      "title": "Pagamento/Saque via PIX",
      "created_at": "2024-02-20T12:00:00.000000Z",
      "updated_at": "2024-02-20T12:00:00.000000Z"
    }
  ]

8. Status dos Clientes

Retorna a lista de status de clientes mapeada do banco.

• GET /api/enums/status-clients
• Retorno (200 OK):

  [
    {
      "id": 1,
      "title": "Ativo",
      "created_at": "2024-02-20T12:00:00.000000Z",
      "updated_at": "2024-02-20T12:00:00.000000Z"
    },
    {
      "id": 2,
      "title": "Inativo",
      "created_at": "2024-02-20T12:00:00.000000Z",
      "updated_at": "2024-02-20T12:00:00.000000Z"
    }
  ]

9. Status das Cobranças (Charges)

Retorna a lista completa de status de cobranças válidas.

• GET /api/enums/charge-status
• Retorno (200 OK):

  [
    {
      "id": 1,
      "title": "pending",
      "created_at": "2024-02-20T12:00:00.000000Z",
      "updated_at": "2024-02-20T12:00:00.000000Z"
    },
    {
      "id": 2,
      "title": "paid",
      "created_at": "2024-02-20T12:00:00.000000Z",
      "updated_at": "2024-02-20T12:00:00.000000Z"
    }
  ]

10. Bancos Homologados e Cadastrados

Retorna o envelope de sucesso padrão contendo a chave banks customizada.

• GET /api/enums/banks
• Retorno (200 OK):

  {
    "code": 200,
    "success": true,
    "banks": [
      {
        "id": 1,
        "name": "SICOOB",
        "code": "756",
        "ispb": "02030405",
        "full_name": "BANCO COOPERATIVO SICOOB S.A.",
        "created_at": "2024-02-20T12:00:00.000000Z",
        "updated_at": "2024-02-20T12:00:00.000000Z"
      },
      {
        "id": 4,
        "name": "SICREDI",
        "code": "748",
        "ispb": "01020304",
        "full_name": "BANCO COOPERATIVO SICREDI S.A.",
        "created_at": "2024-02-20T12:00:00.000000Z",
        "updated_at": "2024-02-20T12:00:00.000000Z"
      }
    ],
    "message": "Bancos listados com sucesso."
  }

11. Status de Links de Pagamento

• GET /api/enums/status/payment_links
• Retorno (200 OK):

  {
    "1": "Ativo",
    "2": "Pausado",
    "3": "Expirado"
  }

12. Status de Saques e Retiradas Pix

Retorna o envelope padrão contendo a lista formatada no campo data.

• GET /api/enums/status/pix-withdraw
• Retorno (200 OK):

  {
    "code": 200,
    "success": true,
    "data": [
      {
        "value": "pending",
        "title": "Pendente",
        "description": "Saque aguardando processamento bancário"
      },
      {
        "value": "completed",
        "title": "Concluído",
        "description": "Transferência realizada com sucesso"
      },
      {
        "value": "failed",
        "title": "Falhou",
        "description": "Transferência devolvida ou cancelada pelo banco"
      }
    ]
  }