Forgedocs

查询交易状态

GET /api/pix/transaction/{id}

返回 PIX 交易的当前状态,包括金额、对手方和时间戳的详细信息。

标识符可以是:

  • 数字 ID:Avista 返回的内部交易标识符
  • externalId:您在创建交易时提供的外部标识符

认证

需要在 Authorization 头中提供 Bearer 令牌。

路径参数

参数类型必填描述
idstring交易 ID(数字)或 externalId(字符串)

响应 (200)

字段类型描述
idstring交易 ID
externalIdstring | null客户端提供的外部 ID
typestring交易类型:PAYMENTWITHDRAWREFUND_INREFUND_OUTTRANSFER
statusstring状态:PENDINGCONFIRMEDERROR
originalAmountstring原始金额(巴西雷亚尔)
feeAmountstring手续费金额(巴西雷亚尔)
finalAmountstring最终金额(巴西雷亚尔)
e2eIdstring | nullPIX End-to-end ID
counterpartNamestring | null对手方名称
counterpartDocumentstring | null对手方证件(CPF/CNPJ)
counterpartAccountBankCodestring | null对手方银行代码
counterpartAccountBranchstring | null对手方支行
counterpartAccountNumberstring | null对手方账号
counterpartAccountIspbstring | null对手方银行 ISPB
counterpartAccountBankNamestring | null对手方银行名称
createdAtstring创建日期(ISO 8601)
updatedAtstring更新日期(ISO 8601)
processedAtstring | null处理日期(ISO 8601)
{
  "id": "123",
  "externalId": "ext-001",
  "type": "PAYMENT",
  "status": "CONFIRMED",
  "originalAmount": "100.00",
  "feeAmount": "1.50",
  "finalAmount": "98.50",
  "e2eId": "E00416968202512121343VX5Sx8fIpkY",
  "counterpartName": "John Marvin",
  "counterpartDocument": "12312312387",
  "counterpartAccountBankCode": "001",
  "counterpartAccountBranch": "0001",
  "counterpartAccountNumber": "123456-7",
  "counterpartAccountIspb": "00000000",
  "counterpartAccountBankName": "Banco do Brasil",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:35:00.000Z",
  "processedAt": "2024-01-15T10:35:00.000Z"
}

错误

状态码描述
401令牌缺失或无效
404交易未找到

本页目录