Referência de Endpoints

Índice de todos os endpoints HTTP de fastgivr-api, organizado pelo mesmo agrupamento de routes/*.php. Para os domínios que já têm um fluxo narrativo dedicado (com diagramas, exemplos de payload e regras de negócio), esta página só lista a rota e aponta para lá — não duplica o conteúdo. Para os demais, a descrição aqui é a documentação.

Envelope padrão em toda a API: { code, success, data|<chave>, message? }. Validação: 422 ({ message, errors: { campo: [...] } } nas rotas com FormRequest, ou { success:false, data: { campo: [...] } } nas rotas com validação manual no controller — ver nota em Fluxo de Cadastro). Sem prefixo /api em nenhuma rota.

Legenda de autenticação: 🔓 pública · 🔑 auth:api,sanctum (sem conta ativa — backoffice/tickets) · 🔐 auth:api,sanctum + conta ativa (SetActiveAccountMiddleware + InjectAccountIntoRequest, inclui /access/manager/*).

---

1. Autenticação — /auth/*

Detalhe completo (login com verificação de dispositivo): Fluxo de Login.

#	Método	Rota	Auth	Descrição
1	POST	/auth/register	🔓	Cadastro simples (guard api) — emite JWT direto, sem etapas/aprovação. Distinto do onboarding em /access/register/*
2	POST	/auth/login	🔓	Login com verificação de dispositivo — ver Fluxo de Login
3	POST	/auth/device/verify	🔓	Confirma o dispositivo novo com o código de 6 dígitos
4	POST	/auth/token	🔓	Emite token de integração (credencial de máquina)
5	POST	/auth/forgot-password	🔓	Envia código de recuperação de senha
6	POST	/auth/reset-password	🔓	Redefine a senha com o código
7	POST	/auth/verify-email	🔓	Confirma e-mail com código (fora do onboarding, ex.: troca de e-mail)
8	GET	/auth/me	🔑	Perfil do usuário autenticado
9	PUT	/auth/profile	🔑	Edita nome/e-mail/telefone/senha do próprio usuário
10	POST	/auth/logout	🔑	Encerra a sessão (invalida o JWT)
11	POST	/auth/refresh	🔑	Renova o JWT
12	POST	/auth/send-verification-code	🔑	Reenvia código de verificação de e-mail

2. Cadastro (onboarding multi-etapas) — /access/register/*

Detalhe completo (diagramas, RegisterStatus, exemplos de payload por etapa): Fluxo de Cadastro.

#	Método	Rota	Auth	Descrição
1	POST	/access/register/start	🔓	Cria User + Register, dispara código de e-mail, confia o dispositivo
2	POST	/access/register/verify-email	🔓	Confirma o código de 6 dígitos
3	POST	/access/register/resend-email-code	🔓	Reenvia (cooldown 2 min)
4	PATCH	/access/register/account-type	🔓	Define PF ou PJ
5	PATCH	/access/register/pep	🔓	Declaração de Pessoa Exposta Politicamente
6	PATCH	/access/register/accept-terms	🔓	Registra consentimento aos termos (aditivo, fora da máquina de etapas obrigatórias)
7	PATCH	/access/register/personal-data	🔓	Dados PF: RG, mãe, nascimento, endereço
8	PATCH	/access/register/company-data	🔓	CNPJ + autofill BrasilAPI (PJ)
9	PATCH	/access/register/legal-representative	🔓	Responsável legal (PJ)
10	POST	/access/register/documents	🔓	Upload dos documentos (multipart)
11	GET	/access/register/progress	🔓	Estado consolidado — usado na retomada
12	POST	/access/register/submit	🔓	Finaliza — aprova automático (sandbox) ou envia para análise

3. Conta e segurança — /access/account*, /access/accounts

Sem fluxo narrativo dedicado — arquitetura geral em Apresentação §2.6.

#	Método	Rota	Auth	Descrição
1	GET	/access/accounts	🔐	Lista as contas do usuário logado
2	GET	/access/account	🔐	Dados da conta ativa
3	PUT	/access/account (ou /access/accounts)	🔐	Edita perfil/endereço/webhook_url/logo/config. (metadata)
4	POST	/access/account/pin	🔐	Cadastra o 1º PIN transacional
5	PATCH	/access/account/pin	🔐	Troca um PIN já existente (exige o atual)
6	POST	/access/account/emergency-lock	🔐	Bloqueio de emergência pelo titular (PIN) — ACTIVE → SUSPENDED
7	POST	/access/account/reactivate/request-code	🔐	Envia código de e-mail para reativar
8	POST	/access/account/reactivate	🔐	Confirma o código — SUSPENDED → ACTIVE
9	DELETE	/access/account	🔐	Solicita encerramento (PIN) — ACTIVE → SOFT_DELETED
10	GET	/access/account/statement-of-earnings	🔐	Informe de rendimentos (?year=), agregado por tipo de transação
11	GET	/access/account/documents	🔐	Documentos enviados no onboarding (resolvido via Register pelo document)
12	GET	/access/account/logs	🔐	Auditoria self-service da conta (activity_logs, channel audit, paginado)
13	GET/PUT	/access/account/notification-preferences	🔐	Toggles de notificação (pix_credit, pix_debit, bill_payment, ...)
14	GET	/access/webhook-notifications[/{id}]	🔐	Histórico de tentativas de entrega de webhook ao lojista

4. Gestão de usuários, tokens e papéis — /access/manager/*

CRUD padrão (apiResource), sem fluxo narrativo dedicado.

#	Método	Rota	Auth	Descrição
1	GET/POST/GET/PUT/DELETE	/access/manager/users[/{id}]	🔐	Usuários da conta (convite, papel, edição, remoção)
2	GET/POST/GET/PUT/DELETE	/access/manager/api-tokens[/{id}]	🔐	Credenciais de integração (máquina) da conta
3	GET	/access/manager/guard/roles	🔐	Papéis e permissões disponíveis para atribuir

5. Notificações in-app — /access/notifications/*

#	Método	Rota	Auth	Descrição
1	GET	/access/notifications	🔐	Lista paginada
2	GET	/access/notifications/unread	🔐	Só não lidas
3	GET	/access/notifications/unread-count	🔐	Contador
4	PUT	/access/notifications/{id}/read	🔐	Marca uma como lida
5	PUT	/access/notifications/mark-all-read	🔐	Marca todas como lidas
6	DELETE	/access/notifications/{id}	🔐	Remove uma
7	DELETE	/access/notifications/read/all	🔐	Remove todas as lidas

6. Pix — /pix/*

Detalhe completo (chaves DICT, QR, transferência, devolução, agendado, recorrente, favoritos): Fluxo de Pix.

Grupo	Rotas	Controller
Cobranças (Pix In)	GET/POST /charges, GET /charges/static, POST /charges/{txid}/simulate-payment, GET/PUT/DELETE /charges/{txid}	PixInController
PIN	POST /pin/verify, GET /pin/status	PixPinController
Chaves (DICT)	GET/POST /keys, POST /keys/lookup, DELETE /keys/{id}	PixKeyController
Reivindicação de chave	GET/POST /keys/claims, PUT /keys/claims/{id}/confirm, DELETE /keys/claims/{id}	PixKeyClaimController
Transferências (Pix Out)	GET /transfers, POST /transfers/key/preview, POST /transfers/key, POST /transfers/copy-paste/preview, POST /transfers/copy-paste, POST /transfers/manual, GET /transfers/{id}, GET /transfers/{id}/receipt	PixOutController
Devolução (MED)	POST /transfers/{id}/refund, GET /refunds/reasons, GET /refunds[/{id}]	PixRefundController
Agendado	POST /transfers/key/schedule, GET /schedules, DELETE /schedules/{id}	PixScheduleController
Recorrente	POST/GET /recurrences, GET /recurrences/{id}, PATCH /recurrences/{id}/pause, PATCH /recurrences/{id}/resume, DELETE /recurrences/{id}	PixRecurrenceController
Favoritos/destinatários	GET/POST /recipients, GET /recipients/frequent, GET/PUT/PATCH/DELETE /recipients/{id}	PixRecipientController

7. Transferência bancária tradicional (TED/DOC) — /transfers/*

Sem fluxo narrativo dedicado.

#	Método	Rota	Auth	Descrição
1	GET	/transfers/banks	🔐	Catálogo de bancos (BankInstitution)
2	GET	/transfers/purposes	🔐	Finalidades da transferência (STR0008)
3	POST	/transfers/preview	🔐	Simula valor + tarifa antes de enviar
4	POST	/transfers/internal	🔐	Transferência conta a conta (mesma instituição, por token) — InternalTransferController
5	POST	/transfers/schedule	🔐	Agenda para uma data futura
6	POST	/transfers	🔐	Envia agora (PIN)
7	GET	/transfers	🔐	Histórico
8	GET	/transfers/{id}	🔐	Detalhe
9	DELETE	/transfers/{id}	🔐	Cancela pendente/agendada
10	GET/POST	/transfers/recipients	🔐	Favorecidos (listar / cadastrar manualmente)
11	GET/DELETE	/transfers/recipients/{id}	🔐	Detalhe / remover um favorecido

8. Pagamento de boletos de terceiros — /payments/*

Detalhe completo (inclui a aprovação em duas etapas): Fluxo de Pagamento de Boleto.

#	Método	Rota	Auth	Descrição
1	GET	/payments/boletos	🔐	Histórico
2	POST	/payments/boletos/inspect	🔐	Consulta a linha digitável
3	GET	/payments/boletos/dda	🔐	Boletos DDA disponíveis
4–6	GET/PUT/DELETE	/payments/boletos/recipients[/{id}]	🔐	Favorecidos (cedente/beneficiário)
7	GET	/payments/boletos/pending-approval	🔐	Fila de aprovação (maker-checker)
8–9	PUT/DELETE	/payments/boletos/approve-batch, /reject-batch	🔐	Aprova/rejeita pendentes em lote
10	GET	/payments/boletos/{id}	🔐	Detalhe
11–13	POST	/{id}/pay, /{id}/schedule, /{id}/cancel	🔐	Paga agora / agenda / cancela
14	GET	/payments/boletos/{id}/receipt	🔐	Comprovante junto ao banco
15–17	POST/PUT/DELETE	/{id}/request-approval, /{id}/approve, /{id}/reject	🔐	Fluxo de aprovação individual

9. Emissão de boleto e extrato rápido — /quickpay/*

Sem fluxo narrativo dedicado.

#	Método	Rota	Auth	Descrição
1	GET	/quickpay/boleto/list (ou /quickpay/boletos)	🔐	Lista boletos emitidos pela conta
2	POST	/quickpay/boleto/create (ou /quickpay/boletos)	🔐	Emite um boleto de cobrança — StoreBoletoRequest
3	POST	/quickpay/boleto/deposit	🔐	Emite boleto de depósito (sem pagador específico)
4	POST	/quickpay/boleto/booklet	🔐	Emite um carnê (N boletos)
5	GET	/quickpay/boleto/booklets	🔐	Lista carnês
6	GET	/quickpay/boleto/booklet/{id}	🔐	Boletos de um carnê
7	GET	/quickpay/boleto/{txid}	🔐	Detalhe de um boleto emitido
8	POST	/quickpay/boleto/pdf/{txid} (ou /{txid}/pdf)	🔐	PDF do boleto
9	POST	/quickpay/boleto/cancel	🔐	Cancela um boleto emitido
10	DELETE	/quickpay/boleto/{txid}	🔐	Remove
11	POST	/quickpay/webhooks/send-charge/{chargeId}	🔐	Reenvia notificação de webhook de uma cobrança
12	GET	/quickpay/charges/reports, /charges/export	🔐	Relatórios/exportação de cobranças
13	GET/POST	/quickpay/charges/{id}/download, /{id}/notify	🔐	Download/reenvio de notificação de uma cobrança
14	GET	/quickpay/transactions, /transactions/balance-summary, /transactions/{id}, /transactions/{id}/download, /extract	🔐	Extrato/transações (via QuickPay\TransactionController — path legado; preferir /consolidation/*, item 11)

/quickpay/boleto/* (path legado) e /quickpay/boletos/* (path "agrupado", preferido pelo front-end atual) apontam para o mesmoQuickPay\BoletoController — URLs diferentes, mesmo comportamento.

10. Cobranças e faturamento — /, /billing/*, /invoices*

Sem fluxo narrativo dedicado. invoices/invoicesv2/clients/ invoices_groups e seus aliases billing/* são apiResources (index, store, show, update, destroy) sobre o mesmo controller — os dois caminhos existem porque o front-end consome ambos.

#	Método	Rota	Auth	Descrição
1	apiResource	/invoices, /invoicesv2, /billing/charges	🔐	Cobranças — InvoiceController
2	apiResource	/clients, /billing/clients	🔐	Clientes/pagadores — ClientController
3	apiResource	/invoices_groups, /billing/charge-groups	🔐	Grupos de cobrança — ChargeGroupController
4	GET	/billing/charges/{id}/download-pdf	🔐	PDF de uma cobrança
5	POST	/billing/simulate-payment[/{id}/charges]	🔐	Simulador de venda (Pix/boleto/parcelas) — SalesSimulatorController
6	POST	/billing/charges/notify, /billing/charges/{id}/notify, /invoices/{id}/notify	🔐	Reenvia notificação de cobrança criada/paga
7	GET	/reports/invoices	🔐	Relatório de cobranças

11. Saldo, extrato e estatísticas — /consolidation/*

Detalhe completo: Fluxo de Saldo & Extrato.

Grupo	Rotas
Transações/extrato	GET /transactions, POST /transactions/export, GET /transactions/daily, /by-type, /time-series, GET/GET-pdf /transactions/{id}[/pdf]
Saldo	GET /balance, GET /get-settlement-statement
Referência	GET /transaction-types, GET /methods-payment
Estatísticas	POST /statistic/cards, GET /statistic/boletos
Dashboard	GET /dashboard
Download assinado	GET /exports/download/{id} 🔓 (link temporário assinado, sem auth de sessão)

12. Backoffice — /backoffice/*

Leitura administrativa + curadoria de cadastro (equipe interna, sem conta vinculada). Sem fluxo narrativo dedicado.

#	Método	Rota	Auth	Descrição
1	GET	/backoffice/dashboard	🔑	Visão geral da plataforma
2	GET	/backoffice/registrations[/{id}]	🔑	Fila de cadastros pendentes de análise
3	POST	/backoffice/registrations/{id}/approve, /reject	🔑	Aprova/rejeita um cadastro — provisiona a conta
4	GET	/backoffice/charges[/{id}], /reports/charges	🔑	Cobranças de todas as contas
5	GET	/backoffice/users[/{id}], /reports/users	🔑	Usuários de todas as contas
6	GET/PUT	/backoffice/accounts[/{id}], /{id}/balance, /reports/accounts	🔑	Contas (leitura + edição administrativa)
7	GET	/backoffice/clients[/{id}], /reports/clients	🔑	Clientes de todas as contas
8	GET/PUT/DELETE	/backoffice/transactions[/{id}], /reports/transactions	🔑	Transações (leitura, correção, exclusão administrativa)

13. Chamados de suporte — /tickets/*

#	Método	Rota	Auth	Descrição
1	POST	/tickets/public	🔓	Abertura pela tela pública (visitante, throttle:10,1)
2	GET/POST	/tickets	🔑	Lista / cria (dono vê os seus; suporte/admin vê todos)
3	GET/PUT/PATCH/DELETE	/tickets/{id}	🔑	Detalhe / edita / remove

14. Enums e listas auxiliares — /enums/*

Sempre 🔓 pública. Alimentam <select>s do front-end.

payment-method · user-status · boleto-status · pix-status · webhook-type · webhook-status · type-transactions · status-clients · charge-status · banks · status/pix-withdraw.

15. Webhooks de entrada (callbacks) — /webhook/*

Sempre 🔓 pública (assinatura/validação própria do provedor, quando aplicável).

#	Método	Rota	Descrição
1	ANY	/webhook/stripe	Callback de pagamento Stripe
2	POST	/webhook/teste/pix-in	Simula o callback de Pix recebido do gateway sandbox Teste — dispara PixInSettlementService

---

Domínios sem endpoint HTTP próprio

• Contas de teste / seed — não são endpoints, é dado gerado por php artisan migrate --seed. Ver Contas de Teste.
• Filas e agendamento (pix:process-scheduled, pix:process-recurrences, ImportBankInstitutionsJob, ...) — comandos Artisan/jobs, não rotas HTTP. Ver Apresentação §2.7.