QuickPay: Serviços de Pagamentos & Saídas
O módulo QuickPay gerencia todas as operações diretas de cobranças (Pix e Boletos emitidos), pagamentos de contas (saída de boletos), retiradas (saque via Pix) e consultas financeiras rápidas do ledger da conta do cliente.
- Prefixo de Rota: Todos os endpoints nesta seção estão sob
/api/quickpay/...(com exceção do novo padrão que pode omitir o prefixo sob o middleware do Sanctum). - Autenticação: Requer Header
Authorization: Bearer {token}e conta ativa via middleware.
⚡ 1. Recebimentos via Pix (Pix In)
Estes endpoints geram Pix imediatos ou fixos vinculados à conta.
Criar Pix Imediato (POST /api/quickpay/pix/create ou qrcode-fixo)
Gera uma nova cobrança Pix com data de expiração e QR Code.
- Payload JSON:json
{ "amount": 100.00, "name": "João da Silva", "email": "joao@exemplo.com", "document": "12345678909" } - Retorno (201 Created) - ApiResponseClass Wrapper:json
{ "code": 201, "success": true, "pix": { "id": 487, "txid": "pix_abc123xyz...", "value": "100.00", "qrcode": "00020126580014br.gov.bcb.pix...", "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...", "created_at": "2026-05-18T20:17:57.000000Z" } }
Detalhar Pix (GET /api/quickpay/pix/{txid})
- Retorno (200 OK) - Raw JSON:json
{ "txid": "pix_abc123xyz...", "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...", "qrcode": "00020126580014br.gov.bcb.pix...", "status": "pending", "value": "100.00", "name": "João da Silva", "email": "joao@exemplo.com", "document": "12345678909", "created_at": "2026-05-18T20:17:57.000000Z", "updated_at": "2026-05-18T20:17:57.000000Z" }
Listar Pix (GET /api/quickpay/pix/list)
Lista cobranças Pix de forma paginada ou retorna o detalhe se txid ou id for enviado via query string.
- Retorno (200 OK) - Raw Paginator JSON:json
{ "current_page": 1, "data": [ { "id": 487, "txid": "pix_abc123xyz...", "qrcode": "00020126580014br.gov.bcb.pix...", "value": "100.00", "status": "pending", "created_at": "2026-05-18T20:17:57.000000Z", "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..." } ], "first_page_url": "https://api.fastgivr.com.br/api/quickpay/pix/list?page=1", "from": 1, "last_page": 1, "last_page_url": "https://api.fastgivr.com.br/api/quickpay/pix/list?page=1", "next_page_url": null, "path": "https://api.fastgivr.com.br/api/quickpay/pix/list", "per_page": 15, "prev_page_url": null, "to": 1, "total": 1 }
💸 2. Saques e Transferências (Withdrawals / Pix Out)
Permite realizar transferências Pix de saída de forma imediata.
Iniciar Saque (POST /api/quickpay/withdraws)
Valida o saldo e os dados e prepara o recebedor, disparando um e-mail de OTP de 4 dígitos para confirmação.
- Payload JSON:json
{ "keypix": "financeiro@loja.com", "value": 1250.00, "message": "Pagamento fornecedor" } - Retorno (201 Created) - ApiResponseClass Wrapper:json
{ "code": 201, "success": true, "data": { "txid": "wtd_987654321...", "value": "1250.00", "name": "Empresa Destinatária S.A.", "bank": "BANCO BRADESCO S.A.", "document": "12345678000109" }, "message": "Recebedor Criado" }
Confirmar Saque com OTP (POST /api/quickpay/withdraws/confirm)
Envia o token numérico recebido no e-mail para autorizar e liquidar a transferência Pix Out no banco parceiro.
- Payload JSON:json
{ "txid": "wtd_987654321...", "code": "1234" } - Retorno (201 Created) - ApiResponseClass Wrapper:json
{ "code": 201, "success": true, "data": { "response": true, "txid": "wtd_987654321...", "value": 1250.00 }, "message": "Pix Saida confirmado." }
📑 3. Emissão de Boletos (Boleto In)
Gerenciamento de emissão e registro de boletos de cobrança.
Emitir Boleto (POST /api/quickpay/boleto/create ou /quickpay/boletos)
Gera e registra o boleto no banco com as devidas instruções e regras opcionais de juros e multas.
- Payload JSON:json
{ "amount": 150.00, "expiration_date": "2026-05-30", "name": "João da Silva", "email": "joao@exemplo.com", "document": "12345678909", "phone": "11999999999", "hasPix": true } - Retorno (200 OK) - ApiResponseClass Wrapper:json
{ "code": 200, "success": true, "data": { "txid": "bol_abc123xyz...", "webhook": null, "qrcode": "00020126580014br.gov.bcb.pix...", "value": 150.00, "account_id": 5, "name": "João da Silva", "email": "joao@exemplo.com", "document": "12345678909", "barcode": "34191790001043510024840730000272", "digitableLine": "34191.79008 01043.510024 48407.300002 7 90001043510024", "expired": "2026-05-30", "ourNumber": "0987654321", "yourNumber": "12345", "client": { "id": 1, "name": "João da Silva", "email": "joao@exemplo.com", "document": "12345678909", "status": 1 }, "boleto": { "id": 12, "txid": "bol_abc123xyz...", "value": 150.00, "barcode": "34191790001043510024840730000272", "digitableLine": "34191.79008 01043.510024 48407.300002 7 90001043510024", "expired": "2026-05-30", "status": 1 } }, "message": "Boleto Gerado com sucesso" }
Cancelar/Baixar Boleto (POST /api/quickpay/boleto/cancel)
- Payload JSON:json
{ "txid": "bol_abc123xyz..." } - Retorno (200 OK) - ApiResponseClass Wrapper:json
{ "code": 200, "success": true, "data": { "bol_abc123xyz...": { "success": true, "message": "Boleto cancelado com sucesso" } }, "message": "Processamento de cancelamento concluído" }
Gerar PDF do Boleto (POST /api/quickpay/boleto/pdf/{txid})
- Retorno (200 OK) - ApiResponseClass Wrapper:json
{ "code": 200, "success": true, "data": { "pdf_url": "/storage/boletos/boleto_bol_abc123xyz.pdf", "pdf_path": "/storage/boletos/boleto_bol_abc123xyz.pdf", "pdf_url_full": "https://api.fastgivr.com.br/storage/boletos/boleto_bol_abc123xyz.pdf" }, "message": "PDF gerado com sucesso" }
Excluir Boleto (DELETE /api/quickpay/boleto/{txid})
- Retorno (200 OK) - ApiResponseClass Wrapper:json
{ "code": 200, "success": true, "data": null, "message": "Boleto deletado com sucesso." }