按 ID 查询 Cash Out

通过 transaction_id 查询 PIX 交易的详情和状态。

端点

GET /api/external/transactions/:id

请求头

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

路径参数

参数	类型	必填	描述
id	String	是	交易 ID（transaction_id）

示例

curl -X GET https://api.owem.com.br/api/external/transactions/PIXOUT20260309a1b2c3d4e5f6 \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

成功响应 -- 200

{
  "worked": true,
  "data": {
    "id": "c7f3a8b1-2d4e-4f6a-9c1b-3e5f7a9b1d3e",
    "transaction_id": "PIXOUT20260309a1b2c3d4e5f6",
    "end_to_end_id": "E37839059202603091530abcdef01",
    "external_id": "order-9876",
    "type": "pix",
    "direction": "outbound",
    "status": "completed",
    "amount": 300000,
    "fee_amount": 350,
    "net_amount": 300350,
    "description": "Pagamento fornecedor",
    "counterparty_name": "Joao Silva",
    "recipient_key": "12345678901",
    "created_at": "2026-03-09T15:30:00Z",
    "completed_at": "2026-03-09T15:30:02Z"
  }
}

响应字段

字段	类型	描述
data.id	String	交易内部 UUID
data.transaction_id	String	交易唯一标识
data.end_to_end_id	String	SPI/BACEN 中的端到端标识
data.external_id	String	您系统中的标识符。未提供时为 null
data.type	String	交易类型（pix）
data.direction	String	outbound（付款）或 inbound（收款）
data.status	String	当前状态（见下表）
data.amount	Integer	金额，以基本单位为单位（/ 10,000 = 雷亚尔）。300000 = R$ 30.00
data.fee_amount	Integer	手续费，以基本单位为单位
data.net_amount	Integer	净额，以基本单位为单位
data.description	String	创建时填写的描述
data.counterparty_name	String	对手方姓名（付款方或收款方）
data.recipient_key	String	收款方 PIX 密钥（仅付款交易）
data.created_at	String	创建时间（ISO 8601）
data.completed_at	String	完成时间（ISO 8601），待处理时为 null

交易状态

状态	描述
pending_approval	等待审批（创建+审批流程）
processing	已发送至 SPI，等待清算
completed	清算成功
failed	被 SPI 拒绝或处理出错
refunded	已退回（全额或部分）

错误响应 -- 404

{
  "worked": false,
  "detail": "Transacao nao encontrada"
}