Fire Bankingdocs

重新发送交易 webhook

POST /api/resend-webhook/{transactionIdentifier}

将特定交易的 webhook 重新发送到已配置的 URL 或临时 URL(覆盖)。

交易标识符可以是:

  • 数字交易 ID:Avista 返回的 ID(webhooks 中的 transactionId 字段)
  • 您的引用 ID:创建交易时提供的标识符(externalId
  • PIX End-to-End ID:webhooks 中返回的 e2eId(格式:E/D + 32 个字符)

认证

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

路径参数

参数类型必填描述
transactionIdentifierstring交易标识符:数字 id、externalId 或 endToEndId

请求体(可选)

字段类型必填描述
urlstring此次重新发送的临时 URL。如果未提供,将使用账户 webhook 中配置的 URL。该 URL 不会被持久化
{
  "url": "https://meu-servidor.com/webhooks/avista"
}

URL 行为

  • 如果请求体中提供了 url,则临时使用该 URL(不会持久化)
  • 如果未提供 url,则使用账户 webhook 中为该操作类型配置的 URL
  • 如果没有可用的 URL,返回错误 400

响应 (200)

字段类型描述
messagestring结果描述信息
webhookLogIdnumber为审计生成的 webhook 日志 ID
sentAtstringWebhook 发送日期/时间(ISO 8601)
statusCodenumber目标 URL 返回的 HTTP 状态码
{
  "message": "Webhook resent successfully",
  "webhookLogId": 12345,
  "sentAt": "2024-01-15T10:30:00.000Z",
  "statusCode": 200
}

错误

状态码描述
400没有可用的 webhook URL。请为此交易的操作类型配置 webhook,或在 url 字段中提供临时 URL
401令牌无效、已过期或缺失
404交易未找到或不属于已认证的账户
429超过速率限制(最大 60 请求/分钟)

本页目录