通道可用选项
POST /api/v1/channel/options 需带公共签名参数,查询当前 Key 已授权且有有效通道的选项。
维护通道不参与新单可用选项;指定维护通道不会借用其他通道返回结果。已生成正式订单的处理与查单不依赖此选项列表。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
option_type |
string | 是 | 查询类型,见下表 |
currency |
string | 条件必填 | 银行及支付方式查询必填一个已授权币种;币种查询可省略,传入时仅查该币种 |
payment_type |
string | 否 | payin 或 payout;省略时按已授权类型查询。银行查询传入时须与 option_type 的方向一致 |
channel_code |
string | 否 | 限定当前商户在当前环境已启用的一个通道;省略时查询所有符合条件的通道 |
option_type |
内容 | 所需权限 |
|---|---|---|
currency |
当前可用交易币种 | query_balance |
payin_bank |
代收银行、电子钱包 | create_pay_order |
payout_bank |
代付银行、电子钱包 | create_payout_order |
payment_method |
支付网络、支付方式 | query_balance |
查询代付可用币种:
{
"api_key": "<API_KEY>",
"merchant_id": "merchant_1001",
"option_type": "currency",
"payment_type": "payout",
"timestamp": "1789731000",
"nonce": "options_currency_001",
"sign": "<64位小写HMAC-SHA256>"
}
响应 data 示例:
{
"options": [
{"code":"MYR","provider_code":"MYR","name":"MYR","currency":"MYR","enabled":true},
{"code":"SGD","provider_code":"SGD","name":"SGD","currency":"SGD","enabled":true}
]
}
查询 MYR 代付银行:
{
"api_key": "<API_KEY>",
"merchant_id": "merchant_1001",
"option_type": "payout_bank",
"currency": "MYR",
"timestamp": "1789731000",
"nonce": "options_bank_001",
"sign": "<64位小写HMAC-SHA256>"
}
响应示例:
{
"code": 0,
"message": "OK",
"data": {
"options": [
{"code":"MBB","name":"Maybank","currency":"MYR","enabled":true}
]
},
"request_id": "req_example_channel_options"
}
查询 MYR 代付方式,并取得每个通道的名称、金额范围与银行:
{
"api_key": "<API_KEY>",
"merchant_id": "merchant_1001",
"option_type": "payment_method",
"currency": "MYR",
"payment_type": "payout",
"timestamp": "1789731000",
"nonce": "options_method_001",
"sign": "<64位小写HMAC-SHA256>"
}
响应示例:
{
"code": 0,
"message": "OK",
"data": {
"options": [],
"channels": [
{
"channel_code": "ch_example_payout",
"name": "Example MYR Payout",
"payment_type": "payout",
"currency": "MYR",
"min_amount": "10.00",
"max_amount": "5000.00",
"options": [
{"code":"BANK_TRANSFER","name":"Bank Transfer","currency":"MYR","payment_method":"BANK_TRANSFER","enabled":true}
],
"banks": [
{"code":"MBB","name":"Maybank","currency":"MYR","enabled":true}
]
}
]
},
"request_id": "req_example_channel_methods"
}
- 币种和银行查询读取
data.options。银行按currency + code合并去重;未指定通道时不返回所属通道、data.channels或通道金额限额。指定channel_code时只返回该通道的银行。 - 支付方式查询读取
data.channels[]。每组包含channel_code、显示名称name、payment_type、currency、通道已配置的min_amount/max_amount、支付方式options和已验证银行banks;指定通道时同时返回该通道的data.options。没有可信映射时banks为空数组。 min_amount/max_amount是对应通道配置的单笔金额上下限,使用当前查询币种的十进制字符串;未配置的边界省略。固定 Key 查询在data返回这些字段;全局 Key 的银行或支付方式查询指定channel_code时也在data返回。不合并 API Key、商户绑定或 Provider 选项的其他限额,实际创建或确认时仍须校验。- 选项包含
code、name、enabled,可包含currency、payment_method、min_amount、max_amount;金额均为十进制字符串。 - 银行列表查询与收款资料预填无关,不传
bank_code、account_no、account_name或recipient_email。银行及支付方式查询要求对应收银台已开启。 - 无可用选项时返回空列表;通道不可用或读取失败时返回业务错误。金额能否交易仍由创建或确认时校验。每次调用按签名重新生成签名;错误码见错误码。