Skip to content

Consultar Status do extrato ​

Esta seção explica como consultar o status de um extrato que foi solicitado a exportação

Visão Geral ​

Após ser solicitada a criação de um extrato, o processo entra em uma fila de processamento. Us essa rota para consultar quando o extrato ficará pronto, retornando a URL para baixar o artefato.

Endpoint ​

GET /account/{account_id}/extract/pix/status ​

Consulta o status de um extrato PIX previamente solicitado

URL Completa:

https://app.finexis.com.br/api/v1/gateway/account/{account_id}/extract/pix/status?uuid={uuid}

Headers:

Authorization: Bearer {token}

Parâmetros da URL:

  • account_id (obrigatório): ID da conta

Query Parameters:

  • uuid (obrigatório): Referência do extrato que deseja localizar

Exemplo de URL:


https://app.finexis.com.br/api/v1/gateway/account/5/extract/pix/status?reference=4a31c00169c84021ae61d9b71c...

Exemplo de Requisição:

bash
curl -X GET \
  'https://app.finexis.com.br/api/v1/gateway/account/5/extract/pix/status?reference=4a31c00169c84021ae61d9b71c' \
  -H 'Authorization: Bearer {seu_token}'

Resposta de Sucesso (200):

json
{
  "status": "success",
  "message": "Getting extract with success",
  "data": {
    "id": 188,
    "file": "https://storage.finexis.com.br/data/exports/2026/10/transactions_20261028_205935_76346710.csv",
    "uuid": "76346710-a5dc-47b3-b430-b22b5a20e9e9",
    "status": "complete",
    "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": [...]
    }
  }
}

Status Possíveis ​

StatusDescriçãoAção
pendingprocesso pendenteContinue monitorando
completeprocesso concluídaProcesso finalizado com sucesso
failedprocesso falhouVerifique os detalhes e tente novamente

Próximos Passos ​

Documentação FinexisPayments