跳到主要内容

快速开始

通过以下 4 步完成 API 接入。

1. 获取凭证​

联系商务获取以下信息：

  • API Token（x-api-key）— 用于接口认证
  • API 端点地址 — 接口的基础 URL
# 验证凭证是否有效
curl -X GET "${API_ENDPOINT}/api/payees" \
  -H "x-api-key: sk-xxxxxxxxxxxxxxxxxxxx"

2. 上传文件（如需附件）​

调用 POST /api/upload/file 上传营业执照、身份证件等文件，获得 fileId 供后续接口使用。

curl -X POST "${API_ENDPOINT}/api/upload/file" \
  -H "x-api-key: sk-xxxxxxxxxxxxxxxxxxxx" \
  -F "file=@/path/to/document.pdf"

3. 创建下发单​

调用 POST /api/payouts 提交下发请求。写操作接口需要携带 X-Request-No（唯一请求编号）防止重复提交。

curl -X POST "${API_ENDPOINT}/api/payouts" \
  -H "x-api-key: sk-xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -H "X-Request-No: unique-request-id-001" \
  -d '{"type": "SWIFT", "remits": [...]}'

幂等性说明详见幂等性。

4. 接收状态通知​

配置 Webhook 端点接收下发单和汇款单的状态变更通知：

  • payouts:status_changed — 下发单状态变更
  • remits:status_changed — 汇款单状态变更
# Webhook 回调示例（您的服务器需要处理的请求）
# POST https://your-server.com/webhook
# Content-Type: application/json
#
# {
#   "event": "payouts:status_changed",
#   "data": { "id": "payout_xxx", "status": "COMPLETED" }
# }