Appearance
Criar Extrato
Esta seção explica como solicitar a criação do extrato .csv usando filtros customizados via API.
Visão Geral
Com o extrato é possivel obter em um arquivo de facil portabilidade para consulta de informações como
- Data/hora
- Valor
- E2E/Referencia
- Operador
- Taxa
- Tipo
- Status
Endpoint
POST /account/{account_id}/extract/pix/create
Cria uma nova cobrança PIX e retorna o QR Code para pagamento.
URL Completa:
https://app.finexis.com.br/api/v1/gateway/account/{account_id}/extract/pix/createHeaders:
Authorization: Bearer {token}
Content-Type: application/jsonParâmetros da URL:
account_id(obrigatório): ID da conta que receberá o pagamento
Body:
json
{
"start_date": "2026-01-01",
"end_date": "2026-10-27"
}Campos do Body:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
start_date | string | ✅ Sim | Data inicial de consulta |
end_date | string | ❌ Não | Data final de consilta |
Exemplo de Requisição:
bash
curl -X POST \
'https://app.finexis.com.br/api/v1/gateway/account/5/extract/pix/create' \
-H 'Authorization: Bearer {seu_token}' \
-H 'Content-Type: application/json' \
-d '{
"start_date": "2026-01-01",
"end_date": "2026-10-27"
}'Resposta de Sucesso (200):
json
{
"status": "success",
"message": "Creating extract for transactions",
"data": {
"account_id": 5,
"uuid": "505a10a9-ed76-4885-b036-75ae3f9c65ff",
"status": "pending",
"data": {
"columns": {
"id": "ID",
"account_id": "Conta",
"provider_id": "Provedor",
"currency": "Moeda",
"gross_amount": "Valor Bruto",
"fee": "Taxa",
"net_amount": "Valor Líquido",
"provider_cost": "Custo",
"splited": "Split de Taxa",
"net_profit": "Lucro Líquido",
"type": "Tipo",
"status": "Status",
"external_id": "ID Externo",
"reference": "Referência",
"created_at": "Criado em"
},
"data": [
{
"id": 28777,
"account_id": "0000022",
"provider_id": "❇️ GetPay #credito",
"currency": "BRL",
"gross_amount": "1.15",
"fee": "0.00",
"net_amount": "1.15",
"provider_cost": "0.00",
"splited": "0.00",
"net_profit": "0.00",
"type": "credit",
"status": "paid",
"external_id": "TXVH77O8U3MK3Q4N78ZXBBLNMODUHD9O",
"reference": "342dd509-97f4-4969-9408-faeb3d1809cd",
"created_at": "08/03/2026 19:03"
}
]
}
}
}Dica
Use o UUID para consultar se o estrato ja está pronto.
Próximos Passos
Após criar o extrato:
- Monitore o Status: Use Consultar Status para verificar a o extrato está completo e obter a URL do artefato.