按 E2E ID 查询 Cash-In

通过 End-to-End ID（BACEN 唯一标识符）查询 PIX 交易。

端点

GET /api/external/transactions/e2e/:e2e_id

请求头

头	类型	必填	描述
Authorization	String	是	ApiKey {client_id}:{client_secret}
X-Key-Case	String	否	设为 camelCase 以使用 camelCase 接收响应字段（默认 snake_case）

路径参数

参数	类型	必填	描述
e2e_id	String	是	交易的 End-to-End ID（BACEN 格式,正则 ^E\d{8}[a-zA-Z0-9]{22,26}$）

E2E ID 格式（BACEN）

E2E ID 遵循 BACEN 标准：E + ISPB（8 位数字）+ UTC 时间戳（13 位数字）+ 字母数字标识符（9-13 字符,可包含字母和数字）。

有效示例：

• E37839059202603071530000001 -- 全数字（由只用数字的系统生成）
• E18236120202604221900s1218936740 -- 包含字母（Nubank 生成,ISPB 18236120）
• E60746948202604091234A2004l6Agm0 -- 典型字母数字（大写和小写字母都有效）

注意：绝不假设 E2E 全是数字 -- 发行方银行可能使用字母。您的集成必须接受正则 ^E\d{8}[a-zA-Z0-9]{22,26}$。

示例

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

成功响应 (200)

{
  "worked": true,
  "data": {
    "id": "a1b2c3d4e5f64a7b8c9d0e1f2a3b4c5d",
    "transaction_id": "7popu57v6us7p6pcicgq12345",
    "end_to_end_id": "E37839059202603071530000001",
    "external_id": "order-9876",
    "type": "pix",
    "status": "settled",
    "amount": 300000,
    "fee_amount": 0,
    "net_amount": 300000,
    "description": "Pedido #1234",
    "direction": "inbound",
    "counterparty_name": "Maria Santos",
    "payer_document": "12345678901",
    "recipient_document": "37839059000188",
    "recipient_key": "contato@empresa.com.br",
    "payer_ispb": "60701190",
    "payer_bank_name": "ITAU UNIBANCO S.A.",
    "created_at": "2026-03-07T15:30:00Z",
    "completed_at": "2026-03-07T15:30:02Z"
  }
}

此端点返回与 按 ID 查询 中描述的相同交易对象 -- 包括替代形式 processing（飞行中的 PIX OUT,带嵌套 recipient 对象）和 failed（带 reason_code + reason_description）。所有货币值均以基础单位（÷ 10.000 得到雷亚尔）。

错误响应 (404)

{
  "worked": false,
  "detail": "Transação não encontrada para o E2E informado"
}

错误响应 (401)

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

Cash-In 和 Cash-Out

此端点返回入款和出款交易。使用 direction 字段区分：inbound（收款）或 outbound（发送）。