Extracto

Lista las transacciones de la cuenta con paginacion y filtros.

Endpoint

GET /api/external/statement

Headers

Header	Tipo	Obligatorio	Descripcion
Authorization	String	Si	ApiKey {client_id}:{client_secret}

Query Parameters

Parametro	Tipo	Obligatorio	Descripcion	Default
page	Integer	No	Numero de pagina	1
per_page	Integer	No	Items por pagina (max 100)	20
status	String	No	Filtrar por estado (pending, completed, failed)	--
type	String	No	Filtrar por tipo (pix, ted, internal)	--
date_from	String	No	Fecha inicial (formato YYYY-MM-DD)	--
date_to	String	No	Fecha final (formato YYYY-MM-DD)	--

Ejemplo

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"

Respuesta de Exito (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	Descripcion
worked	Boolean	true indica exito en la operacion
data	Array	Lista de transacciones
page	Integer	Pagina actual
per_page	Integer	Items por pagina

Campos de cada transaccion

Campo	Tipo	Descripcion
id	String	UUID interno de la transaccion
transaction_id	String	Identificador publico de la transaccion
end_to_end_id	String	E2E ID del BACEN
external_id	String	Identificador de su sistema. null si no fue informado
type	String	Tipo (pix, ted, internal)
status	String	Estado de la transaccion
amount	Integer	Valor en unidades base (/ 10.000 para reales). 300000 = R$ 30,00
fee_amount	Integer	Tarifa cobrada en unidades base
net_amount	Integer	Valor neto en unidades base
description	String	Descripcion de la transaccion
direction	String	inbound (entrada) o outbound (salida)
counterparty_name	String	Nombre de la contraparte
recipient_key	String	Clave PIX del destinatario (solo envios)
created_at	String	Fecha de creacion (ISO 8601)
completed_at	String	Fecha de conclusion (ISO 8601)

Respuesta de Error (401)

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

Paginacion

El limite maximo de per_page es 100. Para extraer grandes volumenes, itere por las paginas incrementando el parametro page hasta que page alcance total_pages.