cdnca

开放接口

/v1/admin/recharge-payment-approvals

7 个接口

← 全部分组 · 第一次调用？先看教程：认证、权限、请求与响应、常见失败

方法路径摘要认证
GET/v1/admin/recharge-payment-approvals稳定快照分页读取充值审批登录会话
POST/v1/admin/recharge-payment-approvals创建充值退款或撤销审批提议登录会话
GET/v1/admin/recharge-payment-approvals/export导出充值审批 CSV登录会话
GET/v1/admin/recharge-payment-approvals/statistics读取充值审批金额统计登录会话
GET/v1/admin/recharge-payment-approvals/{approval_id}读取单条充值审批事实登录会话
POST/v1/admin/recharge-payment-approvals/{approval_id}/approve由不同 operator 批准充值补偿登录会话
POST/v1/admin/recharge-payment-approvals/{approval_id}/reject拒绝充值补偿提议登录会话

契约文件：api/control-recharge-payment-approvals.openapi.yaml

接口详情

GET /v1/admin/recharge-payment-approvals

稳定快照分页读取充值审批

operationId
listRechargePaymentApprovals
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.read

参数

listRechargePaymentApprovals 参数
名称位置类型必填说明
X-Request-IDheaderstring是—
pagequeryinteger是—
limitqueryinteger是—
kindquerystring: refund / void否—
statequerystring: pending / approved / rejected / expired否—
snapshot_atquerystring(date-time)否—

响应

listRechargePaymentApprovals 响应
状态码说明
200稳定快照分页

字段：items: array<Approval> total: integer(int64) page: integer limit: integer snapshot_at: string(date-time)

400稳定错误码
401稳定错误码
403稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

POST /v1/admin/recharge-payment-approvals

创建充值退款或撤销审批提议

operationId
proposeRechargePaymentApproval
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.compensate

参数

proposeRechargePaymentApproval 参数
名称位置类型必填说明
X-Request-IDheaderstring是—
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

proposeRechargePaymentApproval 请求体
名称类型必填说明
order_idstring(uuid)是—
tenant_scope_idstring(uuid)是—
kindstring: refund / void是—
amount_minorinteger(int64)是—
expected_order_revisioninteger(int64)是—
reasonstring是—

响应

proposeRechargePaymentApproval 响应
状态码说明
201新提议或精确重放

字段：id: string(uuid) order_id: string(uuid) tenant_scope_id: string(uuid) kind: string: refund / void amount_minor: integer(int64) currency: string expected_order_revision: integer(int64) reason: string state: string: pending / approved / rejected / expired revision: integer: 1 / 2 proposed_by_scope_id: string(uuid) proposed_by_user_id: string(uuid) proposed_at: string(date-time) expires_at: string(date-time) decided_by_scope_id?: string(uuid) decided_by_user_id?: string(uuid) decided_at?: string(date-time) replayed: boolean

400稳定错误码
401稳定错误码
403稳定错误码
409稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

GET /v1/admin/recharge-payment-approvals/export

导出充值审批 CSV

operationId
exportRechargePaymentApprovals
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.read

参数

exportRechargePaymentApprovals 参数
名称位置类型必填说明
X-Request-IDheaderstring是—
kindquerystring: refund / void否—
statequerystring: pending / approved / rejected / expired否—
snapshot_atquerystring(date-time)否—

响应

exportRechargePaymentApprovals 响应
状态码说明
200UTF-8 CSV with stable snapshot
400稳定错误码
401稳定错误码
403稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

GET /v1/admin/recharge-payment-approvals/statistics

读取充值审批金额统计

operationId
rechargePaymentApprovalStatistics
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.read

参数

rechargePaymentApprovalStatistics 参数
名称位置类型必填说明
X-Request-IDheaderstring是—
kindquerystring: refund / void否—
statequerystring: pending / approved / rejected / expired否—
snapshot_atquerystring(date-time)否—

响应

rechargePaymentApprovalStatistics 响应
状态码说明
200稳定快照统计

字段：snapshot_at: string(date-time) pending_count: integer(int64) approved_count: integer(int64) rejected_count: integer(int64) expired_count: integer(int64) refund_amount_minor: integer(int64) void_amount_minor: integer(int64)

