获取付款支持参数(Get Supported Payout Parameters)
根据可选的 payoutType 和必填的 country 查询创建付款时可使用的参数值。当前支持俄罗斯(RU)银行付款,返回可用的 bankCode 列表。省略 payoutType 时默认查询 bank。
建议在展示银行选项或提交付款前调用本接口,避免使用已失效或不受支持的银行代码。
请求说明
- 方法:
POST - 路径:
/api/v1/payout/supportedParameters - Content-Type:
application/json - 鉴权:必须携带商户认证及请求签名,参考接入准备
请求字段
| 字段名 | 类型 | 长度 / 限制 | 必填 | 示例值 | 说明 |
|---|---|---|---|---|---|
payoutType | string | bank | 否 | bank | 付款类型;省略时默认为 bank,当前仅支持 bank |
country | string | 2 字符,ISO-3166 | 是 | RU | 二位国家代码;当前仅支持 RU |
请求示例
json
{
"payoutType": "bank",
"country": "RU"
}签名时必须使用上述原始 JSON 请求体,签名请求头及时间戳规则参见接入准备。
响应示例
json
{
"result": {
"code": "S0000",
"msg": "Payout supported parameters query success"
},
"data": {
"type": "bank",
"field": "bankCode",
"parameters": [
{
"bankCode": "NORVIK",
"bankName": "Norvik Bank"
},
{
"bankCode": "OZON",
"bankName": "OZON"
}
]
}
}示例仅展示部分 bankCode。请始终以接口实时返回的完整列表为准;当前 RU/bank 返回 204 个银行代码。
响应字段
| 字段名 | 类型 | 必返 | 说明 |
|---|---|---|---|
result | object | 是 | 请求处理结果 |
data | object | 成功时返回 | 指定国家和付款类型支持的参数 |
result 对象
| 字段名 | 类型 | 必返 | 示例值 | 说明 |
|---|---|---|---|---|
code | string | 是 | S0000 | 返回码;S0000 表示成功 |
msg | string | 是 | Payout supported parameters query success | 返回信息 |
data 对象
| 字段名 | 类型 | 必返 | 示例值 | 说明 |
|---|---|---|---|---|
type | string | 是 | bank | 与创建付款的 payoutMethod.type 对应 |
field | string | 是 | bankCode | parameters 中每项对应的创建付款字段 |
parameters | object[] | 是 | — | 该付款品牌支持的参数值列表 |
data.parameters 数组项
| 字段名 | 类型 | 必返 | 说明 |
|---|---|---|---|
bankCode | string | 是 | 创建银行付款时填写到 payoutMethod.bank.bankCode 的银行代码 |
bankName | string | 是 | 银行展示名称 |
错误响应
错误响应同样使用 result.code 和 result.msg:
| 返回码 | 场景 | 说明 |
|---|---|---|
C0002 | 不支持的参数组合 | 当前仅支持 payoutType=bank 和 country=RU |
C0003 | 签名无效 | 签名错误、时间戳无效或请求超过允许时间窗口 |
C0004 | 商户认证失败 | 缺少认证请求头,或商户/API Key 无效 |
不支持的付款类型示例:
json
{
"result": {
"code": "C0002",
"msg": "Unsupported payoutType: e-wallet"
}
}