Skip to content

按 E2E ID 查询 Cash In

通过 End-to-End ID(BACEN 的唯一标识)查询 PIX 交易。

端点

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

请求头

类型必填描述
AuthorizationStringApiKey {client_id}:{client_secret}

路径参数

参数类型必填描述
e2e_idString交易的 End-to-End ID(格式 E{ISPB}{日期}{序号}

E2E ID 格式

E2E ID 遵循 BACEN 标准:E + ISPB(8 位数字)+ UTC 日期时间(12 位数字)+ 序号(6 位数字)。示例:E37839059202603071530000001

示例

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

成功响应 (200)

json
{
  "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 查询相同的交易对象。所有货币金额均以基本单位表示(/ 10,000 = 雷亚尔)。

错误响应 (404)

json
{
  "worked": false,
  "detail": "Transacao nao encontrada para o E2E informado"
}

错误响应 (401)

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

Cash In 和 Cash Out

此端点同时返回收款和付款交易。请使用 direction 字段区分:inbound(收款)或 outbound(付款)。

Owem Pay Instituição de Pagamento — ISPB 37839059