CLOUD REST / 创作者收益

申请创作者提现

申请创作者提现。查看请求字段、访问条件和响应契约。

接口概览

OpenAPI 原始说明

Accepts an idempotency key in the JSON body; replays are checked against the original operation identity.

请求

POST /api/marketplace/creator/withdrawals

接口组：创作者收益

访问范围

需要正常登录会话的 Bearer 令牌

OpenAPI security scheme: bearerAuth（HTTP Bearer；令牌来自正常登录流程）。

幂等字段：请求体中的 idempotency_key。重试时应沿用同一业务操作的幂等键。

路径参数

此接口没有在 OpenAPI 中声明该类字段。

查询参数

此接口没有在 OpenAPI 中声明该类字段。

请求体

媒体类型：application/json；请求体必填

JSON 请求体字段
字段	类型	要求	约束与说明
`currency`	`string`	必填	金额对应的币种。
`amount_minor`	`integer`	必填	格式：int64；最小值：1
`idempotency_key`	`string`	必填	本次业务操作的幂等键，重试同一操作时沿用。

响应契约

下面列出响应状态和字段结构。标为动态 JSON 的部分没有固定字段，请结合目标服务返回值处理；该表来自文档快照。

OpenAPI 响应声明
状态	说明	媒体类型与 schema
`200`	成功响应查看来源说明 Success.	`application/json` `object：code（必填）: integer；message（必填）: string；data: JSON`
`default`	错误响应；按实际状态与正文处理查看来源说明 Errors have mixed Actix/AppResponseError shapes and status codes; the source does not define one uniform error envelope.	`application/json` `错误 JSON 形状不统一`

请求示例

代码仅为模板，需先填入实际路径、参数和请求体；涉及回调令牌或临时授权地址时，仅在目标流程中使用。

示例语言

cURL

: "${TRADINGAI_BASE_URL:?请先显式设置目标环境的 TRADINGAI_BASE_URL}"
: "${TRADINGAI_ACCESS_TOKEN:?请通过正常登录会话设置令牌}"
curl --fail \
  --silent \
  --show-error \
  --request POST \
  --header "Accept: application/json" \
  --header "Authorization: Bearer $TRADINGAI_ACCESS_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "currency": "<填写 currency>",
  "amount_minor": "__FILL_AMOUNT_MINOR_NUMBER__",
  "idempotency_key": "<填写 idempotency_key>"
}' \
  "$TRADINGAI_BASE_URL/api/marketplace/creator/withdrawals"

请求失败时怎么处理？

先记录 HTTP 状态。若 JSON 正文包含 code 和 message，还应检查业务结果；仅凭 HTTP 200 不能认定操作成功。不同接口的错误封装可能不同。

登录失效时重新建立正常会话；权限不足时核对用户角色、发布者验证和功能开关。写入操作的重试要遵循该接口的幂等规则。

按症状查看排错步骤 →

完整契约与来源

下载完整 OpenAPI JSON · 查看 REST 路由总览与高级说明 · 查看契约版本

来源处理器：request_withdrawal；源码位置：AppFlowy-Cloud-main/src/api/marketplace_settlement.rs:41。

API 登记不表示此路由已在每个生产部署启用；权限、服务配置和功能开关以目标 Cloud 部署为准。