账户流水

查询账户的交易记录，支持分页和筛选。

端点

GET /api/external/statement

请求头

头	类型	必填	描述
Authorization	String	是	ApiKey {client_id}:{client_secret}

查询参数

参数	类型	必填	描述	默认值
page	Integer	否	页码	1
per_page	Integer	否	每页条数（最大 100）	20
status	String	否	按状态筛选（pending、completed、failed）	--
type	String	否	按类型筛选（pix、ted、internal）	--
date_from	String	否	起始日期（格式 YYYY-MM-DD）	--
date_to	String	否	截止日期（格式 YYYY-MM-DD）	--

示例

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"

成功响应 (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
}

字段	类型	描述
worked	Boolean	true 表示操作成功
data	Array	交易列表
page	Integer	当前页码
per_page	Integer	每页条数

每笔交易的字段

字段	类型	描述
id	String	交易内部 UUID
transaction_id	String	交易公开标识
end_to_end_id	String	BACEN 的 E2E ID
external_id	String	您系统中的标识符。未提供时为 null
type	String	类型（pix、ted、internal）
status	String	交易状态
amount	Integer	金额，以基本单位为单位（/ 10,000 = 雷亚尔）。300000 = R$ 30.00
fee_amount	Integer	手续费，以基本单位为单位
net_amount	Integer	净额，以基本单位为单位
description	String	交易描述
direction	String	inbound（收款）或 outbound（付款）
counterparty_name	String	对手方姓名
recipient_key	String	收款方 PIX 密钥（仅付款交易）
created_at	String	创建时间（ISO 8601）
completed_at	String	完成时间（ISO 8601）

错误响应 (401)

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

分页

per_page 的最大值为 100。要提取大量数据，请递增 page 参数逐页请求，直到 page 达到 total_pages。