Statement

Lists account transactions with pagination and filters.

Endpoint

GET /api/external/statement

Headers

Header	Type	Required	Description
Authorization	String	Yes	ApiKey {client_id}:{client_secret}

Query Parameters

Parameter	Type	Required	Description	Default
page	Integer	No	Page number	1
per_page	Integer	No	Items per page (max 100)	20
status	String	No	Filter by status (pending, completed, failed)	--
type	String	No	Filter by type (pix, ted, internal)	--
date_from	String	No	Start date (format YYYY-MM-DD)	--
date_to	String	No	End date (format YYYY-MM-DD)	--

Example

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"

Success Response (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
}

Field	Type	Description
worked	Boolean	true indicates operation success
data	Array	List of transactions
page	Integer	Current page
per_page	Integer	Items per page

Transaction fields

Field	Type	Description
id	String	Internal transaction UUID
transaction_id	String	Public transaction identifier
end_to_end_id	String	BACEN E2E ID
external_id	String	Your system identifier. null if not provided
type	String	Type (pix, ted, internal)
status	String	Transaction status
amount	Integer	Amount in base units (/ 10,000 for BRL). 300000 = R$ 30.00
fee_amount	Integer	Fee charged in base units
net_amount	Integer	Net amount in base units
description	String	Transaction description
direction	String	inbound (incoming) or outbound (outgoing)
counterparty_name	String	Counterparty name
recipient_key	String	Recipient PIX key (outbound only)
created_at	String	Creation date (ISO 8601)
completed_at	String	Completion date (ISO 8601)

Error Response (401)

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

Pagination

The maximum per_page limit is 100. To extract large volumes, iterate through pages by incrementing the page parameter until page reaches total_pages.