Consolidação V2 - Transações (Transactions)
Endpoints da versão 2 para gestão consolidada de transações, extratos e relatórios financeiros da plataforma FastGiveMoney.
As rotas de Consolidação V2 estão disponíveis sob o prefixo v2/.
Listagem de Transações
[GET] v2/transactions
Retorna uma lista paginada de todas as transações da conta, com suporte a busca robusta e filtros por tipo e período. A resposta inclui estatísticas financeiras detalhadas e o saldo acumulado (running balance) calculado em tempo real para cada item.
Query Params
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | integer | Não | Página atual (padrão 1). |
| per_page | integer | Não | Itens por página (padrão 15). |
| search | string | Não | Busca por texto em txid, endtoendid, descrição, dados de pagador e recebedor. |
| type | integer | Não | Filtrar por ID de tipo de transação. |
| created_at_start | date | Não | Data inicial (YYYY-MM-DD). Padrão: 30 dias atrás. |
| created_at_end | date | Não | Data final (YYYY-MM-DD). Padrão: hoje. |
Campos de Busca (Search) A busca por texto (search) é otimizada e consulta as seguintes colunas:
txid,endtoendid,descriptionpayer_name,payer_document,payer_bank_name,payer_agency,payer_accountreceiver_name,receiver_document,receiver_bank_name,receiver_agency,receiver_account
Response (200 OK)
{
"data": [
{
"transaction_id": 5821,
"txid": "FDPHHDHWPK48...",
"endtoendid": "E00416968202...",
"description": "Pagamento Recebido via Pix",
"value": 150.00,
"balance": 1500.00,
"status": 1,
"status_description": "Confirmada",
"type_id": 1,
"account_id": 10,
"webhook_id": null,
"payment_date": "2024-03-24",
"bank_id": 1,
"currency": "BRL",
"payer_name": "ESTEVAO DE OLIVEIRA NASCIMENTO",
"payer_document": "17133838702",
"payer_bank_name": "SICOOB",
"payer_agency": "3007",
"payer_account": "1234567",
"receiver_name": "MINHA EMPRESA LTDA",
"receiver_document": "12345678000190",
"receiver_bank_name": "SICOOB",
"receiver_agency": "4169",
"receiver_account": "8202603",
"type": {
"type_id": 1,
"slug": "pix-in",
"name": "PIX RECEBIDO"
},
"datetime": "24/03/2026 14:00:00",
"created_at": "24/03/2026 14:00:00",
"updated_at": "24/03/2026 14:00:00"
}
],
"links": {
"first": "https://api.fastgivemoney.com/v2/transactions?page=1",
"last": "https://api.fastgivemoney.com/v2/transactions?page=10",
"prev": null,
"next": "https://api.fastgivemoney.com/v2/transactions?page=2"
},
"meta": {
"current_page": 1,
"last_page": 10,
"per_page": 15,
"total": 150
},
"statistics": {
"total_received": 15000.50,
"total_paid": 4500.20,
"initial_balance": 10000.00,
"final_balance": 20500.30,
"current_balance": 20500.30,
"period": {
"start_date": "2026-02-24",
"end_date": "2026-03-24"
}
}
}Extrato Financeiro Detalhado (Statement)
[GET] v2/transactions/statement
Gera um extrato financeiro completo incluindo todas as transações, totais de entradas e saídas, e o detalhamento de todas as entidades relacionadas a cada transação (usuário, conta, cobrança, pagamento, etc.).
Query Params
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| page | integer | Não | Página atual (padrão 1) |
| per_page | integer | Não | Itens por página (padrão 15) |
| created_at_start | date | Não | Data inicial (Y-m-d). Padrão: 30 dias atrás |
| created_at_end | date | Não | Data final (Y-m-d). Padrão: hoje |
Response (200 OK)
{
"data": [
{
"transaction_id": 5001,
"type": "received",
"amount": 150.00,
"status": 1,
"description": "Pagamento Pix",
"created_at": "05/03/2024 14:00:00",
"updated_at": "05/03/2024 14:00:00",
"related_entities": {
"user": {
"id": 1,
"name": "Admin",
"email": "admin@fastgivemoney.com"
},
"account": {
"id": 10,
"name": "Empresa X",
"document": "12.345.678/0001-90"
},
"charge": {
"id": 1001,
"value": 150.00,
"due_date": "10/03/2024",
"status": 2
},
"payment": {
"id": 2001,
"type": "pix",
"value": 150.00,
"status": 1,
"payment_date": "05/03/2024"
},
"transfer": [],
"team": [
{ "id": 1, "name": "Admin", "email": "admin@..." }
]
}
}
],
"links": { ... },
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "...",
"per_page": 15,
"to": 1,
"total": 1
},
"statistics": {
"initial_balance": 10000.00,
"final_balance": 15000.00,
"total_received": 150.00,
"total_paid": 0.00,
"period": {
"start_date": "2024-02-05",
"end_date": "2024-03-06"
},
"summary": [
{
"type": "Pix In",
"slug": "pix_in",
"quantity": 10,
"total_value": 1500.00
}
]
}
}Detalhes da Transação
[GET] v2/transactions/{id}
Retorna os detalhes completos de uma única transação específica.
Response (200 OK)
{
"success": true,
"message": "Transaction details retrieved successfully.",
"data": {
"transaction_id": 5001,
"txid": "E123456789...",
"endtoendid": "E123456789...",
"description": "Pagamento Pix",
"value": 150.00,
"balance": 1500.00,
"status": 1,
"status_description": "Confirmada",
"type_id": 1,
"account_id": 10,
"webhook_id": null,
"payment_date": "2024-03-05",
"bank_id": 1,
"payer_name": "JOAO LIMA",
"payer_document": "123.456.789-01",
"payer_bank_name": "BANCO DO BRASIL",
"payer_agency": "0001",
"payer_account": "12345-6",
"currency": "BRL",
"type": {
"type_id": 1,
"name": "Pix In",
"slug": "pix_in"
},
"datetime": "05/03/2024 14:00:00",
"created_at": "05/03/2024 14:00:00",
"updated_at": "05/03/2024 14:00:00"
}
}Download do PDF da Transação
[GET] v2/transactions/{id}/download-pdf
Gera e inicia o download do comprovante em PDF de uma transação específica.
Query Params
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| download | boolean | Não | true (padrão) para download, false para visualizar no browser |
Response (200 OK)
- Download do arquivo binário (PDF).
- Content-Type:
application/pdf
Extrato (Extract)
[GET] v2/extract
Retorna o extrato detalhado de movimentações da conta.
Relatórios (Reports)
[GET] v2/extract/report/transactions
Histórico de entradas, saídas e taxas aplicadas por período.
[GET] v2/extract/report/summary
Sumário consolidado com quantidade total e soma de valores por tipo.
[GET] v2/extract/report/payment-methods
Estatísticas dos métodos de pagamento mais utilizados.