400稳定错误码
401稳定错误码
403稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。

↑ 回到列表

GET /v1/admin/recharge-payment-approvals/{approval_id}

读取单条充值审批事实

operationId
getRechargePaymentApproval
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.read

参数

getRechargePaymentApproval 参数
名称位置类型必填说明
approval_idpathstring(uuid)是—
X-Request-IDheaderstring是—

响应

getRechargePaymentApproval 响应
状态码说明
200充值审批事实

字段：id: string(uuid) order_id: string(uuid) tenant_scope_id: string(uuid) kind: string: refund / void amount_minor: integer(int64) currency: string expected_order_revision: integer(int64) reason: string state: string: pending / approved / rejected / expired revision: integer: 1 / 2 proposed_by_scope_id: string(uuid) proposed_by_user_id: string(uuid) proposed_at: string(date-time) expires_at: string(date-time) decided_by_scope_id?: string(uuid) decided_by_user_id?: string(uuid) decided_at?: string(date-time) replayed: boolean

400稳定错误码
401稳定错误码
403稳定错误码
404稳定错误码
503稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 404 资源不存在或不属于当前租户。
  • 503 依赖暂不可用：稍后用原 Idempotency-Key 重试。

↑ 回到列表

POST /v1/admin/recharge-payment-approvals/{approval_id}/approve

由不同 operator 批准充值补偿

operationId
approveRechargePaymentApproval
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.approve

参数

approveRechargePaymentApproval 参数
名称位置类型必填说明
approval_idpathstring(uuid)是—
X-Request-IDheaderstring是—
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

approveRechargePaymentApproval 请求体
名称类型必填说明
expected_revisioninteger是—

响应

approveRechargePaymentApproval 响应
状态码说明
200批准或精确重放

字段：id: string(uuid) order_id: string(uuid) tenant_scope_id: string(uuid) kind: string: refund / void amount_minor: integer(int64) currency: string expected_order_revision: integer(int64) reason: string state: string: pending / approved / rejected / expired revision: integer: 1 / 2 proposed_by_scope_id: string(uuid) proposed_by_user_id: string(uuid) proposed_at: string(date-time) expires_at: string(date-time) decided_by_scope_id?: string(uuid) decided_by_user_id?: string(uuid) decided_at?: string(date-time) replayed: boolean

400稳定错误码
401稳定错误码
403稳定错误码
409稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表

POST /v1/admin/recharge-payment-approvals/{approval_id}/reject

拒绝充值补偿提议

operationId
rejectRechargePaymentApproval
认证
  • 登录会话：主控登录后的 Bearer 会话，由客户本人在自己的主控里使用；插件不能要求客户交出会话。
所需权限

全部需要：billing.recharges.approve

参数

rejectRechargePaymentApproval 参数
名称位置类型必填说明
approval_idpathstring(uuid)是—
X-Request-IDheaderstring是—
Idempotency-Keyheaderstring是—

请求体

application/json · 必填：是

rejectRechargePaymentApproval 请求体
名称类型必填说明
expected_revisioninteger是—

响应

rejectRechargePaymentApproval 响应
状态码说明
200拒绝或精确重放

字段：id: string(uuid) order_id: string(uuid) tenant_scope_id: string(uuid) kind: string: refund / void amount_minor: integer(int64) currency: string expected_order_revision: integer(int64) reason: string state: string: pending / approved / rejected / expired revision: integer: 1 / 2 proposed_by_scope_id: string(uuid) proposed_by_user_id: string(uuid) proposed_at: string(date-time) expires_at: string(date-time) decided_by_scope_id?: string(uuid) decided_by_user_id?: string(uuid) decided_at?: string(date-time) replayed: boolean

400稳定错误码
401稳定错误码
403稳定错误码
409稳定错误码

失败时怎么办

  • 400 按字段说明修正参数或请求体再发；不要原样重试。
  • 401 检查凭据格式、是否过期或被轮换。
  • 403 检查 Key 范围与所有者当前权限、当前租户作用域；不要换更高权限账号绕过。
  • 409 先回读资源当前状态；同一操作重试保持原 Idempotency-Key 和原请求内容。

↑ 回到列表