版本 2.4.7.20261116085428 · 最新
支付通道 payment-channels
管理员配置支付方式走哪家网关及各网关商户参数;密钥只写不回显。
点击任一接口,右侧显示对应的调用示例。
支付与账户鉴权: 仅管理员3 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/payment-channels支付通道设置
鉴权: 仅管理员
PUT
/api/v2/payment-channels修改支付通道
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
alipay | AlipayGateway | 支付宝网关的商户参数。 |
codepay | CodepayGateway | 码支付网关的商户参数。 |
default_method | string | 充值页默认选中的方式;transfer = 转账汇款(须已开启转账)。 |
epay | EpayGateway | 易支付网关的商户参数。 |
methods | PaymentMethodSet | 各在线支付方式的开关与所走网关。 |
notify_base | string | 面板对网关可达的根地址(如 https://panel.example.com);回调地址由它拼出,空 = 不能下单。 |
return_url | string | 付款后跳回的页面(支付宝电脑网站支付、易支付用);空 = 不跳。 |
transfer | PaymentTransfer | 线下转账设置。 |
usdt | UsdtConf | USDT(TRC20)收款参数。 |
wxpay | WxpayGateway | 微信支付网关的商户参数。 |
POST
/api/v2/payment-channels/usdt-rate立即获取 USDT 汇率
鉴权: 仅管理员
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
currency必填 | string | 币种代码。 |
markup_pct | string | 上浮百分数(-50~100,可带小数),空 = 0。 |
source必填 | string | 行情源:CNY 用 okx/binance(C2C),USD 用 coinbase/kraken,其他币种用 usd(经 USD 换算)。 |
支付通道对象
| 字段 | 类型 | 说明 |
|---|---|---|
alipay | AlipayGateway | 支付宝网关的商户参数。 |
codepay | CodepayGateway | 码支付网关的商户参数。 |
currency必填 | string | 币种代码。 |
default_method | string | 充值页默认选中的方式;transfer = 转账汇款(须已开启转账)。 |
epay | EpayGateway | 易支付网关的商户参数。 |
market | string | 取到的行情:1 USDT = market 该币。 |
markup_pct | string | 上浮百分数(-50~100,可带小数),空 = 0。 |
methods | PaymentMethodSet | 各在线支付方式的开关与所走网关。 |
notify_base | string | 面板对网关可达的根地址(如 https://panel.example.com);回调地址由它拼出,空 = 不能下单。 |
rate | string | 按上浮算出的汇率。 |
return_url | string | 付款后跳回的页面(支付宝电脑网站支付、易支付用);空 = 不跳。 |
source必填 | string | 行情源:CNY 用 okx/binance(C2C),USD 用 coinbase/kraken,其他币种用 usd(经 USD 换算)。 |
transfer | PaymentTransfer | 线下转账设置。 |
updated_at | string | 取值时间(服务端时间);保存设置时采用这份草稿,该行的更新时间就是它。 |
usdt | UsdtConf | USDT(TRC20)收款参数。 |
wxpay | WxpayGateway | 微信支付网关的商户参数。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}