Skip to main content
GET
/
v4
/
i
/
baas
/
accounts
/
{accountId}
/
statement
curl -X GET "https://api.owem.com.br/v4/i/baas/accounts/123456789012/statement?limit=50&offset=0" \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"
{
  "requestId": "b362d0c7-fea7-40d9-ba4e-b4be85a74670",
  "success": true,
  "size": 0,
  "pagination": {
    "page": 1,
    "limit": 50,
    "orderBy": "desc",
    "total": 0,
    "totalPages": 0
  },
  "data": []
}
curl -X GET "https://api.owem.com.br/v4/i/baas/accounts/123456789012/statement?limit=50&offset=0" \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"

Descrição

Consulta o extrato de movimentações (entradas e saídas) de uma conta bancária BaaS. Suporta paginação e filtro por período.
PROGRAMA BETA - Este endpoint está disponível apenas para parceiros aprovados no programa BAAS.

Autenticação

Este endpoint usa Basic Auth com sua API Key + Secret. O scope baas:accounts é configurado pela Owem na sua API Key.
Authorization: Basic {Base64(API_KEY:API_SECRET)}

Request

Headers

HeaderTipoObrigatórioDescrição
AuthorizationstringBasic Auth (API Key + Secret em Base64)

Path Parameters

ParâmetroTipoObrigatórioDescrição
accountIdstringID da conta (retornado em onboarding/status)

Query Parameters

ParâmetroTipoObrigatórioDefaultDescrição
limitnumber50Máximo de resultados (1-100)
offsetnumber0Paginação (início dos resultados)
startDatestring-Data inicial (YYYY-MM-DD)
endDatestring-Data final (YYYY-MM-DD)

Response

Sucesso (200 OK)

{
  "requestId": "b362d0c7-fea7-40d9-ba4e-b4be85a74670",
  "success": true,
  "size": 2,
  "pagination": {
    "page": 1,
    "limit": 50,
    "orderBy": "desc",
    "total": 2,
    "totalPages": 1
  },
  "data": [
    {
      "id": "led_abc123",
      "type": "credit",
      "reason": "pix_in",
      "amount": 500.0,
      "balance": 1500.5,
      "description": "PIX recebido de JOAO DA SILVA",
      "endToEndId": "E5470000120260113123456789012345",
      "externalId": null,
      "createdAt": 1768264800000
    },
    {
      "id": "led_xyz789",
      "type": "debit",
      "reason": "pix_out:key",
      "amount": 100.0,
      "balance": 1000.5,
      "description": "PIX enviado para [email protected]",
      "endToEndId": "E5470000120260113987654321098765",
      "externalId": "pagamento-001",
      "createdAt": 1768261200000
    }
  ]
}

Campos de Cada Entrada

CampoTipoDescrição
idstringID único da entrada no ledger
typestringTipo: credit (entrada) ou debit (saída)
reasonstringMotivo da movimentação (ver tabela abaixo)
amountnumberValor da movimentação
balancenumberSaldo após a movimentação
descriptionstringDescrição da movimentação
endToEndIdstringID E2E do PIX (se aplicável)
externalIdstringID externo definido pelo parceiro
createdAtnumberTimestamp da movimentação (ms)

Tipos de Movimentação (reason)

ReasonTipoDescrição
pix_increditPIX recebido
pix_out:keydebitPIX enviado via chave
pix_out:emv_paydebitPIX enviado via QR Code
transfer_internalambosTransferência interna
feedebitTaxa cobrada
refundcreditEstorno recebido
refund_outdebitEstorno enviado

Paginação

CampoTipoDescrição
pagenumberPágina atual
limitnumberLimite usado na consulta
orderBystringOrdenação (sempre “desc”)
totalnumberTotal de movimentações
totalPagesnumberTotal de páginas

Erros

CódigoDescrição
400Parâmetros inválidos
403Conta não pertence a este parceiro
404Conta não encontrada
Use os filtros de data (startDate e endDate) para consultar períodos específicos. O formato deve ser YYYY-MM-DD.
{
  "requestId": "b362d0c7-fea7-40d9-ba4e-b4be85a74670",
  "success": true,
  "size": 0,
  "pagination": {
    "page": 1,
    "limit": 50,
    "orderBy": "desc",
    "total": 0,
    "totalPages": 0
  },
  "data": []
}