Extrato

Lista as transacoes da conta com paginacao e filtros.

Endpoint

GET /api/external/statement

Headers

Header	Tipo	Obrigatorio	Descricao
Authorization	String	Sim	ApiKey {client_id}:{client_secret}

Query Parameters

Parametro	Tipo	Obrigatorio	Descricao	Default
page	Integer	Nao	Numero da pagina	1
per_page	Integer	Nao	Itens por pagina (max 100)	20
status	String	Nao	Filtrar por status (pending, completed, failed)	--
type	String	Nao	Filtrar por tipo (pix, ted, internal)	--
date_from	String	Nao	Data inicial (formato YYYY-MM-DD)	--
date_to	String	Nao	Data final (formato YYYY-MM-DD)	--

Exemplo

curl -X GET "https://api.owem.com.br/api/external/statement?page=1&per_page=20&status=completed&date_from=2026-03-01&date_to=2026-03-07" \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

Resposta de Sucesso (200)

{
  "worked": true,
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "transaction_id": "7popu57v6us7p6pcicgq12345",
      "end_to_end_id": "E37839059202603071530000001",
      "external_id": "order-9876",
      "type": "pix",
      "status": "completed",
      "amount": 300000,
      "fee_amount": 0,
      "net_amount": 300000,
      "description": "Pedido #1234",
      "direction": "inbound",
      "counterparty_name": "Maria Santos",
      "created_at": "2026-03-07T15:30:00Z",
      "completed_at": "2026-03-07T15:30:02Z"
    },
    {
      "id": "f7e8d9c0-b1a2-4c3d-9e8f-7a6b5c4d3e2f",
      "transaction_id": "PIXOUT20260306x9y8z7w6v5u4",
      "end_to_end_id": "E37839059202603061200000005",
      "external_id": "invoice-4521",
      "type": "pix",
      "status": "completed",
      "amount": 500000,
      "fee_amount": 350,
      "net_amount": 500350,
      "description": "Pagamento fornecedor",
      "direction": "outbound",
      "counterparty_name": "Joao Silva",
      "recipient_key": "12345678901",
      "created_at": "2026-03-06T12:00:00Z",
      "completed_at": "2026-03-06T12:00:03Z"
    }
  ],
  "page": 1,
  "per_page": 20
}

Campo	Tipo	Descricao
worked	Boolean	true indica sucesso na operacao
data	Array	Lista de transacoes
page	Integer	Pagina atual
per_page	Integer	Itens por pagina

Campos de cada transacao

Campo	Tipo	Descricao
id	String	UUID interno da transacao
transaction_id	String	Identificador publico da transacao
end_to_end_id	String	E2E ID do BACEN
external_id	String	Identificador do seu sistema. null se nao informado
type	String	Tipo (pix, ted, internal)
status	String	Status da transacao
amount	Integer	Valor em unidades base (÷ 10.000 para reais). 300000 = R$ 30,00
fee_amount	Integer	Tarifa cobrada em unidades base
net_amount	Integer	Valor liquido em unidades base
description	String	Descricao da transacao
direction	String	inbound (entrada) ou outbound (saida)
counterparty_name	String	Nome da contraparte
recipient_key	String	Chave PIX do destinatario (apenas saidas)
created_at	String	Data de criacao (ISO 8601)
completed_at	String	Data de conclusao (ISO 8601)

Resposta de Erro (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Paginacao

O limite maximo de per_page e 100. Para extrair grandes volumes, itere pelas paginas incrementando o parametro page ate que page atinja total_pages.