跳转到主要内容
POST
Update Card Status

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设置为 account_id,该值可通过 List Connected Accounts 接口获取。若省略或为空,则请求以主账户身份执行。 更多信息参见 关联账户

x-idempotency-key
string<uuid>
必填

用于维持操作幂等性的唯一标识符(UUID),确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败的情况下保持数据一致性。

路径参数

id
string<uuid>
必填

资源的全局唯一标识符(UUID v4)。

示例:

"71fdb0fe-9682-457a-9361-e8868694f12f"

请求体

application/json
card_status
enum<string>
必填

卡片状态枚举。更多信息参见卡生命周期与状态指南。

  • ACTIVE - 创建卡片的请求成功,卡片可以使用。
  • FROZEN - 所有进入的授权请求都将被拒绝。卡片可以重新激活以接受新的授权。
  • CANCELLED - 卡片无法再从此状态重新激活,所有进入的授权请求都将被永久拒绝。
可用选项:
ACTIVE,
FROZEN,
CANCELLED
示例:

"FROZEN"

update_reason
string

更新卡片状态的原因。

Maximum string length: 100

响应

200 - application/json

成功更新卡片。

card_id
string
必填

卡片的唯一标识符。

示例:

"c0cef051-29c5-4796-b86a-cd5b684bfad7"

card_order_id
string
必填

卡订单的 ID。

示例:

"c0cef051-29c5-4796-b86a-cd5ee34bfad7"

order_status
enum<string>
必填

此字段包含请求处理后的状态。

  • PENDING - 订单请求的初始状态。
  • PROCESSING - 此状态将通过 webhooks 通知。
  • SUCCESS - 订单请求的最终状态为成功。
  • FAILED - 订单请求的最终状态为失败。
可用选项:
PENDING,
PROCESSING,
SUCCESS,
FAILED
update_reason
string

更新卡片状态的原因。

Maximum string length: 100