Pular para o conteúdo principal
GET
https://api.owem.com.br
/
v4
/
i
/
ledger
/
extract
/
{id}
Consultar Extrato Gerado
curl --request GET \
  --url https://api.owem.com.br/v4/i/ledger/extract/{id} \
  --header 'Authorization: <authorization>'
{
  "requestId": "edfaaae5-27c3-4930-8d86-f2506fdbac38",
  "success": true,
  "size": 1,
  "data": {
    "id": "bd17bf27-1b14-490d-bcd8-ab6e679010ff",
    "status": "done",
    "format": "pdf",
    "accountId": "572471111234",
    "userId": "usr_551862c8",
    "requestedBy": "API - EMPRESA - 572471111234",
    "startDate": 1770778800000,
    "endDate": 1770951600000,
    "options": {
      "sections": {
        "summary": true,
        "monthlyTable": true,
        "monthSummary": true,
        "transactionTable": true
      },
      "columns": {
        "dateTime": true,
        "type": true,
        "description": true,
        "endToEndId": true,
        "payerReceiver": true,
        "payerBankInfo": true,
        "grossAmount": true,
        "fee": true,
        "netAmount": true,
        "status": true
      }
    },
    "reportId": "20260214_572471111234_7367e833.pdf",
    "reportUrl": "https://storage.googleapis.com/files.owem.com.br/ledger/extracts/572471111234/20260214_572471111234_7367e833.pdf?X-Goog-Algorithm=...",
    "reportPath": "ledger/extracts/572471111234/20260214_572471111234_7367e833.pdf",
    "sizeInMb": 2.134,
    "errorMessage": null,
    "createdAt": 1771077652000,
    "updatedAt": 1771088470942
  }
}

​
Finalidade

Este endpoint permite consultar o status e os detalhes de um extrato bancário solicitado previamente via Gerar Extrato Bancário. Quando o status for done, o campo reportUrl contém o link para download do arquivo.

​
Autenticação

​
Authorization
string
obrigatório
Basic Auth obrigatório no formato: Basic {Base64(API_KEY:API_SECRET)}
Requer o scope ledger_extract:get na API Key.

​
Path Parameters

​
id
string
obrigatório
UUID do extrato retornado no endpoint de criação (extractId).

​
Resposta

​
requestId
string
UUID para rastreio da requisição.
​
success
boolean
Status da operação.
​
size
number
Quantidade de registros retornados.
​
data
object
{
  "requestId": "edfaaae5-27c3-4930-8d86-f2506fdbac38",
  "success": true,
  "size": 1,
  "data": {
    "id": "bd17bf27-1b14-490d-bcd8-ab6e679010ff",
    "status": "done",
    "format": "pdf",
    "accountId": "572471111234",
    "userId": "usr_551862c8",
    "requestedBy": "API - EMPRESA - 572471111234",
    "startDate": 1770778800000,
    "endDate": 1770951600000,
    "options": {
      "sections": {
        "summary": true,
        "monthlyTable": true,
        "monthSummary": true,
        "transactionTable": true
      },
      "columns": {
        "dateTime": true,
        "type": true,
        "description": true,
        "endToEndId": true,
        "payerReceiver": true,
        "payerBankInfo": true,
        "grossAmount": true,
        "fee": true,
        "netAmount": true,
        "status": true
      }
    },
    "reportId": "20260214_572471111234_7367e833.pdf",
    "reportUrl": "https://storage.googleapis.com/files.owem.com.br/ledger/extracts/572471111234/20260214_572471111234_7367e833.pdf?X-Goog-Algorithm=...",
    "reportPath": "ledger/extracts/572471111234/20260214_572471111234_7367e833.pdf",
    "sizeInMb": 2.134,
    "errorMessage": null,
    "createdAt": 1771077652000,
    "updatedAt": 1771088470942
  }
}

​
Status do Extrato

StatusDescrição
newSolicitação criada, aguardando processamento.
processingExtrato sendo gerado (consulta de dados, montagem do relatório).
doneExtrato gerado com sucesso. reportUrl disponível para download.
failedErro na geração. Consulte errorMessage para detalhes.

​
Códigos de Status

HTTPDescrição
200Sucesso
401Credenciais inválidas
403Sem permissão para visualizar o extrato
404Extrato não encontrado
429Rate limit excedido
500Erro interno
Recomendamos fazer polling a cada 3-5 segundos até que o status seja done ou failed. Não é necessário polling muito frequente.
O reportUrl é uma URL assinada com validade de 24 horas. Após esse período, a URL expira e será necessário gerar um novo extrato. Recomendamos fazer o download do arquivo (PDF/CSV) assim que o status for done.