Payment channels payment-channels
Admin settings for which gateway each payment method uses and each gateways merchant parameters; secrets are write-only.
Pick an endpoint to see its example call on the right.
Authentication
Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.
X-API-Key
Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).
Conventions
Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.
Times are RFC 3339 (UTC); amounts are in cents.
Writes return 200/201/204 on success; duplicates of a unique key return 409.
/api/v2/payment-channelsGet payment channel settings
Authentication: Admin only
/api/v2/payment-channelsUpdate payment channels
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
alipay | AlipayGateway | Merchant parameters of the Alipay gateway. |
codepay | CodepayGateway | Merchant parameters of the Codepay gateway. |
default_method | string | The method selected by default on the recharge page; transfer = bank transfer (transfer must be enabled). |
epay | EpayGateway | Merchant parameters of the Epay gateway. |
methods | PaymentMethodSet | Enable switch and gateway for each online payment method. |
notify_base | string | Root URL of the panel reachable by the gateways (for example https://panel.example.com); callback URLs are built from it, and empty = orders cannot be placed. |
return_url | string | Page to return to after payment (used by Alipay desktop website payment and Epay); empty = no redirect. |
transfer | PaymentTransfer | Offline transfer settings. |
usdt | UsdtConf | USDT (TRC20) receiving parameters. |
wxpay | WxpayGateway | Merchant parameters of the WeChat Pay gateway. |
/api/v2/payment-channels/usdt-rateFetch USDT rate now
Authentication: Admin only
Request body application/json
| Field | Type | Description |
|---|---|---|
currencyRequired | string | Currency code. |
markup_pct | string | Markup percentage (-50 to 100, decimals allowed); empty = 0. |
sourceRequired | string | Market source: okx/binance (C2C) for CNY, coinbase/kraken for USD, usd (converted via USD) for other currencies. |
Payment channels object
| Field | Type | Description |
|---|---|---|
alipay | AlipayGateway | Merchant parameters of the Alipay gateway. |
codepay | CodepayGateway | Merchant parameters of the Codepay gateway. |
currencyRequired | string | Currency code. |
default_method | string | The method selected by default on the recharge page; transfer = bank transfer (transfer must be enabled). |
epay | EpayGateway | Merchant parameters of the Epay gateway. |
market | string | Fetched market price: 1 USDT = market units of the currency. |
markup_pct | string | Markup percentage (-50 to 100, decimals allowed); empty = 0. |
methods | PaymentMethodSet | Enable switch and gateway for each online payment method. |
notify_base | string | Root URL of the panel reachable by the gateways (for example https://panel.example.com); callback URLs are built from it, and empty = orders cannot be placed. |
rate | string | Rate after applying the markup. |
return_url | string | Page to return to after payment (used by Alipay desktop website payment and Epay); empty = no redirect. |
sourceRequired | string | Market source: okx/binance (C2C) for CNY, coinbase/kraken for USD, usd (converted via USD) for other currencies. |
transfer | PaymentTransfer | Offline transfer settings. |
updated_at | string | Fetch time (server clock); if this draft is adopted when the settings are saved, it becomes the row's update time. |
usdt | UsdtConf | USDT (TRC20) receiving parameters. |
wxpay | WxpayGateway | Merchant parameters of the WeChat Pay gateway. |
Responses and errors
Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.
{
"id": 1,
"name": "example"
}{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}{
"code": "validation_failed",
"detail": "Invalid request parameters",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name is required"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}